SDL_RenderClipEnabled

Get whether clipping is enabled on the given render target.

Header File

Defined in <SDL3/SDL_render.h>

Syntax

bool SDL_RenderClipEnabled(SDL_Renderer *renderer);

Function Parameters

SDL_Renderer *

renderer

the rendering context.

Return Value

(bool) Returns true if clipping is enabled or false if not; call SDL_GetError() for more information.

Remarks

Each render target has its own clip rectangle. This function checks the cliprect for the current render target.

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.2.0.

See Also

• SDL_GetRenderClipRect
• SDL_SetRenderClipRect

---

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.