SDL_SetSurfaceClipRect(3)

SDL_SetSurfaceClipRect3

Set the clipping rectangle for a surface.

Usage

#include "SDL3/SDL.h"

bool SDL_SetSurfaceClipRect(SDL_Surface *surface, const SDL_Rect *rect);

Header file

Defined in SDL3/SDL_surface.h

Overview

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.

Function 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.

Thread safety

This function is not thread safe.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.