DevKit7/citro3d
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: updates types documentation

Browse Source
This commit is contained in:
oreo639 2024-01-16 18:31:31 -08:00
parent cfe9bd4cbe
commit 4ed5105960
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
include/c3d/types.h
View File

@ -1,3 +1,7 @@
/**
* @file types.h
* @brief Various citro3d types.
*/
#pragma once #pragma once
#if defined(__3DS__) || defined(_3DS) #if defined(__3DS__) || defined(_3DS)
#include <3ds.h> #include <3ds.h>
@ -14,8 +18,19 @@ typedef uint32_t u32;
#define C3D_DEPRECATED #define C3D_DEPRECATED
#endif #endif
/**
* @brief Integer vector
*/
typedef u32 C3D_IVec; typedef u32 C3D_IVec;
/**
* @brief Packs 4 u8 integers into a vector.
* @param[in] x X component of the vector.
* @param[in] y Y component of the vector.
* @param[in] z Z component of the vector.
* @param[in] w W component of the vector.
* @return Returns \ref C3D_IVec.
*/
static inline C3D_IVec IVec_Pack(u8 x, u8 y, u8 z, u8 w) static inline C3D_IVec IVec_Pack(u8 x, u8 y, u8 z, u8 w)
{ {
return (u32)x | ((u32)y << 8) | ((u32)z << 16) | ((u32)w << 24); return (u32)x | ((u32)y << 8) | ((u32)z << 16) | ((u32)w << 24);
@ -64,7 +79,6 @@ typedef union
} C3D_FVec; } C3D_FVec;
/** /**
* @struct C3D_FQuat
* @brief Float quaternion. See @ref C3D_FVec. * @brief Float quaternion. See @ref C3D_FVec.
*/ */
typedef C3D_FVec C3D_FQuat; typedef C3D_FVec C3D_FQuat;