/*

    SDL - Simple DirectMedia Layer

    Copyright (C) 1997-2006 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 access to the SDL raw framebuffer window

 */

#ifndef _SDL_video_h

#define _SDL_video_h

#include "SDL_stdinc.h"

#include "SDL_error.h"

#include "SDL_pixels.h"

#include "SDL_rwops.h"

#include "begin_code.h"

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

#ifdef __cplusplus

/* *INDENT-OFF* */

extern "C" {

/* *INDENT-ON* */

#endif

/* Transparency definitions: These define alpha as the opacity of a surface */

#define SDL_ALPHA_OPAQUE 255

#define SDL_ALPHA_TRANSPARENT 0

/**

 * \struct SDL_Rect

 *

 * \brief A rectangle, with the origin at the upper left.

 */

typedef struct SDL_Rect

{

    Sint16 x, y;

    Uint16 w, h;

} SDL_Rect;

/**

 * \struct SDL_DisplayMode

 *

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

 */

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;

/**

 * \typedef SDL_WindowID

 *

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

 * \sa SDL_SetWindowIcon()

 * \sa SDL_SetWindowPosition()

 * \sa SDL_SetWindowSize()

 * \sa SDL_SetWindowTitle()

 * \sa SDL_ShowWindow()

 */

typedef Uint32 SDL_WindowID;

/**

 * \enum SDL_WindowFlags

 *

 * \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,          /**< minimized */

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

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

    SDL_WINDOW_KEYBOARD_FOCUS = 0x00000200,     /**< window has keyboard focus */

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

} SDL_WindowFlags;

/**

 * \def SDL_WINDOWPOS_UNDEFINED

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

 */

#define SDL_WINDOWPOS_UNDEFINED 0x7FFFFFF

/**

 * \def SDL_WINDOWPOS_CENTERED

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

 */

#define SDL_WINDOWPOS_CENTERED  0x7FFFFFE

/**

 * \enum SDL_WindowEventID

 *

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

/**

 * \enum SDL_RendererFlags

 *

 * \brief Flags used when initializing a render manager.

 */

typedef enum

{

    SDL_Renderer_PresentDiscard = 0x00000001,   /**< Present leaves the contents of the backbuffer undefined */

    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_PresentVSync = 0x00000010,     /**< Present is synchronized with the refresh rate */

    SDL_Renderer_RenderTarget = 0x00000020,     /**< The renderer can create texture render targets */

    SDL_Renderer_Accelerated = 0x00000040,      /**< The renderer uses hardware acceleration */

    SDL_Renderer_Minimal = 0x00000080,          /**< The renderer only supports the read/write pixel and present functions */

} SDL_RendererFlags;

/**

 * \struct SDL_RendererInfo

 *

 * \brief Information on the capabilities of a render manager.

 */

typedef struct SDL_RendererInfo

{

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

    Uint32 flags;               /**< Supported SDL_RendererFlags */

    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[32]; /**< The available texture formats */

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

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

} SDL_RendererInfo;

/**

 * \enum SDL_TextureAccess

 *

 * \brief The access pattern allowed for a texture

 */

typedef enum

{

    SDL_TextureAccess_Render,   /**< Unlockable video memory, rendering allowed */

    SDL_TextureAccess_Remote,   /**< Unlockable video memory */

    SDL_TextureAccess_Local,    /**< Lockable system memory */

} SDL_TextureAccess;

/**

 * \enum SDL_TextureBlendMode

 *

 * \brief The blend mode used in SDL_RenderCopy()

 */

typedef enum

{

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

    SDL_TextureBlendMode_Mask = 0x00000001,     /**< dst = A ? src : dst (alpha is mask) */

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

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

    SDL_TextureBlendMode_Mod = 0x00000008,      /**< dst = src * dst */

} SDL_TextureBlendMode;

/**

 * \enum SDL_TextureScaleMode

 *

 * \brief The 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;

/**

 * \typedef SDL_TextureID

 *

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

 */

typedef Uint32 SDL_TextureID;

/**

 * \typedef SDL_GLContext

 *

 * \brief An opaque handle to an OpenGL context.

 */

typedef void *SDL_GLContext;

/* These are the currently supported flags for the SDL_surface */

/* Used internally (read-only) */

