DPC++ Runtime
Runtime libraries for oneAPI DPC++
sycl::_V1::detail::image_plain Class Reference

#include <sycl/image.hpp>

Inheritance diagram for sycl::_V1::detail::image_plain:
Collaboration diagram for sycl::_V1::detail::image_plain:

Protected Member Functions

 image_plain (const std::shared_ptr< detail::image_impl > &Impl)
 
 image_plain (image_channel_order Order, image_channel_type Type, const range< 3 > &Range, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)
 
 image_plain (image_channel_order Order, image_channel_type Type, const range< 3 > &Range, const range< 2 > &Pitch, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)
 
 image_plain (void *HostPointer, image_channel_order Order, image_channel_type Type, const range< 3 > &Range, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)
 
 image_plain (const void *HostPointer, image_channel_order Order, image_channel_type Type, const range< 3 > &Range, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)
 
 image_plain (void *HostPointer, image_channel_order Order, image_channel_type Type, const range< 3 > &Range, const range< 2 > &Pitch, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)
 
 image_plain (const std::shared_ptr< const void > &HostPointer, image_channel_order Order, image_channel_type Type, const range< 3 > &Range, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList, bool IsConstPtr)
 
 image_plain (const std::shared_ptr< const void > &HostPointer, image_channel_order Order, image_channel_type Type, const range< 3 > &Range, const range< 2 > &Pitch, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList, bool IsConstPtr)
 
 image_plain (const void *HostPointer, image_channel_order Order, image_channel_type Type, image_sampler Sampler, const range< 3 > &Range, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)
 
 image_plain (const void *HostPointer, image_channel_order Order, image_channel_type Type, image_sampler Sampler, const range< 3 > &Range, const range< 2 > &Pitch, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)
 
 image_plain (const std::shared_ptr< const void > &HostPointer, image_channel_order Order, image_channel_type Type, image_sampler Sampler, const range< 3 > &Range, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)
 
 image_plain (const std::shared_ptr< const void > &HostPointer, image_channel_order Order, image_channel_type Type, image_sampler Sampler, const range< 3 > &Range, const range< 2 > &Pitch, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)
 
 image_plain (pi_native_handle MemObject, const context &SyclContext, event AvailableEvent, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, image_channel_order Order, image_channel_type Type, bool OwnNativeHandle, range< 3 > Range3WithOnes)
 
template<typename propertyT >
bool has_property () const noexcept
 
template<typename propertyT >
propertyT get_property () const
 
range< 3 > get_range () const
 
range< 2 > get_pitch () const
 
size_t get_size () const noexcept
 
size_t get_count () const noexcept
 
void set_final_data_internal ()
 
void set_final_data_internal (const std::function< void(const std::function< void(void *const Ptr)> &)> &FinalDataFunc)
 
void set_write_back (bool flag)
 
const std::unique_ptr< SYCLMemObjAllocator > & get_allocator_internal () const
 
size_t getElementSize () const
 
size_t getRowPitch () const
 
size_t getSlicePitch () const
 
image_sampler getSampler () const noexcept
 
image_channel_order getChannelOrder () const
 
image_channel_type getChannelType () const
 
void sampledImageConstructorNotification (const detail::code_location &CodeLoc, void *UserObj, const void *HostObj, uint32_t Dim, size_t Range[3], image_format Format, const image_sampler &Sampler)
 
void sampledImageDestructorNotification (void *UserObj)
 
void unsampledImageConstructorNotification (const detail::code_location &CodeLoc, void *UserObj, const void *HostObj, uint32_t Dim, size_t Range[3], image_format Format)
 
void unsampledImageDestructorNotification (void *UserObj)
 

Protected Attributes

std::shared_ptr< detail::image_implimpl
 

Detailed Description

Definition at line 174 of file image.hpp.

Constructor & Destructor Documentation

◆ image_plain() [1/13]

sycl::_V1::detail::image_plain::image_plain ( const std::shared_ptr< detail::image_impl > &  Impl)
inlineprotected

Definition at line 176 of file image.hpp.

◆ image_plain() [2/13]

sycl::_V1::detail::image_plain::image_plain ( image_channel_order  Order,
image_channel_type  Type,
const range< 3 > &  Range,
std::unique_ptr< SYCLMemObjAllocator Allocator,
uint8_t  Dimensions,
const property_list PropList 
)
protected

Definition at line 15 of file image.cpp.

References sycl::_V1::Dimensions, and impl.

◆ image_plain() [3/13]

sycl::_V1::detail::image_plain::image_plain ( image_channel_order  Order,
image_channel_type  Type,
const range< 3 > &  Range,
const range< 2 > &  Pitch,
std::unique_ptr< SYCLMemObjAllocator Allocator,
uint8_t  Dimensions,
const property_list PropList 
)
protected

