 |
XII Release 0.1.0
|
|
XII Release 0.1.0
|
This describes the multi-planar format attributes. These attributes are intrinsic to the multi-planar format itself and do not depend on the format support. More...
#include <Descriptors.h>
Classes | |
| struct | Plane |
Public Member Functions | |
| XII_DECLARE_POD_TYPE () | |
| XII_ALWAYS_INLINE xiiUInt32 | GetPlaneCount () const |
| Returns the number of planes in this multi-planar format. | |
| XII_ALWAYS_INLINE bool | HasPlane (xiiUInt32 uiPlane) const |
| Returns true if the specified plane index is valid. | |
| XII_ALWAYS_INLINE const Plane & | GetPlane (xiiUInt32 uiPlane) const |
| Returns the description of the specified plane. | |
| XII_ALWAYS_INLINE xiiUInt32 | GetPlaneWidth (xiiUInt32 uiFullWidth, xiiUInt32 uiPlane) const |
| Returns the width of the specified plane, given the full resolution width. | |
| XII_ALWAYS_INLINE xiiUInt32 | GetPlaneHeight (xiiUInt32 uiFullHeight, xiiUInt32 uiPlane) const |
| Returns the height of the specified plane, given the full resolution height. | |
| XII_ALWAYS_INLINE xiiUInt32 | GetPlaneRowPitch (xiiUInt32 uiFullWidth, xiiUInt32 uiPlane) const |
| Returns the row pitch (in bytes) of the specified plane, given the full resolution width. | |
| XII_ALWAYS_INLINE xiiUInt64 | GetPlaneSlicePitch (xiiUInt32 uiFullWidth, xiiUInt32 uiFullHeight, xiiUInt32 uiPlane) const |
| Returns the slice pitch (in bytes) of the specified plane, given the full resolution width and height. | |
| XII_ALWAYS_INLINE bool | IsValid () const |
| Returns true if the multi-planar format description is valid. | |
| XII_ALWAYS_INLINE xiiUInt64 | GetTotalSize (xiiUInt32 uiFullWidth, xiiUInt32 uiFullHeight) const |
| Returns the total size (in bytes) of all planes, given the full resolution width and height. | |
| Public Member Functions inherited from xiiHashableStruct< xiiGALMultiPlanarFormatDescription > | |
| constexpr | xiiHashableStruct () noexcept |
| Default constructor. Initializes all bytes to zero. | |
| xiiHashableStruct & | operator= (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 | |
| xiiEnum< xiiGALResourceFormat > | m_Format = xiiGALResourceFormat::Unknown |
| Multi-planar texture format. | |
| xiiStaticArray< Plane, 4 > | m_Planes |
| Array of formats for each plane. | |
This describes the multi-planar format attributes. These attributes are intrinsic to the multi-planar format itself and do not depend on the format support.
1.15.0