SDL_SetRenderClipRect - Man Page

Set the clip rectangle for rendering on the specified target.

Synopsis

#include <SDL3/SDL_render.h>

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

Description

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

Function Parameters

renderer

the rendering context.

rect

an SDL_Rect structure representing the clip area, relative to the viewport, or NULL to disable clipping.

Return Value

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.

Availability

This function is available since SDL 3.2.0.

See Also

SDL_GetRenderClipRect(3), SDL_RenderClipEnabled(3)

Referenced By

SDL_GetRenderClipRect(3), SDL_RenderClipEnabled(3).

SDL 3.3.2 Simple Directmedia Layer SDL3 FUNCTIONS