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

SDL_SetRenderClipRect

Set the clip rectangle for rendering on the specified target.

Header File

Defined in <SDL3/SDL_render.h>

Syntax

bool SDL_SetRenderClipRect(SDL_Renderer *renderer, const SDL_Rect *rect);

Function Parameters

SDL_Renderer *	renderer	the rendering context.
const SDL_Rect *	rect	an SDL_Rect structure representing the clip area, relative to the viewport, or NULL to disable clipping.

Return Value

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

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.1.3.

See Also

• SDL_GetRenderClipRect
• SDL_RenderClipEnabled

---

CategoryAPI, CategoryAPIFunction, CategoryRender

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