/*

    SDL - Simple DirectMedia Layer

    Copyright (C) 1997-2009 Sam Lantinga

    This library is free software; you can redistribute it and/or

    modify it under the terms of the GNU Lesser General Public

    License as published by the Free Software Foundation; either

    version 2.1 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,

    but WITHOUT ANY WARRANTY; without even the implied warranty of

    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public

    License along with this library; if not, write to the Free Software

    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    Sam Lantinga

    slouken@libsdl.org

*/

/**

 *  \file SDL_video.h

 *  

 *  Header file for SDL video functions.

 */

#ifndef _SDL_video_h

#define _SDL_video_h

#include "SDL_stdinc.h"

#include "SDL_pixels.h"

#include "SDL_rect.h"

#include "SDL_surface.h"

#include "begin_code.h"

/* Set up for C function definitions, even when using C++ */

#ifdef __cplusplus

/* *INDENT-OFF* */

extern "C" {

/* *INDENT-ON* */

#endif

/**

 *  \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_SetWindowDisplayMode()

 *  \sa SDL_GetWindowDisplayMode()

 */

typedef struct

{

    Uint32 format;              /**< pixel format */

    int w;                      /**< width */

    int h;                      /**< height */

    int refresh_rate;           /**< refresh rate (or zero for unspecified) */

    void *driverdata;           /**< driver-specific data, initialize to 0 */

} SDL_DisplayMode;

/**

 *  \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()

 */

typedef enum

{

    SDL_WINDOW_FULLSCREEN = 0x00000001,         /**< fullscreen window, implies borderless */

    SDL_WINDOW_OPENGL = 0x00000002,             /**< window usable with OpenGL context */

    SDL_WINDOW_SHOWN = 0x00000004,              /**< window is visible */

    SDL_WINDOW_BORDERLESS = 0x00000008,         /**< no window decoration */

    SDL_WINDOW_RESIZABLE = 0x00000010,          /**< window can be resized */

    SDL_WINDOW_MINIMIZED = 0x00000020,          /**< window is minimized */

    SDL_WINDOW_MAXIMIZED = 0x00000040,          /**< window is maximized */

    SDL_WINDOW_INPUT_GRABBED = 0x00000100,      /**< window has grabbed input focus */

    SDL_WINDOW_INPUT_FOCUS = 0x00000200,        /**< window has input focus */

    SDL_WINDOW_MOUSE_FOCUS = 0x00000400,        /**< window has mouse focus */

    SDL_WINDOW_FOREIGN = 0x00000800             /**< window not created by SDL */

} SDL_WindowFlags;

/**

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

 */

#define SDL_WINDOWPOS_UNDEFINED 0x7FFFFFF

/**

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

 */

#define SDL_WINDOWPOS_CENTERED  0x7FFFFFE

/**

 *  \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

 */

typedef enum

{

    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.

 */

typedef struct SDL_RendererInfo

{

    const char *name;           /**< The name of the renderer */

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

    Uint32 mod_modes;           /**< A mask of supported channel modulation */

    Uint32 blend_modes;         /**< A mask of supported blend modes */

    Uint32 scale_modes;         /**< A mask of supported scale modes */

    Uint32 num_texture_formats; /**< The number of available texture formats */

    Uint32 texture_formats[20]; /**< The available texture formats */

    int max_texture_width;      /**< The maximimum texture width */

    int max_texture_height;     /**< The maximimum texture height */

} SDL_RendererInfo;

/**

 *  \brief The access pattern allowed for a texture.

 */

typedef enum

{

    SDL_TEXTUREACCESS_STATIC,    /**< Changes rarely, not lockable */

    SDL_TEXTUREACCESS_STREAMING  /**< Changes frequently, lockable */

} SDL_TextureAccess;

/**

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

 */

typedef enum

{

    SDL_TEXTUREMODULATE_NONE = 0x00000000,     /**< No modulation */

    SDL_TEXTUREMODULATE_COLOR = 0x00000001,    /**< srcC = srcC * color */

    SDL_TEXTUREMODULATE_ALPHA = 0x00000002     /**< srcA = srcA * alpha */

} SDL_TextureModulate;

/**

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

 */

typedef enum

{

    SDL_BLENDMODE_NONE = 0x00000000,     /**< No blending */

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

                                              (alpha is mask) */

    SDL_BLENDMODE_BLEND = 0x00000002,    /**< dst = (src * A) + (dst * (1-A)) */

    SDL_BLENDMODE_ADD = 0x00000004,      /**< dst = (src * A) + dst */

    SDL_BLENDMODE_MOD = 0x00000008       /**< dst = src * dst */

} SDL_BlendMode;

/**

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

 */

typedef enum

{

    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 */

} SDL_TextureScaleMode;

/**

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

 */

/**

 *  \brief An opaque handle to an OpenGL context.

 */

typedef void *SDL_GLContext;

/**

 *  \brief OpenGL configuration attributes

 */

typedef enum

{

    SDL_GL_RED_SIZE,

    SDL_GL_GREEN_SIZE,

    SDL_GL_BLUE_SIZE,

    SDL_GL_ALPHA_SIZE,

    SDL_GL_BUFFER_SIZE,

    SDL_GL_DOUBLEBUFFER,

    SDL_GL_DEPTH_SIZE,

    SDL_GL_STENCIL_SIZE,

    SDL_GL_ACCUM_RED_SIZE,

    SDL_GL_ACCUM_GREEN_SIZE,

    SDL_GL_ACCUM_BLUE_SIZE,

    SDL_GL_ACCUM_ALPHA_SIZE,

    SDL_GL_STEREO,

    SDL_GL_MULTISAMPLEBUFFERS,

    SDL_GL_MULTISAMPLESAMPLES,

    SDL_GL_ACCELERATED_VISUAL,

    SDL_GL_RETAINED_BACKING,

    SDL_GL_CONTEXT_MAJOR_VERSION,

    SDL_GL_CONTEXT_MINOR_VERSION

} SDL_GLattr;

/* Function prototypes */

/**

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

 *  

 *  \sa SDL_GetVideoDriver()

 */

extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);

/**

 *  \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()

 */

extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index);

