From 451dc414278dc7b19a997ef7a6d1acf1f951162d Mon Sep 17 00:00:00 2001 From: SDL Wiki Bot Date: Tue, 6 Feb 2024 10:49:24 +0000 Subject: [PATCH] Sync SDL3 wiki -> header --- include/SDL3/SDL_render.h | 18 +++++++++++++----- include/SDL3/SDL_video.h | 7 +++++-- 2 files changed, 18 insertions(+), 7 deletions(-) diff --git a/include/SDL3/SDL_render.h b/include/SDL3/SDL_render.h index ca2b772395..41dcc3ad0f 100644 --- a/include/SDL3/SDL_render.h +++ b/include/SDL3/SDL_render.h @@ -335,9 +335,13 @@ extern DECLSPEC int SDLCALL SDL_GetRendererInfo(SDL_Renderer *renderer, SDL_Rend * The following read-only properties are provided by SDL: * * - `SDL_PROP_RENDERER_NAME_STRING`: the name of the rendering driver - * - `SDL_PROP_RENDERER_WINDOW_POINTER`: the window where rendering is displayed, if any - * - `SDL_PROP_RENDERER_SURFACE_POINTER`: the surface where rendering is displayed, if this is a software renderer without a window - * - `SDL_PROP_RENDERER_OUTPUT_COLORSPACE_NUMBER`: an SDL_ColorSpace value describing the colorspace for output to the display, defaults to SDL_COLORSPACE_SRGB. + * - `SDL_PROP_RENDERER_WINDOW_POINTER`: the window where rendering is + * displayed, if any + * - `SDL_PROP_RENDERER_SURFACE_POINTER`: the surface where rendering is + * displayed, if this is a software renderer without a window + * - `SDL_PROP_RENDERER_OUTPUT_COLORSPACE_NUMBER`: an SDL_ColorSpace value + * describing the colorspace for output to the display, defaults to + * SDL_COLORSPACE_SRGB. * - `SDL_PROP_RENDERER_D3D9_DEVICE_POINTER`: the IDirect3DDevice9 associated * with the renderer * - `SDL_PROP_RENDERER_D3D11_DEVICE_POINTER`: the ID3D11Device associated @@ -1470,9 +1474,13 @@ extern DECLSPEC int SDLCALL SDL_GetRenderDrawColorFloat(SDL_Renderer *renderer, /** * Set the color scale used for render operations. * - * The color scale is an additional scale multiplied into the pixel color value while rendering. This can be used to adjust the brightness of colors during HDR rendering, or changing HDR video brightness when playing on an SDR display. + * The color scale is an additional scale multiplied into the pixel color + * value while rendering. This can be used to adjust the brightness of colors + * during HDR rendering, or changing HDR video brightness when playing on an + * SDR display. * - * The color scale does not affect the alpha channel, only the color brightness. + * The color scale does not affect the alpha channel, only the color + * brightness. * * \param renderer the rendering context * \param scale the color scale value diff --git a/include/SDL3/SDL_video.h b/include/SDL3/SDL_video.h index 8b935cf2c8..c8a68dbb1b 100644 --- a/include/SDL3/SDL_video.h +++ b/include/SDL3/SDL_video.h @@ -355,8 +355,11 @@ extern DECLSPEC SDL_DisplayID SDLCALL SDL_GetPrimaryDisplay(void); * * The following read-only properties are provided by SDL: * - * - `SDL_PROP_DISPLAY_HDR_ENABLED_BOOLEAN`: true if the display has High Dynamic Range enabled - * - `SDL_PROP_DISPLAY_SDR_WHITE_LEVEL_FLOAT`: the luminance, in nits, that SDR white is rendered on this display. If this value is not set or is zero, the value 200 is a reasonable default when HDR is enabled. + * - `SDL_PROP_DISPLAY_HDR_ENABLED_BOOLEAN`: true if the display has High + * Dynamic Range enabled + * - `SDL_PROP_DISPLAY_SDR_WHITE_LEVEL_FLOAT`: the luminance, in nits, that + * SDR white is rendered on this display. If this value is not set or is + * zero, the value 200 is a reasonable default when HDR is enabled. * * \param displayID the instance ID of the display to query * \returns a valid property ID on success or 0 on failure; call