Add comments

This commit is contained in:
Crayon2000 2024-04-01 18:29:00 -04:00
parent 100b1bd2bf
commit 87939430ca

View file

@ -42,19 +42,19 @@ typedef struct _tplimgheader TPLImgHeader;
* Texture header. * Texture header.
*/ */
struct _tplimgheader { struct _tplimgheader {
u16 height; u16 height; /**< Height of the texture in pixels. */
u16 width; u16 width; /**< Width of the texture in pixels. */
u32 fmt; u32 fmt; /**< Format of the texture. */
void *data; void *data; /**< Pointer to the texture data. */
u32 wraps; u32 wraps; /**< Texture coordinate wrapping strategy in the S direction. */
u32 wrapt; u32 wrapt; /**< Texture coordinate wrapping strategy in the T direction. */
u32 minfilter; u32 minfilter; /**< Filter mode when the texel/pixel ratio is ≤ 1.0. */
u32 magfilter; u32 magfilter; /**< Filter mode when the texel/pixel ratio is > 1.0. */
f32 lodbias; f32 lodbias; /**< LOD bias. */
u8 edgelod; u8 edgelod; /**< Edge LOD. */
u8 minlod; u8 minlod; /**< Minimum LOD value. */
u8 maxlod; u8 maxlod; /**< Maximum LOD value. */
u8 unpacked; u8 unpacked; /**< Internal flag. */
} ATTRIBUTE_PACKED; } ATTRIBUTE_PACKED;
/** /**
@ -66,11 +66,11 @@ typedef struct _tplpalheader TPLPalHeader;
* Texture palette header. * Texture palette header.
*/ */
struct _tplpalheader { struct _tplpalheader {
u16 nitems; u16 nitems; /**< Number of palette entries. */
u8 unpacked; u8 unpacked; /**< Internal flag. */
u8 pad; u8 pad; /**< Padding. */
u32 fmt; u32 fmt; /**< Format of the color lookup table (CLUT). */
void *data; void *data; /**< Pointer to the color lookup table (CLUT) data. */
} ATTRIBUTE_PACKED; } ATTRIBUTE_PACKED;
/** /**
@ -82,8 +82,8 @@ typedef struct _tpldesc TPLDescHeader;
* Texture descriptor. * Texture descriptor.
*/ */
struct _tpldesc { struct _tpldesc {
TPLImgHeader *imghead; TPLImgHeader *imghead; /**< Pointer to texture header structure. */
TPLPalHeader *palhead; TPLPalHeader *palhead; /**< Pointer to color lookup table (CLUT) header. */
} ATTRIBUTE_PACKED; } ATTRIBUTE_PACKED;
/** /**