SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)


Set the clipping rectangle for a surface.


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

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 SDL_TRUE if the rectangle intersects the surface, otherwise SDL_FALSE and blits will be completely clipped.


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.


This function is available since SDL 3.0.0.


[ edit | delete | history | feedback | raw ]

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