Updated scRGB render colorspace documentation

This commit is contained in:
Sam Lantinga 2024-02-02 20:38:48 -08:00
parent e67e0c5d55
commit a2c45f61bb

View file

@ -244,15 +244,10 @@ extern DECLSPEC SDL_Renderer * SDLCALL SDL_CreateRenderer(SDL_Window *window, co
* value describing the colorspace for output to the display, defaults to * value describing the colorspace for output to the display, defaults to
* SDL_COLORSPACE_SRGB. The direct3d11 and direct3d12 renderers support * SDL_COLORSPACE_SRGB. The direct3d11 and direct3d12 renderers support
* SDL_COLORSPACE_SCRGB, which is a linear color space and supports HDR * SDL_COLORSPACE_SCRGB, which is a linear color space and supports HDR
* output. * output. If you select SDL_COLORSPACE_SCRGB, drawing still uses the sRGB colorspace, but values can go beyond 1.0 and float (linear) format textures can be used for HDR content.
* - `SDL_PROP_RENDERER_CREATE_PRESENT_VSYNC_BOOLEAN`: true if you want * - `SDL_PROP_RENDERER_CREATE_PRESENT_VSYNC_BOOLEAN`: true if you want
* present synchronized with the refresh rate * present synchronized with the refresh rate
* *
* Note that enabling colorspace conversion between sRGB input and sRGB output
* implies that the rendering is done in a linear colorspace for more correct
* blending results. If colorspace conversion is disabled, then input colors
* are passed directly through to the output.
*
* \param props the properties to use * \param props the properties to use
* \returns a valid rendering context or NULL if there was an error; call * \returns a valid rendering context or NULL if there was an error; call
* SDL_GetError() for more information. * SDL_GetError() for more information.