*  \file SDL_video.h

 *  

 *  Header file for SDL video functions.

 *  \brief  The structure that defines a display mode

 *  

 *  \sa SDL_GetNumDisplayModes()

 *  \sa SDL_GetDisplayMode()

 *  \sa SDL_GetDesktopDisplayMode()

 *  \sa SDL_GetCurrentDisplayMode()

 *  \sa SDL_GetClosestDisplayMode()

 *  \sa SDL_SetDisplayMode()

 *  \brief The type used to identify a window

 *  

 *  \sa SDL_CreateWindow()

 *  \sa SDL_CreateWindowFrom()

 *  \sa SDL_DestroyWindow()

 *  \sa SDL_GetWindowData()

 *  \sa SDL_GetWindowFlags()

 *  \sa SDL_GetWindowGrab()

 *  \sa SDL_GetWindowPosition()

 *  \sa SDL_GetWindowSize()

 *  \sa SDL_GetWindowTitle()

 *  \sa SDL_HideWindow()

 *  \sa SDL_MaximizeWindow()

 *  \sa SDL_MinimizeWindow()

 *  \sa SDL_RaiseWindow()

 *  \sa SDL_RestoreWindow()

 *  \sa SDL_SetWindowData()

 *  \sa SDL_SetWindowFullscreen()

 *  \sa SDL_SetWindowGrab()

 *  \sa SDL_SetWindowIcon()

 *  \sa SDL_SetWindowPosition()

 *  \sa SDL_SetWindowSize()

 *  \sa SDL_SetWindowTitle()

 *  \sa SDL_ShowWindow()

 *  \brief The flags on a window

 *  

 *  \sa SDL_GetWindowFlags()

 *  \brief Used to indicate that you don't care what the window position is.

 *  \brief Used to indicate that the window position should be centered.

 *  \brief Event subtype for window events

 */

typedef enum

{

    SDL_WINDOWEVENT_NONE,           /**< Never used */

    SDL_WINDOWEVENT_SHOWN,          /**< Window has been shown */

    SDL_WINDOWEVENT_HIDDEN,         /**< Window has been hidden */

    SDL_WINDOWEVENT_EXPOSED,        /**< Window has been exposed and should be 

                                         redrawn */

    SDL_WINDOWEVENT_MOVED,          /**< Window has been moved to data1, data2 

                                     */

    SDL_WINDOWEVENT_RESIZED,        /**< Window size changed to data1xdata2 */

    SDL_WINDOWEVENT_MINIMIZED,      /**< Window has been minimized */

    SDL_WINDOWEVENT_MAXIMIZED,      /**< Window has been maximized */

    SDL_WINDOWEVENT_RESTORED,       /**< Window has been restored to normal size

                                         and position */

    SDL_WINDOWEVENT_ENTER,          /**< The window has gained mouse focus */

    SDL_WINDOWEVENT_LEAVE,          /**< The window has lost mouse focus */

    SDL_WINDOWEVENT_FOCUS_GAINED,   /**< The window has gained keyboard focus */

    SDL_WINDOWEVENT_FOCUS_LOST,     /**< The window has lost keyboard focus */

    SDL_WINDOWEVENT_CLOSE           /**< The window manager requests that the 

                                         window be closed */

} SDL_WindowEventID;

