DPC++ Runtime
Runtime libraries for oneAPI DPC++
sycl::_V1::host_unsampled_image_accessor< DataT, Dimensions, AccessMode > Class Template Reference

#include <sycl/accessor_image.hpp>

Inheritance diagram for sycl::_V1::host_unsampled_image_accessor< DataT, Dimensions, AccessMode >:
Collaboration diagram for sycl::_V1::host_unsampled_image_accessor< DataT, Dimensions, AccessMode >:

Public Types

using value_type = typename std::conditional< AccessMode==access_mode::read, const DataT, DataT >::type
 
using reference = value_type &
 
using const_reference = const DataT &
 

Public Member Functions

template<typename AllocatorT >
 host_unsampled_image_accessor (unsampled_image< Dimensions, AllocatorT > &ImageRef, const property_list &PropList={}, const detail::code_location CodeLoc=detail::code_location::current())
 
 host_unsampled_image_accessor (const host_unsampled_image_accessor &Rhs)=default
 
 host_unsampled_image_accessor (host_unsampled_image_accessor &&Rhs)=default
 
host_unsampled_image_accessoroperator= (const host_unsampled_image_accessor &Rhs)=default
 
host_unsampled_image_accessoroperator= (host_unsampled_image_accessor &&Rhs)=default
 
 ~host_unsampled_image_accessor ()=default
 
bool operator== (const host_unsampled_image_accessor &Rhs) const
 
bool operator!= (const host_unsampled_image_accessor &Rhs) const
 
template<typename Property >
bool has_property () const noexcept
 
template<typename Property >
Property get_property () const
 
size_t size () const noexcept
 
template<typename CoordT , typename = std::enable_if_t< (AccessMode == access_mode::read || AccessMode == access_mode::read_write) && detail::IsValidUnsampledCoord2020DataT<Dimensions, CoordT>::value>>
DataT read (const CoordT &Coords) const noexcept
 
template<typename CoordT , typename = std::enable_if_t< (AccessMode == access_mode::write || AccessMode == access_mode::read_write) && detail::IsValidUnsampledCoord2020DataT<Dimensions, CoordT>::value>>
void write (const CoordT &Coords, const DataT &Color) const
 
- Public Member Functions inherited from sycl::_V1::detail::OwnerLessBase< host_unsampled_image_accessor< DataT, 1,(std::is_const_v< DataT > ? access_mode::read :access_mode::read_write) > >
bool ext_oneapi_owner_before (const ext::oneapi::detail::weak_object_base< host_unsampled_image_accessor< DataT, 1,(std::is_const_v< DataT > ? access_mode::read :access_mode::read_write) > > &Other) const noexcept
 Compares the object against a weak object using an owner-based implementation-defined ordering. More...
 
bool ext_oneapi_owner_before (const host_unsampled_image_accessor< DataT, 1,(std::is_const_v< DataT > ? access_mode::read :access_mode::read_write) > &Other) const noexcept
 Compares the object against another object using an owner-based implementation-defined ordering. More...
 

Friends

template<class T >
detail::createSyclObjFromImpl (decltype(T::impl) ImplObj)
 

Detailed Description

template<typename DataT, int Dimensions = 1, access_mode AccessMode = (std::is_const_v<DataT> ? access_mode::read : access_mode::read_write)>
class sycl::_V1::host_unsampled_image_accessor< DataT, Dimensions, AccessMode >

Definition at line 944 of file accessor_image.hpp.

Member Typedef Documentation

◆ const_reference

template<typename DataT , int Dimensions = 1, access_mode AccessMode = (std::is_const_v<DataT> ? access_mode::read : access_mode::read_write)>
using sycl::_V1::host_unsampled_image_accessor< DataT, Dimensions, AccessMode >::const_reference = const DataT &

Definition at line 960 of file accessor_image.hpp.

◆ reference

template<typename DataT , int Dimensions = 1, access_mode AccessMode = (std::is_const_v<DataT> ? access_mode::read : access_mode::read_write)>
using sycl::_V1::host_unsampled_image_accessor< DataT, Dimensions, AccessMode >::reference = value_type &

Definition at line 959 of file accessor_image.hpp.

◆ value_type

template<typename DataT , int Dimensions = 1, access_mode AccessMode = (std::is_const_v<DataT> ? access_mode::read : access_mode::read_write)>
using sycl::_V1::host_unsampled_image_accessor< DataT, Dimensions, AccessMode >::value_type = typename std::conditional<AccessMode == access_mode::read, const DataT, DataT>::type

Definition at line 957 of file accessor_image.hpp.

Constructor & Destructor Documentation

◆ host_unsampled_image_accessor() [1/3]

template<typename DataT , int Dimensions = 1, access_mode AccessMode = (std::is_const_v<DataT> ? access_mode::read : access_mode::read_write)>
template<typename AllocatorT >
sycl::_V1::host_unsampled_image_accessor< DataT, Dimensions, AccessMode >::host_unsampled_image_accessor ( unsampled_image< Dimensions, AllocatorT > &  ImageRef,
const property_list PropList = {},
const detail::code_location  CodeLoc = detail::code_location::current() 
)
inline

Definition at line 963 of file accessor_image.hpp.

◆ host_unsampled_image_accessor() [2/3]

template<typename DataT , int Dimensions = 1, access_mode AccessMode = (std::is_const_v<DataT> ? access_mode::read : access_mode::read_write)>
sycl::_V1::host_unsampled_image_accessor< DataT, Dimensions, AccessMode >::host_unsampled_image_accessor ( const host_unsampled_image_accessor< DataT, Dimensions, AccessMode > &  Rhs)
default

