(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_RenderSetClipRect

Set the clip rectangle for rendering on the specified target.

Header File

Defined in SDL_render.h

Syntax

int SDL_RenderSetClipRect(SDL_Renderer * renderer,
                          const SDL_Rect * rect);

Function Parameters

SDL_Renderer *	renderer	the rendering context for which clip rectangle should be set.
const SDL_Rect *	rect	an SDL_Rect structure representing the clip area, relative to the viewport, or NULL to disable clipping.

Return Value

(int) Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Version

This function is available since SDL 2.0.0.

See Also

• SDL_RenderGetClipRect
• SDL_RenderIsClipEnabled

---

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.