DPC++ Runtime
Runtime libraries for oneAPI DPC++
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)
 
 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)
 
 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)
 
image_descriptor get_mip_level_desc (unsigned int level) const
 Get the descriptor for a mipmap level. More...
 

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
 

Detailed Description

A struct to describe the properties of an image.

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

Definition at line 45 of file bindless_images_descriptor.hpp.

◆ 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 
)
inline

Definition at line 52 of file bindless_images_descriptor.hpp.

◆ 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 
)
inline

Definition at line 59 of file bindless_images_descriptor.hpp.

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

Member Data Documentation

◆ channel_order

◆ channel_type

◆ depth

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

◆ height

◆ num_levels

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

◆ type

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

◆ width


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