Function sdl2_sys::SDL_SetWindowBrightness

source · 
pub unsafe extern "C" fn SDL_SetWindowBrightness(
    window: *mut SDL_Window,
    brightness: f32,
) -> c_int
Expand description

Set the brightness (gamma multiplier) for a given window’s display.

Despite the name and signature, this method sets the brightness of the entire display, not an individual window. A window is considered to be owned by the display that contains the window’s center pixel. (The index of this display can be retrieved using SDL_GetWindowDisplayIndex().) The brightness set will not follow the window if it is moved to another display.

Many platforms will refuse to set the display brightness in modern times. You are better off using a shader to adjust gamma during rendering, or something similar.

\param window the window used to select the display whose brightness will be changed \param brightness the brightness (gamma multiplier) value to set where 0.0 is completely dark and 1.0 is normal brightness \returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

\since This function is available since SDL 2.0.0.

\sa SDL_GetWindowBrightness \sa SDL_SetWindowGammaRamp