DPC++ Runtime
Runtime libraries for oneAPI DPC++
Public Member Functions | Public Attributes | List of all members
sycl::_V1::ext::oneapi::experimental::image_descriptor Struct Reference

A struct to describe the properties of an image. More...

#include <sycl/ext/oneapi/bindless_images_descriptor.hpp>

Collaboration diagram for sycl::_V1::ext::oneapi::experimental::image_descriptor:
Collaboration graph
[legend]

Public Member Functions

 image_descriptor ()=default
 
 image_descriptor (range< 1 > dims, unsigned int num_channels, image_channel_type channel_type, image_type type=image_type::standard, unsigned int num_levels=1, unsigned int array_size=1)
 
 image_descriptor (range< 2 > dims, unsigned int num_channels, image_channel_type channel_type, image_type type=image_type::standard, unsigned int num_levels=1, unsigned int array_size=1)
 
 image_descriptor (range< 3 > dims, unsigned int num_channels, image_channel_type channel_type, image_type type=image_type::standard, unsigned int num_levels=1, unsigned int array_size=1)
 
image_descriptor get_mip_level_desc (unsigned int level) const
 Get the descriptor for a mipmap level. More...
 
void verify () const
 

Public Attributes

size_t width {0}
 
size_t height {0}
 
size_t depth {0}
 
unsigned int num_channels {4}
 
image_channel_type channel_type {image_channel_type::fp32}
 
image_type type {image_type::standard}
 
unsigned int num_levels {1}
 
unsigned int array_size {1}
 

Detailed Description

A struct to describe the properties of an image.

Definition at line 52 of file bindless_images_descriptor.hpp.

Constructor & Destructor Documentation

◆ image_descriptor() [1/4]

sycl::_V1::ext::oneapi::experimental::image_descriptor::image_descriptor ( )
default

◆ image_descriptor() [2/4]

sycl::_V1::ext::oneapi::experimental::image_descriptor::image_descriptor ( range< 1 >  dims,
unsigned int  num_channels,
image_channel_type  channel_type,
image_type  type = image_type::standard,
unsigned int  num_levels = 1,
unsigned int  array_size = 1 
)
inline

Definition at line 64 of file bindless_images_descriptor.hpp.

References verify().

◆ image_descriptor() [3/4]

sycl::_V1::ext::oneapi::experimental::image_descriptor::image_descriptor ( range< 2 >  dims,
unsigned int  num_channels,
image_channel_type  channel_type,
image_type  type = image_type::standard,
unsigned int  num_levels = 1,
unsigned int  array_size = 1 
)
inline

Definition at line 74 of file bindless_images_descriptor.hpp.

References verify().

◆ image_descriptor() [4/4]

sycl::_V1::ext::oneapi::experimental::image_descriptor::image_descriptor ( range< 3 >  dims,
unsigned int  num_channels,
image_channel_type  channel_type,
image_type  type = image_type::standard,
unsigned int  num_levels = 1,
unsigned int  array_size = 1 
)
inline

Definition at line 84 of file bindless_images_descriptor.hpp.

References verify().

Member Function Documentation

◆ get_mip_level_desc()

image_descriptor sycl::_V1::ext::oneapi::experimental::image_descriptor::get_mip_level_desc ( unsigned int  level) const
inline

Get the descriptor for a mipmap level.

Definition at line 95 of file bindless_images_descriptor.hpp.

References channel_type, depth, height, sycl::_V1::ext::oneapi::experimental::mipmap, num_channels, type, verify(), and width.

◆ verify()

void sycl::_V1::ext::oneapi::experimental::image_descriptor::verify ( ) const
inline

Definition at line 122 of file bindless_images_descriptor.hpp.

References sycl::_V1::ext::oneapi::experimental::array, array_size, sycl::_V1::ext::oneapi::experimental::cubemap, depth, height, sycl::_V1::ext::oneapi::experimental::mipmap, num_channels, num_levels, sycl::_V1::ext::oneapi::experimental::standard, type, and width.

Referenced by sycl::_V1::ext::oneapi::experimental::alloc_image_mem(), sycl::_V1::ext::oneapi::experimental::create_image(), sycl::_V1::handler::ext_oneapi_copy(), get_mip_level_desc(), image_descriptor(), and sycl::_V1::ext::oneapi::experimental::map_external_image_memory().

Member Data Documentation

◆ array_size

unsigned int sycl::_V1::ext::oneapi::experimental::image_descriptor::array_size {1}

Definition at line 60 of file bindless_images_descriptor.hpp.

Referenced by sycl::_V1::handler::ext_oneapi_copy(), sycl::_V1::ext::oneapi::experimental::populate_pi_structs(), and verify().

◆ channel_type

image_channel_type sycl::_V1::ext::oneapi::experimental::image_descriptor::channel_type {image_channel_type::fp32}

Definition at line 57 of file bindless_images_descriptor.hpp.

Referenced by sycl::_V1::handler::ext_oneapi_copy(), get_mip_level_desc(), sycl::_V1::ext::oneapi::experimental::pitched_alloc_device(), and sycl::_V1::ext::oneapi::experimental::populate_pi_structs().

◆ depth

size_t sycl::_V1::ext::oneapi::experimental::image_descriptor::depth {0}

Definition at line 55 of file bindless_images_descriptor.hpp.

Referenced by sycl::_V1::handler::ext_oneapi_copy(), get_mip_level_desc(), sycl::_V1::ext::oneapi::experimental::populate_pi_structs(), and verify().

◆ height

size_t sycl::_V1::ext::oneapi::experimental::image_descriptor::height {0}

Definition at line 54 of file bindless_images_descriptor.hpp.

Referenced by sycl::_V1::handler::ext_oneapi_copy(), get_mip_level_desc(), sycl::_V1::ext::oneapi::experimental::pitched_alloc_device(), sycl::_V1::ext::oneapi::experimental::populate_pi_structs(), and verify().

◆ num_channels

unsigned int sycl::_V1::ext::oneapi::experimental::image_descriptor::num_channels {4}

Definition at line 56 of file bindless_images_descriptor.hpp.

Referenced by sycl::_V1::handler::ext_oneapi_copy(), get_mip_level_desc(), sycl::_V1::ext::oneapi::experimental::pitched_alloc_device(), sycl::_V1::ext::oneapi::experimental::populate_pi_structs(), and verify().

◆ num_levels

unsigned int sycl::_V1::ext::oneapi::experimental::image_descriptor::num_levels {1}

Definition at line 59 of file bindless_images_descriptor.hpp.

Referenced by sycl::_V1::ext::oneapi::experimental::populate_pi_structs(), and verify().

◆ type

image_type sycl::_V1::ext::oneapi::experimental::image_descriptor::type {image_type::standard}

Definition at line 58 of file bindless_images_descriptor.hpp.

Referenced by sycl::_V1::handler::ext_oneapi_copy(), get_mip_level_desc(), sycl::_V1::ext::oneapi::experimental::populate_pi_structs(), and verify().

◆ width

size_t sycl::_V1::ext::oneapi::experimental::image_descriptor::width {0}

Definition at line 53 of file bindless_images_descriptor.hpp.

Referenced by sycl::_V1::handler::ext_oneapi_copy(), get_mip_level_desc(), sycl::_V1::ext::oneapi::experimental::pitched_alloc_device(), sycl::_V1::ext::oneapi::experimental::populate_pi_structs(), and verify().

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