Function SDL_ClearSurface

pub unsafe extern "C" fn SDL_ClearSurface(
    surface: *mut SDL_Surface,
    r: f32,
    g: f32,
    b: f32,
    a: f32,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

Clear a surface with a specific color, with floating point precision.

This function handles all surface formats, and ignores any clip rectangle.

If the surface is YUV, the color is assumed to be in the sRGB colorspace, otherwise the color is assumed to be in the colorspace of the suface.

§Parameters

  • surface: the SDL_Surface to clear.
  • r: the red component of the pixel, normally in the range 0-1.
  • g: the green component of the pixel, normally in the range 0-1.
  • b: the blue component of the pixel, normally in the range 0-1.
  • a: the alpha component of the pixel, normally in the range 0-1.

§Return value

Returns true on success or false on failure; call SDL_GetError() for more information.

§Availability

This function is available since SDL 3.2.0.