(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_GetSurfaceClipRect

Get the clipping rectangle for a surface.

Header File

Defined in <SDL3/SDL_surface.h>

Syntax

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

Function Parameters

SDL_Surface *	surface	the SDL_Surface structure representing the surface to be clipped.
SDL_Rect *	rect	an SDL_Rect structure filled in with the clipping rectangle for the surface.

Return Value

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

Remarks

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

Version

This function is available since SDL 3.1.3.

See Also

• SDL_SetSurfaceClipRect

---

CategoryAPI, CategoryAPIFunction, CategorySurface

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