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::interop_handle Class Reference

                                                                                                                                                                                                                                              Handle that allows access to OpenCL interop objects on a specific SYCL queue. More...

                                                                                                                                                                                                                                              #include <interop_handle.h>

                                                                                                                                                                                                                                              Inherited by cl::sycl::detail::interop_handle [protected].

                                                                                                                                                                                                                                              Public Member Functions

                                                                                                                                                                                                                                              template<typename elemT , int kDims, access::mode kMode, access::target kTarget, access::placeholder isPlaceholder>
                                                                                                                                                                                                                                              cl_mem get (const accessor< elemT, kDims, kMode, kTarget, isPlaceholder > &acc) const
                                                                                                                                                                                                                                               Retrieves an OpenCL memory object (buffer/image) associated with a device accessor. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              cl_command_queue get_queue () const
                                                                                                                                                                                                                                               Retrieves the OpenCL command queue from the SYCL one. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              cl_context get_context () const
                                                                                                                                                                                                                                               Retrieves the OpenCL context associated with the SYCL queue. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              cl_device_id get_device () const
                                                                                                                                                                                                                                               Retrieves the OpenCL device associated with the SYCL queue. More...
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Protected Member Functions

                                                                                                                                                                                                                                               interop_handle (dqueue_shptr syclQueue)
                                                                                                                                                                                                                                               Constructs an interop object from a SYCL queue. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              cl_mem get_mem_object_impl (const accessor_base &acc) const
                                                                                                                                                                                                                                               Helper function for retrieving the OpenCL memory object from an accessor. More...
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Friends

                                                                                                                                                                                                                                              codeplay::interop_handle detail::make_interop_handle (detail::interop_handle_tag< codeplay::interop_handle >, dqueue_shptr syclQueue)
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Detailed Description

                                                                                                                                                                                                                                              Handle that allows access to OpenCL interop objects on a specific SYCL queue.

                                                                                                                                                                                                                                              Definition at line 65 of file codeplay/interop_handle.h.

                                                                                                                                                                                                                                              Constructor & Destructor Documentation

                                                                                                                                                                                                                                              ◆ interop_handle()

                                                                                                                                                                                                                                              cl::sycl::codeplay::interop_handle::interop_handle ( dqueue_shptr  syclQueue)
                                                                                                                                                                                                                                              		inlineexplicitprotected

                                                                                                                                                                                                                                              Constructs an interop object from a SYCL queue.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              syclQueueDetail SYCL queue object

                                                                                                                                                                                                                                              Definition at line 109 of file codeplay/interop_handle.h.

                                                                                                                                                                                                                                              Member Function Documentation

                                                                                                                                                                                                                                              ◆ get()

                                                                                                                                                                                                                                              template<typename elemT , int kDims, access::mode kMode, access::target kTarget, access::placeholder isPlaceholder>
                                                                                                                                                                                                                                              cl_mem cl::sycl::codeplay::interop_handle::get ( const accessor< elemT, kDims, kMode, kTarget, isPlaceholder > &  acc) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Retrieves an OpenCL memory object (buffer/image) associated with a device accessor.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              elemTUnderlying type of the accessor data
                                                                                                                                                                                                                                              kDimsNumber of data dimensions
                                                                                                                                                                                                                                              kModeAccess mode
                                                                                                                                                                                                                                              kTargetAccess target
                                                                                                                                                                                                                                              isPlaceholderWhether the accessor is a placeholder
                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              accAccessor to retrieve the OpenCL memory object from
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              OpenCL memory object

                                                                                                                                                                                                                                              Definition at line 85 of file codeplay/interop_handle.h.

                                                                                                                                                                                                                                              ◆ get_context()

                                                                                                                                                                                                                                              cl_context cl::sycl::codeplay::interop_handle::get_context ( ) const

                                                                                                                                                                                                                                              Retrieves the OpenCL context associated with the SYCL queue.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              OpenCL context

                                                                                                                                                                                                                                              ◆ get_device()

                                                                                                                                                                                                                                              cl_device_id cl::sycl::codeplay::interop_handle::get_device ( ) const

                                                                                                                                                                                                                                              Retrieves the OpenCL device associated with the SYCL queue.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              OpenCL device

                                                                                                                                                                                                                                              ◆ get_mem_object_impl()

                                                                                                                                                                                                                                              cl_mem cl::sycl::codeplay::interop_handle::get_mem_object_impl ( const accessor_base &  acc) const
                                                                                                                                                                                                                                              		protected

                                                                                                                                                                                                                                              Helper function for retrieving the OpenCL memory object from an accessor.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              accAccessor to retrieve the OpenCL memory object from
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              OpenCL memory object

                                                                                                                                                                                                                                              ◆ get_queue()

                                                                                                                                                                                                                                              cl_command_queue cl::sycl::codeplay::interop_handle::get_queue ( ) const

                                                                                                                                                                                                                                              Retrieves the OpenCL command queue from the SYCL one.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              OpenCL queue

                                                                                                                                                                                                                                              Friends And Related Function Documentation

                                                                                                                                                                                                                                              ◆ detail::make_interop_handle

                                                                                                                                                                                                                                              codeplay::interop_handle detail::make_interop_handle ( detail::interop_handle_tag< codeplay::interop_handle >  ,
                                                                                                                                                                                                                                              dqueue_shptr  syclQueue 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		friend
                                                                                                                                                                                                                                              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.