/**

 *  \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()

 */

extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name,

                                          Uint32 flags);

/**

 *  \brief Shuts down the video subsystem.

 *  

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

 *  

 *  \sa SDL_VideoInit()

 */

extern DECLSPEC void SDLCALL SDL_VideoQuit(void);

/**

 *  \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()

 */

extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);

/**

 *  \brief Returns the number of available video displays.

 *  

 *  \sa SDL_GetDisplayBounds()

 *  \sa SDL_SelectVideoDisplay()

 */

extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);

/**

 *  \brief Get the desktop area represented by a display, with the primary

 *         display located at 0,0

 *  

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

 *  

 *  \sa SDL_GetNumVideoDisplays()

 */

extern DECLSPEC int SDLCALL SDL_GetDisplayBounds(int index, SDL_Rect * rect);

/**

 *  \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()

 */

extern DECLSPEC int SDLCALL SDL_SelectVideoDisplay(int index);

/**

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

 *  

 *  \return The index of the currently selected display.

 *  

 *  \sa SDL_GetNumVideoDisplays()

 *  \sa SDL_SelectVideoDisplay()

 */

extern DECLSPEC int SDLCALL SDL_GetCurrentVideoDisplay(void);

/**

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

 *  

 *  \sa SDL_GetDisplayMode()

 */

extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(void);

/**

 *  \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()

 */

extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int index,

                                               SDL_DisplayMode * mode);

/**

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

 *         display.

 */

extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(SDL_DisplayMode * mode);

/**

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

 */

extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(SDL_DisplayMode * 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()

 */

extern DECLSPEC SDL_DisplayMode *SDLCALL SDL_GetClosestDisplayMode(const

                                                                   SDL_DisplayMode

                                                                   * mode,

                                                                   SDL_DisplayMode

                                                                   * closest);

/**

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

 *         on the currently selected display.  By default the window's

 *         dimensions and the desktop format and refresh rate are used.

 *  

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

 *  

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

 *  

 *  \sa SDL_GetWindowDisplayMode()

 *  \sa SDL_SetWindowFullscreen()

 */

                                                     const SDL_DisplayMode

                                                         * mode);

/**

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

 *         window is visible on the currently selected display.

 *

 *  \sa SDL_SetWindowDisplayMode()

 *  \sa SDL_SetWindowFullscreen()

 */

                                                     SDL_DisplayMode * mode);

/**

 *  \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.

 */

extern DECLSPEC int SDLCALL SDL_SetDisplayPalette(const SDL_Color * colors,

                                                  int firstcolor,

                                                  int ncolors);

/**

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

 *  

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

 */

extern DECLSPEC int SDLCALL SDL_GetDisplayPalette(SDL_Color * colors,

                                                  int firstcolor,

                                                  int ncolors);

/**

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