#define SDL_HWSURFACE       0x00000001  /* Surface represents a texture */

#define SDL_PREALLOC        0x00000002  /* Surface uses preallocated memory */

#define SDL_SRCALPHA        0x00000004  /* Blit uses source alpha blending */

#define SDL_SRCCOLORKEY     0x00000008  /* Blit uses a source color key */

#define SDL_RLEACCELOK      0x00000010  /* Private flag */

#define SDL_RLEACCEL        0x00000020  /* Surface is RLE encoded */

/* Evaluates to true if the surface needs to be locked before access */

#define SDL_MUSTLOCK(S)	(((S)->flags & (SDL_HWSURFACE|SDL_RLEACCEL)) != 0)

/* This structure should be treated as read-only, except for 'pixels',

   which, if not NULL, contains the raw pixel data for the surface.

*/

typedef struct SDL_Surface

{

    Uint32 flags;               /* Read-only */

    SDL_PixelFormat *format;    /* Read-only */

    int w, h;                   /* Read-only */

    int pitch;                  /* Read-only */

    void *pixels;               /* Read-write */

    /* texture associated with the surface, if any */

    SDL_TextureID textureID;

    /* information needed for surfaces requiring locks */

    int locked;

    void *lock_data;

    /* clipping information */

    SDL_Rect clip_rect;         /* Read-only */

    /* info for fast blit mapping to other surfaces */

    struct SDL_BlitMap *map;    /* Private */

    /* format version, bumped at every change to invalidate blit maps */

    unsigned int format_version;        /* Private */

    /* Reference count -- used when freeing surface */

    int refcount;               /* Read-mostly */

} SDL_Surface;

/* typedef for private surface blitting functions */

typedef int (*SDL_blit) (struct SDL_Surface * src, SDL_Rect * srcrect,

                         struct SDL_Surface * dst, SDL_Rect * dstrect);

/**

 * \enum SDL_GLattr

 *

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

/* Function prototypes */

/**

 * \fn int SDL_GetNumVideoDrivers(void)

 *

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

 *

 * \sa SDL_GetVideoDriver()

 */

extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);

/**

 * \fn const char *SDL_GetVideoDriver(int index)

 *

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

/**

 * \fn int SDL_VideoInit(const char *driver_name, Uint32 flags)

 *

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

/**

 * \fn void SDL_VideoQuit(void)

 *

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

/**

 * \fn const char *SDL_GetCurrentVideoDriver(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);

/**

 * \fn int SDL_GetNumVideoDisplays(void)

 *

 * \brief Returns the number of available video displays.

 *

 * \sa SDL_SelectVideoDisplay()

 */

extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);

/**

 * \fn int SDL_SelectVideoDisplay(int index)

 *

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

 *

 * \return The index of the currently selected display.

 *

 * \note You can query the currently selected display by passing an index of -1.

 *

 * \sa SDL_GetNumVideoDisplays()

 */

extern DECLSPEC int SDLCALL SDL_SelectVideoDisplay(int index);

/**

 * \fn int SDL_GetNumDisplayModes(void)

 *

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

 *

 * \sa SDL_GetDisplayMode()

 */

extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(void);

/**

 * \fn const SDL_DisplayMode *SDL_GetDisplayMode(int index)

 *

 * \brief Retrieve 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 const SDL_DisplayMode *SDLCALL SDL_GetDisplayMode(int index);

/**

 * \fn const SDL_DisplayMode *SDL_GetDesktopDisplayMode(void)

 *

 * \brief Retrieve information about the desktop display mode for the current display.

 */

extern DECLSPEC const SDL_DisplayMode *SDLCALL

SDL_GetDesktopDisplayMode(void);

/**

 * \fn const SDL_DisplayMode *SDL_GetCurrentDisplayMode(void)

 *

 * \brief Retrieve information about the current display mode.

 */

extern DECLSPEC const SDL_DisplayMode *SDLCALL

SDL_GetCurrentDisplayMode(void);

/**

 * \fn SDL_DisplayMode *SDL_GetClosestDisplayMode(const SDL_DisplayMode *mode, SDL_DisplayMode *closest)

 *

 * \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 'closest', or NULL if no matching video mode was available.

 *

 * The available display modes are scanned, and '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);

/**

 *

 *

 *

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

 */