Open 3D Engine Atom Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::RHI::ImageDescriptor Struct Reference

#include <ImageDescriptor.h>

Public Member Functions

 AZ_TYPE_INFO (ImageDescriptor, "{D1FDAC7B-E9CF-4B2D-B1FB-646D3EE3159C}")
 
HashValue64 GetHash (HashValue64 seed=HashValue64{ 0 }) const
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
static ImageDescriptor Create1D (ImageBindFlags bindFlags, uint32_t width, Format format)
 
static ImageDescriptor Create1DArray (ImageBindFlags bindFlags, uint32_t width, uint16_t arraySize, Format format)
 
static ImageDescriptor Create2D (ImageBindFlags bindFlags, uint32_t width, uint32_t height, Format format)
 
static ImageDescriptor Create2DArray (ImageBindFlags bindFlags, uint32_t width, uint32_t height, uint16_t arraySize, Format format)
 
static ImageDescriptor CreateCubemap (ImageBindFlags bindFlags, uint32_t width, Format format)
 
static ImageDescriptor CreateCubemapArray (ImageBindFlags bindFlags, uint32_t width, uint16_t arraySize, Format format)
 
static ImageDescriptor Create3D (ImageBindFlags bindFlags, uint32_t width, uint32_t height, uint32_t depth, Format format)
 

Public Attributes

ImageBindFlags m_bindFlags = ImageBindFlags::ShaderRead
 union of all bind points for this image
 
ImageDimension m_dimension = ImageDimension::Image2D
 Number of dimensions.
 
Size m_size
 Size of the image in pixels.
 
uint16_t m_arraySize = 1
 Number of array elements (must be 1 for 3D images).
 
uint16_t m_mipLevels = 1
 Number of mip levels.
 
Format m_format = Format::Unknown
 Pixel format.
 
HardwareQueueClassMask m_sharedQueueMask = HardwareQueueClassMask::All
 The mask of queue classes supporting shared access of this resource.
 
MultisampleState m_multisampleState
 Multisample information for this image.
 
uint32_t m_isCubemap = 0
 Whether to treat this image as a cubemap.
 

Static Public Attributes

static const uint16_t NumCubeMapSlices = 6
 

Detailed Description

Images are comprised of sub-resources corresponding to the number of mip-mip levels and array slices. Image data is stored as pixels in opaque swizzled formats. Images represent texture data to the shader.


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