Document the packed integer formats SDL_Color is bit-compatible with.

This commit is contained in:
Alex Szpakowski 2021-12-14 14:24:59 -04:00 committed by Sam Lantinga
parent 3a5e148b13
commit 7f5339e6c4
1 changed files with 5 additions and 0 deletions

View File

@ -301,6 +301,11 @@ typedef enum
SDL_DEFINE_PIXELFOURCC('O', 'E', 'S', ' ')
} SDL_PixelFormatEnum;
/**
* The bits of this structure can be directly reinterpreted as an integer-packed
* color which uses the SDL_PIXELFORMAT_RGBA32 format (SDL_PIXELFORMAT_ABGR8888
* on little-endian systems and SDL_PIXELFORMAT_RGBA8888 on big-endian systems).
*/
typedef struct SDL_Color
{
Uint8 r;