(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_GetSurfaceClipRect

Get the clipping rectangle for a surface.

Header File

Defined in SDL_surface.h, but apps should use #include <SDL3/SDL.h>

Syntax

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

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 0 on success or a negative error code 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.0.0.

See Also

• SDL_SetSurfaceClipRect

---

CategoryAPI, CategoryAPIFunction

---

[ edit | delete | history | feedback | raw ]

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