eden-emu/SDL
15
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-06-01 17:37:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Updated colorspace documentation for the wiki

Browse source
This commit is contained in:
Sam Lantinga 2024-07-14 11:02:39 -07:00
parent 1fecef5e4b
commit 6217094c40
1 changed files with 14 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

21
include/SDL3/SDL_pixels.h
View file

@ -187,7 +187,7 @@ typedef enum SDL_PackedLayout
/* Note: If you modify this enum, update SDL_GetPixelFormatName() */ /* Note: If you modify this enum, update SDL_GetPixelFormatName() */
/** /**
* All pixel formats known to SDL. * Pixel format.
* *
* SDL's pixel formats have the following naming convention: * SDL's pixel formats have the following naming convention:
* *
@ -401,7 +401,7 @@ typedef enum SDL_PixelFormat
*/ */
/** /**
* The color type * Colorspace color type.
* *
* \since This enum is available since SDL 3.0.0. * \since This enum is available since SDL 3.0.0.
*/ */
@ -413,7 +413,7 @@ typedef enum SDL_ColorType
} SDL_ColorType; } SDL_ColorType;
/** /**
* The color range, as described by * Colorspace color range, as described by
* https://www.itu.int/rec/R-REC-BT.2100-2-201807-I/en * https://www.itu.int/rec/R-REC-BT.2100-2-201807-I/en
* *
* \since This enum is available since SDL 3.0.0. * \since This enum is available since SDL 3.0.0.
@ -426,7 +426,7 @@ typedef enum SDL_ColorRange
} SDL_ColorRange; } SDL_ColorRange;
/** /**
* The color primaries, as described by * Colorspace color primaries, as described by
* https://www.itu.int/rec/T-REC-H.273-201612-S/en * https://www.itu.int/rec/T-REC-H.273-201612-S/en
* *
* \since This enum is available since SDL 3.0.0. * \since This enum is available since SDL 3.0.0.
@ -450,7 +450,7 @@ typedef enum SDL_ColorPrimaries
} SDL_ColorPrimaries; } SDL_ColorPrimaries;
/** /**
* The color transfer characteristics. * Colorspace transfer characteristics.
* *
* These are as described by https://www.itu.int/rec/T-REC-H.273-201612-S/en * These are as described by https://www.itu.int/rec/T-REC-H.273-201612-S/en
* *
@ -480,7 +480,7 @@ typedef enum SDL_TransferCharacteristics
} SDL_TransferCharacteristics; } SDL_TransferCharacteristics;
/** /**
* The matrix coefficients. * Colorspace matrix coefficients.
* *
* These are as described by https://www.itu.int/rec/T-REC-H.273-201612-S/en * These are as described by https://www.itu.int/rec/T-REC-H.273-201612-S/en
* *
@ -506,7 +506,7 @@ typedef enum SDL_MatrixCoefficients
} SDL_MatrixCoefficients; } SDL_MatrixCoefficients;
/** /**
* The chroma sample location. * Colorspace chroma sample location.
* *
* \since This enum is available since SDL 3.0.0. * \since This enum is available since SDL 3.0.0.
*/ */
@ -537,6 +537,13 @@ typedef enum SDL_ChromaLocation
#define SDL_ISCOLORSPACE_LIMITED_RANGE(X) (SDL_COLORSPACERANGE(X) != SDL_COLOR_RANGE_FULL) #define SDL_ISCOLORSPACE_LIMITED_RANGE(X) (SDL_COLORSPACERANGE(X) != SDL_COLOR_RANGE_FULL)
#define SDL_ISCOLORSPACE_FULL_RANGE(X) (SDL_COLORSPACERANGE(X) == SDL_COLOR_RANGE_FULL) #define SDL_ISCOLORSPACE_FULL_RANGE(X) (SDL_COLORSPACERANGE(X) == SDL_COLOR_RANGE_FULL)
/**
* Colorspace definitions.
*
* Since similar colorspaces may vary in their details (matrix, transfer function, etc.), this is not an exhaustive list, but rather a representative sample of the kinds of colorspaces supported in SDL.
*
* \since This enum is available since SDL 3.0.0.
*/
typedef enum SDL_Colorspace typedef enum SDL_Colorspace
{ {
SDL_COLORSPACE_UNKNOWN = 0, SDL_COLORSPACE_UNKNOWN = 0,