/*

  Simple DirectMedia Layer

  Copyright (C) 1997-2016 Sam Lantinga <slouken@libsdl.org>

  This software is provided 'as-is', without any express or implied

  warranty.  In no event will the authors be held liable for any damages

  arising from the use of this software.

  Permission is granted to anyone to use this software for any purpose,

  including commercial applications, and to alter it and redistribute it

  freely, subject to the following restrictions:

  1. The origin of this software must not be misrepresented; you must not

     claim that you wrote the original software. If you use this software

     in a product, an acknowledgment in the product documentation would be

     appreciated but is not required.

  2. Altered source versions must be plainly marked as such, and must not be

     misrepresented as being the original software.

  3. This notice may not be removed or altered from any source distribution.

*/

/**

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

extern "C" {

#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, in screen coordinates */

    int h;                      /**< height, in screen coordinates */

    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_SetWindowBordered()

 *  \sa SDL_SetWindowTitle()

 *  \sa SDL_ShowWindow()

 */

typedef struct SDL_Window SDL_Window;

/**

 *  \brief The flags on a window

 *

 *  \sa SDL_GetWindowFlags()

 */

typedef enum

{

    /* !!! FIXME: change this to name = (1<<x). */

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

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

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

    SDL_WINDOW_HIDDEN = 0x00000008,             /**< window is not visible */

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

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

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

    SDL_WINDOW_MAXIMIZED = 0x00000080,          /**< 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_FULLSCREEN_DESKTOP = ( SDL_WINDOW_FULLSCREEN | 0x00001000 ),

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

    SDL_WINDOW_ALLOW_HIGHDPI = 0x00002000,      /**< window should be created in high-DPI mode if supported */

    SDL_WINDOW_MOUSE_CAPTURE = 0x00004000,      /**< window has mouse captured (unrelated to INPUT_GRABBED) */

    SDL_WINDOW_ALWAYS_ON_TOP = 0x00008000,      /**< window should always be above others */

    SDL_WINDOW_SKIP_TASKBAR  = 0x00010000,      /**< window should not be added to the taskbar */

    SDL_WINDOW_UTILITY       = 0x00020000,      /**< window should be treated as a utility window */

    SDL_WINDOW_TOOLTIP       = 0x00040000,      /**< window should be treated as a tooltip */

    SDL_WINDOW_POPUP_MENU    = 0x00080000       /**< window should be treated as a popup menu */

} SDL_WindowFlags;

/**

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

 */

#define SDL_WINDOWPOS_UNDEFINED_MASK    0x1FFF0000

#define SDL_WINDOWPOS_UNDEFINED_DISPLAY(X)  (SDL_WINDOWPOS_UNDEFINED_MASK|(X))

#define SDL_WINDOWPOS_UNDEFINED         SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)

