Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

SDL_SetClipRect (3)

Name

SDL_SetClipRect - Sets the clipping rectangle for a surface.

Synopsis

#include "SDL.h"

void SDL_SetClipRect(SDL_Surface *surface, SDL_Rect *rect);

Description

SDL_SetClipRect(3)             SDL API Reference            SDL_SetClipRect(3)



NAME
       SDL_SetClipRect - Sets the clipping rectangle for a surface.

SYNOPSIS
       #include "SDL.h"

       void SDL_SetClipRect(SDL_Surface *surface, SDL_Rect *rect);

DESCRIPTION
       Sets  the  clipping  rectangle  for a surface. When this surface is the
       destination of a blit, only the area within the clip rectangle will  be
       drawn into.

       The  rectangle  pointed  to by rect will be clipped to the edges of the
       surface so that the clip rectangle for a surface can never fall outside
       the edges of the surface.

       If  rect is NULL the clipping rectangle will be set to the full size of
       the surface.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/sdl      |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+
SEE ALSO
       SDL_GetClipRect, SDL_BlitSurface, SDL_Surface



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source       was        downloaded        from         https://www.lib-
       sdl.org/release/SDL-1.2.15.tar.gz

       Further information about this software can be found on the open source
       community website at https://www.libsdl.org/.



SDL                         Tue 11 Sep 2001, 23:01          SDL_SetClipRect(3)