DPC++ Runtime: sycl::_V1::sampled_image_accessor< DataT, Dimensions, AccessTarget > Class Template Reference

DPC++ Runtime

Runtime libraries for oneAPI DPC++

#include <sycl/accessor.hpp>

Inheritance diagram for sycl::_V1::sampled_image_accessor< DataT, Dimensions, AccessTarget >:

Inheritance graph

[legend]

Collaboration diagram for sycl::_V1::sampled_image_accessor< DataT, Dimensions, AccessTarget >:

Collaboration graph

[legend]

Public Types
using	value_type = const DataT

using	reference = const DataT &

using	const_reference = const DataT &

Public Member Functions
template<typename AllocatorT >
	sampled_image_accessor (sampled_image< Dimensions, AllocatorT > &ImageRef, handler &CommandGroupHandlerRef, const property_list &PropList={}, const detail::code_location CodeLoc=detail::code_location::current())

	sampled_image_accessor (const sampled_image_accessor &Rhs)=default

	sampled_image_accessor (sampled_image_accessor &&Rhs)=default

sampled_image_accessor &	operator= (const sampled_image_accessor &Rhs)=default

sampled_image_accessor &	operator= (sampled_image_accessor &&Rhs)=default

	~sampled_image_accessor ()=default

bool	operator== (const sampled_image_accessor &Rhs) const

bool	operator!= (const sampled_image_accessor &Rhs) const

size_t	size () const noexcept

template<typename CoordT , typename = std::enable_if_t<detail::IsValidSampledCoord2020DataT< Dimensions, CoordT>::value>>
DataT	read (const CoordT &Coords) const noexcept

Public Member Functions inherited from sycl::_V1::detail::OwnerLessBase< sampled_image_accessor< DataT, Dimensions, image_target::device > >
bool	ext_oneapi_owner_before (const ext::oneapi::detail::weak_object_base< sampled_image_accessor< DataT, Dimensions, image_target::device > > &Other) const noexcept
	Compares the object against a weak object using an owner-based implementation-defined ordering. More...

bool	ext_oneapi_owner_before (const sampled_image_accessor< DataT, Dimensions, image_target::device > &Other) const noexcept
	Compares the object against another object using an owner-based implementation-defined ordering. More...

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

Detailed Description

template<typename DataT, int Dimensions, image_target AccessTarget = image_target::device>
class sycl::_V1::sampled_image_accessor< DataT, Dimensions, AccessTarget >

Definition at line 3952 of file accessor.hpp.

Member Typedef Documentation

◆ const_reference

template<typename DataT , int Dimensions, image_target AccessTarget = image_target::device>

using sycl::_V1::sampled_image_accessor< DataT, Dimensions, AccessTarget >::const_reference = const DataT &

Definition at line 3973 of file accessor.hpp.

◆ reference

template<typename DataT , int Dimensions, image_target AccessTarget = image_target::device>

using sycl::_V1::sampled_image_accessor< DataT, Dimensions, AccessTarget >::reference = const DataT &

Definition at line 3972 of file accessor.hpp.

◆ value_type

template<typename DataT , int Dimensions, image_target AccessTarget = image_target::device>

using sycl::_V1::sampled_image_accessor< DataT, Dimensions, AccessTarget >::value_type = const DataT

Definition at line 3971 of file accessor.hpp.

Constructor & Destructor Documentation

◆ sampled_image_accessor() [1/3]

template<typename DataT , int Dimensions, image_target AccessTarget = image_target::device>

template<typename AllocatorT >

sycl::_V1::sampled_image_accessor< DataT, Dimensions, AccessTarget >::sampled_image_accessor	(	sampled_image< Dimensions, AllocatorT > &	ImageRef,
		handler &	CommandGroupHandlerRef,
		const property_list &	PropList = `{}`,
		const detail::code_location	CodeLoc = `detail::code_location::current()`
	)

inline

Definition at line 3976 of file accessor.hpp.

◆ sampled_image_accessor() [2/3]

template<typename DataT , int Dimensions, image_target AccessTarget = image_target::device>

sycl::_V1::sampled_image_accessor< DataT, Dimensions, AccessTarget >::sampled_image_accessor ( const sampled_image_accessor< DataT, Dimensions, AccessTarget > & Rhs )

default

◆ sampled_image_accessor() [3/3]

template<typename DataT , int Dimensions, image_target AccessTarget = image_target::device>

sycl::_V1::sampled_image_accessor< DataT, Dimensions, AccessTarget >::sampled_image_accessor ( sampled_image_accessor< DataT, Dimensions, AccessTarget > && Rhs )

default

◆ ~sampled_image_accessor()

template<typename DataT , int Dimensions, image_target AccessTarget = image_target::device>

sycl::_V1::sampled_image_accessor< DataT, Dimensions, AccessTarget >::~sampled_image_accessor ( )

default

Member Function Documentation

◆ operator!=()

template<typename DataT , int Dimensions, image_target AccessTarget = image_target::device>

bool sycl::_V1::sampled_image_accessor< DataT, Dimensions, AccessTarget >::operator!= ( const sampled_image_accessor< DataT, Dimensions, AccessTarget > & Rhs ) const

inline

Definition at line 4032 of file accessor.hpp.

◆ operator=() [1/2]

template<typename DataT , int Dimensions, image_target AccessTarget = image_target::device>

sampled_image_accessor& sycl::_V1::sampled_image_accessor< DataT, Dimensions, AccessTarget >::operator= ( const sampled_image_accessor< DataT, Dimensions, AccessTarget > & Rhs )

default

◆ operator=() [2/2]

template<typename DataT , int Dimensions, image_target AccessTarget = image_target::device>

sampled_image_accessor& sycl::_V1::sampled_image_accessor< DataT, Dimensions, AccessTarget >::operator= ( sampled_image_accessor< DataT, Dimensions, AccessTarget > && Rhs )

default

◆ operator==()

template<typename DataT , int Dimensions, image_target AccessTarget = image_target::device>

bool sycl::_V1::sampled_image_accessor< DataT, Dimensions, AccessTarget >::operator== ( const sampled_image_accessor< DataT, Dimensions, AccessTarget > & Rhs ) const

inline

Definition at line 4027 of file accessor.hpp.

◆ read()

template<typename DataT , int Dimensions, image_target AccessTarget = image_target::device>

template<typename CoordT , typename = std::enable_if_t<detail::IsValidSampledCoord2020DataT< Dimensions, CoordT>::value>>

DataT sycl::_V1::sampled_image_accessor< DataT, Dimensions, AccessTarget >::read ( const CoordT & Coords ) const

inlinenoexcept

Definition at line 4053 of file accessor.hpp.

◆ size()

template<typename DataT , int Dimensions, image_target AccessTarget = image_target::device>

size_t sycl::_V1::sampled_image_accessor< DataT, Dimensions, AccessTarget >::size ( ) const

inlinenoexcept

Definition at line 4038 of file accessor.hpp.

Friends And Related Function Documentation

◆ detail::createSyclObjFromImpl

template<typename DataT , int Dimensions, image_target AccessTarget = image_target::device>

template<class T >

T detail::createSyclObjFromImpl ( decltype(T::impl) ImplObj )

friend

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

include/sycl/accessor.hpp

sycl
_V1
sampled_image_accessor
Generated by 1.8.17