Scroll to navigation

SDL_GetSurfaceClipRect(3) SDL3 FUNCTIONS SDL_GetSurfaceClipRect(3)

NAME

SDL_GetSurfaceClipRect - 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

the SDL_Surface
structure representing the surface to be clipped.
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.1.3.

SEE ALSO

(3), SDL_SetSurfaceClipRect(3)

SDL 3.1.6 Simple Directmedia Layer