DPC++ Runtime
Runtime libraries for oneAPI DPC++
Public Member Functions | List of all members
cl::sycl::accessor< DataT, Dimensions, AccessMode, access::target::host_image, IsPlaceholder > Class Template Reference
DPC++ User API » Accessors

Host image accessor. More...

#include <CL/sycl/accessor.hpp>

Inheritance diagram for cl::sycl::accessor< DataT, Dimensions, AccessMode, access::target::host_image, IsPlaceholder >:
Inheritance graph
[legend]
Collaboration diagram for cl::sycl::accessor< DataT, Dimensions, AccessMode, access::target::host_image, IsPlaceholder >:
Collaboration graph
[legend]

Public Member Functions

template<typename AllocatorT >
 accessor (cl::sycl::image< Dimensions, AllocatorT > &Image)
 
template<typename AllocatorT >
 accessor (cl::sycl::image< Dimensions, AllocatorT > &Image, const property_list &propList)
 
- Public Member Functions inherited from cl::sycl::detail::image_accessor< DataT, Dimensions, AccessMode, access::target::host_image, IsPlaceholder >
 image_accessor (image< Dims, AllocatorT > &ImageRef, int ImageElementSize)
 
 image_accessor (image< Dims, AllocatorT > &ImageRef, handler &CommandGroupHandlerRef, int ImageElementSize)
 
bool operator== (const image_accessor &Rhs) const
 
bool operator!= (const image_accessor &Rhs) const
 
 __SYCL2020_DEPRECATED ("get_count() is deprecated, please use size() instead") size_t get_count() const
 
size_t size () const noexcept
 
range< Dims > get_range () const
 
DataT read (const CoordT &Coords) const
 
DataT read (const CoordT &Coords, const sampler &Smpl) const
 
void write (const CoordT &Coords, const DataT &Color) const
 
- Public Member Functions inherited from cl::sycl::detail::AccessorBaseHost
 AccessorBaseHost (id< 3 > Offset, range< 3 > AccessRange, range< 3 > MemoryRange, access::mode AccessMode, detail::SYCLMemObjI *SYCLMemObject, int Dims, int ElemSize, int OffsetInBytes=0, bool IsSubBuffer=false)
 

Additional Inherited Members

- Public Types inherited from cl::sycl::detail::image_accessor< DataT, Dimensions, AccessMode, access::target::host_image, IsPlaceholder >
using value_type = DataT
 
using reference = DataT &
 
using const_reference = const DataT &
 
- Protected Member Functions inherited from cl::sycl::detail::AccessorBaseHost
id< 3 > & getOffset ()
 
range< 3 > & getAccessRange ()
 
range< 3 > & getMemoryRange ()
 
void * getPtr ()
 
unsigned int getElemSize () const
 
const id< 3 > & getOffset () const
 
const range< 3 > & getAccessRange () const
 
const range< 3 > & getMemoryRange () const
 
void * getPtr () const
 
template<class Obj >
decltype(Obj::impl) friend getSyclObjImpl (const Obj &SyclObject)
 
- Protected Attributes inherited from cl::sycl::detail::AccessorBaseHost
AccessorImplPtr impl
 

Detailed Description

template<typename DataT, int Dimensions, access::mode AccessMode, access::placeholder IsPlaceholder>
class cl::sycl::accessor< DataT, Dimensions, AccessMode, access::target::host_image, IsPlaceholder >

Host image accessor.

Available only when accessTarget == access::target::host_image.

See also
image

Definition at line 2287 of file accessor.hpp.

Constructor & Destructor Documentation

◆ accessor() [1/2]

template<typename DataT , int Dimensions, access::mode AccessMode, access::placeholder IsPlaceholder>
template<typename AllocatorT >
cl::sycl::accessor< DataT, Dimensions, AccessMode, access::target::host_image, IsPlaceholder >::accessor ( cl::sycl::image< Dimensions, AllocatorT > &  Image)
inline

Definition at line 2293 of file accessor.hpp.

◆ accessor() [2/2]

template<typename DataT , int Dimensions, access::mode AccessMode, access::placeholder IsPlaceholder>
template<typename AllocatorT >
cl::sycl::accessor< DataT, Dimensions, AccessMode, access::target::host_image, IsPlaceholder >::accessor ( cl::sycl::image< Dimensions, AllocatorT > &  Image,
const property_list &  propList 
)
inline

Definition at line 2299 of file accessor.hpp.

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