/**

 *  \brief Flags used when creating a rendering context

    SDL_RENDERER_SINGLEBUFFER = 0x00000001,     /**< Render directly to the 

                                                     window, if possible */

    SDL_RENDERER_PRESENTCOPY = 0x00000002,      /**< Present uses a copy from 

                                                     back buffer to the front 

                                                     buffer */

    SDL_RENDERER_PRESENTFLIP2 = 0x00000004,     /**< Present uses a flip, 

                                                     swapping back buffer and 

                                                     front buffer */

    SDL_RENDERER_PRESENTFLIP3 = 0x00000008,     /**< Present uses a flip, 

                                                     rotating between two back 

                                                     buffers and a front buffer

                                                 */

    SDL_RENDERER_PRESENTDISCARD = 0x00000010,   /**< Present leaves the contents

                                                     of the backbuffer undefined

                                                 */

    SDL_RENDERER_PRESENTVSYNC = 0x00000020,     /**< Present is synchronized 

                                                     with the refresh rate */

    SDL_RENDERER_ACCELERATED = 0x00000040       /**< The renderer uses hardware 

                                                     acceleration */

    } SDL_RendererFlags;

 *  \brief Information on the capabilities of a render driver or context.

    Uint32 flags;               /**< Supported ::SDL_RendererFlags */

 *  \brief The access pattern allowed for a texture.

 *  \brief The texture channel modulation used in SDL_RenderCopy().

 *  \brief The blend mode used in SDL_RenderCopy() and drawing operations.

    SDL_BLENDMODE_MASK = 0x00000001,     /**< dst = A ? src : dst 

                                              (alpha is mask) */

 *  \brief The texture scale mode used in SDL_RenderCopy().

    SDL_TEXTURESCALEMODE_NONE = 0x00000000,     /**< No scaling, rectangles must

                                                     match dimensions */

    SDL_TEXTURESCALEMODE_FAST = 0x00000001,     /**< Point sampling or 

                                                     equivalent algorithm */

    SDL_TEXTURESCALEMODE_SLOW = 0x00000002,     /**< Linear filtering or 

                                                     equivalent algorithm */

    SDL_TEXTURESCALEMODE_BEST = 0x00000004      /**< Bicubic filtering or 

                                                     equivalent algorithm */

 *  \brief An efficient driver-specific representation of pixel data

 *  \brief An opaque handle to an OpenGL context.

 *  \brief OpenGL configuration attributes

 *  \brief Get the number of video drivers compiled into SDL

 *  

 *  \sa SDL_GetVideoDriver()

 *  \brief Get the name of a built in video driver.

 *  

 *  \note The video drivers are presented in the order in which they are

 *        normally checked during initialization.

 *  

 *  \sa SDL_GetNumVideoDrivers()

 *  \brief Initialize the video subsystem, optionally specifying a video driver.

 *  

 *  \param driver_name Initialize a specific driver by name, or NULL for the 

 *                     default video driver.

 *  

 *  \param flags FIXME: Still needed?

 *  

 *  \return 0 on success, -1 on error

 *  

 *  This function initializes the video subsystem; setting up a connection

 *  to the window manager, etc, and determines the available display modes

 *  and pixel formats, but does not initialize a window or graphics mode.

 *  

 *  \sa SDL_VideoQuit()

 *  \brief Shuts down the video subsystem.

 *  

 *  This function closes all windows, and restores the original video mode.

 *  

 *  \sa SDL_VideoInit()

 *  \brief Returns the name of the currently initialized video driver.

 *  

 *  \return The name of the current video driver or NULL if no driver

 *          has been initialized

 *  

 *  \sa SDL_GetNumVideoDrivers()

 *  \sa SDL_GetVideoDriver()

 *  \brief Returns the number of available video displays.

 *  

 *  \sa SDL_SelectVideoDisplay()

 *  \brief Set the index of the currently selected display.

 *  

 *  \return 0 on success, or -1 if the index is out of range.

 *  

 *  \sa SDL_GetNumVideoDisplays()

 *  \sa SDL_GetCurrentVideoDisplay()

 *  \brief Get the index of the currently selected display.

 *  

 *  \return The index of the currently selected display.

 *  

 *  \sa SDL_GetNumVideoDisplays()

 *  \sa SDL_SelectVideoDisplay()

 *  \brief Returns the number of available display modes for the current display.

 *  

 *  \sa SDL_GetDisplayMode()

 *  \brief Fill in information about a specific display mode.

 *  

 *  \note The display modes are sorted in this priority:

 *        \li bits per pixel -> more colors to fewer colors

 *        \li width -> largest to smallest

 *        \li height -> largest to smallest

 *        \li refresh rate -> highest to lowest

 *  

 *  \sa SDL_GetNumDisplayModes()

 *  \brief Fill in information about the desktop display mode for the current 

 *         display.

 *  \brief Fill in information about the current display mode.

 *  \brief Get the closest match to the requested display mode.

 *  

 *  \param mode The desired display mode

 *  \param closest A pointer to a display mode to be filled in with the closest 

 *                 match of the available display modes.

 *  

 *  \return The passed in value \c closest, or NULL if no matching video mode 

 *          was available.

 *  

 *  The available display modes are scanned, and \c closest is filled in with the

 *  closest mode matching the requested mode and returned.  The mode format and 

 *  refresh_rate default to the desktop mode if they are 0.  The modes are 

 *  scanned with size being first priority, format being second priority, and 

 *  finally checking the refresh_rate.  If all the available modes are too 

 *  small, then NULL is returned.

 *  

 *  \sa SDL_GetNumDisplayModes()

 *  \sa SDL_GetDisplayMode()

 *  \brief Set the display mode used when a fullscreen window is visible

 *         on the currently selected display.

 *  

 *  \param mode The mode to use, or NULL for the desktop mode.

 *  

 *  \return 0 on success, or -1 if setting the display mode failed.

 *  

 *  \sa SDL_SetWindowFullscreen()

 *  \brief Fill in information about the display mode used when a fullscreen

 *         window is visible on the currently selected display.

 *  \brief Set the palette entries for indexed display modes.

 *  

 *  \return 0 on success, or -1 if the display mode isn't palettized or the 

 *          colors couldn't be set.

 *  \brief Gets the palette entries for indexed display modes.

 *  

 *  \return 0 on success, or -1 if the display mode isn't palettized

 *  \brief Set the gamma correction for each of the color channels on the 

 *         currently selected display.

 *  

 *  \return 0 on success, or -1 if setting the gamma isn't supported.

 *  

 *  \sa SDL_SetGammaRamp()

 *  \brief Set the gamma ramp for the currently selected display.

 *  

 *  \param red The translation table for the red channel, or NULL.

 *  \param green The translation table for the green channel, or NULL.

 *  \param blue The translation table for the blue channel, or NULL.

 *  

 *  \return 0 on success, or -1 if gamma ramps are unsupported.

 *  

 *  Set the gamma translation table for the red, green, and blue channels

 *  of the video hardware.  Each table is an array of 256 16-bit quantities,

 *  representing a mapping between the input and output for that channel.

 *  The input is the index into the array, and the output is the 16-bit