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::codeplay::host_handler Class Reference

                                                                                                                                                                                                                                              Command group host handler that implements Codeplay specific API extensions. More...

                                                                                                                                                                                                                                              #include <apis.h>

                                                                                                                                                                                                                                              Public Member Functions

                                                                                                                                                                                                                                               operator cl::sycl::handler & ()
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               operator const cl::sycl::handler & () const
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<typename functorT >
                                                                                                                                                                                                                                              void host_task (const functorT &functor)
                                                                                                                                                                                                                                               This function effectively just launches a single thread to execute the kernel in serial asynchronously to the host execution. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              void experimental_depends_on (cl::sycl::event e)
                                                                                                                                                                                                                                               Register a single event that this handler should wait for before running. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              void experimental_depends_on (std::vector< cl::sycl::event > v)
                                                                                                                                                                                                                                               Register a set of events that this handler should wait for before running. More...
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Protected Member Functions

                                                                                                                                                                                                                                               host_handler (const dqueue_shptr &q, const dqueue_shptr &fallbackQueue=nullptr)
                                                                                                                                                                                                                                               Creates a handler for a specific queue. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              void host_task_impl (const detail::single_task_ptr &singleTaskPtr)
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Protected Attributes

                                                                                                                                                                                                                                              cl::sycl::handler cgh
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Detailed Description

                                                                                                                                                                                                                                              Command group host handler that implements Codeplay specific API extensions.

                                                                                                                                                                                                                                              Definition at line 106 of file codeplay/apis.h.

                                                                                                                                                                                                                                              Constructor & Destructor Documentation

                                                                                                                                                                                                                                              ◆ host_handler()

                                                                                                                                                                                                                                              cl::sycl::codeplay::host_handler::host_handler ( const dqueue_shptr &  q,
                                                                                                                                                                                                                                              const dqueue_shptr &  fallbackQueue = nullptr 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		inlineexplicitprotected

                                                                                                                                                                                                                                              Creates a handler for a specific queue.

                                                                                                                                                                                                                                              Definition at line 114 of file codeplay/apis.h.

                                                                                                                                                                                                                                              Member Function Documentation

                                                                                                                                                                                                                                              ◆ experimental_depends_on() [1/2]

                                                                                                                                                                                                                                              void cl::sycl::codeplay::host_handler::experimental_depends_on ( cl::sycl::event  e)
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Register a single event that this handler should wait for before running.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              eThe event that the handler should wait for before running.

                                                                                                                                                                                                                                              Definition at line 148 of file codeplay/apis.h.

                                                                                                                                                                                                                                              ◆ experimental_depends_on() [2/2]

                                                                                                                                                                                                                                              void cl::sycl::codeplay::host_handler::experimental_depends_on ( std::vector< cl::sycl::event >  v)
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Register a set of events that this handler should wait for before running.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              va vector of events.

                                                                                                                                                                                                                                              Definition at line 156 of file codeplay/apis.h.

                                                                                                                                                                                                                                              ◆ host_task()

                                                                                                                                                                                                                                              template<typename functorT >
                                                                                                                                                                                                                                              void cl::sycl::codeplay::host_handler::host_task ( const functorT &  functor)
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              This function effectively just launches a single thread to execute the kernel in serial asynchronously to the host execution.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              functorTthis is the type of the kernel. It will be automatically deduced by the compiler
                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              functorthe kernel being enqueued

                                                                                                                                                                                                                                              Definition at line 140 of file codeplay/apis.h.

                                                                                                                                                                                                                                              ◆ host_task_impl()

                                                                                                                                                                                                                                              void cl::sycl::codeplay::host_handler::host_task_impl ( const detail::single_task_ptr &  singleTaskPtr)
                                                                                                                                                                                                                                              		protected

                                                                                                                                                                                                                                              ◆ operator cl::sycl::handler &()

                                                                                                                                                                                                                                              cl::sycl::codeplay::host_handler::operator cl::sycl::handler & ( )
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Definition at line 119 of file codeplay/apis.h.

                                                                                                                                                                                                                                              ◆ operator const cl::sycl::handler &()

                                                                                                                                                                                                                                              cl::sycl::codeplay::host_handler::operator const cl::sycl::handler & ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Definition at line 120 of file codeplay/apis.h.

                                                                                                                                                                                                                                              Member Data Documentation

                                                                                                                                                                                                                                              ◆ cgh

                                                                                                                                                                                                                                              cl::sycl::handler cl::sycl::codeplay::host_handler::cgh
                                                                                                                                                                                                                                              		protected

                                                                                                                                                                                                                                              Definition at line 163 of file codeplay/apis.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.