Sync SDL3 wiki -> header

[ci skip]
This commit is contained in:
SDL Wiki Bot
2024-12-18 06:22:41 +00:00
parent 0fbcd0d586
commit 5608bf5866
2 changed files with 16 additions and 13 deletions

View File

@@ -39,29 +39,29 @@
* understands two different color types, RGB and YCbCr, or in SDL also * understands two different color types, RGB and YCbCr, or in SDL also
* referred to as YUV. * referred to as YUV.
* *
* RGB colors consist of red, green, and blue channels of color that are * RGB colors consist of red, green, and blue channels of color that are added
* added together to represent the colors we see on the screen. * together to represent the colors we see on the screen.
* *
* https://en.wikipedia.org/wiki/RGB_color_model * https://en.wikipedia.org/wiki/RGB_color_model
* *
* YCbCr colors represent colors as a Y luma brightness component and red and * YCbCr colors represent colors as a Y luma brightness component and red and
* blue chroma color offsets. This color representation takes advantage of * blue chroma color offsets. This color representation takes advantage of the
* the fact that the human eye is more sensitive to brightness than the color * fact that the human eye is more sensitive to brightness than the color in
* in an image. The Cb and Cr components are often compressed and have lower * an image. The Cb and Cr components are often compressed and have lower
* resolution than the luma component. * resolution than the luma component.
* *
* https://en.wikipedia.org/wiki/YCbCr * https://en.wikipedia.org/wiki/YCbCr
* *
* When the color information in YCbCr is compressed, the Y pixels are left * When the color information in YCbCr is compressed, the Y pixels are left at
* at full resolution and each Cr and Cb pixel represents an average of the * full resolution and each Cr and Cb pixel represents an average of the color
* color information in a block of Y pixels. The chroma location determines * information in a block of Y pixels. The chroma location determines where in
* where in that block of pixels the color information is coming from. * that block of pixels the color information is coming from.
* *
* The color range defines how much of the pixel to use when converting a * The color range defines how much of the pixel to use when converting a
* pixel into a color on the display. When the full color range is used, the * pixel into a color on the display. When the full color range is used, the
* entire numeric range of the pixel bits is significant. When narrow color * entire numeric range of the pixel bits is significant. When narrow color
* range is used, for historical reasons, the pixel uses only a portion of * range is used, for historical reasons, the pixel uses only a portion of the
* the numeric range to represent colors. * numeric range to represent colors.
* *
* The color primaries and white point are a definition of the colors in the * The color primaries and white point are a definition of the colors in the
* color space relative to the standard XYZ color space. * color space relative to the standard XYZ color space.

View File

@@ -96,6 +96,7 @@ void *alloca(size_t);
#ifndef SDL_COMPILE_TIME_ASSERT #ifndef SDL_COMPILE_TIME_ASSERT
#ifdef SDL_WIKI_DOCUMENTATION_SECTION #ifdef SDL_WIKI_DOCUMENTATION_SECTION
/** /**
* A compile-time assertion. * A compile-time assertion.
* *
@@ -115,8 +116,8 @@ void *alloca(size_t);
* This is used with a C language trick that works on older compilers that * This is used with a C language trick that works on older compilers that
* don't support better assertion techniques. * don't support better assertion techniques.
* *
* If you need an assertion that operates at runtime, on variable data, * If you need an assertion that operates at runtime, on variable data, you
* you should try SDL_assert instead. * should try SDL_assert instead.
* *
* \param name a unique identifier for this assertion. * \param name a unique identifier for this assertion.
* \param x the value to test. Must be a boolean value. * \param x the value to test. Must be a boolean value.
@@ -2886,6 +2887,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_randf_r(Uint64 *state);
extern SDL_DECLSPEC Uint32 SDLCALL SDL_rand_bits_r(Uint64 *state); extern SDL_DECLSPEC Uint32 SDLCALL SDL_rand_bits_r(Uint64 *state);
#ifndef SDL_PI_D #ifndef SDL_PI_D
/** /**
* The value of Pi, as a double-precision floating point literal. * The value of Pi, as a double-precision floating point literal.
* *
@@ -2897,6 +2899,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_rand_bits_r(Uint64 *state);
#endif #endif
#ifndef SDL_PI_F #ifndef SDL_PI_F
/** /**
* The value of Pi, as a single-precision floating point literal. * The value of Pi, as a single-precision floating point literal.
* *