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

Public Member Functions

 AZ_TYPE_INFO (ImageSubresourceRange,"{CD682C5C-1119-4291-84E1-253415F5D390}")
 ImageSubresourceRange ()=default
 Defaults to the full mapping of the image.
 ImageSubresourceRange (uint16_t mipSliceMin, uint16_t mipSliceMax, uint16_t arraySliceMin, uint16_t arraySliceMax)
 Constructs a range from a [min, max] range for mips and array indices.
 ImageSubresourceRange (const ImageDescriptor &descriptor)
 Constructs a range that covers the whole image.
 ImageSubresourceRange (const ImageViewDescriptor &descriptor)
 Constructs a range that covers the same region as the image view.
 ImageSubresourceRange (ImageSubresource subresource)
 Constructs a range from a single subresource.
HashValue64 GetHash (HashValue64 seed=HashValue64{0}) const
 Returns the hash of the view.
bool operator== (const ImageSubresourceRange &other) const
 Comparison operator.

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)

Public Attributes

uint16_t m_mipSliceMin = 0
 Minimum mip slice offset.
uint16_t m_mipSliceMax = HighestSliceIndex
 Maximum mip slice offset. Must be greater than or equal to the min mip slice offset.
uint16_t m_arraySliceMin = 0
 Minimum array slice offset.
uint16_t m_arraySliceMax = HighestSliceIndex
 Maximum array slice offset. Must be greater or equal to the min array slice offset.
ImageAspectFlags m_aspectFlags = ImageAspectFlags::All
 The image aspects that are included in the subresource range.

Static Public Attributes

static const uint16_t HighestSliceIndex = static_cast<uint16_t>(-1)

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