Function SDL_SetSurfaceClipRect

pub unsafe extern "C" fn SDL_SetSurfaceClipRect(
    surface: *mut SDL_Surface,
    rect: *const SDL_Rect,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

Set the clipping rectangle for a surface.

When surface is the destination of a blit, only the area within the clip rectangle is drawn into.

Note that blits are automatically clipped to the edges of the source and destination surfaces.

§Parameters

  • surface: the SDL_Surface structure to be clipped.
  • rect: the SDL_Rect structure representing the clipping rectangle, or NULL to disable clipping.

§Return value

Returns true if the rectangle intersects the surface, otherwise false and blits will be completely clipped.

§Availability

This function is available since SDL 3.2.0.

§See also