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

fnsince: update \since policy for documentation.

Browse source 
Everything in SDL3 up to the ABI lock is reported as available since 3.1.3.
Everything else will be reported as since 3.2.0 (what will be the first
official release).

Also ran a Perl script over the headers to change everything to 3.1.3 that
wasn't an API function, since fnsince.pl can't manage those. If there's a
macro or datatype that has snuck in that needs to be 3.2.0 instead, we'll
have to manually fix it up, but it shouldn't be a big deal in any case.

Reference PR #11304.
This commit is contained in:
Ryan C. Gordon 2024-10-23 12:19:38 -04:00
parent 21c91d5535
commit 1c1706a00b
No known key found for this signature in database
GPG key ID: FA148B892AB48044
59 changed files with 1828 additions and 1825 deletions
Download patch file Download diff file Expand all files Collapse all files

64
include/SDL3/SDL_pixels.h
View file

@ -41,7 +41,7 @@ extern "C" {
/**
* A fully opaque 8-bit alpha value.
*
* \since This macro is available since SDL 3.0.0.
* \since This macro is available since SDL 3.1.3.
*
* \sa SDL_ALPHA_TRANSPARENT
*/
@ -50,7 +50,7 @@ extern "C" {
/**
* A fully opaque floating point alpha value.
*
* \since This macro is available since SDL 3.0.0.
* \since This macro is available since SDL 3.1.3.
*
* \sa SDL_ALPHA_TRANSPARENT_FLOAT
*/
@ -59,7 +59,7 @@ extern "C" {
/**
* A fully transparent 8-bit alpha value.
*
* \since This macro is available since SDL 3.0.0.
* \since This macro is available since SDL 3.1.3.
*
* \sa SDL_ALPHA_OPAQUE
*/
@ -68,7 +68,7 @@ extern "C" {
/**
* A fully transparent floating point alpha value.
*
* \since This macro is available since SDL 3.0.0.
* \since This macro is available since SDL 3.1.3.
*
* \sa SDL_ALPHA_OPAQUE_FLOAT
*/
@ -77,7 +77,7 @@ extern "C" {
/**
* Pixel type.
*
* \since This enum is available since SDL 3.0.0.
* \since This enum is available since SDL 3.1.3.
*/
typedef enum SDL_PixelType
{
@ -100,7 +100,7 @@ typedef enum SDL_PixelType
/**
* Bitmap pixel order, high bit -> low bit.
*
* \since This enum is available since SDL 3.0.0.
* \since This enum is available since SDL 3.1.3.
*/
typedef enum SDL_BitmapOrder
{
@ -112,7 +112,7 @@ typedef enum SDL_BitmapOrder
/**
* Packed component order, high bit -> low bit.
*
* \since This enum is available since SDL 3.0.0.
* \since This enum is available since SDL 3.1.3.
*/
typedef enum SDL_PackedOrder
{
@ -130,7 +130,7 @@ typedef enum SDL_PackedOrder
/**
* Array component order, low byte -> high byte.
*
* \since This enum is available since SDL 3.0.0.
* \since This enum is available since SDL 3.1.3.
*/
typedef enum SDL_ArrayOrder
{
@ -146,7 +146,7 @@ typedef enum SDL_ArrayOrder
/**
* Packed component layout.
*
* \since This enum is available since SDL 3.0.0.
* \since This enum is available since SDL 3.1.3.
*/
typedef enum SDL_PackedLayout
{
@ -259,7 +259,7 @@ typedef enum SDL_PackedLayout
* an alias for ABGR8888 on little-endian CPUs like x86, or an alias for
* RGBA8888 on big-endian CPUs.
*
* \since This enum is available since SDL 3.0.0.
* \since This enum is available since SDL 3.1.3.
*/
typedef enum SDL_PixelFormat
{
@ -441,7 +441,7 @@ typedef enum SDL_PixelFormat
/**
* Colorspace color type.
*
* \since This enum is available since SDL 3.0.0.
* \since This enum is available since SDL 3.1.3.
*/
typedef enum SDL_ColorType
{
@ -454,7 +454,7 @@ typedef enum SDL_ColorType
* Colorspace color range, as described by
* 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.1.3.
*/
typedef enum SDL_ColorRange
{
@ -467,7 +467,7 @@ typedef enum SDL_ColorRange
* Colorspace color primaries, as described by
* 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.1.3.
*/
typedef enum SDL_ColorPrimaries
{
@ -492,7 +492,7 @@ typedef enum SDL_ColorPrimaries
*
* These are as described by 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.1.3.
*/
typedef enum SDL_TransferCharacteristics
{
@ -522,7 +522,7 @@ typedef enum SDL_TransferCharacteristics
*
* These are as described by 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.1.3.
*/
typedef enum SDL_MatrixCoefficients
{
@ -546,7 +546,7 @@ typedef enum SDL_MatrixCoefficients
/**
* Colorspace chroma sample location.
*
* \since This enum is available since SDL 3.0.0.
* \since This enum is available since SDL 3.1.3.
*/
typedef enum SDL_ChromaLocation
{
@ -582,7 +582,7 @@ typedef enum SDL_ChromaLocation
* 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.
* \since This enum is available since SDL 3.1.3.
*
* \sa SDL_ColorPrimaries
* \sa SDL_ColorRange
@ -689,7 +689,7 @@ typedef enum SDL_Colorspace
* (SDL_PIXELFORMAT_ABGR8888 on little-endian systems and
* SDL_PIXELFORMAT_RGBA8888 on big-endian systems).
*
* \since This struct is available since SDL 3.0.0.
* \since This struct is available since SDL 3.1.3.
*/
typedef struct SDL_Color
{
@ -703,7 +703,7 @@ typedef struct SDL_Color
* The bits of this structure can be directly reinterpreted as a float-packed
* color which uses the SDL_PIXELFORMAT_RGBA128_FLOAT format
*
* \since This struct is available since SDL 3.0.0.
* \since This struct is available since SDL 3.1.3.
*/
typedef struct SDL_FColor
{
@ -716,7 +716,7 @@ typedef struct SDL_FColor
/**
* A set of indexed colors representing a palette.
*
* \since This struct is available since SDL 3.0.0.
* \since This struct is available since SDL 3.1.3.
*
* \sa SDL_SetPaletteColors
*/
@ -731,7 +731,7 @@ typedef struct SDL_Palette
/**
* Details about the format of a pixel.
*
* \since This struct is available since SDL 3.0.0.
* \since This struct is available since SDL 3.1.3.
*/
typedef struct SDL_PixelFormatDetails
{
@ -762,7 +762,7 @@ typedef struct SDL_PixelFormatDetails
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*/
extern SDL_DECLSPEC const char * SDLCALL SDL_GetPixelFormatName(SDL_PixelFormat format);
@ -780,7 +780,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetPixelFormatName(SDL_PixelFormat
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*
* \sa SDL_GetPixelFormatForMasks
*/
@ -802,7 +802,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetMasksForPixelFormat(SDL_PixelFormat form
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*
* \sa SDL_GetMasksForPixelFormat
*/
@ -821,7 +821,7 @@ extern SDL_DECLSPEC SDL_PixelFormat SDLCALL SDL_GetPixelFormatForMasks(int bpp,
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*/
extern SDL_DECLSPEC const SDL_PixelFormatDetails * SDLCALL SDL_GetPixelFormatDetails(SDL_PixelFormat format);
@ -837,7 +837,7 @@ extern SDL_DECLSPEC const SDL_PixelFormatDetails * SDLCALL SDL_GetPixelFormatDet
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*
* \sa SDL_DestroyPalette
* \sa SDL_SetPaletteColors
@ -858,7 +858,7 @@ extern SDL_DECLSPEC SDL_Palette * SDLCALL SDL_CreatePalette(int ncolors);
* \threadsafety It is safe to call this function from any thread, as long as
* the palette is not modified or destroyed in another thread.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*/
extern SDL_DECLSPEC bool SDLCALL SDL_SetPaletteColors(SDL_Palette *palette, const SDL_Color *colors, int firstcolor, int ncolors);
@ -870,7 +870,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetPaletteColors(SDL_Palette *palette, cons
* \threadsafety It is safe to call this function from any thread, as long as
* the palette is not modified or destroyed in another thread.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*
* \sa SDL_CreatePalette
*/
@ -905,7 +905,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyPalette(SDL_Palette *palette);
* \threadsafety It is safe to call this function from any thread, as long as
* the palette is not modified.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*
* \sa SDL_GetPixelFormatDetails
* \sa SDL_GetRGB
@ -944,7 +944,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_MapRGB(const SDL_PixelFormatDetails *form
* \threadsafety It is safe to call this function from any thread, as long as
* the palette is not modified.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*
* \sa SDL_GetPixelFormatDetails
* \sa SDL_GetRGBA
@ -972,7 +972,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_MapRGBA(const SDL_PixelFormatDetails *for
* \threadsafety It is safe to call this function from any thread, as long as
* the palette is not modified.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*
* \sa SDL_GetPixelFormatDetails
* \sa SDL_GetRGBA
@ -1004,7 +1004,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_GetRGB(Uint32 pixel, const SDL_PixelFormatD
* \threadsafety It is safe to call this function from any thread, as long as
* the palette is not modified.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*
* \sa SDL_GetPixelFormatDetails
* \sa SDL_GetRGB