◆ host_unsampled_image_accessor() [3/3]

template<typename DataT , int Dimensions = 1, access_mode AccessMode = (std::is_const_v<DataT> ? access_mode::read : access_mode::read_write)>
sycl::_V1::host_unsampled_image_accessor< DataT, Dimensions, AccessMode >::host_unsampled_image_accessor ( host_unsampled_image_accessor< DataT, Dimensions, AccessMode > &&  Rhs)
default

◆ ~host_unsampled_image_accessor()

template<typename DataT , int Dimensions = 1, access_mode AccessMode = (std::is_const_v<DataT> ? access_mode::read : access_mode::read_write)>
sycl::_V1::host_unsampled_image_accessor< DataT, Dimensions, AccessMode >::~host_unsampled_image_accessor ( )
default

Member Function Documentation

◆ get_property()

template<typename DataT , int Dimensions = 1, access_mode AccessMode = (std::is_const_v<DataT> ? access_mode::read : access_mode::read_write)>
template<typename Property >
Property sycl::_V1::host_unsampled_image_accessor< DataT, Dimensions, AccessMode >::get_property ( ) const
inline

Definition at line 1010 of file accessor_image.hpp.

◆ has_property()

template<typename DataT , int Dimensions = 1, access_mode AccessMode = (std::is_const_v<DataT> ? access_mode::read : access_mode::read_write)>
template<typename Property >
bool sycl::_V1::host_unsampled_image_accessor< DataT, Dimensions, AccessMode >::has_property ( ) const
inlinenoexcept

Definition at line 1003 of file accessor_image.hpp.

◆ operator!=()

template<typename DataT , int Dimensions = 1, access_mode AccessMode = (std::is_const_v<DataT> ? access_mode::read : access_mode::read_write)>
bool sycl::_V1::host_unsampled_image_accessor< DataT, Dimensions, AccessMode >::operator!= ( const host_unsampled_image_accessor< DataT, Dimensions, AccessMode > &  Rhs) const
inline

Definition at line 998 of file accessor_image.hpp.

◆ operator=() [1/2]

template<typename DataT , int Dimensions = 1, access_mode AccessMode = (std::is_const_v<DataT> ? access_mode::read : access_mode::read_write)>
host_unsampled_image_accessor& sycl::_V1::host_unsampled_image_accessor< DataT, Dimensions, AccessMode >::operator= ( const host_unsampled_image_accessor< DataT, Dimensions, AccessMode > &  Rhs)
default

◆ operator=() [2/2]

template<typename DataT , int Dimensions = 1, access_mode AccessMode = (std::is_const_v<DataT> ? access_mode::read : access_mode::read_write)>
host_unsampled_image_accessor& sycl::_V1::host_unsampled_image_accessor< DataT, Dimensions, AccessMode >::operator= ( host_unsampled_image_accessor< DataT, Dimensions, AccessMode > &&  Rhs)
default

◆ operator==()

template<typename DataT , int Dimensions = 1, access_mode AccessMode = (std::is_const_v<DataT> ? access_mode::read : access_mode::read_write)>
bool sycl::_V1::host_unsampled_image_accessor< DataT, Dimensions, AccessMode >::operator== ( const host_unsampled_image_accessor< DataT, Dimensions, AccessMode > &  Rhs) const
inline

Definition at line 995 of file accessor_image.hpp.

◆ read()

template<typename DataT , int Dimensions = 1, access_mode AccessMode = (std::is_const_v<DataT> ? access_mode::read : access_mode::read_write)>
template<typename CoordT , typename = std::enable_if_t< (AccessMode == access_mode::read || AccessMode == access_mode::read_write) && detail::IsValidUnsampledCoord2020DataT<Dimensions, CoordT>::value>>
DataT sycl::_V1::host_unsampled_image_accessor< DataT, Dimensions, AccessMode >::read ( const CoordT &  Coords) const
inlinenoexcept

Definition at line 1031 of file accessor_image.hpp.

◆ size()

template<typename DataT , int Dimensions = 1, access_mode AccessMode = (std::is_const_v<DataT> ? access_mode::read : access_mode::read_write)>
size_t sycl::_V1::host_unsampled_image_accessor< DataT, Dimensions, AccessMode >::size ( ) const
inlinenoexcept

Definition at line 1018 of file accessor_image.hpp.

◆ write()

template<typename DataT , int Dimensions = 1, access_mode AccessMode = (std::is_const_v<DataT> ? access_mode::read : access_mode::read_write)>
template<typename CoordT , typename = std::enable_if_t< (AccessMode == access_mode::write || AccessMode == access_mode::read_write) && detail::IsValidUnsampledCoord2020DataT<Dimensions, CoordT>::value>>
void sycl::_V1::host_unsampled_image_accessor< DataT, Dimensions, AccessMode >::write ( const CoordT &  Coords,
const DataT &  Color 
) const
inline

Definition at line 1053 of file accessor_image.hpp.

Friends And Related Function Documentation

◆ detail::createSyclObjFromImpl

template<typename DataT , int Dimensions = 1, access_mode AccessMode = (std::is_const_v<DataT> ? access_mode::read : access_mode::read_write)>
template<class T >
T detail::createSyclObjFromImpl ( decltype(T::impl)  ImplObj)
friend

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