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

                                                                                                                                                                                                                                              Public sampler class. More...

                                                                                                                                                                                                                                              #include <sampler.h>

                                                                                                                                                                                                                                              Public Member Functions

                                                                                                                                                                                                                                               COMPUTECPP_DEPRECATED_API ("sampler::sampler(bool, addressing_mode, filtering_mode) deprecated. Use" "sampler::sampler(coordinate_normalization_mode, addressing_mode," "filtering_mode) instead.") sampler(const bool normalizedCoords
                                                                                                                                                                                                                                               Constructor that creates a sampler from the sampler addressing mode sampler filter mode and a boolean specifying whether normalized coordinates are enabled. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               COMPUTECPP_DEPRECATED_API ("sampler(cl_sampler) deprecated in SYCL 1.2.1, " "please also provide a SYCL context") explicit sampler(cl_sampler clSampler)
                                                                                                                                                                                                                                               Inter-op constructor that creates a sampler from a cl_sampler object. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               sampler (cl_sampler clSampler, const context &syclContext)
                                                                                                                                                                                                                                               Inter-op constructor that creates a sampler from a cl_sampler object. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               sampler (const cl::sycl::sampler &rhs)
                                                                                                                                                                                                                                               Default copy constructor. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               sampler (cl::sycl::sampler &&rhs) noexcept
                                                                                                                                                                                                                                               Default move constructor. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               ~sampler ()=default
                                                                                                                                                                                                                                               Default destructor. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              sampler & operator= (const cl::sycl::sampler &rhs)
                                                                                                                                                                                                                                               Default assignment operator. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              sampler & operator= (cl::sycl::sampler &&rhs) noexcept
                                                                                                                                                                                                                                               Default move assignment operator. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              bool is_host () const
                                                                                                                                                                                                                                               Returns true if this sampler is a host sampler. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              addressing_mode get_addressing_mode () const
                                                                                                                                                                                                                                               Get the addressing mode. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              filtering_mode get_filtering_mode () const
                                                                                                                                                                                                                                               Get the filter mode. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              coordinate_normalization_mode get_coordinate_normalization_mode () const
                                                                                                                                                                                                                                               Get the coordinate normalization mode. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              cl_sampler get () const
                                                                                                                                                                                                                                               Get the sampler object for OpenCL. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              dsampler_shptr get_impl () const
                                                                                                                                                                                                                                               Get implementation object. More...
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Public Attributes

                                                                                                                                                                                                                                              const addressing_mode addressMode
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              const addressing_mode const filtering_mode filterMode: sampler{normalizedCoords ? coordinate_normalization_mode::normalized : coordinate_normalization_mode::unnormalized
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              const addressing_mode const filtering_mode addressMode
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Friends

                                                                                                                                                                                                                                              bool operator== (const cl::sycl::sampler &lhs, const cl::sycl::sampler &rhs)
                                                                                                                                                                                                                                               Determines if lhs and rhs are equal. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              bool operator!= (const sampler &lhs, const sampler &rhs)
                                                                                                                                                                                                                                               Determines if lhs and rhs are not equal. More...
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Detailed Description

                                                                                                                                                                                                                                              Public sampler class.

                                                                                                                                                                                                                                              Encapsulates an OpenCL sampler and host device sampler.

                                                                                                                                                                                                                                              Definition at line 95 of file sampler.h.

                                                                                                                                                                                                                                              Constructor & Destructor Documentation

                                                                                                                                                                                                                                              ◆ sampler() [1/3]

                                                                                                                                                                                                                                              cl::sycl::sampler::sampler ( cl_sampler  clSampler,
                                                                                                                                                                                                                                              const context &  syclContext 
                                                                                                                                                                                                                                              )

                                                                                                                                                                                                                                              Inter-op constructor that creates a sampler from a cl_sampler object.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              clSamplerOpenCL cl_sampler object
                                                                                                                                                                                                                                              syclContextContext associated with the OpenCL sampler object

                                                                                                                                                                                                                                              ◆ sampler() [2/3]

                                                                                                                                                                                                                                              cl::sycl::sampler::sampler ( const cl::sycl::sampler &  rhs)
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Default copy constructor.

                                                                                                                                                                                                                                              Definition at line 157 of file sampler.h.

                                                                                                                                                                                                                                              ◆ sampler() [3/3]

                                                                                                                                                                                                                                              cl::sycl::sampler::sampler ( cl::sycl::sampler &&  rhs)
                                                                                                                                                                                                                                              		inlinenoexcept

                                                                                                                                                                                                                                              Default move constructor.

                                                                                                                                                                                                                                              Definition at line 168 of file sampler.h.

                                                                                                                                                                                                                                              ◆ ~sampler()

                                                                                                                                                                                                                                              cl::sycl::sampler::~sampler ( )
                                                                                                                                                                                                                                              		default

                                                                                                                                                                                                                                              Default destructor.

                                                                                                                                                                                                                                              Member Function Documentation

                                                                                                                                                                                                                                              ◆ COMPUTECPP_DEPRECATED_API() [1/2]

                                                                                                                                                                                                                                              cl::sycl::sampler::COMPUTECPP_DEPRECATED_API ( "sampler::sampler(bool, addressing_mode, filtering_mode) deprecated. Use" "sampler::sampler(coordinate_normalization_mode, addressing_mode," "filtering_mode) instead."  ) const

                                                                                                                                                                                                                                              Constructor that creates a sampler from the sampler addressing mode sampler filter mode and a boolean specifying whether normalized coordinates are enabled.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              normalizedCoordsBoolean specifying whether normalized coordinates are enabled.
                                                                                                                                                                                                                                              addressModeThe sampler addressing mode.
                                                                                                                                                                                                                                              filterModeThe sampler filter mode.
                                                                                                                                                                                                                                              Deprecated:
                                                                                                                                                                                                                                              Use sampler::sampler(coordinate_normalization_mode, addressing_mode, filtering_mode) instead.

                                                                                                                                                                                                                                              ◆ COMPUTECPP_DEPRECATED_API() [2/2]

                                                                                                                                                                                                                                              cl::sycl::sampler::COMPUTECPP_DEPRECATED_API ( "sampler(cl_sampler) deprecated in SYCL 1.2.  1,
                                                                                                                                                                                                                                              " "please also provide a SYCL context"   
                                                                                                                                                                                                                                              )

                                                                                                                                                                                                                                              Inter-op constructor that creates a sampler from a cl_sampler object.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              clSamplerOpenCL cl_sampler object/
                                                                                                                                                                                                                                              Deprecated:
                                                                                                                                                                                                                                              Please also provide a SYCL context

                                                                                                                                                                                                                                              ◆ get()

                                                                                                                                                                                                                                              cl_sampler cl::sycl::sampler::get ( ) const

                                                                                                                                                                                                                                              Get the sampler object for OpenCL.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              The OpenCL sampler that is associated with the latest context the sampler was used in.

                                                                                                                                                                                                                                              ◆ get_addressing_mode()

                                                                                                                                                                                                                                              addressing_mode cl::sycl::sampler::get_addressing_mode ( ) const

                                                                                                                                                                                                                                              Get the addressing mode.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Sampler addressing mode.

                                                                                                                                                                                                                                              ◆ get_coordinate_normalization_mode()

                                                                                                                                                                                                                                              coordinate_normalization_mode cl::sycl::sampler::get_coordinate_normalization_mode ( ) const

                                                                                                                                                                                                                                              Get the coordinate normalization mode.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Sampler normalization mode.

                                                                                                                                                                                                                                              ◆ get_filtering_mode()

                                                                                                                                                                                                                                              filtering_mode cl::sycl::sampler::get_filtering_mode ( ) const

                                                                                                                                                                                                                                              Get the filter mode.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Sampler filter mode.

                                                                                                                                                                                                                                              ◆ get_impl()

                                                                                                                                                                                                                                              dsampler_shptr cl::sycl::sampler::get_impl ( ) const

                                                                                                                                                                                                                                              Get implementation object.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Implementation shared_ptr.

                                                                                                                                                                                                                                              ◆ is_host()

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

                                                                                                                                                                                                                                              Returns true if this sampler is a host sampler.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              True is a host sampler, false otherwise

                                                                                                                                                                                                                                              ◆ operator=() [1/2]

                                                                                                                                                                                                                                              sampler& cl::sycl::sampler::operator= ( const cl::sycl::sampler &  rhs)
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Default assignment operator.

                                                                                                                                                                                                                                              Definition at line 184 of file sampler.h.

                                                                                                                                                                                                                                              ◆ operator=() [2/2]

                                                                                                                                                                                                                                              sampler& cl::sycl::sampler::operator= ( cl::sycl::sampler &&  rhs)
                                                                                                                                                                                                                                              		inlinenoexcept

                                                                                                                                                                                                                                              Default move assignment operator.

                                                                                                                                                                                                                                              Definition at line 196 of file sampler.h.

                                                                                                                                                                                                                                              Friends And Related Function Documentation

                                                                                                                                                                                                                                              ◆ operator!=

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

                                                                                                                                                                                                                                              Determines if lhs and rhs are not equal.

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

                                                                                                                                                                                                                                              Definition at line 226 of file sampler.h.

                                                                                                                                                                                                                                              ◆ operator==

                                                                                                                                                                                                                                              bool operator== ( const cl::sycl::sampler &  lhs,
                                                                                                                                                                                                                                              const cl::sycl::sampler &  rhs 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		friend

                                                                                                                                                                                                                                              Determines if lhs and rhs are equal.

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

                                                                                                                                                                                                                                              Definition at line 210 of file sampler.h.

                                                                                                                                                                                                                                              Member Data Documentation

                                                                                                                                                                                                                                              ◆ addressMode [1/2]

                                                                                                                                                                                                                                              const addressing_mode cl::sycl::sampler::addressMode

                                                                                                                                                                                                                                              Definition at line 122 of file sampler.h.

                                                                                                                                                                                                                                              ◆ addressMode [2/2]

                                                                                                                                                                                                                                              const addressing_mode const filtering_mode cl::sycl::sampler::addressMode

                                                                                                                                                                                                                                              Definition at line 122 of file sampler.h.

                                                                                                                                                                                                                                              ◆ filterMode

                                                                                                                                                                                                                                              const addressing_mode const filtering_mode cl::sycl::sampler::filterMode
                                                                                                                                                                                                                                              Initial value:
                                                                                                                                                                                                                                              {}
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               sampler(coordinate_normalization_mode normalizedCoords,
                                                                                                                                                                                                                                               addressing_mode addressMode, filtering_mode filterMode,
                                                                                                                                                                                                                                               const property_list& propList = {})

                                                                                                                                                                                                                                              Definition at line 122 of file sampler.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