Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

SDL_UpdateRects (3)

Name

SDL_UpdateRects - Makes sure the given list of rectangles is updated on the given screen.

Synopsis

#include "SDL.h"

void  SDL_UpdateRects(SDL_Surface  *screen,  int   numrects,   SDL_Rect
*rects);

Description

SDL_UpdateRects(3)             SDL API Reference            SDL_UpdateRects(3)



NAME
       SDL_UpdateRects - Makes sure the given list of rectangles is updated on
       the given screen.

SYNOPSIS
       #include "SDL.h"

       void  SDL_UpdateRects(SDL_Surface  *screen,  int   numrects,   SDL_Rect
       *rects);

DESCRIPTION
       Makes sure the given list of rectangles is updated on the given screen.
       The rectangles must all be confined within the  screen  boundaries  (no
       clipping is done).

       This function should not be called while screen is locked.

              Note:

              It  is  adviced to call this function only once per frame, since
              each call has some processing overhead. This is  no  restriction
              since you can pass any number of rectangles each time.

              The rectangles are not automatically merged or checked for over-
              lap. In general, the programmer can use his knowledge about  his
              particular  rectangles  to  merge  them  in an efficient way, to
              avoid overdraw.


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


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/sdl      |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+
SEE ALSO
       SDL_UpdateRect, SDL_Rect, SDL_Surface, SDL_LockSurface



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_UpdateRects(3)