SDL_SetRenderClipRect(3)

SDL_SetRenderClipRect3

Set the clip rectangle for rendering on the specified target.

Usage

#include "SDL3/SDL.h"

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

Header file

Defined in SDL3/SDL_render.h

Overview

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.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.