Scroll to navigation

SDL_SetRenderClipRectFloat(3) SDL3 FUNCTIONS SDL_SetRenderClipRectFloat(3)

NAME

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

SYNOPSIS

#include <SDL3/SDL_render.h>
bool SDL_SetRenderClipRectFloat(SDL_Renderer *renderer, const SDL_FRect *rect);

DESCRIPTION

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

FUNCTION PARAMETERS

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

SEE ALSO

SDL_GetRenderClipRectFloat(3), SDL_RenderClipEnabled(3)

SDL 3.5.0 Simple Directmedia Layer