SDL_GetSurfaceClipRect - Man Page

Get the clipping rectangle for a surface.

Header File

Defined in SDL3/SDL_surface.h

Synopsis

#include "SDL3/SDL.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.

Availability

This function is available since SDL 3.2.0.

See Also

·(3), SDL_SetSurfaceClipRect(3)

Referenced By

SDL_SetSurfaceClipRect(3).

SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS