sdl-ios-xcode: include/SDL

annotate include/SDL_video.h @ 1734:f7c667ded87d SDL-1.3

The general code handles restoring video mode/gamma/etc. when the window loses focus. Support for changing fullscreen/windowed mode in progress.

author	Sam Lantinga <slouken@libsdl.org>
date	Sun, 09 Jul 2006 18:09:16 +0000
parents	0b1070f2f94d
children	8dd28c4ef746

rev	line source
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	2 SDL - Simple DirectMedia Layer
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1020 diff changeset	3 Copyright (C) 1997-2006 Sam Lantinga
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	4
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	5 This library is free software; you can redistribute it and/or
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1020 diff changeset	6 modify it under the terms of the GNU Lesser General Public
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	7 License as published by the Free Software Foundation; either
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1020 diff changeset	8 version 2.1 of the License, or (at your option) any later version.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	9
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	10 This library is distributed in the hope that it will be useful,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	11 but WITHOUT ANY WARRANTY; without even the implied warranty of
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1020 diff changeset	13 Lesser General Public License for more details.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	14
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1020 diff changeset	15 You should have received a copy of the GNU Lesser General Public
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1020 diff changeset	16 License along with this library; if not, write to the Free Software
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1020 diff changeset	17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	18
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	19 Sam Lantinga
251 b8688cfdc232 Updated the headers with the correct e-mail address Sam Lantinga <slouken@libsdl.org> parents: 130 diff changeset	20 slouken@libsdl.org
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	21 */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	22
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	23 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	24 * \file SDL_video.h
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	25 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	26 * Header file for access to the SDL raw framebuffer window
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	27 */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	28
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	29 #ifndef _SDL_video_h
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	30 #define _SDL_video_h
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	31
1356 67114343400d * empty log message * Sam Lantinga <slouken@libsdl.org> parents: 1330 diff changeset	32 #include "SDL_stdinc.h"
1358 c71e05b4dc2e More header massaging... works great on Windows. ;-) Sam Lantinga <slouken@libsdl.org> parents: 1356 diff changeset	33 #include "SDL_error.h"
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	34 #include "SDL_pixels.h"
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	35 #include "SDL_rwops.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	36
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	37 #include "begin_code.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	38 /* Set up for C function definitions, even when using C++ */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	39 #ifdef __cplusplus
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	40 /* INDENT-OFF */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	41 extern "C" {
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	42 /* INDENT-ON */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	43 #endif
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	44
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	45 /* Transparency definitions: These define alpha as the opacity of a surface */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	46 #define SDL_ALPHA_OPAQUE 255
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	47 #define SDL_ALPHA_TRANSPARENT 0
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	48
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	49 /**
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	50 * \struct SDL_Rect
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	51 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	52 * \brief A rectangle, with the origin at the upper left.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	53 */
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	54 typedef struct SDL_Rect
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	55 {
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	56 Sint16 x, y;
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	57 Uint16 w, h;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	58 } SDL_Rect;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	59
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	60 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	61 * \struct SDL_DisplayMode
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	62 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	63 * \brief The structure that defines a display mode
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	64 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	65 * \sa SDL_GetNumDisplayModes()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	66 * \sa SDL_GetDisplayMode()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	67 * \sa SDL_GetDesktopDisplayMode()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	68 * \sa SDL_GetCurrentDisplayMode()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	69 * \sa SDL_GetClosestDisplayMode()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	70 * \sa SDL_SetDisplayMode()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	71 */
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	72 typedef struct
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	73 {
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	74 Uint32 format; /*< pixel format /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	75 int w; /*< width /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	76 int h; /*< height /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	77 int refresh_rate; /*< refresh rate (or zero for unspecified) /
1725 98a3207ddde8 Implemented Win32 video mode support Sam Lantinga <slouken@libsdl.org> parents: 1724 diff changeset	78 void driverdata; /< driver-specific data, initialize to 0 /
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	79 } SDL_DisplayMode;
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	80
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	81 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	82 * \typedef SDL_WindowID
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	83 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	84 * \brief The type used to identify a window
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	85 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	86 * \sa SDL_CreateWindow()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	87 * \sa SDL_CreateWindowFrom()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	88 * \sa SDL_DestroyWindow()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	89 * \sa SDL_GetWindowData()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	90 * \sa SDL_GetWindowFlags()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	91 * \sa SDL_GetWindowGrab()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	92 * \sa SDL_GetWindowPosition()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	93 * \sa SDL_GetWindowSize()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	94 * \sa SDL_GetWindowTitle()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	95 * \sa SDL_HideWindow()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	96 * \sa SDL_MaximizeWindow()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	97 * \sa SDL_MinimizeWindow()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	98 * \sa SDL_RaiseWindow()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	99 * \sa SDL_RestoreWindow()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	100 * \sa SDL_SetWindowData()
1733 0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	101 * \sa SDL_SetWindowFullscreen()
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	102 * \sa SDL_SetWindowGrab()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	103 * \sa SDL_SetWindowIcon()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	104 * \sa SDL_SetWindowPosition()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	105 * \sa SDL_SetWindowSize()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	106 * \sa SDL_SetWindowTitle()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	107 * \sa SDL_ShowWindow()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	108 */
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	109 typedef Uint32 SDL_WindowID;
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	110
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	111 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	112 * \enum SDL_WindowFlags
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	113 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	114 * \brief The flags on a window
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	115 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	116 * \sa SDL_GetWindowFlags()
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	117 */
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	118 typedef enum
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	119 {
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	120 SDL_WINDOW_FULLSCREEN = 0x00000001, /*< fullscreen window, implies borderless /
1719 5b9f50c957ed You can now create multiple windows on Win32 Sam Lantinga <slouken@libsdl.org> parents: 1707 diff changeset	121 SDL_WINDOW_OPENGL = 0x00000002, /*< window usable with OpenGL context /
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	122 SDL_WINDOW_SHOWN = 0x00000004, /*< window is visible /
1719 5b9f50c957ed You can now create multiple windows on Win32 Sam Lantinga <slouken@libsdl.org> parents: 1707 diff changeset	123 SDL_WINDOW_BORDERLESS = 0x00000008, /*< no window decoration /
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	124 SDL_WINDOW_RESIZABLE = 0x00000010, /*< window can be resized /
1722 5daa04d862f1 Added a userdata parameter for event filters. Sam Lantinga <slouken@libsdl.org> parents: 1720 diff changeset	125 SDL_WINDOW_MINIMIZED = 0x00000020, /*< minimized /
5daa04d862f1 Added a userdata parameter for event filters. Sam Lantinga <slouken@libsdl.org> parents: 1720 diff changeset	126 SDL_WINDOW_MAXIMIZED = 0x00000040, /*< maximized /
1719 5b9f50c957ed You can now create multiple windows on Win32 Sam Lantinga <slouken@libsdl.org> parents: 1707 diff changeset	127 SDL_WINDOW_INPUT_GRABBED = 0x00000100, /*< window has grabbed input focus /
1734 f7c667ded87d The general code handles restoring video mode/gamma/etc. when the window loses focus. Sam Lantinga <slouken@libsdl.org> parents: 1733 diff changeset	128 SDL_WINDOW_INPUT_FOCUS = 0x00000200, /*< window has input focus /
1719 5b9f50c957ed You can now create multiple windows on Win32 Sam Lantinga <slouken@libsdl.org> parents: 1707 diff changeset	129 SDL_WINDOW_MOUSE_FOCUS = 0x00000400, /*< window has mouse focus /
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	130 } SDL_WindowFlags;
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	131
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	132 /**
1719 5b9f50c957ed You can now create multiple windows on Win32 Sam Lantinga <slouken@libsdl.org> parents: 1707 diff changeset	133 * \def SDL_WINDOWPOS_UNDEFINED
5b9f50c957ed You can now create multiple windows on Win32 Sam Lantinga <slouken@libsdl.org> parents: 1707 diff changeset	134 * \brief Used to indicate that you don't care what the window position is.
5b9f50c957ed You can now create multiple windows on Win32 Sam Lantinga <slouken@libsdl.org> parents: 1707 diff changeset	135 */
5b9f50c957ed You can now create multiple windows on Win32 Sam Lantinga <slouken@libsdl.org> parents: 1707 diff changeset	136 #define SDL_WINDOWPOS_UNDEFINED 0x7FFFFFF
5b9f50c957ed You can now create multiple windows on Win32 Sam Lantinga <slouken@libsdl.org> parents: 1707 diff changeset	137 /**
5b9f50c957ed You can now create multiple windows on Win32 Sam Lantinga <slouken@libsdl.org> parents: 1707 diff changeset	138 * \def SDL_WINDOWPOS_CENTERED
5b9f50c957ed You can now create multiple windows on Win32 Sam Lantinga <slouken@libsdl.org> parents: 1707 diff changeset	139 * \brief Used to indicate that the window position should be centered.
5b9f50c957ed You can now create multiple windows on Win32 Sam Lantinga <slouken@libsdl.org> parents: 1707 diff changeset	140 */
5b9f50c957ed You can now create multiple windows on Win32 Sam Lantinga <slouken@libsdl.org> parents: 1707 diff changeset	141 #define SDL_WINDOWPOS_CENTERED 0x7FFFFFE
5b9f50c957ed You can now create multiple windows on Win32 Sam Lantinga <slouken@libsdl.org> parents: 1707 diff changeset	142
5b9f50c957ed You can now create multiple windows on Win32 Sam Lantinga <slouken@libsdl.org> parents: 1707 diff changeset	143 /**
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	144 * \enum SDL_WindowEventID
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	145 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	146 * \brief Event subtype for window events
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	147 */
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	148 typedef enum
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	149 {
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	150 SDL_WINDOWEVENT_NONE, /*< Never used /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	151 SDL_WINDOWEVENT_SHOWN, /*< Window has been shown /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	152 SDL_WINDOWEVENT_HIDDEN, /*< Window has been hidden /
1724 6c63fc2bd986 Proof of concept done - Win32 GDI implementation mostly complete. Sam Lantinga <slouken@libsdl.org> parents: 1722 diff changeset	153 SDL_WINDOWEVENT_EXPOSED, /*< Window has been exposed and should be redrawn /
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	154 SDL_WINDOWEVENT_MOVED, /*< Window has been moved to data1,data2 /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	155 SDL_WINDOWEVENT_RESIZED, /*< Window size changed to data1xdata2 /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	156 SDL_WINDOWEVENT_MINIMIZED, /*< Window has been minimized /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	157 SDL_WINDOWEVENT_MAXIMIZED, /*< Window has been maximized /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	158 SDL_WINDOWEVENT_RESTORED, /*< Window has been restored to normal size and position /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	159 SDL_WINDOWEVENT_ENTER, /*< The window has gained mouse focus /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	160 SDL_WINDOWEVENT_LEAVE, /*< The window has lost mouse focus /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	161 SDL_WINDOWEVENT_FOCUS_GAINED, /*< The window has gained keyboard focus /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	162 SDL_WINDOWEVENT_FOCUS_LOST, /*< The window has lost keyboard focus /
1724 6c63fc2bd986 Proof of concept done - Win32 GDI implementation mostly complete. Sam Lantinga <slouken@libsdl.org> parents: 1722 diff changeset	163 SDL_WINDOWEVENT_CLOSE, /*< The window manager requests that the window be closed /
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	164 } SDL_WindowEventID;
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	165
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	166 /**
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	167 * \enum SDL_RendererFlags
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	168 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	169 * \brief Flags used when initializing a render manager.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	170 */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	171 typedef enum
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	172 {
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	173 SDL_Renderer_PresentDiscard = 0x00000001, /*< Present leaves the contents of the backbuffer undefined /
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	174 SDL_Renderer_PresentCopy = 0x00000002, /*< Present uses a copy from back buffer to the front buffer /
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	175 SDL_Renderer_PresentFlip2 = 0x00000004, /*< Present uses a flip, swapping back buffer and front buffer /
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	176 SDL_Renderer_PresentFlip3 = 0x00000008, /*< Present uses a flip, rotating between two back buffers and a front buffer /
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	177 SDL_Renderer_PresentVSync = 0x00000010, /*< Present is synchronized with the refresh rate /
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	178 SDL_Renderer_RenderTarget = 0x00000020, /*< The renderer can create texture render targets /
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	179 SDL_Renderer_Accelerated = 0x00000040, /*< The renderer uses hardware acceleration /
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	180 SDL_Renderer_Minimal = 0x00000080, /*< The renderer only supports the read/write pixel and present functions /
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	181 } SDL_RendererFlags;
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	182
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	183 /**
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	184 * \struct SDL_RendererInfo
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	185 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	186 * \brief Information on the capabilities of a render manager.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	187 */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	188 typedef struct SDL_RendererInfo
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	189 {
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	190 const char name; /< The name of the renderer /
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	191 Uint32 flags; /*< Supported SDL_RendererFlags /
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	192 Uint32 blend_modes; /*< A mask of supported blend modes /
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	193 Uint32 scale_modes; /*< A mask of supported scale modes /
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	194 Uint32 num_texture_formats; /*< The number of available texture formats /
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	195 Uint32 texture_formats[32]; /*< The available texture formats /
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	196 int max_texture_width; /*< The maximimum texture width /
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	197 int max_texture_height; /*< The maximimum texture height /
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	198 } SDL_RendererInfo;
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	199
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	200 /**
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	201 * \enum SDL_TextureAccess
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	202 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	203 * \brief The access pattern allowed for a texture
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	204 */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	205 typedef enum
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	206 {
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	207 SDL_TextureAccess_Render, /*< Unlockable video memory, rendering allowed /
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	208 SDL_TextureAccess_Remote, /*< Unlockable video memory /
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	209 SDL_TextureAccess_Local, /*< Lockable system memory /
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	210 } SDL_TextureAccess;
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	211
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	212 /**
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	213 * \enum SDL_TextureBlendMode
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	214 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	215 * \brief The blend mode used in SDL_RenderCopy()
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	216 */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	217 typedef enum
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	218 {
1676 e136f3ffdc1b Adding software renderer implementation Sam Lantinga <slouken@libsdl.org> parents: 1675 diff changeset	219 SDL_TextureBlendMode_None = 0x00000000, /*< No blending /
e136f3ffdc1b Adding software renderer implementation Sam Lantinga <slouken@libsdl.org> parents: 1675 diff changeset	220 SDL_TextureBlendMode_Mask = 0x00000001, /*< dst = A ? src : dst (alpha is mask) /
e136f3ffdc1b Adding software renderer implementation Sam Lantinga <slouken@libsdl.org> parents: 1675 diff changeset	221 SDL_TextureBlendMode_Blend = 0x00000002, /*< dst = (src A) + (dst * (1-A)) */
e136f3ffdc1b Adding software renderer implementation Sam Lantinga <slouken@libsdl.org> parents: 1675 diff changeset	222 SDL_TextureBlendMode_Add = 0x00000004, /*< dst = (src A) + dst */
e136f3ffdc1b Adding software renderer implementation Sam Lantinga <slouken@libsdl.org> parents: 1675 diff changeset	223 SDL_TextureBlendMode_Mod = 0x00000008, /*< dst = src dst */
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	224 } SDL_TextureBlendMode;
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	225
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	226 /**
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	227 * \enum SDL_TextureScaleMode
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	228 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	229 * \brief The scale mode used in SDL_RenderCopy()
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	230 */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	231 typedef enum
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	232 {
1676 e136f3ffdc1b Adding software renderer implementation Sam Lantinga <slouken@libsdl.org> parents: 1675 diff changeset	233 SDL_TextureScaleMode_None = 0x00000000, /*< No scaling, rectangles must match dimensions /
e136f3ffdc1b Adding software renderer implementation Sam Lantinga <slouken@libsdl.org> parents: 1675 diff changeset	234 SDL_TextureScaleMode_Fast = 0x00000001, /*< Point sampling or equivalent algorithm /
e136f3ffdc1b Adding software renderer implementation Sam Lantinga <slouken@libsdl.org> parents: 1675 diff changeset	235 SDL_TextureScaleMode_Slow = 0x00000002, /*< Linear filtering or equivalent algorithm /
e136f3ffdc1b Adding software renderer implementation Sam Lantinga <slouken@libsdl.org> parents: 1675 diff changeset	236 SDL_TextureScaleMode_Best = 0x00000004, /*< Bicubic filtering or equivalent algorithm /
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	237 } SDL_TextureScaleMode;
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	238
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	239 /**
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	240 * \typedef SDL_TextureID
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	241 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	242 * \brief An efficient driver-specific representation of pixel data
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	243 */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	244 typedef Uint32 SDL_TextureID;
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	245
1729 0ef52d56e8bb Fixed compile problems with new OpenGL API. Sam Lantinga <slouken@libsdl.org> parents: 1727 diff changeset	246 /**
0ef52d56e8bb Fixed compile problems with new OpenGL API. Sam Lantinga <slouken@libsdl.org> parents: 1727 diff changeset	247 * \typedef SDL_GLContext
0ef52d56e8bb Fixed compile problems with new OpenGL API. Sam Lantinga <slouken@libsdl.org> parents: 1727 diff changeset	248 *
0ef52d56e8bb Fixed compile problems with new OpenGL API. Sam Lantinga <slouken@libsdl.org> parents: 1727 diff changeset	249 * \brief An opaque handle to an OpenGL context.
0ef52d56e8bb Fixed compile problems with new OpenGL API. Sam Lantinga <slouken@libsdl.org> parents: 1727 diff changeset	250 */
0ef52d56e8bb Fixed compile problems with new OpenGL API. Sam Lantinga <slouken@libsdl.org> parents: 1727 diff changeset	251 typedef void *SDL_GLContext;
0ef52d56e8bb Fixed compile problems with new OpenGL API. Sam Lantinga <slouken@libsdl.org> parents: 1727 diff changeset	252
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	253
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	254 /* These are the currently supported flags for the SDL_surface */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	255 /* Used internally (read-only) */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	256 #define SDL_HWSURFACE 0x00000001 /* Surface represents a texture */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	257 #define SDL_PREALLOC 0x00000002 /* Surface uses preallocated memory */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	258 #define SDL_SRCALPHA 0x00000004 /* Blit uses source alpha blending */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	259 #define SDL_SRCCOLORKEY 0x00000008 /* Blit uses a source color key */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	260 #define SDL_RLEACCELOK 0x00000010 /* Private flag */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	261 #define SDL_RLEACCEL 0x00000020 /* Surface is RLE encoded */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	262
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	263 /* Evaluates to true if the surface needs to be locked before access */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	264 #define SDL_MUSTLOCK(S) (((S)->flags & (SDL_HWSURFACE\|SDL_RLEACCEL)) != 0)
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	265
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	266 /* This structure should be treated as read-only, except for 'pixels',
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	267 which, if not NULL, contains the raw pixel data for the surface.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	268 */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	269 typedef struct SDL_Surface
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	270 {
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	271 Uint32 flags; /* Read-only */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	272 SDL_PixelFormat format; / Read-only */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	273 int w, h; /* Read-only */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	274 int pitch; /* Read-only */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	275 void pixels; / Read-write */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	276
1683 396a35389351 Finished palettized display handling. Sam Lantinga <slouken@libsdl.org> parents: 1682 diff changeset	277 /* texture associated with the surface, if any */
396a35389351 Finished palettized display handling. Sam Lantinga <slouken@libsdl.org> parents: 1682 diff changeset	278 SDL_TextureID textureID;
396a35389351 Finished palettized display handling. Sam Lantinga <slouken@libsdl.org> parents: 1682 diff changeset	279
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	280 /* information needed for surfaces requiring locks */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	281 int locked;
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	282 void *lock_data;
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	283
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	284 /* clipping information */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	285 SDL_Rect clip_rect; /* Read-only */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	286
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	287 /* info for fast blit mapping to other surfaces */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	288 struct SDL_BlitMap map; / Private */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	289
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	290 /* format version, bumped at every change to invalidate blit maps */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	291 unsigned int format_version; /* Private */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	292
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	293 /* Reference count -- used when freeing surface */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	294 int refcount; /* Read-mostly */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	295 } SDL_Surface;
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	296
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	297 /* typedef for private surface blitting functions */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	298 typedef int (SDL_blit) (struct SDL_Surface src, SDL_Rect * srcrect,
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	299 struct SDL_Surface * dst, SDL_Rect * dstrect);
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	300
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	301
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	302 /**
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	303 * \enum SDL_GLattr
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	304 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	305 * \brief OpenGL configuration attributes
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	306 */
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	307 typedef enum
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	308 {
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	309 SDL_GL_RED_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	310 SDL_GL_GREEN_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	311 SDL_GL_BLUE_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	312 SDL_GL_ALPHA_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	313 SDL_GL_BUFFER_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	314 SDL_GL_DOUBLEBUFFER,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	315 SDL_GL_DEPTH_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	316 SDL_GL_STENCIL_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	317 SDL_GL_ACCUM_RED_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	318 SDL_GL_ACCUM_GREEN_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	319 SDL_GL_ACCUM_BLUE_SIZE,
450 8a43e0cbf02f Added SDL_GL_STEREO for stereoscopic OpenGL contexts Sam Lantinga <slouken@libsdl.org> parents: 432 diff changeset	320 SDL_GL_ACCUM_ALPHA_SIZE,
655 9c42ee1b7d77 Date: Thu, 24 Apr 2003 15:13:47 -0400 Sam Lantinga <slouken@libsdl.org> parents: 639 diff changeset	321 SDL_GL_STEREO,
656 864e2d2a9a55 Merged in Ryan's multisample code for MacOS, and changed the constants to match. Sam Lantinga <slouken@libsdl.org> parents: 655 diff changeset	322 SDL_GL_MULTISAMPLEBUFFERS,
1656 96c2f89cc7e1 SDL-trunk-1.3-merge-1 Sam Lantinga <slouken@libsdl.org> parents: 1654 diff changeset	323 SDL_GL_MULTISAMPLESAMPLES,
1727 90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	324 SDL_GL_ACCELERATED_VISUAL
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	325 } SDL_GLattr;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	326
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	327
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	328 /* Function prototypes */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	329
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	330 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	331 * \fn int SDL_GetNumVideoDrivers(void)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	332 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	333 * \brief Get the number of video drivers compiled into SDL
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	334 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	335 * \sa SDL_GetVideoDriver()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	336 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	337 extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	338
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	339 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	340 * \fn const char *SDL_GetVideoDriver(int index)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	341 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	342 * \brief Get the name of a built in video driver.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	343 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	344 * \note The video drivers are presented in the order in which they are
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	345 * normally checked during initialization.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	346 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	347 * \sa SDL_GetNumVideoDrivers()
1660 8b9d79e7eacf Added API requested in bug #43: Sam Lantinga <slouken@libsdl.org> parents: 1658 diff changeset	348 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	349 extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index);
1660 8b9d79e7eacf Added API requested in bug #43: Sam Lantinga <slouken@libsdl.org> parents: 1658 diff changeset	350
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	351 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	352 * \fn int SDL_VideoInit(const char *driver_name, Uint32 flags)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	353 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	354 * \brief Initialize the video subsystem, optionally specifying a video driver.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	355 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	356 * \param driver_name Initialize a specific driver by name, or NULL for the default video driver.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	357 * \param flags FIXME: Still needed?
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	358 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	359 * \return 0 on success, -1 on error
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	360 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	361 * This function initializes the video subsystem; setting up a connection
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	362 * to the window manager, etc, and determines the available display modes
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	363 * and pixel formats, but does not initialize a window or graphics mode.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	364 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	365 * \sa SDL_VideoQuit()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	366 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	367 extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	368 Uint32 flags);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	369
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	370 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	371 * \fn void SDL_VideoQuit(void)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	372 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	373 * \brief Shuts down the video subsystem.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	374 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	375 * This function closes all windows, and restores the original video mode.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	376 *
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	377 * \sa SDL_VideoInit()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	378 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	379 extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	380
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	381 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	382 * \fn const char *SDL_GetCurrentVideoDriver(void)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	383 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	384 * \brief Returns the name of the currently initialized video driver.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	385 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	386 * \return The name of the current video driver or NULL if no driver
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	387 * has been initialized
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	388 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	389 * \sa SDL_GetNumVideoDrivers()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	390 * \sa SDL_GetVideoDriver()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	391 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	392 extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	393
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	394 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	395 * \fn int SDL_GetNumVideoDisplays(void)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	396 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	397 * \brief Returns the number of available video displays.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	398 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	399 * \sa SDL_SelectVideoDisplay()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	400 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	401 extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	402
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	403 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	404 * \fn int SDL_SelectVideoDisplay(int index)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	405 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	406 * \brief Set the index of the currently selected display.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	407 *
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	408 * \return The index of the currently selected display.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	409 *
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	410 * \note You can query the currently selected display by passing an index of -1.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	411 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	412 * \sa SDL_GetNumVideoDisplays()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	413 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	414 extern DECLSPEC int SDLCALL SDL_SelectVideoDisplay(int index);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	415
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	416 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	417 * \fn int SDL_GetNumDisplayModes(void)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	418 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	419 * \brief Returns the number of available display modes for the current display.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	420 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	421 * \sa SDL_GetDisplayMode()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	422 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	423 extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	424
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	425 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	426 * \fn const SDL_DisplayMode *SDL_GetDisplayMode(int index)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	427 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	428 * \brief Retrieve information about a specific display mode.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	429 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	430 * \note The display modes are sorted in this priority:
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	431 * \li bits per pixel -> more colors to fewer colors
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	432 * \li width -> largest to smallest
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	433 * \li height -> largest to smallest
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	434 * \li refresh rate -> highest to lowest
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	435 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	436 * \sa SDL_GetNumDisplayModes()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	437 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	438 extern DECLSPEC const SDL_DisplayMode *SDLCALL SDL_GetDisplayMode(int index);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	439
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	440 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	441 * \fn const SDL_DisplayMode *SDL_GetDesktopDisplayMode(void)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	442 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	443 * \brief Retrieve information about the desktop display mode for the current display.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	444 */
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	445 extern DECLSPEC const SDL_DisplayMode *SDLCALL
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	446 SDL_GetDesktopDisplayMode(void);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	447
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	448 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	449 * \fn const SDL_DisplayMode *SDL_GetCurrentDisplayMode(void)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	450 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	451 * \brief Retrieve information about the current display mode.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	452 */
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	453 extern DECLSPEC const SDL_DisplayMode *SDLCALL
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	454 SDL_GetCurrentDisplayMode(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	455
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	456 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	457 * \fn SDL_DisplayMode SDL_GetClosestDisplayMode(const SDL_DisplayMode mode, SDL_DisplayMode *closest)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	458 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	459 * \brief Get the closest match to the requested display mode.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	460 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	461 * \param mode The desired display mode
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	462 * \param closest A pointer to a display mode to be filled in with the closest match of the available display modes.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	463 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	464 * \return The passed in value 'closest', or NULL if no matching video mode was available.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	465 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	466 * 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.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	467 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	468 * \sa SDL_GetNumDisplayModes()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	469 * \sa SDL_GetDisplayMode()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	470 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	471 extern DECLSPEC SDL_DisplayMode *SDLCALL SDL_GetClosestDisplayMode(const
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	472 SDL_DisplayMode
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	473 * mode,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	474 SDL_DisplayMode
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	475 * closest);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	476
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	477 /**
1733 0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	478 * \fn int SDL_SetFullscreenDisplayMode(const SDL_DisplayMode *mode)
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	479 *
1733 0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	480 * \brief Set the display mode used when a fullscreen window is visible
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	481 * on the currently selected display.
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	482 *
1733 0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	483 * \param mode The mode to use, or NULL for the desktop mode.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	484 *
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	485 * \return 0 on success, or -1 if setting the display mode failed.
1733 0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	486 *
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	487 * \sa SDL_SetWindowFullscreen()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	488 */
1733 0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	489 extern DECLSPEC int SDLCALL SDL_SetFullscreenDisplayMode(const SDL_DisplayMode
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	490 * mode);
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	491
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	492 /**
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	493 * \fn const SDL_DisplayMode *SDL_GetFullscreenDisplayMode(void)
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	494 *
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	495 * \brief Query the display mode used when a fullscreen window is visible
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	496 * on the currently selected display.
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	497 */
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	498 extern DECLSPEC const SDL_DisplayMode *SDLCALL
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	499 SDL_GetFullscreenDisplayMode(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	500
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	501 /**
1681 80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	502 * \fn int SDL_SetDisplayPalette(const SDL_Color *colors, int firstcolor, int ncolors)
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	503 *
1681 80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	504 * \brief Set the palette entries for indexed display modes.
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	505 *
1681 80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	506 * \return 0 on success, or -1 if the display mode isn't palettized or the colors couldn't be set.
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	507 */
1681 80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	508 extern DECLSPEC int SDLCALL SDL_SetDisplayPalette(const SDL_Color * colors,
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	509 int firstcolor,
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	510 int ncolors);
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	511
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	512 /**
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	513 * \fn int SDL_GetDisplayPalette(SDL_Color *colors, int firstcolor, int ncolors)
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	514 *
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	515 * \brief Gets the palette entries for indexed display modes.
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	516 *
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	517 * \return 0 on success, or -1 if the display mode isn't palettized
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	518 */
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	519 extern DECLSPEC int SDLCALL SDL_GetDisplayPalette(SDL_Color * colors,
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	520 int firstcolor,
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	521 int ncolors);
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	522
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	523 /**
1733 0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	524 * \fn int SDL_SetGamma(float red, float green, float blue)
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	525 *
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	526 * \brief Set the gamma correction for each of the color channels on the currently selected display.
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	527 *
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	528 * \return 0 on success, or -1 if setting the gamma isn't supported.
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	529 *
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	530 * \sa SDL_SetGammaRamp()
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	531 */
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	532 extern DECLSPEC int SDLCALL SDL_SetGamma(float red, float green, float blue);
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	533
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	534 /**
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	535 * \fn int SDL_SetGammaRamp(const Uint16 * red, const Uint16 * green, const Uint16 * blue)
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	536 *
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	537 * \brief Set the gamma ramp for the currently selected display.
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	538 *
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	539 * \param red The translation table for the red channel, or NULL
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	540 * \param green The translation table for the green channel, or NULL
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	541 * \param blue The translation table for the blue channel, or NULL
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	542 *
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	543 * \return 0 on success, or -1 if gamma ramps are unsupported.
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	544 *
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	545 * Set the gamma translation table for the red, green, and blue channels
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	546 * of the video hardware. Each table is an array of 256 16-bit quantities,
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	547 * representing a mapping between the input and output for that channel.
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	548 * The input is the index into the array, and the output is the 16-bit
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	549 * gamma value at that index, scaled to the output color precision.
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	550 *
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	551 * \sa SDL_GetGammaRamp()
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	552 */
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	553 extern DECLSPEC int SDLCALL SDL_SetGammaRamp(const Uint16 * red,
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	554 const Uint16 * green,
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	555 const Uint16 * blue);
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	556
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	557 /**
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	558 * \fn int SDL_GetGammaRamp(Uint16 * red, Uint16 * green, Uint16 * blue)
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	559 *
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	560 * \brief Get the gamma ramp for the currently selected display.
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	561 *
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	562 * \param red A pointer to a 256 element array of 16-bit quantities to hold the translation table for the red channel, or NULL.
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	563 * \param green A pointer to a 256 element array of 16-bit quantities to hold the translation table for the green channel, or NULL.
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	564 * \param blue A pointer to a 256 element array of 16-bit quantities to hold the translation table for the blue channel, or NULL.
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	565 *
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	566 * \return 0 on success, or -1 if gamma ramps are unsupported.
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	567 *
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	568 * \sa SDL_SetGammaRamp()
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	569 */
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	570 extern DECLSPEC int SDLCALL SDL_GetGammaRamp(Uint16 * red, Uint16 * green,
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	571 Uint16 * blue);
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	572
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	573
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	574 /**
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	575 * \fn SDL_WindowID SDL_CreateWindow(const char *title, int x, int y, int w, int h, Uint32 flags)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	576 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	577 * \brief Create a window with the specified position, dimensions, and flags.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	578 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	579 * \param title The title of the window
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	580 * \param x The x position of the window
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	581 * \param y The y position of the window
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	582 * \param w The width of the window
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	583 * \param h The height of the window
1733 0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	584 * \param flags The flags for the window, a mask of any of the following: SDL_WINDOW_FULLSCREEN, SDL_WINDOW_OPENGL, SDL_WINDOW_SHOWN, SDL_WINDOW_BORDERLESS, SDL_WINDOW_RESIZABLE, SDL_WINDOW_MAXIMIZED, SDL_WINDOW_MINIMIZED, SDL_WINDOW_INPUT_GRABBED
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	585 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	586 * \return The id of the window created, or zero if window creation failed.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	587 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	588 * \note Setting the position to -1, -1, indicates any position is fine.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	589 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	590 * \sa SDL_DestroyWindow()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	591 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	592 extern DECLSPEC SDL_WindowID SDLCALL SDL_CreateWindow(const char *title,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	593 int x, int y, int w,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	594 int h, Uint32 flags);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	595
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	596 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	597 * \fn SDL_WindowID SDL_CreateWindowFrom(void *data)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	598 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	599 * \brief Create an SDL window struct from an existing native window.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	600 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	601 * \param data A pointer to driver-dependent window creation data
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	602 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	603 * \return The id of the window created, or zero if window creation failed.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	604 *
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	605 * \warning This function is NOT SUPPORTED, use at your own risk!
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	606 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	607 * \sa SDL_DestroyWindow()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	608 */
1681 80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	609 extern DECLSPEC SDL_WindowID SDLCALL SDL_CreateWindowFrom(const void *data);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	610
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	611 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	612 * \fn Uint32 SDL_GetWindowFlags(SDL_WindowID windowID)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	613 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	614 * \brief Get the window flags.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	615 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	616 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_WindowID windowID);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	617
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	618 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	619 * \fn void SDL_SetWindowTitle(SDL_WindowID windowID, const char *title)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	620 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	621 * \brief Set the title of the window, in UTF-8 format.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	622 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	623 * \sa SDL_GetWindowTitle()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	624 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	625 extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_WindowID windowID,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	626 const char *title);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	627
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	628 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	629 * \fn const char *SDL_GetWindowTitle(SDL_WindowID windowID)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	630 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	631 * \brief Get the title of the window, in UTF-8 format.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	632 *
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	633 * \sa SDL_SetWindowTitle()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	634 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	635 extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_WindowID windowID);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	636
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	637 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	638 * \fn void SDL_SetWindowIcon(SDL_Surface *icon)
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	639 *
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	640 * \brief Set the icon of the window.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	641 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	642 * \param icon The icon for the window
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	643 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	644 * FIXME: The icon needs to be set before the window is first shown. Should some icon representation be part of the window creation data?
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	645 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	646 extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Surface * icon);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	647
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	648 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	649 * \fn void SDL_SetWindowData(SDL_WindowID windowID, void *userdata)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	650 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	651 * \brief Associate an arbitrary pointer with the window.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	652 *
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	653 * \sa SDL_GetWindowData()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	654 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	655 extern DECLSPEC void SDLCALL SDL_SetWindowData(SDL_WindowID windowID,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	656 void *userdata);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	657
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	658 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	659 * \fn void *SDL_GetWindowData(SDL_WindowID windowID)
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	660 *
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	661 * \brief Retrieve the data pointer associated with the window.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	662 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	663 * \sa SDL_SetWindowData()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	664 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	665 extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_WindowID windowID);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	666
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	667 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	668 * \fn void SDL_SetWindowPosition(SDL_WindowID windowID, int x, int y)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	669 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	670 * \brief Set the position of the window.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	671 *
1719 5b9f50c957ed You can now create multiple windows on Win32 Sam Lantinga <slouken@libsdl.org> parents: 1707 diff changeset	672 * \param windowID The window to reposition
5b9f50c957ed You can now create multiple windows on Win32 Sam Lantinga <slouken@libsdl.org> parents: 1707 diff changeset	673 * \param x The x coordinate of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED
5b9f50c957ed You can now create multiple windows on Win32 Sam Lantinga <slouken@libsdl.org> parents: 1707 diff changeset	674 * \param y The y coordinate of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED
5b9f50c957ed You can now create multiple windows on Win32 Sam Lantinga <slouken@libsdl.org> parents: 1707 diff changeset	675 *
5b9f50c957ed You can now create multiple windows on Win32 Sam Lantinga <slouken@libsdl.org> parents: 1707 diff changeset	676 * \note The window coordinate origin is the upper left of the display.
5b9f50c957ed You can now create multiple windows on Win32 Sam Lantinga <slouken@libsdl.org> parents: 1707 diff changeset	677 *
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	678 * \sa SDL_GetWindowPosition()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	679 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	680 extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_WindowID windowID,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	681 int x, int y);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	682
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	683 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	684 * \fn void SDL_GetWindowPosition(SDL_WindowID windowID, int x, int y)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	685 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	686 * \brief Get the position of the window.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	687 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	688 * \sa SDL_SetWindowPosition()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	689 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	690 extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_WindowID windowID,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	691 int x, int y);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	692
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	693 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	694 * \fn void SDL_SetWindowSize(SDL_WindowID windowID, int w, int w)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	695 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	696 * \brief Set the size of the window's client area.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	697 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	698 * \note You can't change the size of a fullscreen window, it automatically
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	699 * matches the size of the display mode.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	700 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	701 * \sa SDL_GetWindowSize()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	702 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	703 extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_WindowID windowID, int w,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	704 int h);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	705
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	706 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	707 * \fn void SDL_GetWindowSize(SDL_WindowID windowID, int w, int w)
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	708 *
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	709 * \brief Get the size of the window's client area.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	710 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	711 * \sa SDL_SetWindowSize()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	712 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	713 extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_WindowID windowID, int *w,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	714 int *h);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	715
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	716 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	717 * \fn void SDL_ShowWindow(SDL_WindowID windowID)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	718 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	719 * \brief Show the window
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	720 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	721 * \sa SDL_HideWindow()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	722 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	723 extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_WindowID windowID);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	724
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	725 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	726 * \fn void SDL_HideWindow(SDL_WindowID windowID)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	727 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	728 * \brief Hide the window
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	729 *
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	730 * \sa SDL_ShowWindow()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	731 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	732 extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_WindowID windowID);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	733
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	734 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	735 * \fn void SDL_RaiseWindow(SDL_WindowID windowID)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	736 *
1734 f7c667ded87d The general code handles restoring video mode/gamma/etc. when the window loses focus. Sam Lantinga <slouken@libsdl.org> parents: 1733 diff changeset	737 * \brief Raise the window above other windows and set the input focus.
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	738 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	739 extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_WindowID windowID);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	740
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	741 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	742 * \fn void SDL_MaximizeWindow(SDL_WindowID windowID)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	743 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	744 * \brief Make the window as large as possible.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	745 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	746 * \sa SDL_RestoreWindow()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	747 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	748 extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_WindowID windowID);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	749
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	750 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	751 * \fn void SDL_MinimizeWindow(SDL_WindowID windowID)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	752 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	753 * \brief Minimize the window to an iconic representation.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	754 *
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	755 * \sa SDL_RestoreWindow()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	756 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	757 extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_WindowID windowID);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	758
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	759 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	760 * \fn void SDL_RestoreWindow(SDL_WindowID windowID)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	761 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	762 * \brief Restore the size and position of a minimized or maximized window.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	763 *
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	764 * \sa SDL_MaximizeWindow()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	765 * \sa SDL_MinimizeWindow()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	766 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	767 extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_WindowID windowID);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	768
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	769 /**
1733 0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	770 * \fn int SDL_SetWindowFullscreen(SDL_WindowID windowID, int fullscreen)
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	771 *
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	772 * \brief Set the window's fullscreen state.
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	773 *
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	774 * \return 0 on success, or -1 if setting the display mode failed.
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	775 *
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	776 * \sa SDL_SetFullscreenDisplayMode()
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	777 */
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	778 extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_WindowID windowID,
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	779 int fullscreen);
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	780
0b1070f2f94d Implemented gamma correction on Windows. Sam Lantinga <slouken@libsdl.org> parents: 1729 diff changeset	781 /**
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	782 * \fn void SDL_SetWindowGrab(SDL_WindowID windowID, int mode)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	783 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	784 * \brief Set the window's input grab mode.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	785 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	786 * \param mode This is 1 to grab input, and 0 to release input.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	787 *
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	788 * \sa SDL_GetWindowGrab()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	789 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	790 extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_WindowID windowID,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	791 int mode);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	792
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	793 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	794 * \fn int SDL_GetWindowGrab(SDL_WindowID windowID)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	795 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	796 * \brief Get the window's input grab mode.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	797 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	798 * \return This returns 1 if input is grabbed, and 0 otherwise.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	799 *
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	800 * \sa SDL_SetWindowGrab()
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	801 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	802 extern DECLSPEC int SDLCALL SDL_GetWindowGrab(SDL_WindowID windowID);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	803
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	804 /**
1720 a1ebb17f9c52 Cleaned up a bunch of warnings, started adding Win32 event support Sam Lantinga <slouken@libsdl.org> parents: 1719 diff changeset	805 * \fn SDL_bool SDL_GetWindowWMInfo(SDL_WindowID windowID, struct SDL_SysWMinfo * info)
a1ebb17f9c52 Cleaned up a bunch of warnings, started adding Win32 event support Sam Lantinga <slouken@libsdl.org> parents: 1719 diff changeset	806 *
a1ebb17f9c52 Cleaned up a bunch of warnings, started adding Win32 event support Sam Lantinga <slouken@libsdl.org> parents: 1719 diff changeset	807 * \brief Get driver specific information about a window.
a1ebb17f9c52 Cleaned up a bunch of warnings, started adding Win32 event support Sam Lantinga <slouken@libsdl.org> parents: 1719 diff changeset	808 *
a1ebb17f9c52 Cleaned up a bunch of warnings, started adding Win32 event support Sam Lantinga <slouken@libsdl.org> parents: 1719 diff changeset	809 * \note Include SDL_syswm.h for the declaration of SDL_SysWMinfo.
a1ebb17f9c52 Cleaned up a bunch of warnings, started adding Win32 event support Sam Lantinga <slouken@libsdl.org> parents: 1719 diff changeset	810 */
a1ebb17f9c52 Cleaned up a bunch of warnings, started adding Win32 event support Sam Lantinga <slouken@libsdl.org> parents: 1719 diff changeset	811 struct SDL_SysWMinfo;
a1ebb17f9c52 Cleaned up a bunch of warnings, started adding Win32 event support Sam Lantinga <slouken@libsdl.org> parents: 1719 diff changeset	812 extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_WindowID windowID,
a1ebb17f9c52 Cleaned up a bunch of warnings, started adding Win32 event support Sam Lantinga <slouken@libsdl.org> parents: 1719 diff changeset	813 struct SDL_SysWMinfo
a1ebb17f9c52 Cleaned up a bunch of warnings, started adding Win32 event support Sam Lantinga <slouken@libsdl.org> parents: 1719 diff changeset	814 *info);
a1ebb17f9c52 Cleaned up a bunch of warnings, started adding Win32 event support Sam Lantinga <slouken@libsdl.org> parents: 1719 diff changeset	815
a1ebb17f9c52 Cleaned up a bunch of warnings, started adding Win32 event support Sam Lantinga <slouken@libsdl.org> parents: 1719 diff changeset	816 /**
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	817 * \fn void SDL_DestroyWindow(SDL_WindowID windowID)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	818 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	819 * \brief Destroy a window.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	820 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	821 extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_WindowID windowID);
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	822
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	823 /**
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	824 * \fn int SDL_GetNumRenderers(void)
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	825 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	826 * \brief Get the number of render managers on the current display.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	827 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	828 * A render manager is a set of code that handles rendering and texture
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	829 * management on a particular display. Normally there is only one, but
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	830 * some drivers may have several available with different capabilities.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	831 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	832 * \sa SDL_GetRendererInfo()
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	833 * \sa SDL_CreateRenderer()
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	834 */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	835 extern DECLSPEC int SDLCALL SDL_GetNumRenderers(void);
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	836
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	837 /**
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	838 * \fn SDL_RendererInfo *SDL_GetRendererInfo(int index)
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	839 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	840 * \brief Get information about a specific render manager on the current
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	841 * display.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	842 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	843 * \sa SDL_CreateRenderer()
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	844 */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	845 extern DECLSPEC int SDLCALL SDL_GetRendererInfo(int index,
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	846 SDL_RendererInfo * info);
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	847
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	848 /**
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	849 * \fn int SDL_CreateRenderer(SDL_WindowID window, int index, Uint32 flags)
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	850 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	851 * \brief Create and make active a 2D rendering context for a window.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	852 *
1719 5b9f50c957ed You can now create multiple windows on Win32 Sam Lantinga <slouken@libsdl.org> parents: 1707 diff changeset	853 * \param windowID The window used for rendering
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	854 * \param index The index of the render manager to initialize, or -1 to initialize the first one supporting the requested flags.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	855 * \param flags SDL_RendererFlags
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	856 *
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	857 * \return 0 on success, -1 if the flags were not supported, or -2 if
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	858 * there isn't enough memory to support the requested flags
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	859 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	860 * \sa SDL_SelectRenderer()
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	861 * \sa SDL_DestroyRenderer()
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	862 */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	863 extern DECLSPEC int SDLCALL SDL_CreateRenderer(SDL_WindowID windowID,
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	864 int index, Uint32 flags);
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	865
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	866 /**
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	867 * \fn int SDL_SelectRenderer(SDL_WindowID windowID)
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	868 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	869 * \brief Select the rendering context for a particular window.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	870 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	871 * \return 0 on success, -1 if the selected window doesn't have a
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	872 * rendering context.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	873 */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	874 extern DECLSPEC int SDLCALL SDL_SelectRenderer(SDL_WindowID windowID);
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	875
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	876 /**
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	877 * \fn SDL_TextureID SDL_CreateTexture(Uint32 format, int access, int w, int h)
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	878 *
1706 1577404809f0 Added a multi-window version of testsprite using the new API. Sam Lantinga <slouken@libsdl.org> parents: 1683 diff changeset	879 * \brief Create a texture for the current rendering context.
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	880 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	881 * \param format The format of the texture
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	882 * \param access One of the enumerated values in SDL_TextureAccess
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	883 * \param w The width of the texture in pixels
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	884 * \param h The height of the texture in pixels
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	885 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	886 * \return The created texture is returned, or 0 if no render manager was active, the format was unsupported, or the width or height were out of range.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	887 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	888 * \sa SDL_QueryTexture()
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	889 * \sa SDL_DestroyTexture()
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	890 */
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	891 extern DECLSPEC SDL_TextureID SDLCALL SDL_CreateTexture(Uint32 format,
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	892 int access, int w,
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	893 int h);
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	894
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	895 /**
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	896 * \fn SDL_TextureID SDL_CreateTextureFromSurface(Uint32 format, int access, SDL_Surface *surface)
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	897 *
1678 90bf530ced8e SDL_SetVideoMode() compiles now... Sam Lantinga <slouken@libsdl.org> parents: 1676 diff changeset	898 * \brief Create a texture from an existing surface.
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	899 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	900 * \param format The format of the texture, or 0 to pick an appropriate format
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	901 * \param access One of the enumerated values in SDL_TextureAccess
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	902 * \param surface The surface containing pixel data used to fill the texture
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	903 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	904 * \return The created texture is returned, or 0 if no render manager was active, the format was unsupported, or the surface width or height were out of range.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	905 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	906 * \note The surface is not modified or freed by this function.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	907 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	908 * \sa SDL_QueryTexture()
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	909 * \sa SDL_DestroyTexture()
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	910 */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	911 extern DECLSPEC SDL_TextureID SDLCALL SDL_CreateTextureFromSurface(Uint32
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	912 format,
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	913 int access,
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	914 SDL_Surface
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	915 * surface);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	916
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	917 /**
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	918 * \fn int SDL_QueryTexture(SDL_TextureID textureID, Uint32 format, int access, int w, int h)
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	919 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	920 * \brief Query the attributes of a texture
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	921 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	922 * \param texture A texture to be queried
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	923 * \param format A pointer filled in with the raw format of the texture. The actual format may differ, but pixel transfers will use this format.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	924 * \param access A pointer filled in with the actual access to the texture.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	925 * \param w A pointer filled in with the width of the texture in pixels
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	926 * \param h A pointer filled in with the height of the texture in pixels
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	927 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	928 * \return 0 on success, or -1 if the texture is not valid
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	929 */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	930 extern DECLSPEC int SDLCALL SDL_QueryTexture(SDL_TextureID textureID,
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	931 Uint32 * format, int *access,
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	932 int w, int h);
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	933
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	934 /**
1678 90bf530ced8e SDL_SetVideoMode() compiles now... Sam Lantinga <slouken@libsdl.org> parents: 1676 diff changeset	935 * \fn int SDL_QueryTexturePixels(SDL_TextureID textureID, void **pixels, int pitch)
90bf530ced8e SDL_SetVideoMode() compiles now... Sam Lantinga <slouken@libsdl.org> parents: 1676 diff changeset	936 *
90bf530ced8e SDL_SetVideoMode() compiles now... Sam Lantinga <slouken@libsdl.org> parents: 1676 diff changeset	937 * \brief Query the pixels of a texture, if the texture does not need to be locked for pixel access.
90bf530ced8e SDL_SetVideoMode() compiles now... Sam Lantinga <slouken@libsdl.org> parents: 1676 diff changeset	938 *
90bf530ced8e SDL_SetVideoMode() compiles now... Sam Lantinga <slouken@libsdl.org> parents: 1676 diff changeset	939 * \param texture A texture to be queried, which was created with SDL_TextureAccess_Local
90bf530ced8e SDL_SetVideoMode() compiles now... Sam Lantinga <slouken@libsdl.org> parents: 1676 diff changeset	940 * \param pixels A pointer filled with a pointer to the pixels for the texture
90bf530ced8e SDL_SetVideoMode() compiles now... Sam Lantinga <slouken@libsdl.org> parents: 1676 diff changeset	941 * \param pitch A pointer filled in with the pitch of the pixel data
90bf530ced8e SDL_SetVideoMode() compiles now... Sam Lantinga <slouken@libsdl.org> parents: 1676 diff changeset	942 *
90bf530ced8e SDL_SetVideoMode() compiles now... Sam Lantinga <slouken@libsdl.org> parents: 1676 diff changeset	943 * \return 0 on success, or -1 if the texture is not valid, or must be locked for pixel access.
90bf530ced8e SDL_SetVideoMode() compiles now... Sam Lantinga <slouken@libsdl.org> parents: 1676 diff changeset	944 */
90bf530ced8e SDL_SetVideoMode() compiles now... Sam Lantinga <slouken@libsdl.org> parents: 1676 diff changeset	945 extern DECLSPEC int SDLCALL SDL_QueryTexturePixels(SDL_TextureID textureID,
90bf530ced8e SDL_SetVideoMode() compiles now... Sam Lantinga <slouken@libsdl.org> parents: 1676 diff changeset	946 void *pixels, int pitch);
90bf530ced8e SDL_SetVideoMode() compiles now... Sam Lantinga <slouken@libsdl.org> parents: 1676 diff changeset	947
90bf530ced8e SDL_SetVideoMode() compiles now... Sam Lantinga <slouken@libsdl.org> parents: 1676 diff changeset	948 /**
1681 80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	949 * \fn int SDL_SetTexturePalette(SDL_TextureID textureID, const SDL_Color * colors, int firstcolor, int ncolors)
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	950 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	951 * \brief Update an indexed texture with a color palette
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	952 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	953 * \param texture The texture to update
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	954 * \param colors The array of RGB color data
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	955 * \param firstcolor The first index to update
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	956 * \param ncolors The number of palette entries to fill with the color data
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	957 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	958 * \return 0 on success, or -1 if the texture is not valid or not an indexed texture
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	959 */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	960 extern DECLSPEC int SDLCALL SDL_SetTexturePalette(SDL_TextureID textureID,
1681 80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	961 const SDL_Color * colors,
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	962 int firstcolor,
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	963 int ncolors);
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	964
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	965 /**
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	966 * \fn int SDL_GetTexturePalette(SDL_TextureID textureID, SDL_Color * colors, int firstcolor, int ncolors)
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	967 *
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	968 * \brief Update an indexed texture with a color palette
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	969 *
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	970 * \param texture The texture to update
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	971 * \param colors The array to fill with RGB color data
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	972 * \param firstcolor The first index to retrieve
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	973 * \param ncolors The number of palette entries to retrieve
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	974 *
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	975 * \return 0 on success, or -1 if the texture is not valid or not an indexed texture
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	976 */
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	977 extern DECLSPEC int SDLCALL SDL_GetTexturePalette(SDL_TextureID textureID,
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	978 SDL_Color * colors,
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	979 int firstcolor,
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	980 int ncolors);
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	981
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	982 /**
1681 80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	983 * \fn int SDL_UpdateTexture(SDL_TextureID textureID, const SDL_Rect rect, const void pixels, int pitch)
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	984 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	985 * \brief Update the given texture rectangle with new pixel data.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	986 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	987 * \param texture The texture to update
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	988 * \param rect A pointer to the rectangle of pixels to update, or NULL to update the entire texture.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	989 * \param pixels The raw pixel data
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	990 * \param pitch The number of bytes between rows of pixel data
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	991 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	992 * \return 0 on success, or -1 if the texture is not valid
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	993 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	994 * \note This is a very slow function for textures not created with SDL_TextureAccess_Local.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	995 */
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	996 extern DECLSPEC int SDLCALL SDL_UpdateTexture(SDL_TextureID textureID,
1681 80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	997 const SDL_Rect * rect,
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	998 const void *pixels, int pitch);
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	999
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1000 /**
1681 80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	1001 * \fn void SDL_LockTexture(SDL_TextureID textureID, const SDL_Rect rect, int markDirty, void pixels, int pitch)
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1002 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1003 * \brief Lock a portion of the texture for pixel access.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1004 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1005 * \param texture The texture to lock for access, which must have been created with SDL_TextureAccess_Local.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1006 * \param rect A pointer to the rectangle to lock for access. If the rect is NULL, the entire texture will be locked.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1007 * \param markDirty If this is nonzero, the locked area will be marked dirty when the texture is unlocked.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1008 * \param pixels This is filled in with a pointer to the locked pixels, appropriately offset by the locked area.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1009 * \param pitch This is filled in with the pitch of the locked pixels.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1010 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1011 * \return 0 on success, or -1 if the texture is not valid or was created with SDL_TextureAccess_Remote
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1012 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1013 * \sa SDL_DirtyTexture()
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1014 * \sa SDL_UnlockTexture()
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1015 */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1016 extern DECLSPEC int SDLCALL SDL_LockTexture(SDL_TextureID textureID,
1681 80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	1017 const SDL_Rect * rect,
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	1018 int markDirty, void **pixels,
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	1019 int *pitch);
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1020
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1021 /**
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1022 * \fn void SDL_UnlockTexture(SDL_TextureID textureID)
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1023 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1024 * \brief Unlock a texture, uploading the changes to video memory, if needed.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1025 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1026 * \sa SDL_LockTexture()
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1027 * \sa SDL_DirtyTexture()
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1028 */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1029 extern DECLSPEC void SDLCALL SDL_UnlockTexture(SDL_TextureID textureID);
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1030
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1031 /**
1681 80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	1032 * \fn void SDL_DirtyTexture(SDL_TextureID textureID, int numrects, const SDL_Rect * rects)
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1033 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1034 * \brief Mark the specified rectangles of the texture as dirty.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1035 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1036 * \note The texture must have been created with SDL_TextureAccess_Local.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1037 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1038 * \sa SDL_LockTexture()
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1039 * \sa SDL_UnlockTexture()
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1040 */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1041 extern DECLSPEC void SDLCALL SDL_DirtyTexture(SDL_TextureID textureID,
1681 80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	1042 int numrects,
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	1043 const SDL_Rect * rects);
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1044
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1045 /**
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1046 * \fn void SDL_SelectRenderTexture(SDL_TextureID textureID)
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1047 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1048 * \brief Select a texture as the rendering target, or 0 to reselect the current window.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1049 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1050 * \note The texture must have been created with SDL_TextureAccess_Render.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1051 */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1052 extern DECLSPEC void SDLCALL SDL_SelectRenderTexture(SDL_TextureID textureID);
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1053
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1054 /**
1681 80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	1055 * \fn void SDL_RenderFill(const SDL_Rect *rect, Uint32 color)
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1056 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1057 * \brief Fill the current rendering target with the specified color.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1058 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1059 * \param rect A pointer to the destination rectangle, or NULL for the entire rendering target.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1060 * \param color An ARGB color value.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1061 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1062 * \return 0 on success, or -1 if there is no renderer current
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1063 */
1681 80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	1064 extern DECLSPEC int SDLCALL SDL_RenderFill(const SDL_Rect * rect,
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	1065 Uint32 color);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1066
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1067 /**
1681 80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	1068 * \fn int SDL_RenderCopy(SDL_TextureID textureID, const SDL_Rect srcrect, const SDL_Rect dstrect, Uint32 blendMode, Uint32 scaleMode)
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1069 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1070 * \brief Copy a portion of the texture to the current rendering target.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1071 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1072 * \param texture The source texture.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1073 * \param srcrect A pointer to the source rectangle, or NULL for the entire texture.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1074 * \param dstrect A pointer to the destination rectangle, or NULL for the entire rendering target.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1075 * \param blendMode SDL_TextureBlendMode to be used if the source texture has an alpha channel.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1076 * \param scaleMode SDL_TextureScaleMode to be used if the source and destination rectangles don't have the same width and height.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1077 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1078 * \return 0 on success, or -1 if there is no renderer current, or the driver doesn't support the requested operation.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1079 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1080 * \note You can check the video driver info to see what operations are supported.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1081 */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1082 extern DECLSPEC int SDLCALL SDL_RenderCopy(SDL_TextureID textureID,
1681 80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	1083 const SDL_Rect * srcrect,
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	1084 const SDL_Rect * dstrect,
80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	1085 int blendMode, int scaleMode);
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1086
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1087 /**
1681 80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	1088 * \fn int SDL_RenderReadPixels(const SDL_Rect rect, void pixels, int pitch)
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1089 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1090 * \brief Read pixels from the current rendering target.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1091 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1092 * \param rect A pointer to the rectangle to read, or NULL for the entire render target
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1093 * \param pixels A pointer to be filled in with the pixel data
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1094 * \param pitch The pitch of the pixels parameter
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1095 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1096 * \return 0 on success, or -1 if pixel reading is not supported.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1097 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1098 * \warning This is a very slow operation, and should not be used frequently.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1099 */
1681 80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	1100 extern DECLSPEC int SDLCALL SDL_RenderReadPixels(const SDL_Rect * rect,
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1101 void *pixels, int pitch);
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1102
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1103 /**
1681 80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	1104 * \fn int SDL_RenderWritePixels(const SDL_Rect rect, const void pixels, int pitch)
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1105 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1106 * \brief Write pixels to the current rendering target.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1107 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1108 * \param rect A pointer to the rectangle to write, or NULL for the entire render target
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1109 * \param pixels A pointer to the pixel data to write
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1110 * \param pitch The pitch of the pixels parameter
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1111 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1112 * \return 0 on success, or -1 if pixel writing is not supported.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1113 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1114 * \warning This is a very slow operation, and should not be used frequently.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1115 */
1681 80a5e6a4e1e2 Working on paletted display and texture support (two different issues) Sam Lantinga <slouken@libsdl.org> parents: 1678 diff changeset	1116 extern DECLSPEC int SDLCALL SDL_RenderWritePixels(const SDL_Rect * rect,
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1117 const void *pixels,
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1118 int pitch);
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1119
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1120 /**
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1121 * \fn void SDL_RenderPresent(void)
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1122 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1123 * \brief Update the screen with rendering performed.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1124 */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1125 extern DECLSPEC void SDLCALL SDL_RenderPresent(void);
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1126
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1127 /**
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1128 * \fn void SDL_DestroyTexture(SDL_TextureID textureID);
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1129 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1130 * \brief Destroy the specified texture.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1131 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1132 * \sa SDL_CreateTexture()
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1133 * \sa SDL_CreateTextureFromSurface()
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1134 */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1135 extern DECLSPEC void SDLCALL SDL_DestroyTexture(SDL_TextureID textureID);
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1136
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1137 /**
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1138 * \fn void SDL_DestroyRenderer(SDL_WindowID windowID);
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1139 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1140 * \brief Destroy the rendering context for a window and free associated
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1141 * textures.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1142 *
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1143 * \sa SDL_CreateRenderer()
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1144 */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1145 extern DECLSPEC void SDLCALL SDL_DestroyRenderer(SDL_WindowID windowID);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1146
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1147 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1148 * Maps an RGB triple to an opaque pixel value for a given pixel format
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1149 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	1150 extern DECLSPEC Uint32 SDLCALL SDL_MapRGB
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	1151 (SDL_PixelFormat * format, Uint8 r, Uint8 g, Uint8 b);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1152
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1153 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1154 * Maps an RGBA quadruple to a pixel value for a given pixel format
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1155 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1156 extern DECLSPEC Uint32 SDLCALL SDL_MapRGBA(SDL_PixelFormat * format,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1157 Uint8 r, Uint8 g, Uint8 b,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1158 Uint8 a);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1159
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1160 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1161 * Maps a pixel value into the RGB components for a given pixel format
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1162 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1163 extern DECLSPEC void SDLCALL SDL_GetRGB(Uint32 pixel, SDL_PixelFormat * fmt,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1164 Uint8 * r, Uint8 * g, Uint8 * b);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1165
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1166 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1167 * Maps a pixel value into the RGBA components for a given pixel format
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1168 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1169 extern DECLSPEC void SDLCALL SDL_GetRGBA(Uint32 pixel, SDL_PixelFormat * fmt,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1170 Uint8 * r, Uint8 * g, Uint8 * b,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1171 Uint8 * a);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1172
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1173 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1174 * Allocate and free an RGB surface (must be called after SDL_SetVideoMode)
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1175 * If the depth is 4 or 8 bits, an empty palette is allocated for the surface.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1176 * If the depth is greater than 8 bits, the pixel format is set using the
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1177 * flags '[RGB]mask'.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1178 * If the function runs out of memory, it will return NULL.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1179 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1180 * The 'flags' tell what kind of surface to create.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1181 * SDL_SRCCOLORKEY indicates that the surface will be used for colorkey blits.
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1182 * SDL_SRCALPHA means that the surface will be used for alpha blits.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1183 */
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	1184 extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateRGBSurface
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	1185 (Uint32 flags, int width, int height, int depth,
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	1186 Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask);
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1187 extern DECLSPEC SDL_Surface SDLCALL SDL_CreateRGBSurfaceFrom(void pixels,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1188 int width,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1189 int height,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1190 int depth,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1191 int pitch,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1192 Uint32 Rmask,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1193 Uint32 Gmask,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1194 Uint32 Bmask,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1195 Uint32 Amask);
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1196 extern DECLSPEC SDL_Surface *SDLCALL
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1197 SDL_CreateRGBSurfaceFromTexture(SDL_TextureID textureID);
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1198 extern DECLSPEC void SDLCALL SDL_FreeSurface(SDL_Surface * surface);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1199
1683 396a35389351 Finished palettized display handling. Sam Lantinga <slouken@libsdl.org> parents: 1682 diff changeset	1200 /**
396a35389351 Finished palettized display handling. Sam Lantinga <slouken@libsdl.org> parents: 1682 diff changeset	1201 * \fn int SDL_SetSurfacePalette(SDL_Surface surface, SDL_Palette palette)
396a35389351 Finished palettized display handling. Sam Lantinga <slouken@libsdl.org> parents: 1682 diff changeset	1202 *
396a35389351 Finished palettized display handling. Sam Lantinga <slouken@libsdl.org> parents: 1682 diff changeset	1203 * \brief Set the palette used by a surface.
396a35389351 Finished palettized display handling. Sam Lantinga <slouken@libsdl.org> parents: 1682 diff changeset	1204 *
396a35389351 Finished palettized display handling. Sam Lantinga <slouken@libsdl.org> parents: 1682 diff changeset	1205 * \return 0, or -1 if the surface format doesn't use a palette.
396a35389351 Finished palettized display handling. Sam Lantinga <slouken@libsdl.org> parents: 1682 diff changeset	1206 *
396a35389351 Finished palettized display handling. Sam Lantinga <slouken@libsdl.org> parents: 1682 diff changeset	1207 * \note A single palette can be shared with many surfaces.
396a35389351 Finished palettized display handling. Sam Lantinga <slouken@libsdl.org> parents: 1682 diff changeset	1208 */
396a35389351 Finished palettized display handling. Sam Lantinga <slouken@libsdl.org> parents: 1682 diff changeset	1209 extern DECLSPEC int SDLCALL SDL_SetSurfacePalette(SDL_Surface * surface,
396a35389351 Finished palettized display handling. Sam Lantinga <slouken@libsdl.org> parents: 1682 diff changeset	1210 SDL_Palette * palette);
396a35389351 Finished palettized display handling. Sam Lantinga <slouken@libsdl.org> parents: 1682 diff changeset	1211
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1212 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1213 * SDL_LockSurface() sets up a surface for directly accessing the pixels.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1214 * Between calls to SDL_LockSurface()/SDL_UnlockSurface(), you can write
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1215 * to and read from 'surface->pixels', using the pixel format stored in
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1216 * 'surface->format'. Once you are done accessing the surface, you should
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1217 * use SDL_UnlockSurface() to release it.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1218 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1219 * Not all surfaces require locking. If SDL_MUSTLOCK(surface) evaluates
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1220 * to 0, then you can read and write to the surface at any time, and the
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1221 * pixel format of the surface will not change.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1222 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1223 * No operating system or library calls should be made between lock/unlock
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1224 * pairs, as critical system locks may be held during this time.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1225 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1226 * SDL_LockSurface() returns 0, or -1 if the surface couldn't be locked.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1227 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1228 extern DECLSPEC int SDLCALL SDL_LockSurface(SDL_Surface * surface);
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1229 extern DECLSPEC void SDLCALL SDL_UnlockSurface(SDL_Surface * surface);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1230
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1231 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1232 * Load a surface from a seekable SDL data source (memory or file.)
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1233 * If 'freesrc' is non-zero, the source will be closed after being read.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1234 * Returns the new surface, or NULL if there was an error.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1235 * The new surface should be freed with SDL_FreeSurface().
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1236 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1237 extern DECLSPEC SDL_Surface SDLCALL SDL_LoadBMP_RW(SDL_RWops src,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1238 int freesrc);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1239
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1240 /* Convenience macro -- load a surface from a file */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1241 #define SDL_LoadBMP(file) SDL_LoadBMP_RW(SDL_RWFromFile(file, "rb"), 1)
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1242
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1243 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1244 * Save a surface to a seekable SDL data source (memory or file.)
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1245 * If 'freedst' is non-zero, the source will be closed after being written.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1246 * Returns 0 if successful or -1 if there was an error.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1247 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	1248 extern DECLSPEC int SDLCALL SDL_SaveBMP_RW
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	1249 (SDL_Surface * surface, SDL_RWops * dst, int freedst);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1250
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1251 /* Convenience macro -- save a surface to a file */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1252 #define SDL_SaveBMP(surface, file) \
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1253 SDL_SaveBMP_RW(surface, SDL_RWFromFile(file, "wb"), 1)
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1254
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1255 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1256 * Sets the color key (transparent pixel) in a blittable surface.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1257 * If 'flag' is SDL_SRCCOLORKEY (optionally OR'd with SDL_RLEACCEL),
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1258 * 'key' will be the transparent pixel in the source image of a blit.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1259 * SDL_RLEACCEL requests RLE acceleration for the surface if present,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1260 * and removes RLE acceleration if absent.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1261 * If 'flag' is 0, this function clears any current color key.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1262 * This function returns 0, or -1 if there was an error.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1263 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	1264 extern DECLSPEC int SDLCALL SDL_SetColorKey
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	1265 (SDL_Surface * surface, Uint32 flag, Uint32 key);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1266
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1267 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1268 * This function sets the alpha value for the entire surface, as opposed to
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1269 * using the alpha component of each pixel. This value measures the range
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1270 * of transparency of the surface, 0 being completely transparent to 255
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1271 * being completely opaque. An 'alpha' value of 255 causes blits to be
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1272 * opaque, the source pixels copied to the destination (the default). Note
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1273 * that per-surface alpha can be combined with colorkey transparency.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1274 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1275 * If 'flag' is 0, alpha blending is disabled for the surface.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1276 * If 'flag' is SDL_SRCALPHA, alpha blending is enabled for the surface.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1277 * OR:ing the flag with SDL_RLEACCEL requests RLE acceleration for the
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1278 * surface; if SDL_RLEACCEL is not specified, the RLE accel will be removed.
432 80a35d43a58f * empty log message * Sam Lantinga <slouken@libsdl.org> parents: 431 diff changeset	1279 *
80a35d43a58f * empty log message * Sam Lantinga <slouken@libsdl.org> parents: 431 diff changeset	1280 * The 'alpha' parameter is ignored for surfaces that have an alpha channel.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1281 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1282 extern DECLSPEC int SDLCALL SDL_SetAlpha(SDL_Surface * surface, Uint32 flag,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1283 Uint8 alpha);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1284
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1285 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1286 * Sets the clipping rectangle for the destination surface in a blit.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1287 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1288 * If the clip rectangle is NULL, clipping will be disabled.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1289 * If the clip rectangle doesn't intersect the surface, the function will
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1290 * return SDL_FALSE and blits will be completely clipped. Otherwise the
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1291 * function returns SDL_TRUE and blits to the surface will be clipped to
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1292 * the intersection of the surface area and the clipping rectangle.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1293 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1294 * Note that blits are automatically clipped to the edges of the source
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1295 * and destination surfaces.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1296 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1297 extern DECLSPEC SDL_bool SDLCALL SDL_SetClipRect(SDL_Surface * surface,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1298 const SDL_Rect * rect);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1299
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1300 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1301 * Gets the clipping rectangle for the destination surface in a blit.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1302 * 'rect' must be a pointer to a valid rectangle which will be filled
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1303 * with the correct values.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1304 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1305 extern DECLSPEC void SDLCALL SDL_GetClipRect(SDL_Surface * surface,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1306 SDL_Rect * rect);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1307
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1308 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1309 * Creates a new surface of the specified format, and then copies and maps
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1310 * the given surface to it so the blit of the converted surface will be as
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1311 * fast as possible. If this function fails, it returns NULL.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1312 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1313 * The 'flags' parameter is passed to SDL_CreateRGBSurface() and has those
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1314 * semantics. You can also pass SDL_RLEACCEL in the flags parameter and
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1315 * SDL will try to RLE accelerate colorkey and alpha blits in the resulting
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1316 * surface.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1317 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1318 * This function is used internally by SDL_DisplayFormat().
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1319 */
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	1320 extern DECLSPEC SDL_Surface *SDLCALL SDL_ConvertSurface
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	1321 (SDL_Surface * src, SDL_PixelFormat * fmt, Uint32 flags);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1322
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1323 /*
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1324 * This function performs a fast fill of the given rectangle with 'color'
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1325 * The given rectangle is clipped to the destination surface clip area
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1326 * and the final fill rectangle is saved in the passed in pointer.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1327 * If 'dstrect' is NULL, the whole surface will be filled with 'color'
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1328 * The color should be a pixel of the format used by the surface, and
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1329 * can be generated by the SDL_MapRGB() function.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1330 * This function returns 0 on success, or -1 on error.
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1331 */
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1332 extern DECLSPEC int SDLCALL SDL_FillRect
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1333 (SDL_Surface * dst, SDL_Rect * dstrect, Uint32 color);
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1334
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1335 /*
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1336 * This performs a fast blit from the source surface to the destination
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1337 * surface. It assumes that the source and destination rectangles are
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1338 * the same size. If either 'srcrect' or 'dstrect' are NULL, the entire
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1339 * surface (src or dst) is copied. The final blit rectangles are saved
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1340 * in 'srcrect' and 'dstrect' after all clipping is performed.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1341 * If the blit is successful, it returns 0, otherwise it returns -1.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1342 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1343 * The blit function should not be called on a locked surface.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1344 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1345 * The blit semantics for surfaces with and without alpha and colorkey
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1346 * are defined as follows:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1347 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1348 * RGBA->RGB:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1349 * SDL_SRCALPHA set:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1350 * alpha-blend (using alpha-channel).
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1351 * SDL_SRCCOLORKEY ignored.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1352 * SDL_SRCALPHA not set:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1353 * copy RGB.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1354 * if SDL_SRCCOLORKEY set, only copy the pixels matching the
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1355 * RGB values of the source colour key, ignoring alpha in the
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1356 * comparison.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1357 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1358 * RGB->RGBA:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1359 * SDL_SRCALPHA set:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1360 * alpha-blend (using the source per-surface alpha value);
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1361 * set destination alpha to opaque.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1362 * SDL_SRCALPHA not set:
431 41cadcba32e8 Fixed SDL_DisplayFormatAlpha() on RGB surfaces with alpha Sam Lantinga <slouken@libsdl.org> parents: 337 diff changeset	1363 * copy RGB, set destination alpha to source per-surface alpha value.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1364 * both:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1365 * if SDL_SRCCOLORKEY set, only copy the pixels matching the
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1366 * source colour key.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1367 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1368 * RGBA->RGBA:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1369 * SDL_SRCALPHA set:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1370 * alpha-blend (using the source alpha channel) the RGB values;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1371 * leave destination alpha untouched. [Note: is this correct?]
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1372 * SDL_SRCCOLORKEY ignored.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1373 * SDL_SRCALPHA not set:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1374 * copy all of RGBA to the destination.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1375 * if SDL_SRCCOLORKEY set, only copy the pixels matching the
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1376 * RGB values of the source colour key, ignoring alpha in the
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1377 * comparison.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1378 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1379 * RGB->RGB:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1380 * SDL_SRCALPHA set:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1381 * alpha-blend (using the source per-surface alpha value).
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1382 * SDL_SRCALPHA not set:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1383 * copy RGB.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1384 * both:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1385 * if SDL_SRCCOLORKEY set, only copy the pixels matching the
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1386 * source colour key.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1387 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1388 * If either of the surfaces were in video memory, and the blit returns -2,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1389 * the video memory was lost, so it should be reloaded with artwork and
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1390 * re-blitted:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1391 while ( SDL_BlitSurface(image, imgrect, screen, dstrect) == -2 ) {
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1392 while ( SDL_LockSurface(image) < 0 )
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1393 Sleep(10);
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1394 -- Write image pixels to image->pixels --
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1395 SDL_UnlockSurface(image);
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1396 }
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1397 * This happens under DirectX 5.0 when the system switches away from your
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1398 * fullscreen application. The lock will also fail until you have access
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1399 * to the video memory again.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1400 */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1401 /* You should call SDL_BlitSurface() unless you know exactly how SDL
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1402 blitting works internally and how to use the other blit functions.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1403 */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1404 #define SDL_BlitSurface SDL_UpperBlit
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1405
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1406 /* This is the public blit function, SDL_BlitSurface(), and it performs
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1407 rectangle validation and clipping before passing it to SDL_LowerBlit()
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1408 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	1409 extern DECLSPEC int SDLCALL SDL_UpperBlit
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	1410 (SDL_Surface * src, SDL_Rect * srcrect,
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	1411 SDL_Surface * dst, SDL_Rect * dstrect);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1412 /* This is a semi-private blit function and it performs low-level surface
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1413 blitting only.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1414 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	1415 extern DECLSPEC int SDLCALL SDL_LowerBlit
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	1416 (SDL_Surface * src, SDL_Rect * srcrect,
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	1417 SDL_Surface * dst, SDL_Rect * dstrect);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1418
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1419 /**
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1420 * \fn int SDL_SoftStretch(SDL_Surface * src, SDL_Rect * srcrect, SDL_Surface * dst, SDL_Rect * dstrect)
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1421 *
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1422 * \brief Perform a fast, low quality, stretch blit between two surfaces of the same pixel format.
1727 90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1423 *
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1424 * \note This function uses a static buffer, and is not thread-safe.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1425 */
1670 eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1426 extern DECLSPEC int SDLCALL SDL_SoftStretch(SDL_Surface * src,
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1427 SDL_Rect * srcrect,
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1428 SDL_Surface * dst,
eef792d31de8 Work in progress. :) Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	1429 SDL_Rect * dstrect);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1430
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1431 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1432 /* OpenGL support functions. */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1433 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1434
1727 90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1435 /**
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1436 * \fn int SDL_GL_LoadLibrary(const char *path)
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1437 *
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1438 * \brief Dynamically load an OpenGL library.
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1439 *
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1440 * \param path The platform dependent OpenGL library name, or NULL to open the default OpenGL library
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1441 *
1727 90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1442 * \return 0 on success, or -1 if the library couldn't be loaded
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1443 *
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1444 * \note If you do this, you need to retrieve all of the GL functions used in
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1445 * your program from the dynamic library using SDL_GL_GetProcAddress().
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1446 *
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1447 * \sa SDL_GL_GetProcAddress()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1448 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1449 extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1450
1727 90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1451 /**
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1452 * \fn void SDL_GL_GetProcAddress(const char proc)
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1453 *
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1454 * \brief Get the address of an OpenGL function.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1455 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1456 extern DECLSPEC void SDLCALL SDL_GL_GetProcAddress(const char proc);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1457
1727 90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1458 /**
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1459 * \fn int SDL_GL_SetAttribute(SDL_GLattr attr, int value)
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1460 *
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1461 * \brief Set an OpenGL window attribute before window creation.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1462 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1463 extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1464
1727 90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1465 /**
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1466 * \fn int SDL_GL_GetWindowAttribute(SDL_WindowID windowID, SDL_GLattr attr, int *value)
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1467 *
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1468 * \brief Get the actual value for an OpenGL window attribute.
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1469 */
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1470 extern DECLSPEC int SDLCALL SDL_GL_GetWindowAttribute(SDL_WindowID windowID,
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1471 SDL_GLattr attr,
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1472 int *value);
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1473
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1474 /**
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1475 * \fn SDL_GLContext SDL_GL_CreateContext(SDL_WindowID windowID)
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1476 *
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1477 * \brief Create an OpenGL context for use with an OpenGL window, and make it current.
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1478 *
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1479 * \sa SDL_GL_DeleteContext()
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1480 */
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1481 extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_WindowID
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1482 windowID);
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1483
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1484 /**
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1485 * \fn int SDL_GL_MakeCurrent(SDL_WindowID windowID, SDL_GLContext context)
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1486 *
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1487 * \brief Set up an OpenGL context for rendering into an OpenGL window.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1488 *
1727 90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1489 * \note The context must have been created with a compatible window.
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1490 */
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1491 extern DECLSPEC int SDLCALL SDL_GL_MakeCurrent(SDL_WindowID windowID,
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1492 SDL_GLContext context);
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1493
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1494 /**
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1495 * \fn int SDL_GL_SetSwapInterval(int interval)
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1496 *
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1497 * \brief Set the swap interval for the current OpenGL context.
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1498 *
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1499 * \sa SDL_GL_GetSwapInterval()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1500 */
1727 90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1501 extern DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1502
1727 90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1503 /**
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1504 * \fn int SDL_GL_GetSwapInterval(void)
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1505 *
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1506 * \brief Get the swap interval for the current OpenGL context.
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1507 *
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1508 * \sa SDL_GL_SetSwapInterval()
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1509 */
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1510 extern DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(void);
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1511
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1512 /**
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1513 * \fn void SDL_GL_SwapBuffers(void)
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1514 *
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1515 * Swap the OpenGL buffers, if double-buffering is supported.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1516 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	1517 extern DECLSPEC void SDLCALL SDL_GL_SwapBuffers(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1518
1727 90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1519 /**
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1520 * \fn void SDL_GL_DeleteContext(SDL_GLContext context)
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1521 *
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1522 * \brief Delete an OpenGL context.
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1523 *
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1524 * \sa SDL_GL_CreateContext()
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1525 */
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1526 extern DECLSPEC void SDLCALL SDL_GL_DeleteContext(SDL_GLContext context);
90a3e0fccb88 Started on the OpenGL API revamp. Sam Lantinga <slouken@libsdl.org> parents: 1725 diff changeset	1527
1724 6c63fc2bd986 Proof of concept done - Win32 GDI implementation mostly complete. Sam Lantinga <slouken@libsdl.org> parents: 1722 diff changeset	1528 /*
6c63fc2bd986 Proof of concept done - Win32 GDI implementation mostly complete. Sam Lantinga <slouken@libsdl.org> parents: 1722 diff changeset	1529 * Calculate the intersection of two rectangles
6c63fc2bd986 Proof of concept done - Win32 GDI implementation mostly complete. Sam Lantinga <slouken@libsdl.org> parents: 1722 diff changeset	1530 */
6c63fc2bd986 Proof of concept done - Win32 GDI implementation mostly complete. Sam Lantinga <slouken@libsdl.org> parents: 1722 diff changeset	1531 extern DECLSPEC SDL_bool SDLCALL SDL_IntersectRect(const SDL_Rect * A,
6c63fc2bd986 Proof of concept done - Win32 GDI implementation mostly complete. Sam Lantinga <slouken@libsdl.org> parents: 1722 diff changeset	1532 const SDL_Rect * B,
6c63fc2bd986 Proof of concept done - Win32 GDI implementation mostly complete. Sam Lantinga <slouken@libsdl.org> parents: 1722 diff changeset	1533 SDL_Rect * intersection);
6c63fc2bd986 Proof of concept done - Win32 GDI implementation mostly complete. Sam Lantinga <slouken@libsdl.org> parents: 1722 diff changeset	1534
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1535 /* Ends C function definitions when using C++ */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1536 #ifdef __cplusplus
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	1537 /* INDENT-OFF */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1538 }
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	1539 /* INDENT-ON */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1540 #endif
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1541 #include "close_code.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1542
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1543 #endif /* _SDL_video_h */
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	1544
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1660 diff changeset	1545 /* vi: set ts=4 sw=4 expandtab: */

Mercurial > sdl-ios-xcode

annotate include/SDL_video.h @ 1734:f7c667ded87d SDL-1.3