SDL_SetSurfaceClipRect - Man Page
Set the clipping rectangle for a surface.
Header File
Defined in SDL3/SDL_surface.h
Synopsis
#include "SDL3/SDL.h" bool SDL_SetSurfaceClipRect(SDL_Surface *surface, const SDL_Rect *rect);
Description
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.
Availability
This function is available since SDL 3.2.0.
See Also
Referenced By
SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS