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:

Public Member Functions
	image_descriptor ()=default
	image_descriptor (range< 1 > dims, image_channel_order channel_order, 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, image_channel_order channel_order, 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, image_channel_order channel_order, 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
size_t	height
size_t	depth
image_channel_order	channel_order
image_channel_type	channel_type
image_type	type
unsigned int	num_levels
unsigned int	array_size

Detailed Description

A struct to describe the properties of an image.

Definition at line 33 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, image_channel_order  channel_order, 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 45 of file bindless_images_descriptor.hpp.

References verify().

image_descriptor() [3/4]

sycl::_V1::ext::oneapi::experimental::image_descriptor::image_descriptor ( range< 2 >  dims, image_channel_order  channel_order, 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 55 of file bindless_images_descriptor.hpp.

References verify().

image_descriptor() [4/4]

sycl::_V1::ext::oneapi::experimental::image_descriptor::image_descriptor ( range< 3 >  dims, image_channel_order  channel_order, 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 65 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 76 of file bindless_images_descriptor.hpp.

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

verify()

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

inline

Definition at line 103 of file bindless_images_descriptor.hpp.

References sycl::_V1::ext::oneapi::experimental::array, sycl::_V1::ext::oneapi::experimental::cubemap, sycl::_V1::ext::oneapi::experimental::mipmap, and sycl::_V1::ext::oneapi::experimental::standard.

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

Definition at line 41 of file bindless_images_descriptor.hpp.

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

channel_order

image_channel_order sycl::_V1::ext::oneapi::experimental::image_descriptor::channel_order

Definition at line 37 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().

channel_type

image_channel_type sycl::_V1::ext::oneapi::experimental::image_descriptor::channel_type

Definition at line 38 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

Definition at line 36 of file bindless_images_descriptor.hpp.

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

height

size_t sycl::_V1::ext::oneapi::experimental::image_descriptor::height

Definition at line 35 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().

num_levels

unsigned int sycl::_V1::ext::oneapi::experimental::image_descriptor::num_levels

Definition at line 40 of file bindless_images_descriptor.hpp.

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

type

image_type sycl::_V1::ext::oneapi::experimental::image_descriptor::type

Definition at line 39 of file bindless_images_descriptor.hpp.

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

width

size_t sycl::_V1::ext::oneapi::experimental::image_descriptor::width

Definition at line 34 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().

---

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

• include/sycl/ext/oneapi/bindless_images_descriptor.hpp