sdl-ios-xcode: include/SDL

annotate include/SDL_video.h @ 5251:58265e606e4e

Window coordinates are in the global space and windows are not tied to a particular display. Also added Ctrl-Enter keybinding to the test code to toggle fullscreen mode for testing.

author	Sam Lantinga <slouken@libsdl.org>
date	Thu, 10 Feb 2011 14:44:25 -0800
parents	762e40fb8e28
children	b530ef003506

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
3697 f7b03b6838cb Fixed bug #926 Sam Lantinga <slouken@libsdl.org> parents: 3691 diff changeset	3 Copyright (C) 1997-2010 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
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	23 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	24 * \file SDL_video.h
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	25 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	26 * Header file for SDL video functions.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 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"
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	33 #include "SDL_pixels.h"
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: 2267 diff changeset	34 #include "SDL_rect.h"
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: 2267 diff changeset	35 #include "SDL_surface.h"
0 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
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	40 /* INDENT-OFF */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	41 extern "C" {
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 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
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	45 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	46 * \brief The structure that defines a display mode
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	47 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	48 * \sa SDL_GetNumDisplayModes()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	49 * \sa SDL_GetDisplayMode()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	50 * \sa SDL_GetDesktopDisplayMode()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	51 * \sa SDL_GetCurrentDisplayMode()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	52 * \sa SDL_GetClosestDisplayMode()
3500 4b594623401b Work in progress on multi-display support: Sam Lantinga <slouken@libsdl.org> parents: 3493 diff changeset	53 * \sa SDL_SetWindowDisplayMode()
4b594623401b Work in progress on multi-display support: Sam Lantinga <slouken@libsdl.org> parents: 3493 diff changeset	54 * \sa SDL_GetWindowDisplayMode()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	55 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	56 typedef struct
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	57 {
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	58 Uint32 format; /*< pixel format /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	59 int w; /*< width /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	60 int h; /*< height /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	61 int refresh_rate; /*< refresh rate (or zero for unspecified) /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	62 void driverdata; /< driver-specific data, initialize to 0 /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	63 } SDL_DisplayMode;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	64
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	65 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	66 * \brief The type used to identify a window
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	67 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	68 * \sa SDL_CreateWindow()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	69 * \sa SDL_CreateWindowFrom()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	70 * \sa SDL_DestroyWindow()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	71 * \sa SDL_GetWindowData()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	72 * \sa SDL_GetWindowFlags()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	73 * \sa SDL_GetWindowGrab()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	74 * \sa SDL_GetWindowPosition()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	75 * \sa SDL_GetWindowSize()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	76 * \sa SDL_GetWindowTitle()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	77 * \sa SDL_HideWindow()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	78 * \sa SDL_MaximizeWindow()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	79 * \sa SDL_MinimizeWindow()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	80 * \sa SDL_RaiseWindow()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	81 * \sa SDL_RestoreWindow()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	82 * \sa SDL_SetWindowData()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	83 * \sa SDL_SetWindowFullscreen()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	84 * \sa SDL_SetWindowGrab()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	85 * \sa SDL_SetWindowIcon()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	86 * \sa SDL_SetWindowPosition()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	87 * \sa SDL_SetWindowSize()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	88 * \sa SDL_SetWindowTitle()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	89 * \sa SDL_ShowWindow()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	90 */
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	91 typedef struct SDL_Window SDL_Window;
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	92
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	93 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	94 * \brief The flags on a window
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	95 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	96 * \sa SDL_GetWindowFlags()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	97 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	98 typedef enum
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	99 {
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	100 SDL_WINDOW_FULLSCREEN = 0x00000001, /*< fullscreen window, implies borderless /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	101 SDL_WINDOW_OPENGL = 0x00000002, /*< window usable with OpenGL context /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	102 SDL_WINDOW_SHOWN = 0x00000004, /*< window is visible /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	103 SDL_WINDOW_BORDERLESS = 0x00000008, /*< no window decoration /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	104 SDL_WINDOW_RESIZABLE = 0x00000010, /*< window can be resized /
3523 d38acda781ae Made the window flag comments more consistent Sam Lantinga <slouken@libsdl.org> parents: 3522 diff changeset	105 SDL_WINDOW_MINIMIZED = 0x00000020, /*< window is minimized /
d38acda781ae Made the window flag comments more consistent Sam Lantinga <slouken@libsdl.org> parents: 3522 diff changeset	106 SDL_WINDOW_MAXIMIZED = 0x00000040, /*< window is maximized /
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	107 SDL_WINDOW_INPUT_GRABBED = 0x00000100, /*< window has grabbed input focus /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	108 SDL_WINDOW_INPUT_FOCUS = 0x00000200, /*< window has input focus /
3057 089a77aebb7d Added test program for SDL_CreateWindowFrom() Sam Lantinga <slouken@libsdl.org> parents: 3033 diff changeset	109 SDL_WINDOW_MOUSE_FOCUS = 0x00000400, /*< window has mouse focus /
089a77aebb7d Added test program for SDL_CreateWindowFrom() Sam Lantinga <slouken@libsdl.org> parents: 3033 diff changeset	110 SDL_WINDOW_FOREIGN = 0x00000800 /*< window not created by SDL /
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	111 } SDL_WindowFlags;
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	112
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	113 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	114 * \brief Used to indicate that you don't care what the window position is.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	115 */
5251 58265e606e4e Window coordinates are in the global space and windows are not tied to a particular display. Sam Lantinga <slouken@libsdl.org> parents: 5249 diff changeset	116 #define SDL_WINDOWPOS_UNDEFINED_MASK 0x1FFF0000
58265e606e4e Window coordinates are in the global space and windows are not tied to a particular display. Sam Lantinga <slouken@libsdl.org> parents: 5249 diff changeset	117 #define SDL_WINDOWPOS_UNDEFINED_DISPLAY(X) (SDL_WINDOWPOS_UNDEFINED_MASK\|(X))
58265e606e4e Window coordinates are in the global space and windows are not tied to a particular display. Sam Lantinga <slouken@libsdl.org> parents: 5249 diff changeset	118 #define SDL_WINDOWPOS_UNDEFINED SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)
58265e606e4e Window coordinates are in the global space and windows are not tied to a particular display. Sam Lantinga <slouken@libsdl.org> parents: 5249 diff changeset	119 #define SDL_WINDOWPOS_ISUNDEFINED(X) \
58265e606e4e Window coordinates are in the global space and windows are not tied to a particular display. Sam Lantinga <slouken@libsdl.org> parents: 5249 diff changeset	120 (((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK)
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	121
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	122 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	123 * \brief Used to indicate that the window position should be centered.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	124 */
5251 58265e606e4e Window coordinates are in the global space and windows are not tied to a particular display. Sam Lantinga <slouken@libsdl.org> parents: 5249 diff changeset	125 #define SDL_WINDOWPOS_CENTERED_MASK 0x2FFF0000
58265e606e4e Window coordinates are in the global space and windows are not tied to a particular display. Sam Lantinga <slouken@libsdl.org> parents: 5249 diff changeset	126 #define SDL_WINDOWPOS_CENTERED_DISPLAY(X) (SDL_WINDOWPOS_CENTERED_MASK\|(X))
58265e606e4e Window coordinates are in the global space and windows are not tied to a particular display. Sam Lantinga <slouken@libsdl.org> parents: 5249 diff changeset	127 #define SDL_WINDOWPOS_CENTERED SDL_WINDOWPOS_CENTERED_DISPLAY(0)
58265e606e4e Window coordinates are in the global space and windows are not tied to a particular display. Sam Lantinga <slouken@libsdl.org> parents: 5249 diff changeset	128 #define SDL_WINDOWPOS_ISCENTERED(X) \
58265e606e4e Window coordinates are in the global space and windows are not tied to a particular display. Sam Lantinga <slouken@libsdl.org> parents: 5249 diff changeset	129 (((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK)
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	130
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	131 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	132 * \brief Event subtype for window events
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	133 */
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	134 typedef enum
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	135 {
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	136 SDL_WINDOWEVENT_NONE, /*< Never used /
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	137 SDL_WINDOWEVENT_SHOWN, /*< Window has been shown /
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	138 SDL_WINDOWEVENT_HIDDEN, /*< Window has been hidden /
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	139 SDL_WINDOWEVENT_EXPOSED, /**< Window has been exposed and should be
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	140 redrawn */
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	141 SDL_WINDOWEVENT_MOVED, /**< Window has been moved to data1, data2
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	142 */
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	143 SDL_WINDOWEVENT_RESIZED, /*< Window size changed to data1xdata2 /
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	144 SDL_WINDOWEVENT_MINIMIZED, /*< Window has been minimized /
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	145 SDL_WINDOWEVENT_MAXIMIZED, /*< Window has been maximized /
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	146 SDL_WINDOWEVENT_RESTORED, /**< Window has been restored to normal size
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	147 and position */
3691 9fed2aa469ed Documentation consistency Sam Lantinga <slouken@libsdl.org> parents: 3685 diff changeset	148 SDL_WINDOWEVENT_ENTER, /*< Window has gained mouse focus /
9fed2aa469ed Documentation consistency Sam Lantinga <slouken@libsdl.org> parents: 3685 diff changeset	149 SDL_WINDOWEVENT_LEAVE, /*< Window has lost mouse focus /
9fed2aa469ed Documentation consistency Sam Lantinga <slouken@libsdl.org> parents: 3685 diff changeset	150 SDL_WINDOWEVENT_FOCUS_GAINED, /*< Window has gained keyboard focus /
9fed2aa469ed Documentation consistency Sam Lantinga <slouken@libsdl.org> parents: 3685 diff changeset	151 SDL_WINDOWEVENT_FOCUS_LOST, /*< Window has lost keyboard focus /
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	152 SDL_WINDOWEVENT_CLOSE /**< The window manager requests that the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	153 window be closed */
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	154 } SDL_WindowEventID;
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	155
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	156 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	157 * \brief An opaque handle to an OpenGL context.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	158 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	159 typedef void *SDL_GLContext;
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	160
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	161 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	162 * \brief OpenGL configuration attributes
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	163 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	164 typedef enum
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	165 {
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	166 SDL_GL_RED_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	167 SDL_GL_GREEN_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	168 SDL_GL_BLUE_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	169 SDL_GL_ALPHA_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	170 SDL_GL_BUFFER_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	171 SDL_GL_DOUBLEBUFFER,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	172 SDL_GL_DEPTH_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	173 SDL_GL_STENCIL_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	174 SDL_GL_ACCUM_RED_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	175 SDL_GL_ACCUM_GREEN_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	176 SDL_GL_ACCUM_BLUE_SIZE,
450 8a43e0cbf02f Added SDL_GL_STEREO for stereoscopic OpenGL contexts Sam Lantinga <slouken@libsdl.org> parents: 432 diff changeset	177 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	178 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	179 SDL_GL_MULTISAMPLEBUFFERS,
1736 3b2a92126f4d Implemented bug #2, 117: Sam Lantinga <slouken@libsdl.org> parents: 1545 diff changeset	180 SDL_GL_MULTISAMPLESAMPLES,
2747 47519ce71def Added SDL_GL_RETAINED_BACKING attribute to SDL_GLattr Holmes Futrell <hfutrell@umail.ucsb.edu> parents: 2275 diff changeset	181 SDL_GL_ACCELERATED_VISUAL,
3100 7dc982143c06 Date: Sun, 22 Mar 2009 12:52:29 +0000 Sam Lantinga <slouken@libsdl.org> parents: 3091 diff changeset	182 SDL_GL_RETAINED_BACKING,
3139 7f684f249ec9 indent Sam Lantinga <slouken@libsdl.org> parents: 3100 diff changeset	183 SDL_GL_CONTEXT_MAJOR_VERSION,
7f684f249ec9 indent Sam Lantinga <slouken@libsdl.org> parents: 3100 diff changeset	184 SDL_GL_CONTEXT_MINOR_VERSION
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	185 } SDL_GLattr;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	186
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	187
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	188 /* Function prototypes */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	189
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	190 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	191 * \brief Get the number of video drivers compiled into SDL
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	192 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	193 * \sa SDL_GetVideoDriver()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	194 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	195 extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	196
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	197 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	198 * \brief Get the name of a built in video driver.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	199 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	200 * \note The video drivers are presented in the order in which they are
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	201 * normally checked during initialization.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	202 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	203 * \sa SDL_GetNumVideoDrivers()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	204 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	205 extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	206
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	207 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	208 * \brief Initialize the video subsystem, optionally specifying a video driver.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	209 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	210 * \param driver_name Initialize a specific driver by name, or NULL for the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	211 * default video driver.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	212 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	213 * \return 0 on success, -1 on error
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	214 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	215 * This function initializes the video subsystem; setting up a connection
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	216 * to the window manager, etc, and determines the available display modes
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	217 * and pixel formats, but does not initialize a window or graphics mode.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	218 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	219 * \sa SDL_VideoQuit()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	220 */
5125 dc0dfdd58f27 Removed completely non-portable event thread hack. Sam Lantinga <slouken@libsdl.org> parents: 4971 diff changeset	221 extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name);
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	222
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	223 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	224 * \brief Shuts down the video subsystem.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	225 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	226 * This function closes all windows, and restores the original video mode.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	227 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	228 * \sa SDL_VideoInit()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	229 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	230 extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	231
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	232 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	233 * \brief Returns the name of the currently initialized video driver.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	234 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	235 * \return The name of the current video driver or NULL if no driver
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	236 * has been initialized
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	237 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	238 * \sa SDL_GetNumVideoDrivers()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	239 * \sa SDL_GetVideoDriver()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	240 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	241 extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	242
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	243 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	244 * \brief Returns the number of available video displays.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	245 *
3528 59ff7a2beb57 Added an API function to query geometry of multiple monitors: Sam Lantinga <slouken@libsdl.org> parents: 3523 diff changeset	246 * \sa SDL_GetDisplayBounds()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	247 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	248 extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	249
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	250 /**
3528 59ff7a2beb57 Added an API function to query geometry of multiple monitors: Sam Lantinga <slouken@libsdl.org> parents: 3523 diff changeset	251 * \brief Get the desktop area represented by a display, with the primary
59ff7a2beb57 Added an API function to query geometry of multiple monitors: Sam Lantinga <slouken@libsdl.org> parents: 3523 diff changeset	252 * display located at 0,0
59ff7a2beb57 Added an API function to query geometry of multiple monitors: Sam Lantinga <slouken@libsdl.org> parents: 3523 diff changeset	253 *
59ff7a2beb57 Added an API function to query geometry of multiple monitors: Sam Lantinga <slouken@libsdl.org> parents: 3523 diff changeset	254 * \return 0 on success, or -1 if the index is out of range.
59ff7a2beb57 Added an API function to query geometry of multiple monitors: Sam Lantinga <slouken@libsdl.org> parents: 3523 diff changeset	255 *
59ff7a2beb57 Added an API function to query geometry of multiple monitors: Sam Lantinga <slouken@libsdl.org> parents: 3523 diff changeset	256 * \sa SDL_GetNumVideoDisplays()
59ff7a2beb57 Added an API function to query geometry of multiple monitors: Sam Lantinga <slouken@libsdl.org> parents: 3523 diff changeset	257 */
5249 762e40fb8e28 Be explicit about what display you're querying. The default display is 0. Sam Lantinga <slouken@libsdl.org> parents: 5248 diff changeset	258 extern DECLSPEC int SDLCALL SDL_GetDisplayBounds(int displayIndex, SDL_Rect * rect);
3528 59ff7a2beb57 Added an API function to query geometry of multiple monitors: Sam Lantinga <slouken@libsdl.org> parents: 3523 diff changeset	259
59ff7a2beb57 Added an API function to query geometry of multiple monitors: Sam Lantinga <slouken@libsdl.org> parents: 3523 diff changeset	260 /**
5249 762e40fb8e28 Be explicit about what display you're querying. The default display is 0. Sam Lantinga <slouken@libsdl.org> parents: 5248 diff changeset	261 * \brief Returns the number of available display modes.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	262 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	263 * \sa SDL_GetDisplayMode()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	264 */
5249 762e40fb8e28 Be explicit about what display you're querying. The default display is 0. Sam Lantinga <slouken@libsdl.org> parents: 5248 diff changeset	265 extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(int displayIndex);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	266
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	267 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	268 * \brief Fill in information about a specific display mode.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	269 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	270 * \note The display modes are sorted in this priority:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	271 * \li bits per pixel -> more colors to fewer colors
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	272 * \li width -> largest to smallest
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	273 * \li height -> largest to smallest
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	274 * \li refresh rate -> highest to lowest
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	275 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	276 * \sa SDL_GetNumDisplayModes()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	277 */
5249 762e40fb8e28 Be explicit about what display you're querying. The default display is 0. Sam Lantinga <slouken@libsdl.org> parents: 5248 diff changeset	278 extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int displayIndex, int modeIndex,
1967 01e29c3e9a29 In general, fill in pointers to structures, rather than return them. Sam Lantinga <slouken@libsdl.org> parents: 1966 diff changeset	279 SDL_DisplayMode * mode);
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	280
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	281 /**
5249 762e40fb8e28 Be explicit about what display you're querying. The default display is 0. Sam Lantinga <slouken@libsdl.org> parents: 5248 diff changeset	282 * \brief Fill in information about the desktop display mode.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	283 */
5249 762e40fb8e28 Be explicit about what display you're querying. The default display is 0. Sam Lantinga <slouken@libsdl.org> parents: 5248 diff changeset	284 extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(int displayIndex, SDL_DisplayMode * mode);
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	285
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	286 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	287 * \brief Fill in information about the current display mode.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	288 */
5249 762e40fb8e28 Be explicit about what display you're querying. The default display is 0. Sam Lantinga <slouken@libsdl.org> parents: 5248 diff changeset	289 extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(int displayIndex, SDL_DisplayMode * mode);
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	290
3400 4ec48602f1db iPhone interruption patch / SDL 1.3 Sam Lantinga <slouken@libsdl.org> parents: 3227 diff changeset	291
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	292 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	293 * \brief Get the closest match to the requested display mode.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	294 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	295 * \param mode The desired display mode
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	296 * \param closest A pointer to a display mode to be filled in with the closest
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	297 * match of the available display modes.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	298 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	299 * \return The passed in value \c closest, or NULL if no matching video mode
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	300 * was available.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	301 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	302 * The available display modes are scanned, and \c closest is filled in with the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	303 * closest mode matching the requested mode and returned. The mode format and
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	304 * refresh_rate default to the desktop mode if they are 0. The modes are
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	305 * scanned with size being first priority, format being second priority, and
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	306 * finally checking the refresh_rate. If all the available modes are too
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	307 * small, then NULL is returned.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	308 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	309 * \sa SDL_GetNumDisplayModes()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	310 * \sa SDL_GetDisplayMode()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	311 */
5249 762e40fb8e28 Be explicit about what display you're querying. The default display is 0. Sam Lantinga <slouken@libsdl.org> parents: 5248 diff changeset	312 extern DECLSPEC SDL_DisplayMode * SDLCALL SDL_GetClosestDisplayMode(int displayIndex, const SDL_DisplayMode * mode, SDL_DisplayMode * closest);
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	313
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	314 /**
5251 58265e606e4e Window coordinates are in the global space and windows are not tied to a particular display. Sam Lantinga <slouken@libsdl.org> parents: 5249 diff changeset	315 * \brief Get the display index associated with a window.
58265e606e4e Window coordinates are in the global space and windows are not tied to a particular display. Sam Lantinga <slouken@libsdl.org> parents: 5249 diff changeset	316 *
58265e606e4e Window coordinates are in the global space and windows are not tied to a particular display. Sam Lantinga <slouken@libsdl.org> parents: 5249 diff changeset	317 * \return the display index of the display containing the center of the
58265e606e4e Window coordinates are in the global space and windows are not tied to a particular display. Sam Lantinga <slouken@libsdl.org> parents: 5249 diff changeset	318 * window, or -1 on error.
58265e606e4e Window coordinates are in the global space and windows are not tied to a particular display. Sam Lantinga <slouken@libsdl.org> parents: 5249 diff changeset	319 */
58265e606e4e Window coordinates are in the global space and windows are not tied to a particular display. Sam Lantinga <slouken@libsdl.org> parents: 5249 diff changeset	320 extern DECLSPEC int SDLCALL SDL_GetWindowDisplay(SDL_Window * window);
58265e606e4e Window coordinates are in the global space and windows are not tied to a particular display. Sam Lantinga <slouken@libsdl.org> parents: 5249 diff changeset	321
58265e606e4e Window coordinates are in the global space and windows are not tied to a particular display. Sam Lantinga <slouken@libsdl.org> parents: 5249 diff changeset	322 /**
5249 762e40fb8e28 Be explicit about what display you're querying. The default display is 0. Sam Lantinga <slouken@libsdl.org> parents: 5248 diff changeset	323 * \brief Set the display mode used when a fullscreen window is visible.
762e40fb8e28 Be explicit about what display you're querying. The default display is 0. Sam Lantinga <slouken@libsdl.org> parents: 5248 diff changeset	324 *
762e40fb8e28 Be explicit about what display you're querying. The default display is 0. Sam Lantinga <slouken@libsdl.org> parents: 5248 diff changeset	325 * By default the window's dimensions and the desktop format and refresh rate
762e40fb8e28 Be explicit about what display you're querying. The default display is 0. Sam Lantinga <slouken@libsdl.org> parents: 5248 diff changeset	326 * are used.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	327 *
3500 4b594623401b Work in progress on multi-display support: Sam Lantinga <slouken@libsdl.org> parents: 3493 diff changeset	328 * \param mode The mode to use, or NULL for the default mode.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	329 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	330 * \return 0 on success, or -1 if setting the display mode failed.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	331 *
3522 fa1abe1ff8b8 Added related functions Sam Lantinga <slouken@libsdl.org> parents: 3500 diff changeset	332 * \sa SDL_GetWindowDisplayMode()
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	333 * \sa SDL_SetWindowFullscreen()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	334 */
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	335 extern DECLSPEC int SDLCALL SDL_SetWindowDisplayMode(SDL_Window * window,
3500 4b594623401b Work in progress on multi-display support: Sam Lantinga <slouken@libsdl.org> parents: 3493 diff changeset	336 const SDL_DisplayMode
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	337 * mode);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	338
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	339 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	340 * \brief Fill in information about the display mode used when a fullscreen
5249 762e40fb8e28 Be explicit about what display you're querying. The default display is 0. Sam Lantinga <slouken@libsdl.org> parents: 5248 diff changeset	341 * window is visible.
3522 fa1abe1ff8b8 Added related functions Sam Lantinga <slouken@libsdl.org> parents: 3500 diff changeset	342 *
fa1abe1ff8b8 Added related functions Sam Lantinga <slouken@libsdl.org> parents: 3500 diff changeset	343 * \sa SDL_SetWindowDisplayMode()
fa1abe1ff8b8 Added related functions Sam Lantinga <slouken@libsdl.org> parents: 3500 diff changeset	344 * \sa SDL_SetWindowFullscreen()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	345 */
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	346 extern DECLSPEC int SDLCALL SDL_GetWindowDisplayMode(SDL_Window * window,
3500 4b594623401b Work in progress on multi-display support: Sam Lantinga <slouken@libsdl.org> parents: 3493 diff changeset	347 SDL_DisplayMode * mode);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	348
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	349 /**
5157 fb424691cfc7 Moved the rendering code out to a separate directory in the hope that it can someday be completely decoupled from the rest of the library and be expanded to an awesome 2D on 3D library. Sam Lantinga <slouken@libsdl.org> parents: 5152 diff changeset	350 * \brief Get the pixel format associated with the window.
fb424691cfc7 Moved the rendering code out to a separate directory in the hope that it can someday be completely decoupled from the rest of the library and be expanded to an awesome 2D on 3D library. Sam Lantinga <slouken@libsdl.org> parents: 5152 diff changeset	351 */
fb424691cfc7 Moved the rendering code out to a separate directory in the hope that it can someday be completely decoupled from the rest of the library and be expanded to an awesome 2D on 3D library. Sam Lantinga <slouken@libsdl.org> parents: 5152 diff changeset	352 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowPixelFormat(SDL_Window * window);
fb424691cfc7 Moved the rendering code out to a separate directory in the hope that it can someday be completely decoupled from the rest of the library and be expanded to an awesome 2D on 3D library. Sam Lantinga <slouken@libsdl.org> parents: 5152 diff changeset	353
fb424691cfc7 Moved the rendering code out to a separate directory in the hope that it can someday be completely decoupled from the rest of the library and be expanded to an awesome 2D on 3D library. Sam Lantinga <slouken@libsdl.org> parents: 5152 diff changeset	354 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	355 * \brief Create a window with the specified position, dimensions, and flags.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	356 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	357 * \param title The title of the window, in UTF-8 encoding.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	358 * \param x The x position of the window, ::SDL_WINDOWPOS_CENTERED, or
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	359 * ::SDL_WINDOWPOS_UNDEFINED.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	360 * \param y The y position of the window, ::SDL_WINDOWPOS_CENTERED, or
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	361 * ::SDL_WINDOWPOS_UNDEFINED.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	362 * \param w The width of the window.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	363 * \param h The height of the window.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	364 * \param flags The flags for the window, a mask of any of the following:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	365 * ::SDL_WINDOW_FULLSCREEN, ::SDL_WINDOW_OPENGL,
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	366 * ::SDL_WINDOW_SHOWN, ::SDL_WINDOW_BORDERLESS,
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	367 * ::SDL_WINDOW_RESIZABLE, ::SDL_WINDOW_MAXIMIZED,
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	368 * ::SDL_WINDOW_MINIMIZED, ::SDL_WINDOW_INPUT_GRABBED.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	369 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	370 * \return The id of the window created, or zero if window creation failed.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	371 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	372 * \sa SDL_DestroyWindow()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	373 */
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	374 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title,
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	375 int x, int y, int w,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	376 int h, Uint32 flags);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	377
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	378 /**
3493 40b1f7cb2062 SDL_CreateWindowFrom() is actually going to be supported. :) Sam Lantinga <slouken@libsdl.org> parents: 3492 diff changeset	379 * \brief Create an SDL window from an existing native window.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	380 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	381 * \param data A pointer to driver-dependent window creation data
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	382 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	383 * \return The id of the window created, or zero if window creation failed.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	384 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	385 * \sa SDL_DestroyWindow()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	386 */
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	387 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowFrom(const void *data);
64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	388
64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	389 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	390 * \brief Get the numeric ID of a window, for logging purposes.
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	391 */
64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	392 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowID(SDL_Window * window);
64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	393
64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	394 /**
64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	395 * \brief Get a window from a stored ID, or NULL if it doesn't exist.
64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	396 */
64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	397 extern DECLSPEC SDL_Window * SDLCALL SDL_GetWindowFromID(Uint32 id);
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	398
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	399 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	400 * \brief Get the window flags.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	401 */
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	402 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_Window * window);
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	403
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	404 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	405 * \brief Set the title of a window, in UTF-8 format.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	406 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	407 * \sa SDL_GetWindowTitle()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	408 */
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	409 extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_Window * window,
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	410 const char *title);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	411
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	412 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	413 * \brief Get the title of a window, in UTF-8 format.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	414 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	415 * \sa SDL_SetWindowTitle()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	416 */
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	417 extern DECLSPEC const char SDLCALL SDL_GetWindowTitle(SDL_Window window);
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	418
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	419 /**
4887 0a77d2fc95ad Fixed grammar, thanks to Sheena's suggestion. Sam Lantinga <slouken@libsdl.org> parents: 4883 diff changeset	420 * \brief Set the icon for a window.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	421 *
4887 0a77d2fc95ad Fixed grammar, thanks to Sheena's suggestion. Sam Lantinga <slouken@libsdl.org> parents: 4883 diff changeset	422 * \param icon The icon for the window.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	423 */
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	424 extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Window * window,
2990 502adab079a4 indent Sam Lantinga <slouken@libsdl.org> parents: 2967 diff changeset	425 SDL_Surface * icon);
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	426
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	427 /**
5168 2b1989f59674 Extended SDL_SetWindowData() to allow arbitrary named values. Sam Lantinga <slouken@libsdl.org> parents: 5157 diff changeset	428 * \brief Associate an arbitrary named pointer with a window.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	429 *
5168 2b1989f59674 Extended SDL_SetWindowData() to allow arbitrary named values. Sam Lantinga <slouken@libsdl.org> parents: 5157 diff changeset	430 * \param window The window to associate with the pointer.
2b1989f59674 Extended SDL_SetWindowData() to allow arbitrary named values. Sam Lantinga <slouken@libsdl.org> parents: 5157 diff changeset	431 * \param name The name of the pointer.
2b1989f59674 Extended SDL_SetWindowData() to allow arbitrary named values. Sam Lantinga <slouken@libsdl.org> parents: 5157 diff changeset	432 * \param userdata The associated pointer.
2b1989f59674 Extended SDL_SetWindowData() to allow arbitrary named values. Sam Lantinga <slouken@libsdl.org> parents: 5157 diff changeset	433 *
2b1989f59674 Extended SDL_SetWindowData() to allow arbitrary named values. Sam Lantinga <slouken@libsdl.org> parents: 5157 diff changeset	434 * \return The previous value associated with 'name'
2b1989f59674 Extended SDL_SetWindowData() to allow arbitrary named values. Sam Lantinga <slouken@libsdl.org> parents: 5157 diff changeset	435 *
2b1989f59674 Extended SDL_SetWindowData() to allow arbitrary named values. Sam Lantinga <slouken@libsdl.org> parents: 5157 diff changeset	436 * \note The name is case-sensitive.
2b1989f59674 Extended SDL_SetWindowData() to allow arbitrary named values. Sam Lantinga <slouken@libsdl.org> parents: 5157 diff changeset	437 *
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	438 * \sa SDL_GetWindowData()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	439 */
5168 2b1989f59674 Extended SDL_SetWindowData() to allow arbitrary named values. Sam Lantinga <slouken@libsdl.org> parents: 5157 diff changeset	440 extern DECLSPEC void* SDLCALL SDL_SetWindowData(SDL_Window * window,
2b1989f59674 Extended SDL_SetWindowData() to allow arbitrary named values. Sam Lantinga <slouken@libsdl.org> parents: 5157 diff changeset	441 const char *name,
2b1989f59674 Extended SDL_SetWindowData() to allow arbitrary named values. Sam Lantinga <slouken@libsdl.org> parents: 5157 diff changeset	442 void *userdata);
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	443
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	444 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	445 * \brief Retrieve the data pointer associated with a window.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	446 *
5168 2b1989f59674 Extended SDL_SetWindowData() to allow arbitrary named values. Sam Lantinga <slouken@libsdl.org> parents: 5157 diff changeset	447 * \param window The window to query.
2b1989f59674 Extended SDL_SetWindowData() to allow arbitrary named values. Sam Lantinga <slouken@libsdl.org> parents: 5157 diff changeset	448 * \param name The name of the pointer.
2b1989f59674 Extended SDL_SetWindowData() to allow arbitrary named values. Sam Lantinga <slouken@libsdl.org> parents: 5157 diff changeset	449 *
2b1989f59674 Extended SDL_SetWindowData() to allow arbitrary named values. Sam Lantinga <slouken@libsdl.org> parents: 5157 diff changeset	450 * \return The value associated with 'name'
2b1989f59674 Extended SDL_SetWindowData() to allow arbitrary named values. Sam Lantinga <slouken@libsdl.org> parents: 5157 diff changeset	451 *
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	452 * \sa SDL_SetWindowData()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	453 */
5168 2b1989f59674 Extended SDL_SetWindowData() to allow arbitrary named values. Sam Lantinga <slouken@libsdl.org> parents: 5157 diff changeset	454 extern DECLSPEC void SDLCALL SDL_GetWindowData(SDL_Window window,
2b1989f59674 Extended SDL_SetWindowData() to allow arbitrary named values. Sam Lantinga <slouken@libsdl.org> parents: 5157 diff changeset	455 const char *name);
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	456
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	457 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	458 * \brief Set the position of a window.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	459 *
5168 2b1989f59674 Extended SDL_SetWindowData() to allow arbitrary named values. Sam Lantinga <slouken@libsdl.org> parents: 5157 diff changeset	460 * \param window The window to reposition.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	461 * \param x The x coordinate of the window, ::SDL_WINDOWPOS_CENTERED, or
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	462 ::SDL_WINDOWPOS_UNDEFINED.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	463 * \param y The y coordinate of the window, ::SDL_WINDOWPOS_CENTERED, or
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	464 ::SDL_WINDOWPOS_UNDEFINED.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	465 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	466 * \note The window coordinate origin is the upper left of the display.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	467 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	468 * \sa SDL_GetWindowPosition()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	469 */
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	470 extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_Window * window,
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	471 int x, int y);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	472
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	473 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	474 * \brief Get the position of a window.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	475 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	476 * \sa SDL_SetWindowPosition()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	477 */
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	478 extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_Window * window,
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	479 int x, int y);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	480
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	481 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	482 * \brief Set the size of a window's client area.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	483 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	484 * \note You can't change the size of a fullscreen window, it automatically
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	485 * matches the size of the display mode.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	486 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	487 * \sa SDL_GetWindowSize()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	488 */
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	489 extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_Window * window, int w,
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	490 int h);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	491
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	492 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	493 * \brief Get the size of a window's client area.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	494 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	495 * \sa SDL_SetWindowSize()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	496 */
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	497 extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_Window * window, int *w,
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	498 int *h);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	499
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	500 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	501 * \brief Show a window.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	502 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	503 * \sa SDL_HideWindow()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	504 */
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	505 extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_Window * window);
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	506
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	507 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	508 * \brief Hide a window.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	509 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	510 * \sa SDL_ShowWindow()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	511 */
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	512 extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_Window * window);
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	513
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	514 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	515 * \brief Raise a window above other windows and set the input focus.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	516 */
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	517 extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_Window * window);
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	518
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	519 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	520 * \brief Make a window as large as possible.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	521 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	522 * \sa SDL_RestoreWindow()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	523 */
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	524 extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_Window * window);
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	525
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	526 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	527 * \brief Minimize a window to an iconic representation.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	528 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	529 * \sa SDL_RestoreWindow()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	530 */
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	531 extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_Window * window);
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	532
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	533 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	534 * \brief Restore the size and position of a minimized or maximized window.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	535 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	536 * \sa SDL_MaximizeWindow()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	537 * \sa SDL_MinimizeWindow()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	538 */
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	539 extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_Window * window);
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	540
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	541 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	542 * \brief Set a window's fullscreen state.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	543 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	544 * \return 0 on success, or -1 if setting the display mode failed.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	545 *
3522 fa1abe1ff8b8 Added related functions Sam Lantinga <slouken@libsdl.org> parents: 3500 diff changeset	546 * \sa SDL_SetWindowDisplayMode()
fa1abe1ff8b8 Added related functions Sam Lantinga <slouken@libsdl.org> parents: 3500 diff changeset	547 * \sa SDL_GetWindowDisplayMode()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	548 */
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	549 extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_Window * window,
5251 58265e606e4e Window coordinates are in the global space and windows are not tied to a particular display. Sam Lantinga <slouken@libsdl.org> parents: 5249 diff changeset	550 SDL_bool fullscreen);
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	551
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	552 /**
5169 4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	553 * \brief Get an SDL surface associated with the window.
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	554 *
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	555 * \return A surface in the optimal format for the window, or NULL on error.
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	556 *
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	557 * \note You may not combine this with 3D or the rendering API on this window.
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	558 *
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	559 * \sa SDL_UpdateWindowSurface()
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	560 * \sa SDL_UpdateWindowSurfaceRects()
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	561 */
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	562 extern DECLSPEC SDL_Surface * SDLCALL SDL_GetWindowSurface(SDL_Window * window);
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	563
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	564 /**
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	565 * \brief Copy the window surface to the screen.
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	566 *
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	567 * \return 0 on success, or -1 on error.
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	568 *
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	569 * \sa SDL_GetWindowSurface()
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	570 * \sa SDL_UpdateWindowSurfaceRects()
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	571 */
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	572 extern DECLSPEC int SDLCALL SDL_UpdateWindowSurface(SDL_Window * window);
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	573
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	574 /**
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	575 * \brief Copy a number of rectangles on the window surface to the screen.
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	576 *
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	577 * \return 0 on success, or -1 on error.
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	578 *
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	579 * \sa SDL_GetWindowSurface()
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	580 * \sa SDL_UpdateWindowSurfaceRect()
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	581 */
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	582 extern DECLSPEC int SDLCALL SDL_UpdateWindowSurfaceRects(SDL_Window * window,
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	583 int numrects,
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	584 SDL_Rect * rects);
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	585
4d39eeaad00b Added a way to get a framebuffer interface for a window, and also a way to create a software renderer for an arbitrary surface. Sam Lantinga <slouken@libsdl.org> parents: 5168 diff changeset	586 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	587 * \brief Set a window's input grab mode.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	588 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	589 * \param mode This is 1 to grab input, and 0 to release input.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	590 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	591 * \sa SDL_GetWindowGrab()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	592 */
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	593 extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_Window * window,
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	594 int mode);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	595
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	596 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	597 * \brief Get a window's input grab mode.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	598 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	599 * \return This returns 1 if input is grabbed, and 0 otherwise.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	600 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	601 * \sa SDL_SetWindowGrab()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	602 */
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	603 extern DECLSPEC int SDLCALL SDL_GetWindowGrab(SDL_Window * window);
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	604
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	605 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	606 * \brief Get driver specific information about a window.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	607 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	608 * \note Include SDL_syswm.h for the declaration of SDL_SysWMinfo.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	609 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	610 struct SDL_SysWMinfo;
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	611 extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_Window * window,
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	612 struct SDL_SysWMinfo
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	613 *info);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	614
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	615 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	616 * \brief Destroy a window.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	617 */
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	618 extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_Window * window);
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	619
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	620
3025 54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	621 /**
4875 22ce07e8e824 Suspending the screensaver defaults off. Sam Lantinga <slouken@libsdl.org> parents: 4869 diff changeset	622 * \brief Returns whether the screensaver is currently enabled (default on).
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	623 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	624 * \sa SDL_EnableScreenSaver()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	625 * \sa SDL_DisableScreenSaver()
3025 54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	626 */
3033 4e4f47c5f941 Fix third party "-Wall -Werror" builds Couriersud <couriersud@arcor.de> parents: 3025 diff changeset	627 extern DECLSPEC SDL_bool SDLCALL SDL_IsScreenSaverEnabled(void);
3025 54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	628
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	629 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	630 * \brief Allow the screen to be blanked by a screensaver
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	631 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	632 * \sa SDL_IsScreenSaverEnabled()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	633 * \sa SDL_DisableScreenSaver()
3025 54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	634 */
3033 4e4f47c5f941 Fix third party "-Wall -Werror" builds Couriersud <couriersud@arcor.de> parents: 3025 diff changeset	635 extern DECLSPEC void SDLCALL SDL_EnableScreenSaver(void);
3025 54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	636
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	637 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	638 * \brief Prevent the screen from being blanked by a screensaver
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	639 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	640 * \sa SDL_IsScreenSaverEnabled()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	641 * \sa SDL_EnableScreenSaver()
3025 54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	642 */
3033 4e4f47c5f941 Fix third party "-Wall -Werror" builds Couriersud <couriersud@arcor.de> parents: 3025 diff changeset	643 extern DECLSPEC void SDLCALL SDL_DisableScreenSaver(void);
3025 54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	644
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	645
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	646 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	647 * \name OpenGL support functions
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	648 */
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	649 /@{/
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	650
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	651 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	652 * \brief Dynamically load an OpenGL library.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	653 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	654 * \param path The platform dependent OpenGL library name, or NULL to open the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	655 * default OpenGL library.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	656 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	657 * \return 0 on success, or -1 if the library couldn't be loaded.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	658 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	659 * This should be done after initializing the video driver, but before
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	660 * creating any OpenGL windows. If no OpenGL library is loaded, the default
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	661 * library will be loaded upon creation of the first OpenGL window.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	662 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	663 * \note If you do this, you need to retrieve all of the GL functions used in
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	664 * your program from the dynamic library using SDL_GL_GetProcAddress().
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	665 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	666 * \sa SDL_GL_GetProcAddress()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	667 * \sa SDL_GL_UnloadLibrary()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	668 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	669 extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	670
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	671 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	672 * \brief Get the address of an OpenGL function.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	673 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	674 extern DECLSPEC void SDLCALL SDL_GL_GetProcAddress(const char proc);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	675
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	676 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	677 * \brief Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	678 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	679 * \sa SDL_GL_LoadLibrary()
3057 089a77aebb7d Added test program for SDL_CreateWindowFrom() Sam Lantinga <slouken@libsdl.org> parents: 3033 diff changeset	680 */
089a77aebb7d Added test program for SDL_CreateWindowFrom() Sam Lantinga <slouken@libsdl.org> parents: 3033 diff changeset	681 extern DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void);
089a77aebb7d Added test program for SDL_CreateWindowFrom() Sam Lantinga <slouken@libsdl.org> parents: 3033 diff changeset	682
089a77aebb7d Added test program for SDL_CreateWindowFrom() Sam Lantinga <slouken@libsdl.org> parents: 3033 diff changeset	683 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	684 * \brief Return true if an OpenGL extension is supported for the current
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	685 * context.
1926 307355678142 Added SDL_GL_ExtensionSupported() Sam Lantinga <slouken@libsdl.org> parents: 1920 diff changeset	686 */
307355678142 Added SDL_GL_ExtensionSupported() Sam Lantinga <slouken@libsdl.org> parents: 1920 diff changeset	687 extern DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported(const char
307355678142 Added SDL_GL_ExtensionSupported() Sam Lantinga <slouken@libsdl.org> parents: 1920 diff changeset	688 *extension);
307355678142 Added SDL_GL_ExtensionSupported() Sam Lantinga <slouken@libsdl.org> parents: 1920 diff changeset	689
307355678142 Added SDL_GL_ExtensionSupported() Sam Lantinga <slouken@libsdl.org> parents: 1920 diff changeset	690 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	691 * \brief Set an OpenGL window attribute before window creation.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	692 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	693 extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	694
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	695 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	696 * \brief Get the actual value for an attribute from the current context.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	697 */
1936 83946ee0ff1f Implemented OpenGL support on Mac OS X Sam Lantinga <slouken@libsdl.org> parents: 1926 diff changeset	698 extern DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int *value);
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	699
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	700 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	701 * \brief Create an OpenGL context for use with an OpenGL window, and make it
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	702 * current.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	703 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	704 * \sa SDL_GL_DeleteContext()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	705 */
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	706 extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window *
64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	707 window);
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	708
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	709 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	710 * \brief Set up an OpenGL context for rendering into an OpenGL window.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	711 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	712 * \note The context must have been created with a compatible window.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	713 */
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	714 extern DECLSPEC int SDLCALL SDL_GL_MakeCurrent(SDL_Window * window,
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	715 SDL_GLContext context);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	716
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	717 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	718 * \brief Set the swap interval for the current OpenGL context.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	719 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	720 * \param interval 0 for immediate updates, 1 for updates synchronized with the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	721 * vertical retrace.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	722 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	723 * \return 0 on success, or -1 if setting the swap interval is not supported.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	724 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	725 * \sa SDL_GL_GetSwapInterval()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	726 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	727 extern DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	728
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	729 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	730 * \brief Get the swap interval for the current OpenGL context.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	731 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	732 * \return 0 if there is no vertical retrace synchronization, 1 if the buffer
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	733 * swap is synchronized with the vertical retrace, and -1 if getting
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	734 * the swap interval is not supported.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	735 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	736 * \sa SDL_GL_SetSwapInterval()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	737 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	738 extern DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(void);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	739
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	740 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	741 * \brief Swap the OpenGL buffers for a window, if double-buffering is
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	742 * supported.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	743 */
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3677 diff changeset	744 extern DECLSPEC void SDLCALL SDL_GL_SwapWindow(SDL_Window * window);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	745
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	746 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	747 * \brief Delete an OpenGL context.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	748 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	749 * \sa SDL_GL_CreateContext()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	750 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	751 extern DECLSPEC void SDLCALL SDL_GL_DeleteContext(SDL_GLContext context);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	752
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	753 /@}//OpenGL support functions/
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	754
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	755
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	756 /* Ends C function definitions when using C++ */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	757 #ifdef __cplusplus
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	758 /* INDENT-OFF */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	759 }
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	760 /* INDENT-ON */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	761 #endif
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	762 #include "close_code.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	763
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	764 #endif /* _SDL_video_h */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	765
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	766 /* vi: set ts=4 sw=4 expandtab: */

Mercurial > sdl-ios-xcode

annotate include/SDL_video.h @ 5251:58265e606e4e