NAME

       SDL_SetSurfaceClipRect - Set the clipping rectangle for a surface.

HEADER FILE

       Defined in SDL3/SDL_surface.h

SYNOPSIS

       #include "SDL3/SDL.h"

       bool SDL_SetSurfaceClipRect(SDL_Surface *surface, const SDL_Rect *rect);

DESCRIPTION

       When surface is the destination of a blit, only the area within the clip rectangle is drawn into.

       Note that blits are automatically clipped to the edges of the source and destination surfaces.

FUNCTION PARAMETERS

       surface
              the SDL_Surface
               structure to be clipped.

       rect   the SDL_Rect
               structure representing the clipping rectangle, or NULL to disable clipping.

RETURN VALUE

       Returns  true  if  the  rectangle  intersects  the  surface, otherwise false and blits will be completely
       clipped.

AVAILABILITY

       This function is available since SDL 3.2.0.

SEE ALSO

       •(3), SDL_GetSurfaceClipRect(3)

Simple Directmedia Layer                            SDL 3.2.8                          SDL_SetSurfaceClipRect(3)