include/SDL_video.h
changeset 6382 64d54101773a
parent 6370 93187f7f7d5d
child 6393 a773384edf20
     1.1 --- a/include/SDL_video.h	Tue Jul 31 16:55:09 2012 -0700
     1.2 +++ b/include/SDL_video.h	Wed Aug 01 20:29:36 2012 -0400
     1.3 @@ -789,7 +789,9 @@
     1.4   *  \brief Set the swap interval for the current OpenGL context.
     1.5   *  
     1.6   *  \param interval 0 for immediate updates, 1 for updates synchronized with the
     1.7 - *                  vertical retrace.
     1.8 + *                  vertical retrace. If the system supports it, you may
     1.9 + *                  specify -1 to allow late swaps to happen immediately
    1.10 + *                  instead of waiting for the next retrace.
    1.11   *  
    1.12   *  \return 0 on success, or -1 if setting the swap interval is not supported.
    1.13   *  
    1.14 @@ -801,8 +803,10 @@
    1.15   *  \brief Get the swap interval for the current OpenGL context.
    1.16   *  
    1.17   *  \return 0 if there is no vertical retrace synchronization, 1 if the buffer 
    1.18 - *          swap is synchronized with the vertical retrace, and -1 if getting 
    1.19 - *          the swap interval is not supported.
    1.20 + *          swap is synchronized with the vertical retrace, and -1 if late
    1.21 + *          swaps happen immediately instead of waiting for the next retrace.
    1.22 + *          If the system can't determine the swap interval, or there isn't a
    1.23 + *          valid current context, this will return 0 as a safe default.
    1.24   *  
    1.25   *  \sa SDL_GL_SetSwapInterval()
    1.26   */