XII Release 0.1.0
Loading...
Searching...
No Matches
xiiGALBufferToTextureCopyDescription Struct Reference

This describes the information required to perform a copy operation between a buffer and a texture. More...

#include <TextureUtilities.h>

Inheritance diagram for xiiGALBufferToTextureCopyDescription:
[legend]

Public Member Functions

 XII_DECLARE_POD_TYPE ()
 
- Public Member Functions inherited from xiiHashableStruct< xiiGALBufferToTextureCopyDescription >
constexpr xiiHashableStruct () noexcept
 Default constructor. Initializes all bytes to zero.
 
 xiiHashableStruct (const xiiHashableStruct &other) noexcept
 Bitwise copy constructor.
 
xiiHashableStructoperator= (const xiiHashableStruct &other) noexcept
 Bitwise assignment operator.
 
bool operator== (const xiiHashableStruct &other) const noexcept
 Compares equality via raw byte comparison.
 
std::strong_ordering operator<=> (const xiiHashableStruct &other) const noexcept
 Compares ordering via raw byte comparison.
 
xiiUInt32 CalculateHash () const noexcept
 Calculates a 32-bit hash from raw bytes of the struct.
 
void Clear () noexcept
 Fills all bytes with zero.
 
bool IsZero () const noexcept
 Returns true if all bytes are zero.
 

Public Attributes

xiiUInt64 m_uiRowSize = 0
 Texture region row size, in bytes. For compressed formats, this is the size of one row of compressed blocks.
 
xiiUInt64 m_uiRowStride = 0
 Row stride, in bytes. The stride is computed by aligning the RowSize, and is thus always >= RowSize.
 
xiiUInt32 m_uiRowStrideInTexels = 0
 Row stride in texels.
 
xiiUInt32 m_uiRowCount = 0
 The number of rows in the region. For compressed formats, this is the number of compressed-block rows.
 
xiiUInt32 m_uiDepthStride = 0
 Depth stride (RowStride * RowCount).
 
xiiUInt32 m_uiMemorySize = 0
 Total memory size required to store the pixels in the region.
 
xiiBoundingBoxU32 m_Region = xiiBoundingBoxU32::MakeZero()
 Texture region.
 

Detailed Description

This describes the information required to perform a copy operation between a buffer and a texture.


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