Scroll to navigation

SDL_SetRenderClipRect(3) SDL3 FUNCTIONS SDL_SetRenderClipRect(3)

NAME

SDL_SetRenderClipRect - Set the clip rectangle for rendering on the specified target.

HEADER FILE

Defined in SDL3/SDL_render.h

SYNOPSIS

#include "SDL3/SDL.h"
bool SDL_SetRenderClipRect(SDL_Renderer *renderer, const SDL_Rect *rect);

FUNCTION PARAMETERS

the rendering context.
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

You may only call this function from the main thread.

AVAILABILITY

This function is available since SDL 3.1.3.

SEE ALSO

(3), SDL_GetRenderClipRect(3), (3), SDL_RenderClipEnabled(3)

SDL 3.1.6 Simple Directmedia Layer