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::image< kDimensions, AllocatorT > Class Template Reference

                                                                                                                                                                                                                                              #include <image.h>

                                                                                                                                                                                                                                              Inheritance diagram for cl::sycl::image< kDimensions, AllocatorT >:

                                                                                                                                                                                                                                              Public Member Functions

                                                                                                                                                                                                                                               image (const image< kDimensions, AllocatorT > &)=default
                                                                                                                                                                                                                                               Copy constructor. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               image (image< kDimensions, AllocatorT > &&rhs)=default
                                                                                                                                                                                                                                               Move Constructor. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              image< kDimensions, AllocatorT > & operator= (const image< kDimensions, AllocatorT > &rhs)=default
                                                                                                                                                                                                                                               Copy assignment.Copies the image descriptor of the original image. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              image< kDimensions, AllocatorT > & operator= (image< kDimensions, AllocatorT > &&rhs)=default
                                                                                                                                                                                                                                               Move Assignment. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               image (cl::sycl::image_channel_order order, cl::sycl::image_channel_type type, const range< kDimensions > &rng, const property_list &propList={})
                                                                                                                                                                                                                                               Construct an image of the specified channel_order and channel_type and range, with no host pointer, performing device side allocation of the buffer, this means that on destruction the data will not be copied back unless a final pointer is specified using set_final_data() in which case that specified pointer will be used. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               image (cl::sycl::image_channel_order order, cl::sycl::image_channel_type type, const range< kDimensions > &rng, AllocatorT allocator, const property_list &propList={})
                                                                                                                                                                                                                                               Construct an image of the specified channel_order and channel_type and range, with no host pointer, performing device side allocation of the buffer, this means that on destruction the data will not be copied back unless a final pointer is specified using set_final_data() in which case that specified pointer will be used. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<COMPUTECPP_ENABLE_IF(kdims_t,(kDimensions > 1)) >
                                                                                                                                                                                                                                               image (cl::sycl::image_channel_order order, cl::sycl::image_channel_type type, const range< kDimensions > &rng, const pitch_range_t &pit, const property_list &propList={})
                                                                                                                                                                                                                                               Construct an image of the specified channel_order and channel_type and range, with no host pointer, performing device side allocation of the buffer, this means that on destruction the data will not be copied back unless a final pointer is specified using set_final_data() in which case that specified pointer will be used. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<COMPUTECPP_ENABLE_IF(kdims_t,(kDimensions > 1)) >
                                                                                                                                                                                                                                               image (cl::sycl::image_channel_order order, cl::sycl::image_channel_type type, const range< kDimensions > &rng, const pitch_range_t &pit, AllocatorT allocator, const property_list &propList={})
                                                                                                                                                                                                                                               Construct an image of the specified channel_order and channel_type and range, with no host pointer, performing device side allocation of the buffer, this means that on destruction the data will not be copied back unless a final pointer is specified using set_final_data() in which case that specified pointer will be used. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               image (void *hostPtr, cl::sycl::image_channel_order order, cl::sycl::image_channel_type type, const range< kDimensions > &rng, const property_list &propList={})
                                                                                                                                                                                                                                               Construct an image of the specified channel_order and channel_type and range, with a raw host pointer to the image data. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               image (void *hostPtr, cl::sycl::image_channel_order order, cl::sycl::image_channel_type type, const range< kDimensions > &rng, AllocatorT allocator, const property_list &propList={})
                                                                                                                                                                                                                                               Construct an image of the specified channel_order and channel_type and range, with a raw host pointer to the image data. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               image (const void *hostPtr, cl::sycl::image_channel_order order, cl::sycl::image_channel_type type, const range< kDimensions > &rng, const property_list &propList={})
                                                                                                                                                                                                                                               Construct an image of the specified channel_order and channel_type and range, with a constant raw host pointer to the image data. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               image (const void *hostPtr, cl::sycl::image_channel_order order, cl::sycl::image_channel_type type, const range< kDimensions > &rng, AllocatorT allocator, const property_list &propList={})
                                                                                                                                                                                                                                               Construct an image of the specified channel_order and channel_type and range, with a raw host pointer to the image data. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<COMPUTECPP_ENABLE_IF(kdims_t,(kDimensions > 1)) >
                                                                                                                                                                                                                                               image (void *hostPtr, cl::sycl::image_channel_order order, cl::sycl::image_channel_type type, const range< kDimensions > &rng, const pitch_range_t &pit, const property_list &propList={})
                                                                                                                                                                                                                                               Construct an image of the specified channel_order and channel_type, range and pitch, with a raw host pointer to the image data. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<COMPUTECPP_ENABLE_IF(kdims_t,(kDimensions > 1)) >
                                                                                                                                                                                                                                               image (void *hostPtr, cl::sycl::image_channel_order order, cl::sycl::image_channel_type type, const range< kDimensions > &rng, const pitch_range_t &pit, AllocatorT allocator, const property_list &propList={})
                                                                                                                                                                                                                                               Construct an image of the specified channel_order and channel_type, range and pitch, with a raw host pointer to the image data. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               image (shared_ptr_class< void > sharedPtr, cl::sycl::image_channel_order order, cl::sycl::image_channel_type type, const range< kDimensions > &rng, const property_list &propList={})
                                                                                                                                                                                                                                               Construct an image of the specified channel_order and channel_type and range, with a shared host pointer to the image data. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               image (shared_ptr_class< void > sharedPtr, cl::sycl::image_channel_order order, cl::sycl::image_channel_type type, const range< kDimensions > &rng, AllocatorT allocator, const property_list &propList={})
                                                                                                                                                                                                                                               Construct an image of the specified channel_order and channel_type and range, with a shared host pointer to the image data. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<COMPUTECPP_ENABLE_IF(kdims_t,(kDimensions > 1)) >
                                                                                                                                                                                                                                               image (shared_ptr_class< void > sharedPtr, cl::sycl::image_channel_order order, cl::sycl::image_channel_type type, const range< kDimensions > &rng, const pitch_range_t &pit, const property_list &propList={})
                                                                                                                                                                                                                                               Construct an image of the specified channel_order and channel_type, range and pitch, with a shared host pointer to the image data. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<COMPUTECPP_ENABLE_IF(kdims_t,(kDimensions > 1)) >
                                                                                                                                                                                                                                               image (shared_ptr_class< void > sharedPtr, cl::sycl::image_channel_order order, cl::sycl::image_channel_type type, const range< kDimensions > &rng, const pitch_range_t &pit, AllocatorT allocator, const property_list &propList={})
                                                                                                                                                                                                                                               Construct an image of the specified channel_order and channel_type, range and pitch, with a shared host pointer to the image data. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               image (cl_mem memObject, const context &syclContext, event availableEvent={})
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<typename T , access::mode accessMode>
                                                                                                                                                                                                                                              COMPUTECPP_SET_IGNORE_DEPRECATED_API accessor< T, kDimensions, accessMode, access::target::host_image > get_access ()
                                                                                                                                                                                                                                               Create an accessor to the image. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<typename T , access::mode accessMode>
                                                                                                                                                                                                                                              accessor< T, kDimensions, accessMode, access::target::image > get_access (handler &cgh)
                                                                                                                                                                                                                                               Create an accessor to the image for command group handler. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<int dims = kDimensions, class = typename std::enable_if<(2 == dims) || (3 == dims)>::type>
                                                                                                                                                                                                                                              range< dims - 1 > get_pitch () const
                                                                                                                                                                                                                                               Returns the pitch of the image object. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              cl::sycl::range< kDimensions > get_range () const
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<typename propertyT >
                                                                                                                                                                                                                                              bool has_property () const noexcept
                                                                                                                                                                                                                                               Returns whether this SYCL image was constructed with the property specified by propertyT. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<typename propertyT >
                                                                                                                                                                                                                                              propertyT get_property () const
                                                                                                                                                                                                                                               Returns a copy of the property of type propertyT that this SYCL image was constructed with. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              AllocatorT get_allocator () const
                                                                                                                                                                                                                                               Returns the allocator provided to the image. More...
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Friends

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

                                                                                                                                                                                                                                              Detailed Description

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              class cl::sycl::image< kDimensions, AllocatorT >

                                                                                                                                                                                                                                              Definition at line 188 of file image.h.

                                                                                                                                                                                                                                              Constructor & Destructor Documentation

                                                                                                                                                                                                                                              ◆ image() [1/17]

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              cl::sycl::image< kDimensions, AllocatorT >::image ( const image< kDimensions, AllocatorT > &  )
                                                                                                                                                                                                                                              		default

                                                                                                                                                                                                                                              Copy constructor.

                                                                                                                                                                                                                                              Copy the image descriptor of the original image. After the copy, both image object will point to the same underlying memory.

                                                                                                                                                                                                                                              ◆ image() [2/17]

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              cl::sycl::image< kDimensions, AllocatorT >::image ( image< kDimensions, AllocatorT > &&  rhs)
                                                                                                                                                                                                                                              		default

                                                                                                                                                                                                                                              Move Constructor.

                                                                                                                                                                                                                                              Moves the image descriptor of the original image. After the move, rhs will be invalid.

                                                                                                                                                                                                                                              ◆ image() [3/17]

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              cl::sycl::image< kDimensions, AllocatorT >::image ( cl::sycl::image_channel_order  order,
                                                                                                                                                                                                                                              cl::sycl::image_channel_type  type,
                                                                                                                                                                                                                                              const range< kDimensions > &  rng,
                                                                                                                                                                                                                                              const property_list &  propList = {} 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Construct an image of the specified channel_order and channel_type and range, with no host pointer, performing device side allocation of the buffer, this means that on destruction the data will not be copied back unless a final pointer is specified using set_final_data() in which case that specified pointer will be used.

                                                                                                                                                                                                                                              Any host side allocation of data will be performed using the allocator specified by AllocatorT.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              orderImage channel order.
                                                                                                                                                                                                                                              typeImage channel type.
                                                                                                                                                                                                                                              rngImage range.
                                                                                                                                                                                                                                              propListList of image properties

                                                                                                                                                                                                                                              Definition at line 264 of file image.h.

                                                                                                                                                                                                                                              ◆ image() [4/17]

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              cl::sycl::image< kDimensions, AllocatorT >::image ( cl::sycl::image_channel_order  order,
                                                                                                                                                                                                                                              cl::sycl::image_channel_type  type,
                                                                                                                                                                                                                                              const range< kDimensions > &  rng,
                                                                                                                                                                                                                                              AllocatorT  allocator,
                                                                                                                                                                                                                                              const property_list &  propList = {} 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Construct an image of the specified channel_order and channel_type and range, with no host pointer, performing device side allocation of the buffer, this means that on destruction the data will not be copied back unless a final pointer is specified using set_final_data() in which case that specified pointer will be used.

                                                                                                                                                                                                                                              Any host side allocation of data will be performed using the provided allocator.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              orderImage channel order.
                                                                                                                                                                                                                                              typeImage channel type.
                                                                                                                                                                                                                                              rngImage range.
                                                                                                                                                                                                                                              allocatorThe allocator used to create internal storage
                                                                                                                                                                                                                                              propListList of image properties

                                                                                                                                                                                                                                              Definition at line 288 of file image.h.

                                                                                                                                                                                                                                              ◆ image() [5/17]

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              template<COMPUTECPP_ENABLE_IF(kdims_t,(kDimensions > 1)) >
                                                                                                                                                                                                                                              cl::sycl::image< kDimensions, AllocatorT >::image ( cl::sycl::image_channel_order  order,
                                                                                                                                                                                                                                              cl::sycl::image_channel_type  type,
                                                                                                                                                                                                                                              const range< kDimensions > &  rng,
                                                                                                                                                                                                                                              const pitch_range_t &  pit,
                                                                                                                                                                                                                                              const property_list &  propList = {} 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Construct an image of the specified channel_order and channel_type and range, with no host pointer, performing device side allocation of the buffer, this means that on destruction the data will not be copied back unless a final pointer is specified using set_final_data() in which case that specified pointer will be used.

                                                                                                                                                                                                                                              Any host side allocation of data will be performed using the allocator specified by AllocatorT.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              COMPUTECPP_ENABLE_IFOnly enabled when kDimensions greater than 1
                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              orderImage channel order.
                                                                                                                                                                                                                                              typeImage channel type.
                                                                                                                                                                                                                                              rngImage range.
                                                                                                                                                                                                                                              pitImage pitch.
                                                                                                                                                                                                                                              propListList of image properties

                                                                                                                                                                                                                                              Definition at line 315 of file image.h.

                                                                                                                                                                                                                                              ◆ image() [6/17]

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              template<COMPUTECPP_ENABLE_IF(kdims_t,(kDimensions > 1)) >
                                                                                                                                                                                                                                              cl::sycl::image< kDimensions, AllocatorT >::image ( cl::sycl::image_channel_order  order,
                                                                                                                                                                                                                                              cl::sycl::image_channel_type  type,
                                                                                                                                                                                                                                              const range< kDimensions > &  rng,
                                                                                                                                                                                                                                              const pitch_range_t &  pit,
                                                                                                                                                                                                                                              AllocatorT  allocator,
                                                                                                                                                                                                                                              const property_list &  propList = {} 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Construct an image of the specified channel_order and channel_type and range, with no host pointer, performing device side allocation of the buffer, this means that on destruction the data will not be copied back unless a final pointer is specified using set_final_data() in which case that specified pointer will be used.

                                                                                                                                                                                                                                              Any host side allocation of data will be performed using the provided allocator.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              COMPUTECPP_ENABLE_IFOnly enabled when kDimensions greater than 1
                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              orderImage channel order.
                                                                                                                                                                                                                                              typeImage channel type.
                                                                                                                                                                                                                                              rngImage range.
                                                                                                                                                                                                                                              pitImage pitch.
                                                                                                                                                                                                                                              allocatorThe allocator used to create internal storage
                                                                                                                                                                                                                                              propListList of image properties

                                                                                                                                                                                                                                              Definition at line 343 of file image.h.

                                                                                                                                                                                                                                              ◆ image() [7/17]

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              cl::sycl::image< kDimensions, AllocatorT >::image ( void *  hostPtr,
                                                                                                                                                                                                                                              cl::sycl::image_channel_order  order,
                                                                                                                                                                                                                                              cl::sycl::image_channel_type  type,
                                                                                                                                                                                                                                              const range< kDimensions > &  rng,
                                                                                                                                                                                                                                              const property_list &  propList = {} 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Construct an image of the specified channel_order and channel_type and range, with a raw host pointer to the image data.

                                                                                                                                                                                                                                              On object destruction, the data will be copied to the specified host pointer unless a final pointer is specified using set_final_data() in which case that specified pointer will be used.

                                                                                                                                                                                                                                              Any host side allocation of data will be performed using the allocator specified by AllocatorT.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              hostPtrRaw pointer to the image data.
                                                                                                                                                                                                                                              orderImage channel order.
                                                                                                                                                                                                                                              typeImage channel type.
                                                                                                                                                                                                                                              rngImage range.
                                                                                                                                                                                                                                              propListList of image properties

                                                                                                                                                                                                                                              Definition at line 368 of file image.h.

                                                                                                                                                                                                                                              ◆ image() [8/17]

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              cl::sycl::image< kDimensions, AllocatorT >::image ( void *  hostPtr,
                                                                                                                                                                                                                                              cl::sycl::image_channel_order  order,
                                                                                                                                                                                                                                              cl::sycl::image_channel_type  type,
                                                                                                                                                                                                                                              const range< kDimensions > &  rng,
                                                                                                                                                                                                                                              AllocatorT  allocator,
                                                                                                                                                                                                                                              const property_list &  propList = {} 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Construct an image of the specified channel_order and channel_type and range, with a raw host pointer to the image data.

                                                                                                                                                                                                                                              On object destruction, the data will be copied to the specified host pointer unless a final pointer is specified using set_final_data() in which case that specified pointer will be used.

                                                                                                                                                                                                                                              Any host side allocation of data will be performed using the provided allocator.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              hostPtrRaw pointer to the image data.
                                                                                                                                                                                                                                              orderImage channel order.
                                                                                                                                                                                                                                              typeImage channel type.
                                                                                                                                                                                                                                              rngImage range.
                                                                                                                                                                                                                                              allocatorThe allocator used to create internal storage
                                                                                                                                                                                                                                              propListList of image properties

                                                                                                                                                                                                                                              Definition at line 395 of file image.h.

                                                                                                                                                                                                                                              ◆ image() [9/17]

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              cl::sycl::image< kDimensions, AllocatorT >::image ( const void *  hostPtr,
                                                                                                                                                                                                                                              cl::sycl::image_channel_order  order,
                                                                                                                                                                                                                                              cl::sycl::image_channel_type  type,
                                                                                                                                                                                                                                              const range< kDimensions > &  rng,
                                                                                                                                                                                                                                              const property_list &  propList = {} 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Construct an image of the specified channel_order and channel_type and range, with a constant raw host pointer to the image data.

                                                                                                                                                                                                                                              On object destruction, the data will not be copied back, unless a final pointer is specified using set_final_data() in which case that specified pointer will be used.

                                                                                                                                                                                                                                              Any host side allocation of data will be performed using the allocator specified by AllocatorT.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              hostPtrRaw pointer to the image data.
                                                                                                                                                                                                                                              orderImage channel order.
                                                                                                                                                                                                                                              typeImage channel type.
                                                                                                                                                                                                                                              rngImage range.
                                                                                                                                                                                                                                              propListList of image properties

                                                                                                                                                                                                                                              Definition at line 421 of file image.h.

                                                                                                                                                                                                                                              ◆ image() [10/17]

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              cl::sycl::image< kDimensions, AllocatorT >::image ( const void *  hostPtr,
                                                                                                                                                                                                                                              cl::sycl::image_channel_order  order,
                                                                                                                                                                                                                                              cl::sycl::image_channel_type  type,
                                                                                                                                                                                                                                              const range< kDimensions > &  rng,
                                                                                                                                                                                                                                              AllocatorT  allocator,
                                                                                                                                                                                                                                              const property_list &  propList = {} 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Construct an image of the specified channel_order and channel_type and range, with a raw host pointer to the image data.

                                                                                                                                                                                                                                              On object destruction, the data will not be copied back unless a final pointer is specified using set_final_data() in which case that specified pointer will be used.

                                                                                                                                                                                                                                              Any host side allocation of data will be performed using the provided allocator.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              hostPtrRaw pointer to the image data.
                                                                                                                                                                                                                                              orderImage channel order.
                                                                                                                                                                                                                                              typeImage channel type.
                                                                                                                                                                                                                                              rngImage range.
                                                                                                                                                                                                                                              allocatorThe allocator used to create internal storage
                                                                                                                                                                                                                                              propListList of image properties

                                                                                                                                                                                                                                              Definition at line 449 of file image.h.

                                                                                                                                                                                                                                              ◆ image() [11/17]

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              template<COMPUTECPP_ENABLE_IF(kdims_t,(kDimensions > 1)) >
                                                                                                                                                                                                                                              cl::sycl::image< kDimensions, AllocatorT >::image ( void *  hostPtr,
                                                                                                                                                                                                                                              cl::sycl::image_channel_order  order,
                                                                                                                                                                                                                                              cl::sycl::image_channel_type  type,
                                                                                                                                                                                                                                              const range< kDimensions > &  rng,
                                                                                                                                                                                                                                              const pitch_range_t &  pit,
                                                                                                                                                                                                                                              const property_list &  propList = {} 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Construct an image of the specified channel_order and channel_type, range and pitch, with a raw host pointer to the image data.

                                                                                                                                                                                                                                              On object destruction, the data will be copied to the specified host pointer unless a final pointer is specified using set_final_data() in which case that specified pointer will be used.

                                                                                                                                                                                                                                              Any host side allocation of data will be performed using the allocator specified by AllocatorT.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              COMPUTECPP_ENABLE_IFOnly enabled when kDimensions greater than 1
                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              hostPtrRaw pointer to the image data.
                                                                                                                                                                                                                                              orderImage channel order.
                                                                                                                                                                                                                                              typeImage channel type.
                                                                                                                                                                                                                                              rngImage range.
                                                                                                                                                                                                                                              pitImage pitch.
                                                                                                                                                                                                                                              propListList of image properties

                                                                                                                                                                                                                                              Definition at line 479 of file image.h.

                                                                                                                                                                                                                                              ◆ image() [12/17]

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              template<COMPUTECPP_ENABLE_IF(kdims_t,(kDimensions > 1)) >
                                                                                                                                                                                                                                              cl::sycl::image< kDimensions, AllocatorT >::image ( void *  hostPtr,
                                                                                                                                                                                                                                              cl::sycl::image_channel_order  order,
                                                                                                                                                                                                                                              cl::sycl::image_channel_type  type,
                                                                                                                                                                                                                                              const range< kDimensions > &  rng,
                                                                                                                                                                                                                                              const pitch_range_t &  pit,
                                                                                                                                                                                                                                              AllocatorT  allocator,
                                                                                                                                                                                                                                              const property_list &  propList = {} 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Construct an image of the specified channel_order and channel_type, range and pitch, with a raw host pointer to the image data.

                                                                                                                                                                                                                                              On object destruction, the data will be copied to the specified host pointer unless a final pointer is specified using set_final_data() in which case that specified pointer will be used.

                                                                                                                                                                                                                                              Any host side allocation of data will be performed using the provided allocator.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              COMPUTECPP_ENABLE_IFOnly enabled when kDimensions greater than 1
                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              hostPtrRaw pointer to the image data.
                                                                                                                                                                                                                                              orderImage channel order.
                                                                                                                                                                                                                                              typeImage channel type.
                                                                                                                                                                                                                                              rngImage range.
                                                                                                                                                                                                                                              pitImage pitch.
                                                                                                                                                                                                                                              allocatorThe allocator used to create internal storage
                                                                                                                                                                                                                                              propListList of image properties

                                                                                                                                                                                                                                              Definition at line 508 of file image.h.

                                                                                                                                                                                                                                              ◆ image() [13/17]

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              cl::sycl::image< kDimensions, AllocatorT >::image ( shared_ptr_class< void >  sharedPtr,
                                                                                                                                                                                                                                              cl::sycl::image_channel_order  order,
                                                                                                                                                                                                                                              cl::sycl::image_channel_type  type,
                                                                                                                                                                                                                                              const range< kDimensions > &  rng,
                                                                                                                                                                                                                                              const property_list &  propList = {} 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Construct an image of the specified channel_order and channel_type and range, with a shared host pointer to the image data.

                                                                                                                                                                                                                                              The host pointer's ownership is shared and on destruction the data will be copied to the specified host pointer unless the runtime maintains the last reference to the shared_ptr or a final pointer is specified using set_final_data() in which case that specified pointer will be used. Any host side allocation of data will be performed using the allocator specified by AllocatorT.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              sharedPtrshared pointer to the image data.
                                                                                                                                                                                                                                              orderImage channel order.
                                                                                                                                                                                                                                              typeImage channel type.
                                                                                                                                                                                                                                              rngImage range.
                                                                                                                                                                                                                                              allocatorThe allocator used to create internal storage
                                                                                                                                                                                                                                              propListList of image properties

                                                                                                                                                                                                                                              Definition at line 536 of file image.h.

                                                                                                                                                                                                                                              ◆ image() [14/17]

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              cl::sycl::image< kDimensions, AllocatorT >::image ( shared_ptr_class< void >  sharedPtr,
                                                                                                                                                                                                                                              cl::sycl::image_channel_order  order,
                                                                                                                                                                                                                                              cl::sycl::image_channel_type  type,
                                                                                                                                                                                                                                              const range< kDimensions > &  rng,
                                                                                                                                                                                                                                              AllocatorT  allocator,
                                                                                                                                                                                                                                              const property_list &  propList = {} 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Construct an image of the specified channel_order and channel_type and range, with a shared host pointer to the image data.

                                                                                                                                                                                                                                              The host pointer's ownership is shared and on destruction the data will be copied to the specified host pointer unless the runtime maintains the last reference to the shared_ptr or a final pointer is specified using set_final_data() in which case that specified pointer will be used.

                                                                                                                                                                                                                                              Any host side allocation of data will be performed using the provided allocator.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              sharedPtrshared pointer to the image data.
                                                                                                                                                                                                                                              orderImage channel order.
                                                                                                                                                                                                                                              typeImage channel type.
                                                                                                                                                                                                                                              rngImage range.
                                                                                                                                                                                                                                              allocatorThe allocator used to create internal storage
                                                                                                                                                                                                                                              propListList of image properties

                                                                                                                                                                                                                                              Definition at line 564 of file image.h.

                                                                                                                                                                                                                                              ◆ image() [15/17]

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              template<COMPUTECPP_ENABLE_IF(kdims_t,(kDimensions > 1)) >
                                                                                                                                                                                                                                              cl::sycl::image< kDimensions, AllocatorT >::image ( shared_ptr_class< void >  sharedPtr,
                                                                                                                                                                                                                                              cl::sycl::image_channel_order  order,
                                                                                                                                                                                                                                              cl::sycl::image_channel_type  type,
                                                                                                                                                                                                                                              const range< kDimensions > &  rng,
                                                                                                                                                                                                                                              const pitch_range_t &  pit,
                                                                                                                                                                                                                                              const property_list &  propList = {} 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Construct an image of the specified channel_order and channel_type, range and pitch, with a shared host pointer to the image data.

                                                                                                                                                                                                                                              The host pointer's ownership is shared and on destruction the data will be copied to the specified host pointer unless the runtime maintains the last reference to the shared_ptr or a final pointer is specified using set_final_data() in which case that specified pointer will be used. Any host side allocation of data will be performed using the allocator specified by AllocatorT.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              COMPUTECPP_ENABLE_IFOnly enabled when kDimensions greater than 1
                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              sharedPtrShared pointer to the image data.
                                                                                                                                                                                                                                              orderImage channel order.
                                                                                                                                                                                                                                              typeImage channel type.
                                                                                                                                                                                                                                              rngImage range.
                                                                                                                                                                                                                                              pitImage pitch.
                                                                                                                                                                                                                                              propListList of image properties

                                                                                                                                                                                                                                              Definition at line 593 of file image.h.

                                                                                                                                                                                                                                              ◆ image() [16/17]

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              template<COMPUTECPP_ENABLE_IF(kdims_t,(kDimensions > 1)) >
                                                                                                                                                                                                                                              cl::sycl::image< kDimensions, AllocatorT >::image ( shared_ptr_class< void >  sharedPtr,
                                                                                                                                                                                                                                              cl::sycl::image_channel_order  order,
                                                                                                                                                                                                                                              cl::sycl::image_channel_type  type,
                                                                                                                                                                                                                                              const range< kDimensions > &  rng,
                                                                                                                                                                                                                                              const pitch_range_t &  pit,
                                                                                                                                                                                                                                              AllocatorT  allocator,
                                                                                                                                                                                                                                              const property_list &  propList = {} 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Construct an image of the specified channel_order and channel_type, range and pitch, with a shared host pointer to the image data.

                                                                                                                                                                                                                                              The host pointer's ownership is shared and on destruction the data will be copied to the specified host pointer unless the runtime maintains the last reference to the shared_ptr or a final pointer is specified using set_final_data() in which case that specified pointer will be used.

                                                                                                                                                                                                                                              Any host side allocation of data will be performed using the provided allocator.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              COMPUTECPP_ENABLE_IFOnly enabled when kDimensions greater than 1
                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              sharedPtrShared pointer to the image data.
                                                                                                                                                                                                                                              orderImage channel order.
                                                                                                                                                                                                                                              typeImage channel type.
                                                                                                                                                                                                                                              rngImage range.
                                                                                                                                                                                                                                              pitImage pitch.
                                                                                                                                                                                                                                              allocatorThe allocator used to create internal storage
                                                                                                                                                                                                                                              propListList of image properties

                                                                                                                                                                                                                                              Definition at line 624 of file image.h.

                                                                                                                                                                                                                                              ◆ image() [17/17]

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              cl::sycl::image< kDimensions, AllocatorT >::image ( cl_mem  memObject,
                                                                                                                                                                                                                                              const context &  syclContext,
                                                                                                                                                                                                                                              event  availableEvent = {} 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Definition at line 635 of file image.h.

                                                                                                                                                                                                                                              Member Function Documentation

                                                                                                                                                                                                                                              ◆ get_access() [1/2]

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              template<typename T , access::mode accessMode>
                                                                                                                                                                                                                                              COMPUTECPP_SET_IGNORE_DEPRECATED_API accessor<T, kDimensions, accessMode, access::target::host_image> cl::sycl::image< kDimensions, AllocatorT >::get_access ( )
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Create an accessor to the image.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              TTypename of the accessor
                                                                                                                                                                                                                                              accessModeThe data access mode descriptor

                                                                                                                                                                                                                                              Definition at line 653 of file image.h.

                                                                                                                                                                                                                                              ◆ get_access() [2/2]

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              template<typename T , access::mode accessMode>
                                                                                                                                                                                                                                              accessor<T, kDimensions, accessMode, access::target::image> cl::sycl::image< kDimensions, AllocatorT >::get_access ( handler &  cgh)
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Create an accessor to the image for command group handler.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              TTypename of the accessor
                                                                                                                                                                                                                                              accessModeThe data access mode descriptor
                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              cghThe command group handler

                                                                                                                                                                                                                                              Definition at line 665 of file image.h.

                                                                                                                                                                                                                                              ◆ get_allocator()

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              AllocatorT cl::sycl::image< kDimensions, AllocatorT >::get_allocator ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Returns the allocator provided to the image.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Allocator that was provided to the image

                                                                                                                                                                                                                                              Definition at line 711 of file image.h.

                                                                                                                                                                                                                                              ◆ get_pitch()

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              template<int dims = kDimensions, class = typename std::enable_if<(2 == dims) || (3 == dims)>::type>
                                                                                                                                                                                                                                              range<dims - 1> cl::sycl::image< kDimensions, AllocatorT >::get_pitch ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Returns the pitch of the image object.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              pitch

                                                                                                                                                                                                                                              Definition at line 677 of file image.h.

                                                                                                                                                                                                                                              ◆ get_property()

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              template<typename propertyT >
                                                                                                                                                                                                                                              propertyT cl::sycl::image< kDimensions, AllocatorT >::get_property ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Returns a copy of the property of type propertyT that this SYCL image was constructed with.

                                                                                                                                                                                                                                              Throws an error if image was not constructed with the property.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              propertyTProperty to retrieve
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Copy of the property

                                                                                                                                                                                                                                              Definition at line 704 of file image.h.

                                                                                                                                                                                                                                              ◆ get_range()

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              cl::sycl::range<kDimensions> cl::sycl::image< kDimensions, AllocatorT >::get_range ( ) const
                                                                                                                                                                                                                                              		inline
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              The image range

                                                                                                                                                                                                                                              Definition at line 683 of file image.h.

                                                                                                                                                                                                                                              ◆ has_property()

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              template<typename propertyT >
                                                                                                                                                                                                                                              bool cl::sycl::image< kDimensions, AllocatorT >::has_property ( ) const
                                                                                                                                                                                                                                              		inlinenoexcept

                                                                                                                                                                                                                                              Returns whether this SYCL image was constructed with the property specified by propertyT.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              propertyTProperty to check for
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              True if image constructed with the property

                                                                                                                                                                                                                                              Definition at line 693 of file image.h.

                                                                                                                                                                                                                                              ◆ operator=() [1/2]

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              image<kDimensions, AllocatorT>& cl::sycl::image< kDimensions, AllocatorT >::operator= ( const image< kDimensions, AllocatorT > &  rhs)
                                                                                                                                                                                                                                              		default

                                                                                                                                                                                                                                              Copy assignment.Copies the image descriptor of the original image.

                                                                                                                                                                                                                                              After the copy, both image object will point to the same underlying memory.

                                                                                                                                                                                                                                              ◆ operator=() [2/2]

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              image<kDimensions, AllocatorT>& cl::sycl::image< kDimensions, AllocatorT >::operator= ( image< kDimensions, AllocatorT > &&  rhs)
                                                                                                                                                                                                                                              		default

                                                                                                                                                                                                                                              Move Assignment.

                                                                                                                                                                                                                                              Moves the image descriptor of the original image. After the move, rhs will be invalid.

                                                                                                                                                                                                                                              Friends And Related Function Documentation

                                                                                                                                                                                                                                              ◆ operator!=

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              bool operator!= ( const image< kDimensions, AllocatorT > &  lhs,
                                                                                                                                                                                                                                              const image< kDimensions, AllocatorT > &  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 246 of file image.h.

                                                                                                                                                                                                                                              ◆ operator==

                                                                                                                                                                                                                                              template<int kDimensions = 1, typename AllocatorT = image_allocator>
                                                                                                                                                                                                                                              bool operator== ( const image< kDimensions, AllocatorT > &  lhs,
                                                                                                                                                                                                                                              const image< kDimensions, AllocatorT > &  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 237 of file image.h.

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

                                                                                                                                                                                                                                              Select a Product

                                                                                                                                                                                                                                              Please select a product

                                                                                                                                                                                                                                              oneAPI

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

                                                                                                                                                                                                                                              Dark Mode
                                                                                                                                                                                                                                              brightness_2

                                                                                                                                                                                                                                              Dark Mode

                                                                                                                                                                                                                                              Light text on a dark background.

                                                                                                                                                                                                                                              Light Mode
                                                                                                                                                                                                                                              lightbulb_outline

                                                                                                                                                                                                                                              Light Mode

                                                                                                                                                                                                                                              Dark text on a light background.

                                                                                                                                                                                                                                              public

                                                                                                                                                                                                                                              Also,

                                                                                                                                                                                                                                              part of our network

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

                                                                                                                                                                                                                                              Please type to begin searching or try these:


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