(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_SetSurfaceClipRect

Set the clipping rectangle for a surface.

Header File

Defined in <SDL3/SDL_surface.h>

Syntax

bool SDL_SetSurfaceClipRect(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

(bool) Returns true if the rectangle intersects the surface, otherwise 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 3.1.3.

See Also

• SDL_GetSurfaceClipRect

---

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.