SDL_GetSurfaceClipRect - Man Page

Get the clipping rectangle for a surface.

Synopsis

#include <SDL3/SDL_surface.h>

bool SDL_GetSurfaceClipRect(SDL_Surface *surface, SDL_Rect *rect);

Description

When surface is the destination of a blit, only the area within the clip rectangle is drawn into.

Function Parameters

surface

the SDL_Surface structure representing the surface to be clipped.

rect

an SDL_Rect structure filled in with the clipping rectangle for the surface.

Return Value

Returns true on success or false on failure; call SDL_GetError() for more information.

Thread Safety

This function can be called on different threads with different surfaces.

Availability

This function is available since SDL 3.2.0.

See Also

SDL_SetSurfaceClipRect(3)

Referenced By

SDL_SetSurfaceClipRect(3).

SDL 3.3.2 Simple Directmedia Layer SDL3 FUNCTIONS