info Please note that this product is now discontinued and product support has ceased. For more information, please read the blog

menu_bookReference

history2.11.0
  1. Classes
    1. N
      cl
      1. N
        sycl
        1. S
          hash< cl::sycl::accessor< elemT, kDims, kMode, kTarget, isPlaceholder > >
          1. N
            info
            1. N
              property
              1. C
                device_selector
                1. C
                  accessor< elemT, 0, kMode, access::target::local, access::placeholder::false_t >
                  1. C
                    accessor< elemT, kDims, kMode, access::target::host_image, access::placeholder::false_t >
                    1. C
                      accessor< elemT, kDims, kMode, access::target::image, access::placeholder::false_t >
                      1. C
                        accessor< elemT, kDims, kMode, access::target::local, access::placeholder::false_t >
                        1. C
                          accessor_error
                          1. S
                            atomic
                            1. C
                              backend_traits< backend::opencl >
                              1. C
                                buffer< const T, dims, AllocatorT >
                                1. C
                                  context
                                  1. C
                                    default_selector
                                    1. C
                                      device_error
                                      1. S
                                        device_type
                                        1. C
                                          event
                                          1. C
                                            exception
                                            1. C
                                              feature_not_supported
                                              1. C
                                                group
                                                1. C
                                                  handler
                                                  1. C
                                                    id
                                                    1. S
                                                      info_convert< cl_context *, context >
                                                      1. S
                                                        info_convert< cl_platform_id *, platform >
                                                        1. C
                                                          intel_selector
                                                          1. C
                                                            invalid_parameter_error
                                                            1. C
                                                              kernel
                                                              1. C
                                                                link_program_error
                                                                1. C
                                                                  multi_ptr
                                                                  1. C
                                                                    multi_ptr< void, asp >
                                                                    1. C
                                                                      nd_range
                                                                      1. C
                                                                        opencl_selector
                                                                        1. C
                                                                          platform_error
                                                                          1. C
                                                                            private_memory
                                                                            1. C
                                                                              profiling_error
                                                                              1. C
                                                                                property_list
                                                                                1. C
                                                                                  range
                                                                                  1. C
                                                                                    sampler
                                                                                    1. S
                                                                                      stream_vec
                                                                                      1. S
                                                                                        stream_vec< 2, true, elementT, kDimensions >
                                                                                        1. S
                                                                                          stream_vec< 4, true, elementT, kDimensions >
                                                                                          1. C
                                                                                            swizzled_vec
                                                                                          2. S
                                                                                            hash< cl::sycl::context >
                                                                                            1. S
                                                                                              hash< cl::sycl::event >
                                                                                              1. S
                                                                                                hash< cl::sycl::kernel >
                                                                                                1. S
                                                                                                  hash< cl::sycl::program >
                                                                                                  1. S
                                                                                                    hash< cl::sycl::sampler >
                                                                                                  2. N
                                                                                                    codeplay
                                                                                                    1. N
                                                                                                      profiling
                                                                                                      1. N
                                                                                                        property
                                                                                                        1. C
                                                                                                          handler
                                                                                                          1. C
                                                                                                            interop_handle
                                                                                                            1. S
                                                                                                              maximum
                                                                                                              1. S
                                                                                                                maximum< void >
                                                                                                                1. S
                                                                                                                  minimum< void >
                                                                                                                  1. C
                                                                                                                    no_init_impl
                                                                                                                  2. C
                                                                                                                    profiling_zone
                                                                                                                    1. C
                                                                                                                      host_access
                                                                                                                    2. N
                                                                                                                      buffer
                                                                                                                      1. C
                                                                                                                        use_onchip_memory
                                                                                                                        1. C
                                                                                                                          host_handler
                                                                                                                          1. S
                                                                                                                            rebind
                                                                                                                            1. C
                                                                                                                              context_bound
                                                                                                                              1. C
                                                                                                                                use_mutex
                                                                                                                                1. C
                                                                                                                                  enable_profiling
                                                                                                                                2. N
                                                                                                                                  experimental
                                                                                                                                  1. S
                                                                                                                                    sub_group
                                                                                                                                    1. S
                                                                                                                                      minimum
                                                                                                                                      1. C
                                                                                                                                        usm_allocator
                                                                                                                                        1. N
                                                                                                                                          ext
                                                                                                                                          1. S
                                                                                                                                            param_traits
                                                                                                                                            1. N
                                                                                                                                              buffer
                                                                                                                                              1. C
                                                                                                                                                use_host_ptr
                                                                                                                                                1. N
                                                                                                                                                  queue
                                                                                                                                                  1. C
                                                                                                                                                    in_order_impl
                                                                                                                                                    1. C
                                                                                                                                                      accelerator_selector
                                                                                                                                                      1. C
                                                                                                                                                        accessor
                                                                                                                                                        1. C
                                                                                                                                                          accessor< elemT, kDims, kMode, access::target::host_buffer, access::placeholder::false_t >
                                                                                                                                                          1. C
                                                                                                                                                            accessor< elemT, kDims, kMode, access::target::host_task, IsPlaceholder >
                                                                                                                                                            1. C
                                                                                                                                                              accessor< elemT, kDims, kMode, access::target::image_array, access::placeholder::false_t >
                                                                                                                                                              1. C
                                                                                                                                                                accessor< elemT, kDims, kMode, access::target::subgroup_local, access::placeholder::false_t >
                                                                                                                                                                1. C
                                                                                                                                                                  amd_selector
                                                                                                                                                                  1. C
                                                                                                                                                                    backend_traits
                                                                                                                                                                    1. C
                                                                                                                                                                      buffer
                                                                                                                                                                      1. C
                                                                                                                                                                        compile_program_error
                                                                                                                                                                        1. C
                                                                                                                                                                          cpu_selector
                                                                                                                                                                          1. C
                                                                                                                                                                            device
                                                                                                                                                                            1. C
                                                                                                                                                                              device_event
                                                                                                                                                                              1. S
                                                                                                                                                                                elem
                                                                                                                                                                                1. C
                                                                                                                                                                                  event_error
                                                                                                                                                                                  1. C
                                                                                                                                                                                    exception_list
                                                                                                                                                                                    1. C
                                                                                                                                                                                      gpu_selector
                                                                                                                                                                                      1. C
                                                                                                                                                                                        h_item
                                                                                                                                                                                        1. C
                                                                                                                                                                                          host_selector
                                                                                                                                                                                          1. C
                                                                                                                                                                                            image
                                                                                                                                                                                            1. S
                                                                                                                                                                                              info_convert< cl_device_id *, device >
                                                                                                                                                                                              1. S
                                                                                                                                                                                                info_convert< size_t *, range< 3 > >
                                                                                                                                                                                                1. C
                                                                                                                                                                                                  invalid_object_error
                                                                                                                                                                                                  1. C
                                                                                                                                                                                                    item
                                                                                                                                                                                                    1. C
                                                                                                                                                                                                      kernel_error
                                                                                                                                                                                                      1. C
                                                                                                                                                                                                        memory_allocation_error
                                                                                                                                                                                                        1. C
                                                                                                                                                                                                          multi_ptr< const void, asp >
                                                                                                                                                                                                          1. C
                                                                                                                                                                                                            nd_item
                                                                                                                                                                                                            1. C
                                                                                                                                                                                                              nd_range_error
                                                                                                                                                                                                              1. C
                                                                                                                                                                                                                platform
                                                                                                                                                                                                                1. C
                                                                                                                                                                                                                  precision_manipulator
                                                                                                                                                                                                                  1. C
                                                                                                                                                                                                                    handler::parallel_for_work_group
                                                                                                                                                                                                                    1. C
                                                                                                                                                                                                                      program
                                                                                                                                                                                                                      1. C
                                                                                                                                                                                                                        queue
                                                                                                                                                                                                                        1. C
                                                                                                                                                                                                                          runtime_error
                                                                                                                                                                                                                          1. C
                                                                                                                                                                                                                            stream
                                                                                                                                                                                                                            1. S
                                                                                                                                                                                                                              stream_vec< 16, true, elementT, kDimensions >
                                                                                                                                                                                                                              1. S
                                                                                                                                                                                                                                stream_vec< 3, true, elementT, kDimensions >
                                                                                                                                                                                                                                1. S
                                                                                                                                                                                                                                  stream_vec< 8, true, elementT, kDimensions >
                                                                                                                                                                                                                                  1. C
                                                                                                                                                                                                                                    vec
                                                                                                                                                                                                                                    1. S
                                                                                                                                                                                                                                      hash< cl::sycl::buffer< T, dimensions, AllocatorT > >
                                                                                                                                                                                                                                      1. S
                                                                                                                                                                                                                                        hash< cl::sycl::device >
                                                                                                                                                                                                                                        1. S
                                                                                                                                                                                                                                          hash< cl::sycl::image< kDimensions, AllocatorT > >
                                                                                                                                                                                                                                          1. S
                                                                                                                                                                                                                                            hash< cl::sycl::platform >
                                                                                                                                                                                                                                            1. S
                                                                                                                                                                                                                                              hash< cl::sycl::queue >
                                                                                                                                                                                                                                              1. S
                                                                                                                                                                                                                                                hash< cl::sycl::stream >

                                                                                                                                                                                                                                              cl::sycl::kernel Class Reference

                                                                                                                                                                                                                                              SYCL Kernel interface. More...

                                                                                                                                                                                                                                              #include <kernel.h>

                                                                                                                                                                                                                                              Public Member Functions

                                                                                                                                                                                                                                               kernel (const kernel &rhs)=default
                                                                                                                                                                                                                                               Copy constructor. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              kernel & operator= (const kernel &rhs)=default
                                                                                                                                                                                                                                               Assignment operator. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               kernel (kernel &&rhs)=default
                                                                                                                                                                                                                                               Move constructor. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              kernel & operator= (kernel &&rhs)=default
                                                                                                                                                                                                                                               Move assignment operator. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              COMPUTECPP_TEST_VIRTUAL ~kernel ()=default
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               COMPUTECPP_DEPRECATED_BY_SYCL_VER (201703, "Use the OpenCL interop constructor which takes a SYCL context instead.") kernel(cl_kernel clKernel)
                                                                                                                                                                                                                                               Create a kernel object from cl_kernel object created by an OpenCL runtime. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               kernel (cl_kernel clKernel, const context &syclContext)
                                                                                                                                                                                                                                               Constructs a kernel object from an OpenCL cl_kernel object. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              COMPUTECPP_TEST_VIRTUAL program get_program () const
                                                                                                                                                                                                                                               Gets the SYCL program object this kernel is associated to. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              COMPUTECPP_TEST_VIRTUAL context get_context () const
                                                                                                                                                                                                                                               Gets the SYCL Context this kernel has been constructed to. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              COMPUTECPP_TEST_VIRTUAL cl_kernel get () const
                                                                                                                                                                                                                                               Get the underlying OpenCL kernel object. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<info::kernel param>
                                                                                                                                                                                                                                              COMPUTECPP_EXPORT info::param_traits< info::kernel, param >::return_type get_info () const
                                                                                                                                                                                                                                               Query information about the kernel. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<info::kernel_work_group param>
                                                                                                                                                                                                                                              info::param_traits< info::kernel_work_group, param >::return_type get_work_group_info (const cl::sycl::device &device) const
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<info::kernel_sub_group param>
                                                                                                                                                                                                                                              info::param_traits< info::kernel_sub_group, param >::return_type get_sub_group_info (const cl::sycl::device &device) const
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<info::kernel_sub_group param>
                                                                                                                                                                                                                                              info::param_traits< info::kernel_sub_group, param >::return_type get_sub_group_info (const cl::sycl::device &device, typename info::param_traits< info::kernel_sub_group, param >::input_type value) const
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              bool is_host () const
                                                                                                                                                                                                                                               Returns whether the kernel was constructed from a host context. More...
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Protected Member Functions

                                                                                                                                                                                                                                              COMPUTECPP_TEST_VIRTUAL cl_kernel get_no_retain () const
                                                                                                                                                                                                                                               Get the underlying OpenCL kernel object without retaining it. More...
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Friends

                                                                                                                                                                                                                                              bool operator== (const kernel &lhs, const kernel &rhs)
                                                                                                                                                                                                                                               Determines if lhs and rhs are equal. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              bool operator!= (const kernel &lhs, const kernel &rhs)
                                                                                                                                                                                                                                               Determines if lhs and rhs are not equal. More...
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Detailed Description

                                                                                                                                                                                                                                              SYCL Kernel interface.

                                                                                                                                                                                                                                              See Section 3.5.4 of the Specification.

                                                                                                                                                                                                                                              Definition at line 535 of file kernel.h.

                                                                                                                                                                                                                                              Constructor & Destructor Documentation

                                                                                                                                                                                                                                              ◆ kernel() [1/3]

                                                                                                                                                                                                                                              cl::sycl::kernel::kernel ( const kernel &  rhs)
                                                                                                                                                                                                                                              		default

                                                                                                                                                                                                                                              Copy constructor.

                                                                                                                                                                                                                                              Create a copy of a kernel.

                                                                                                                                                                                                                                              ◆ kernel() [2/3]

                                                                                                                                                                                                                                              cl::sycl::kernel::kernel ( kernel &&  rhs)
                                                                                                                                                                                                                                              		default

                                                                                                                                                                                                                                              Move constructor.

                                                                                                                                                                                                                                              Create a copy of a kernel.

                                                                                                                                                                                                                                              ◆ ~kernel()

                                                                                                                                                                                                                                              COMPUTECPP_TEST_VIRTUAL cl::sycl::kernel::~kernel ( )
                                                                                                                                                                                                                                              		default

                                                                                                                                                                                                                                              ◆ kernel() [3/3]

                                                                                                                                                                                                                                              cl::sycl::kernel::kernel ( cl_kernel  clKernel,
                                                                                                                                                                                                                                              const context &  syclContext 
                                                                                                                                                                                                                                              )

                                                                                                                                                                                                                                              Constructs a kernel object from an OpenCL cl_kernel object.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              clKernelKernel object created by an OpenCL runtime
                                                                                                                                                                                                                                              syclContextContext associated with the OpenCL kernel object

                                                                                                                                                                                                                                              Member Function Documentation

                                                                                                                                                                                                                                              ◆ COMPUTECPP_DEPRECATED_BY_SYCL_VER()

                                                                                                                                                                                                                                              cl::sycl::kernel::COMPUTECPP_DEPRECATED_BY_SYCL_VER ( 201703  ,
                                                                                                                                                                                                                                              "Use the OpenCL interop constructor which takes a SYCL context instead."   
                                                                                                                                                                                                                                              )

                                                                                                                                                                                                                                              Create a kernel object from cl_kernel object created by an OpenCL runtime.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              clKernelan OpenCL kernel created using the OpenCL API.
                                                                                                                                                                                                                                              Deprecated:
                                                                                                                                                                                                                                              Provide a context as the second argument

                                                                                                                                                                                                                                              ◆ get()

                                                                                                                                                                                                                                              COMPUTECPP_TEST_VIRTUAL cl_kernel cl::sycl::kernel::get ( ) const

                                                                                                                                                                                                                                              Get the underlying OpenCL kernel object.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              A cl_kernel object usable with the OpenCL API.

                                                                                                                                                                                                                                              ◆ get_context()

                                                                                                                                                                                                                                              COMPUTECPP_TEST_VIRTUAL context cl::sycl::kernel::get_context ( ) const

                                                                                                                                                                                                                                              Gets the SYCL Context this kernel has been constructed to.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              The SYCL context this kernel belongs to

                                                                                                                                                                                                                                              ◆ get_info()

                                                                                                                                                                                                                                              template<info::kernel param>
                                                                                                                                                                                                                                              COMPUTECPP_EXPORT info::param_traits<info::kernel, param>::return_type cl::sycl::kernel::get_info ( ) const

                                                                                                                                                                                                                                              Query information about the kernel.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              paramThe kernel information descriptor
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              The kernel information requested with param.

                                                                                                                                                                                                                                              ◆ get_no_retain()

                                                                                                                                                                                                                                              COMPUTECPP_TEST_VIRTUAL cl_kernel cl::sycl::kernel::get_no_retain ( ) const
                                                                                                                                                                                                                                              		protected

                                                                                                                                                                                                                                              Get the underlying OpenCL kernel object without retaining it.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              A cl_kernel object usable with the OpenCL API.

                                                                                                                                                                                                                                              ◆ get_program()

                                                                                                                                                                                                                                              COMPUTECPP_TEST_VIRTUAL program cl::sycl::kernel::get_program ( ) const

                                                                                                                                                                                                                                              Gets the SYCL program object this kernel is associated to.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              The SYCL program this kernel belongs to

                                                                                                                                                                                                                                              ◆ get_sub_group_info() [1/2]

                                                                                                                                                                                                                                              template<info::kernel_sub_group param>
                                                                                                                                                                                                                                              info::param_traits<info::kernel_sub_group, param>::return_type cl::sycl::kernel::get_sub_group_info ( const cl::sycl::device &  device) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Definition at line 697 of file kernel.h.

                                                                                                                                                                                                                                              ◆ get_sub_group_info() [2/2]

                                                                                                                                                                                                                                              template<info::kernel_sub_group param>
                                                                                                                                                                                                                                              info::param_traits<info::kernel_sub_group, param>::return_type cl::sycl::kernel::get_sub_group_info ( const cl::sycl::device &  device,
                                                                                                                                                                                                                                              typename info::param_traits< info::kernel_sub_group, param >::input_type  value 
                                                                                                                                                                                                                                              ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Definition at line 710 of file kernel.h.

                                                                                                                                                                                                                                              ◆ get_work_group_info()

                                                                                                                                                                                                                                              template<info::kernel_work_group param>
                                                                                                                                                                                                                                              info::param_traits<info::kernel_work_group, param>::return_type cl::sycl::kernel::get_work_group_info ( const cl::sycl::device &  device) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Definition at line 684 of file kernel.h.

                                                                                                                                                                                                                                              ◆ is_host()

                                                                                                                                                                                                                                              bool cl::sycl::kernel::is_host ( ) const

                                                                                                                                                                                                                                              Returns whether the kernel was constructed from a host context.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              True if kernel constructed from a host context

                                                                                                                                                                                                                                              ◆ operator=() [1/2]

                                                                                                                                                                                                                                              kernel& cl::sycl::kernel::operator= ( const kernel &  rhs)
                                                                                                                                                                                                                                              		default

                                                                                                                                                                                                                                              Assignment operator.

                                                                                                                                                                                                                                              Assign a copy of a kernel.

                                                                                                                                                                                                                                              ◆ operator=() [2/2]

                                                                                                                                                                                                                                              kernel& cl::sycl::kernel::operator= ( kernel &&  rhs)
                                                                                                                                                                                                                                              		default

                                                                                                                                                                                                                                              Move assignment operator.

                                                                                                                                                                                                                                              Assign a copy of a kernel.

                                                                                                                                                                                                                                              Friends And Related Function Documentation

                                                                                                                                                                                                                                              ◆ operator!=

                                                                                                                                                                                                                                              bool operator!= ( const kernel &  lhs,
                                                                                                                                                                                                                                              const kernel &  rhs 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		friend

                                                                                                                                                                                                                                              Determines if lhs and rhs are not equal.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              lhsLeft-hand-side object in comparison
                                                                                                                                                                                                                                              rhsRight-hand-side object in comparison
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              True if different underlying objects

                                                                                                                                                                                                                                              Definition at line 633 of file kernel.h.

                                                                                                                                                                                                                                              ◆ operator==

                                                                                                                                                                                                                                              bool operator== ( const kernel &  lhs,
                                                                                                                                                                                                                                              const kernel &  rhs 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		friend

                                                                                                                                                                                                                                              Determines if lhs and rhs are equal.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              lhsLeft-hand-side object in comparison
                                                                                                                                                                                                                                              rhsRight-hand-side object in comparison
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              True if same underlying object

                                                                                                                                                                                                                                              Definition at line 624 of file kernel.h.

                                                                                                                                                                                                                                              The documentation for this class was generated from the following file:

                                                                                                                                                                                                                                              Select a Product

                                                                                                                                                                                                                                              Please select a product

                                                                                                                                                                                                                                              oneAPI

                                                                                                                                                                                                                                              oneAPI is a cross-industry, open, standards-based unified programming model that delivers a common developer experience across accelerator architecture - for faster application performance, more productivity, and greater innovation.

                                                                                                                                                                                                                                              Dark Mode
                                                                                                                                                                                                                                              brightness_2

                                                                                                                                                                                                                                              Dark Mode

                                                                                                                                                                                                                                              Light text on a dark background.

                                                                                                                                                                                                                                              Light Mode
                                                                                                                                                                                                                                              lightbulb_outline

                                                                                                                                                                                                                                              Light Mode

                                                                                                                                                                                                                                              Dark text on a light background.

                                                                                                                                                                                                                                              public

                                                                                                                                                                                                                                              Also,

                                                                                                                                                                                                                                              part of our network

                                                                                                                                                                                                                                              search
                                                                                                                                                                                                                                              No results found, please try another search term.
                                                                                                                                                                                                                                              sync
                                                                                                                                                                                                                                              Searching, Please Wait...

                                                                                                                                                                                                                                              Please type to begin searching or try these:


                                                                                                                                                                                                                                              • oneapi nvidia
                                                                                                                                                                                                                                              • cl::sycl
                                                                                                                                                                                                                                              • 2.5.0
                                                                                                                                                                                                                                              • download oneapi amd
                                                                                                                                                                                                                                              • getting started guide
                                                                                                                                                                                                                                              • construction kit
                                                                                                                                                                                                                                              Tip: Press 'enter' key to select first result.
                                                                                                                                                                                                                                              There was a problem searching, please try again later.