Scroll to navigation

SDL_RenderClipEnabled(3) SDL3 FUNCTIONS SDL_RenderClipEnabled(3)

NAME

SDL_RenderClipEnabled - Get whether clipping is enabled on the given render target.

HEADER FILE

Defined in SDL3/SDL_render.h

SYNOPSIS

#include "SDL3/SDL.h"
bool SDL_RenderClipEnabled(SDL_Renderer *renderer);

DESCRIPTION

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

FUNCTION PARAMETERS

the rendering context.

RETURN VALUE

Returns true if clipping is enabled or false if not; 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

(3), SDL_GetRenderClipRect(3), (3), SDL_SetRenderClipRect(3)

SDL 3.2.8 Simple Directmedia Layer