#define SDL_WINDOWPOS_ISUNDEFINED(X)    \

            (((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK)

/**

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

 */

#define SDL_WINDOWPOS_CENTERED_MASK    0x2FFF0000

#define SDL_WINDOWPOS_CENTERED_DISPLAY(X)  (SDL_WINDOWPOS_CENTERED_MASK|(X))

#define SDL_WINDOWPOS_CENTERED         SDL_WINDOWPOS_CENTERED_DISPLAY(0)

#define SDL_WINDOWPOS_ISCENTERED(X)    \

            (((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK)

/**

 *  \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 has been resized to data1xdata2 */

    SDL_WINDOWEVENT_SIZE_CHANGED,   /**< The window size has changed, either as

                                         a result of an API call or through the

                                         system or user changing the window size. */

    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,          /**< Window has gained mouse focus */

    SDL_WINDOWEVENT_LEAVE,          /**< Window has lost mouse focus */

    SDL_WINDOWEVENT_FOCUS_GAINED,   /**< Window has gained keyboard focus */

    SDL_WINDOWEVENT_FOCUS_LOST,     /**< Window has lost keyboard focus */

    SDL_WINDOWEVENT_CLOSE,          /**< The window manager requests that the window be closed */

    SDL_WINDOWEVENT_TAKE_FOCUS,     /**< Window is being offered a focus (should SetWindowInputFocus() on itself or a subwindow, or ignore) */

    SDL_WINDOWEVENT_HIT_TEST        /**< Window had a hit test that wasn't SDL_HITTEST_NORMAL. */

} SDL_WindowEventID;

/**

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

    SDL_GL_CONTEXT_FLAGS,

    SDL_GL_CONTEXT_PROFILE_MASK,

    SDL_GL_SHARE_WITH_CURRENT_CONTEXT,

    SDL_GL_FRAMEBUFFER_SRGB_CAPABLE,

    SDL_GL_CONTEXT_RELEASE_BEHAVIOR

} SDL_GLattr;

typedef enum

{

    SDL_GL_CONTEXT_PROFILE_CORE           = 0x0001,

    SDL_GL_CONTEXT_PROFILE_COMPATIBILITY  = 0x0002,

    SDL_GL_CONTEXT_PROFILE_ES             = 0x0004 /* GLX_CONTEXT_ES2_PROFILE_BIT_EXT */

} SDL_GLprofile;

typedef enum

{

    SDL_GL_CONTEXT_DEBUG_FLAG              = 0x0001,

    SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG = 0x0002,

    SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG      = 0x0004,

    SDL_GL_CONTEXT_RESET_ISOLATION_FLAG    = 0x0008

} SDL_GLcontextFlag;

typedef enum

{

    SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE   = 0x0000,

    SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH  = 0x0001

} SDL_GLcontextReleaseFlag;

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

 *

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

/**

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

 */

extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);

/**

 *  \brief Get the name of a display in UTF-8 encoding

 *

 *  \return The name of a display, or NULL for an invalid display index.

 *

 *  \sa SDL_GetNumVideoDisplays()

 */

extern DECLSPEC const char * SDLCALL SDL_GetDisplayName(int displayIndex);

/**

 *  \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 displayIndex, SDL_Rect * rect);

/**

 *  \brief Get the dots/pixels-per-inch for a display

 *

 *  \note Diagonal, horizontal and vertical DPI can all be optionally

 *        returned if the parameter is non-NULL.

 *

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

 *

 *  \sa SDL_GetNumVideoDisplays()

 */

extern DECLSPEC int SDLCALL SDL_GetDisplayDPI(int displayIndex, float * ddpi, float * hdpi, float * vdpi);

/**

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

 *         primary display located at 0,0

 *

 *  This is the same area as SDL_GetDisplayBounds() reports, but with portions

 *  reserved by the system removed. For example, on Mac OS X, this subtracts

 *  the area occupied by the menu bar and dock.

 *

 *  Setting a window to be fullscreen generally bypasses these unusable areas,

 *  so these are good guidelines for the maximum space available to a

 *  non-fullscreen window.

 *

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

 *

 *  \sa SDL_GetDisplayBounds()

 *  \sa SDL_GetNumVideoDisplays()

 */

extern DECLSPEC int SDLCALL SDL_GetDisplayUsableBounds(int displayIndex, SDL_Rect * rect);

/**

 *  \brief Returns the number of available display modes.

 *

 *  \sa SDL_GetDisplayMode()

 */

extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(int displayIndex);

/**

 *  \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 displayIndex, int modeIndex,

                                               SDL_DisplayMode * mode);

/**

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

 */

extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(int displayIndex, SDL_DisplayMode * mode);

/**

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

 */

extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(int displayIndex, SDL_DisplayMode * mode);

/**

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

 *

 *  \param displayIndex The index of display from which mode should be queried.

 *  \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(int displayIndex, const SDL_DisplayMode * mode, SDL_DisplayMode * closest);

/**

 *  \brief Get the display index associated with a window.

 *

 *  \return the display index of the display containing the center of the

 *          window, or -1 on error.

 */

extern DECLSPEC int SDLCALL SDL_GetWindowDisplayIndex(SDL_Window * window);

/**

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

 *

 *  By default the window's dimensions and the desktop format and refresh rate

 *  are used.

 *

 *  \param window The window for which the display mode should be set.

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

 */

extern DECLSPEC int SDLCALL SDL_SetWindowDisplayMode(SDL_Window * window,

                                                     const SDL_DisplayMode

                                                         * mode);

/**

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

 *         window is visible.

 *

 *  \sa SDL_SetWindowDisplayMode()

 *  \sa SDL_SetWindowFullscreen()

 */

extern DECLSPEC int SDLCALL SDL_GetWindowDisplayMode(SDL_Window * window,

                                                     SDL_DisplayMode * mode);

/**

 *  \brief Get the pixel format associated with the window.

 */

extern DECLSPEC Uint32 SDLCALL SDL_GetWindowPixelFormat(SDL_Window * window);

/**

 *  \brief Create a window with the specified position, dimensions, and flags.

 *

 *  \param title The title of the window, in UTF-8 encoding.

 *  \param x     The x position of the window, ::SDL_WINDOWPOS_CENTERED, or

 *               ::SDL_WINDOWPOS_UNDEFINED.

 *  \param y     The y position of the window, ::SDL_WINDOWPOS_CENTERED, or

 *               ::SDL_WINDOWPOS_UNDEFINED.

 *  \param w     The width of the window, in screen coordinates.

 *  \param h     The height of the window, in screen coordinates.

 *  \param flags The flags for the window, a mask of any of the following:

 *               ::SDL_WINDOW_FULLSCREEN,    ::SDL_WINDOW_OPENGL,

 *               ::SDL_WINDOW_HIDDEN,        ::SDL_WINDOW_BORDERLESS,

 *               ::SDL_WINDOW_RESIZABLE,     ::SDL_WINDOW_MAXIMIZED,

 *               ::SDL_WINDOW_MINIMIZED,     ::SDL_WINDOW_INPUT_GRABBED,

 *               ::SDL_WINDOW_ALLOW_HIGHDPI.

 *

 *  \return The created window, or NULL if window creation failed.

 *

 *  If the window is created with the SDL_WINDOW_ALLOW_HIGHDPI flag, its size

 *  in pixels may differ from its size in screen coordinates on platforms with

 *  high-DPI support (e.g. iOS and Mac OS X). Use SDL_GetWindowSize() to query

 *  the client area's size in screen coordinates, and SDL_GL_GetDrawableSize()

 *  or SDL_GetRendererOutputSize() to query the drawable size in pixels.

 *

 *  \sa SDL_DestroyWindow()

 */

extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title,

                                                      int x, int y, int w,

                                                      int h, Uint32 flags);

/**

 *  \brief Create an SDL window from an existing native window.

 *

 *  \param data A pointer to driver-dependent window creation data

 *

 *  \return The created window, or NULL if window creation failed.

 *

 *  \sa SDL_DestroyWindow()

 */

extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowFrom(const void *data);

/**

 *  \brief Get the numeric ID of a window, for logging purposes.

 */

extern DECLSPEC Uint32 SDLCALL SDL_GetWindowID(SDL_Window * window);

/**