(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_SetClipRect

Set the clipping rectangle for a surface.

Header File

Defined in SDL_surface.h

Syntax

SDL_bool SDL_SetClipRect(SDL_Surface * surface,
                         const SDL_Rect * rect);

Function Parameters

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

Return Value

(SDL_bool) Returns SDL_TRUE if the rectangle intersects the surface, otherwise SDL_FALSE and blits will be completely clipped.

Remarks

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.

Version

This function is available since SDL 2.0.0.

See Also

• SDL_BlitSurface
• SDL_GetClipRect

---

CategoryAPI, CategoryAPIFunction, CategorySurface

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.