Definition at line 23 of file image.cpp.

References sycl::_V1::Dimensions, and impl.

◆ image_plain() [4/13]

sycl::_V1::detail::image_plain::image_plain ( void *  HostPointer,
image_channel_order  Order,
image_channel_type  Type,
const range< 3 > &  Range,
std::unique_ptr< SYCLMemObjAllocator Allocator,
uint8_t  Dimensions,
const property_list PropList 
)
protected

Definition at line 31 of file image.cpp.

References sycl::_V1::Dimensions, and impl.

◆ image_plain() [5/13]

sycl::_V1::detail::image_plain::image_plain ( const void *  HostPointer,
image_channel_order  Order,
image_channel_type  Type,
const range< 3 > &  Range,
std::unique_ptr< SYCLMemObjAllocator Allocator,
uint8_t  Dimensions,
const property_list PropList 
)
protected

Definition at line 40 of file image.cpp.

References sycl::_V1::Dimensions, and impl.

◆ image_plain() [6/13]

sycl::_V1::detail::image_plain::image_plain ( void *  HostPointer,
image_channel_order  Order,
image_channel_type  Type,
const range< 3 > &  Range,
const range< 2 > &  Pitch,
std::unique_ptr< SYCLMemObjAllocator Allocator,
uint8_t  Dimensions,
const property_list PropList 
)
protected

Definition at line 49 of file image.cpp.

References sycl::_V1::Dimensions, and impl.

◆ image_plain() [7/13]

sycl::_V1::detail::image_plain::image_plain ( const std::shared_ptr< const void > &  HostPointer,
image_channel_order  Order,
image_channel_type  Type,
const range< 3 > &  Range,
std::unique_ptr< SYCLMemObjAllocator Allocator,
uint8_t  Dimensions,
const property_list PropList,
bool  IsConstPtr 
)
protected

Definition at line 59 of file image.cpp.

References sycl::_V1::Dimensions, and impl.

◆ image_plain() [8/13]

sycl::_V1::detail::image_plain::image_plain ( const std::shared_ptr< const void > &  HostPointer,
image_channel_order  Order,
image_channel_type  Type,
const range< 3 > &  Range,
const range< 2 > &  Pitch,
std::unique_ptr< SYCLMemObjAllocator Allocator,
uint8_t  Dimensions,
const property_list PropList,
bool  IsConstPtr 
)
protected

Definition at line 70 of file image.cpp.

References sycl::_V1::Dimensions, and impl.

◆ image_plain() [9/13]

sycl::_V1::detail::image_plain::image_plain ( const void *  HostPointer,
image_channel_order  Order,
image_channel_type  Type,
image_sampler  Sampler,
const range< 3 > &  Range,
std::unique_ptr< SYCLMemObjAllocator Allocator,
uint8_t  Dimensions,
const property_list PropList 
)
protected

Definition at line 81 of file image.cpp.

References sycl::_V1::Dimensions, and impl.

◆ image_plain() [10/13]

sycl::_V1::detail::image_plain::image_plain ( const void *  HostPointer,
image_channel_order  Order,
image_channel_type  Type,
image_sampler  Sampler,
const range< 3 > &  Range,
const range< 2 > &  Pitch,
std::unique_ptr< SYCLMemObjAllocator Allocator,
uint8_t  Dimensions,
const property_list PropList 
)
protected

Definition at line 91 of file image.cpp.

References sycl::_V1::Dimensions, and impl.

◆ image_plain() [11/13]

sycl::_V1::detail::image_plain::image_plain ( const std::shared_ptr< const void > &  HostPointer,
image_channel_order  Order,
image_channel_type  Type,
image_sampler  Sampler,
const range< 3 > &  Range,
std::unique_ptr< SYCLMemObjAllocator Allocator,
uint8_t  Dimensions,
const property_list PropList 
)
protected

Definition at line 101 of file image.cpp.

References sycl::_V1::Dimensions, and impl.

◆ image_plain() [12/13]

sycl::_V1::detail::image_plain::image_plain ( const std::shared_ptr< const void > &  HostPointer,
image_channel_order  Order,
image_channel_type  Type,
image_sampler  Sampler,
const range< 3 > &  Range,
const range< 2 > &  Pitch,
std::unique_ptr< SYCLMemObjAllocator Allocator,
uint8_t  Dimensions,
const property_list PropList 
)
protected

Definition at line 111 of file image.cpp.

References sycl::_V1::Dimensions, and impl.

◆ image_plain() [13/13]

sycl::_V1::detail::image_plain::image_plain ( pi_native_handle  MemObject,
const context SyclContext,
event  AvailableEvent,
std::unique_ptr< SYCLMemObjAllocator Allocator,
uint8_t  Dimensions,
image_channel_order  Order,
image_channel_type  Type,
bool  OwnNativeHandle,
range< 3 >  Range3WithOnes 
)
protected

Definition at line 133 of file image.cpp.

References sycl::_V1::Dimensions, and impl.

Member Function Documentation

◆ get_allocator_internal()

const std::unique_ptr< SYCLMemObjAllocator > & sycl::_V1::detail::image_plain::get_allocator_internal ( ) const
protected

Definition at line 183 of file image.cpp.

References impl.

Referenced by sycl::_V1::detail::image_common< Dimensions, AllocatorT >::get_allocator().

◆ get_count()

size_t sycl::_V1::detail::image_plain::get_count ( ) const
protectednoexcept

Definition at line 168 of file image.cpp.

References impl.

Referenced by sycl::_V1::detail::image_common< Dimensions, AllocatorT >::size().

◆ get_pitch()

range< 2 > sycl::_V1::detail::image_plain::get_pitch ( ) const
protected

Definition at line 164 of file image.cpp.

References impl.

Referenced by sycl::_V1::detail::image_common< Dimensions, AllocatorT >::get_pitch().

◆ get_property()

template<typename propertyT >
propertyT sycl::_V1::detail::image_plain::get_property ( ) const
protected

◆ get_range()

range< 3 > sycl::_V1::detail::image_plain::get_range ( ) const
protected

Definition at line 162 of file image.cpp.

References impl.

Referenced by sycl::_V1::detail::image_common< Dimensions, AllocatorT >::get_range().

◆ get_size()

size_t sycl::_V1::detail::image_plain::get_size ( ) const
protectednoexcept

Definition at line 166 of file image.cpp.

References impl.

◆ getChannelOrder()

image_channel_order sycl::_V1::detail::image_plain::getChannelOrder ( ) const
protected

Definition at line 197 of file image.cpp.

◆ getChannelType()

image_channel_type sycl::_V1::detail::image_plain::getChannelType ( ) const
protected

Definition at line 201 of file image.cpp.

References impl.

◆ getElementSize()

size_t sycl::_V1::detail::image_plain::getElementSize ( ) const
protected

Definition at line 187 of file image.cpp.

References impl.

◆ getRowPitch()

size_t sycl::_V1::detail::image_plain::getRowPitch ( ) const
protected

Definition at line 189 of file image.cpp.

References impl.

◆ getSampler()

image_sampler sycl::_V1::detail::image_plain::getSampler ( ) const
protectednoexcept

Definition at line 193 of file image.cpp.

References impl.

◆ getSlicePitch()

size_t sycl::_V1::detail::image_plain::getSlicePitch ( ) const
protected

Definition at line 191 of file image.cpp.

References impl.

◆ has_property()

template<typename propertyT >
bool sycl::_V1::detail::image_plain::has_property ( ) const
protectednoexcept

◆ sampledImageConstructorNotification()

void sycl::_V1::detail::image_plain::sampledImageConstructorNotification ( const detail::code_location CodeLoc,
void *  UserObj,
const void *  HostObj,
uint32_t  Dim,
size_t  Range[3],
image_format  Format,
const image_sampler Sampler 
)
protected

Definition at line 205 of file image.cpp.

References impl.

◆ sampledImageDestructorNotification()

void sycl::_V1::detail::image_plain::sampledImageDestructorNotification ( void *  UserObj)
protected

Definition at line 213 of file image.cpp.

References impl.

◆ set_final_data_internal() [1/2]

void sycl::_V1::detail::image_plain::set_final_data_internal ( )
protected

Definition at line 170 of file image.cpp.

References impl.

◆ set_final_data_internal() [2/2]

void sycl::_V1::detail::image_plain::set_final_data_internal ( const std::function< void(const std::function< void(void *const Ptr)> &)> &  FinalDataFunc)
protected

Definition at line 172 of file image.cpp.

References impl.

◆ set_write_back()

void sycl::_V1::detail::image_plain::set_write_back ( bool  flag)
protected

Definition at line 178 of file image.cpp.

◆ unsampledImageConstructorNotification()

void sycl::_V1::detail::image_plain::unsampledImageConstructorNotification ( const detail::code_location CodeLoc,
void *  UserObj,
const void *  HostObj,
uint32_t  Dim,
size_t  Range[3],
image_format  Format 
)
protected

Definition at line 217 of file image.cpp.

◆ unsampledImageDestructorNotification()

void sycl::_V1::detail::image_plain::unsampledImageDestructorNotification ( void *  UserObj)
protected

Definition at line 224 of file image.cpp.

Member Data Documentation

◆ impl


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