SDL_GetSurfaceClipRect(3)

SDL_GetSurfaceClipRect3

Get the clipping rectangle for a surface.

Usage

#include "SDL3/SDL.h"

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

Header file

Defined in SDL3/SDL_surface.h

Overview

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 is not thread safe.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.