sdl-ios-xcode: include/SDL

annotate include/SDL_video.h @ 4981:55b82067815b

Fill in the video mode with the correct screen format

author	Sam Lantinga <slouken@libsdl.org>
date	Wed, 12 Jan 2011 14:29:01 -0800
parents	158bb5752974
children	dc0dfdd58f27

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"
4929 aa8888658021 Use the enumerated type for blend and scale mode instead of int Sam Lantinga <slouken@libsdl.org> parents: 4887 diff changeset	35 #include "SDL_blendmode.h"
aa8888658021 Use the enumerated type for blend and scale mode instead of int Sam Lantinga <slouken@libsdl.org> parents: 4887 diff changeset	36 #include "SDL_scalemode.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	37 #include "SDL_surface.h"
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	38
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	39 #include "begin_code.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	40 /* Set up for C function definitions, even when using C++ */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	41 #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	42 /* INDENT-OFF */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	43 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	44 /* INDENT-ON */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	45 #endif
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	46
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	47 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	48 * \brief The structure that defines a display mode
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	49 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	50 * \sa SDL_GetNumDisplayModes()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	51 * \sa SDL_GetDisplayMode()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	52 * \sa SDL_GetDesktopDisplayMode()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	53 * \sa SDL_GetCurrentDisplayMode()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	54 * \sa SDL_GetClosestDisplayMode()
3500 4b594623401b Work in progress on multi-display support: Sam Lantinga <slouken@libsdl.org> parents: 3493 diff changeset	55 * \sa SDL_SetWindowDisplayMode()
4b594623401b Work in progress on multi-display support: Sam Lantinga <slouken@libsdl.org> parents: 3493 diff changeset	56 * \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	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 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	59 {
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 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	61 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	62 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	63 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	64 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	65 } SDL_DisplayMode;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	66
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	67 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	68 * \brief The type used to identify a window
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	69 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	70 * \sa SDL_CreateWindow()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	71 * \sa SDL_CreateWindowFrom()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	72 * \sa SDL_DestroyWindow()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	73 * \sa SDL_GetWindowData()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	74 * \sa SDL_GetWindowFlags()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	75 * \sa SDL_GetWindowGrab()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	76 * \sa SDL_GetWindowPosition()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	77 * \sa SDL_GetWindowSize()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	78 * \sa SDL_GetWindowTitle()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	79 * \sa SDL_HideWindow()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	80 * \sa SDL_MaximizeWindow()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	81 * \sa SDL_MinimizeWindow()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	82 * \sa SDL_RaiseWindow()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	83 * \sa SDL_RestoreWindow()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	84 * \sa SDL_SetWindowData()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	85 * \sa SDL_SetWindowFullscreen()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	86 * \sa SDL_SetWindowGrab()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	87 * \sa SDL_SetWindowIcon()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	88 * \sa SDL_SetWindowPosition()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	89 * \sa SDL_SetWindowSize()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	90 * \sa SDL_SetWindowTitle()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	91 * \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	92 */
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	93 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	94
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	95 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	96 * \brief The flags on a window
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	97 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	98 * \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	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 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	101 {
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_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	103 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	104 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	105 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	106 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	107 SDL_WINDOW_MINIMIZED = 0x00000020, /*< window is minimized /
d38acda781ae Made the window flag comments more consistent Sam Lantinga <slouken@libsdl.org> parents: 3522 diff changeset	108 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	109 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	110 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	111 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	112 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	113 } 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	114
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 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	116 * \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	117 */
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	118 #define SDL_WINDOWPOS_UNDEFINED 0x7FFFFFF
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	119
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	120 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	121 * \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	122 */
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	123 #define SDL_WINDOWPOS_CENTERED 0x7FFFFFE
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	124
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	125 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	126 * \brief Event subtype for window events
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	127 */
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	128 typedef enum
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	129 {
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	130 SDL_WINDOWEVENT_NONE, /*< Never used /
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	131 SDL_WINDOWEVENT_SHOWN, /*< Window has been shown /
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	132 SDL_WINDOWEVENT_HIDDEN, /*< Window has been hidden /
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	133 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	134 redrawn */
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	135 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	136 */
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	137 SDL_WINDOWEVENT_RESIZED, /*< Window size changed to data1xdata2 /
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	138 SDL_WINDOWEVENT_MINIMIZED, /*< Window has been minimized /
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	139 SDL_WINDOWEVENT_MAXIMIZED, /*< Window has been maximized /
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	140 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	141 and position */
3691 9fed2aa469ed Documentation consistency Sam Lantinga <slouken@libsdl.org> parents: 3685 diff changeset	142 SDL_WINDOWEVENT_ENTER, /*< Window has gained mouse focus /
9fed2aa469ed Documentation consistency Sam Lantinga <slouken@libsdl.org> parents: 3685 diff changeset	143 SDL_WINDOWEVENT_LEAVE, /*< Window has lost mouse focus /
9fed2aa469ed Documentation consistency Sam Lantinga <slouken@libsdl.org> parents: 3685 diff changeset	144 SDL_WINDOWEVENT_FOCUS_GAINED, /*< Window has gained keyboard focus /
9fed2aa469ed Documentation consistency Sam Lantinga <slouken@libsdl.org> parents: 3685 diff changeset	145 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	146 SDL_WINDOWEVENT_CLOSE /**< The window manager requests that the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	147 window be closed */
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	148 } SDL_WindowEventID;
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	149
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	150 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	151 * \brief Flags used when creating a rendering 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	152 */
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	153 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	154 {
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	155 SDL_RENDERER_SINGLEBUFFER = 0x00000001, /**< Render directly to the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	156 window, if possible */
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	157
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	158 SDL_RENDERER_PRESENTCOPY = 0x00000002, /**< Present uses a copy from
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	159 back buffer to the front
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	160 buffer */
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	161
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	162 SDL_RENDERER_PRESENTFLIP2 = 0x00000004, /**< Present uses a flip,
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	163 swapping back buffer and
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	164 front buffer */
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	165
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	166 SDL_RENDERER_PRESENTFLIP3 = 0x00000008, /**< Present uses a flip,
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	167 rotating between two back
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	168 buffers and a front buffer
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	169 */
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	170
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	171 SDL_RENDERER_PRESENTDISCARD = 0x00000010, /**< Present leaves the contents
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	172 of the backbuffer undefined
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	173 */
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	174
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	175 SDL_RENDERER_PRESENTVSYNC = 0x00000020, /**< Present is synchronized
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	176 with the refresh rate */
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	177
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	178 SDL_RENDERER_ACCELERATED = 0x00000040 /**< The renderer uses hardware
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	179 acceleration */
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	180
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	181 } SDL_RendererFlags;
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	182
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	183 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	184 * \brief Information on the capabilities of a render driver or 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	185 */
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	186 typedef struct SDL_RendererInfo
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	187 {
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	188 const char name; /< The name of the renderer /
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	189 Uint32 flags; /*< Supported ::SDL_RendererFlags /
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	190 Uint32 mod_modes; /*< A mask of supported channel modulation /
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	191 Uint32 blend_modes; /*< A mask of supported blend modes /
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	192 Uint32 scale_modes; /*< A mask of supported scale modes /
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	193 Uint32 num_texture_formats; /*< The number of available texture formats /
4612 9a5db97cd569 Advertise support for all supported texture formats. Sunny Sachanandani <sunnysachanandani@gmail.com> parents: 3697 diff changeset	194 Uint32 texture_formats[50]; /*< The available texture formats /
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	195 int max_texture_width; /*< The maximimum texture 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	196 int max_texture_height; /*< The maximimum texture 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	197 } SDL_RendererInfo;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	198
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	199 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	200 * \brief The access pattern allowed for a texture.
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	201 */
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	202 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	203 {
2222 926294b2bb4e Emphasized the separation between SDL_Surface and SDL_Texture Sam Lantinga <slouken@libsdl.org> parents: 2208 diff changeset	204 SDL_TEXTUREACCESS_STATIC, /*< Changes rarely, not lockable /
926294b2bb4e Emphasized the separation between SDL_Surface and SDL_Texture Sam Lantinga <slouken@libsdl.org> parents: 2208 diff changeset	205 SDL_TEXTUREACCESS_STREAMING /*< Changes frequently, lockable /
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	206 } SDL_TextureAccess;
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
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	208 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	209 * \brief The texture channel modulation used in SDL_RenderCopy().
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	210 */
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	211 typedef enum
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	212 {
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	213 SDL_TEXTUREMODULATE_NONE = 0x00000000, /*< No modulation /
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	214 SDL_TEXTUREMODULATE_COLOR = 0x00000001, /*< srcC = srcC color */
2208 b03710fb0333 Fixed bug #467 Sam Lantinga <slouken@libsdl.org> parents: 2131 diff changeset	215 SDL_TEXTUREMODULATE_ALPHA = 0x00000002 /*< srcA = srcA alpha */
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	216 } SDL_TextureModulate;
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	217
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	218 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	219 * \brief An efficient driver-specific representation of pixel data
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	220 */
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	221 struct SDL_Texture;
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	222 typedef struct SDL_Texture SDL_Texture;
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	223
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	224 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	225 * \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	226 */
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	227 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	228
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 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	230 * \brief OpenGL configuration attributes
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 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	233 {
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	234 SDL_GL_RED_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	235 SDL_GL_GREEN_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	236 SDL_GL_BLUE_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	237 SDL_GL_ALPHA_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	238 SDL_GL_BUFFER_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	239 SDL_GL_DOUBLEBUFFER,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	240 SDL_GL_DEPTH_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	241 SDL_GL_STENCIL_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	242 SDL_GL_ACCUM_RED_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	243 SDL_GL_ACCUM_GREEN_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	244 SDL_GL_ACCUM_BLUE_SIZE,
450 8a43e0cbf02f Added SDL_GL_STEREO for stereoscopic OpenGL contexts Sam Lantinga <slouken@libsdl.org> parents: 432 diff changeset	245 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	246 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	247 SDL_GL_MULTISAMPLEBUFFERS,
1736 3b2a92126f4d Implemented bug #2, 117: Sam Lantinga <slouken@libsdl.org> parents: 1545 diff changeset	248 SDL_GL_MULTISAMPLESAMPLES,
2747 47519ce71def Added SDL_GL_RETAINED_BACKING attribute to SDL_GLattr Holmes Futrell <hfutrell@umail.ucsb.edu> parents: 2275 diff changeset	249 SDL_GL_ACCELERATED_VISUAL,
3100 7dc982143c06 Date: Sun, 22 Mar 2009 12:52:29 +0000 Sam Lantinga <slouken@libsdl.org> parents: 3091 diff changeset	250 SDL_GL_RETAINED_BACKING,
3139 7f684f249ec9 indent Sam Lantinga <slouken@libsdl.org> parents: 3100 diff changeset	251 SDL_GL_CONTEXT_MAJOR_VERSION,
7f684f249ec9 indent Sam Lantinga <slouken@libsdl.org> parents: 3100 diff changeset	252 SDL_GL_CONTEXT_MINOR_VERSION
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	253 } SDL_GLattr;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	254
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	255
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	256 /* Function prototypes */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	257
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	258 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	259 * \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	260 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	261 * \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	262 */
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	263 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	264
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	265 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	266 * \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	267 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	268 * \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	269 * normally checked during initialization.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	270 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	271 * \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	272 */
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	273 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	274
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	275 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	276 * \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	277 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	278 * \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	279 * default video driver.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	280 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	281 * \param flags FIXME: Still needed?
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	282 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	283 * \return 0 on success, -1 on error
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	284 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	285 * 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	286 * 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	287 * 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	288 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	289 * \sa SDL_VideoQuit()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	290 */
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	291 extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name,
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 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	293
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	294 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	295 * \brief Shuts down the video subsystem.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	296 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	297 * 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	298 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	299 * \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	300 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	301 extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	302
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	303 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	304 * \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	305 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	306 * \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	307 * has been initialized
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_GetNumVideoDrivers()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	310 * \sa SDL_GetVideoDriver()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	311 */
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	312 extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	313
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	314 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	315 * \brief Returns the number of available video displays.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	316 *
3528 59ff7a2beb57 Added an API function to query geometry of multiple monitors: Sam Lantinga <slouken@libsdl.org> parents: 3523 diff changeset	317 * \sa SDL_GetDisplayBounds()
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	318 * \sa SDL_SelectVideoDisplay()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	319 */
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	320 extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	321
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	322 /**
3528 59ff7a2beb57 Added an API function to query geometry of multiple monitors: Sam Lantinga <slouken@libsdl.org> parents: 3523 diff changeset	323 * \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	324 * 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	325 *
59ff7a2beb57 Added an API function to query geometry of multiple monitors: Sam Lantinga <slouken@libsdl.org> parents: 3523 diff changeset	326 * \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	327 *
59ff7a2beb57 Added an API function to query geometry of multiple monitors: Sam Lantinga <slouken@libsdl.org> parents: 3523 diff changeset	328 * \sa SDL_GetNumVideoDisplays()
59ff7a2beb57 Added an API function to query geometry of multiple monitors: Sam Lantinga <slouken@libsdl.org> parents: 3523 diff changeset	329 */
59ff7a2beb57 Added an API function to query geometry of multiple monitors: Sam Lantinga <slouken@libsdl.org> parents: 3523 diff changeset	330 extern DECLSPEC int SDLCALL SDL_GetDisplayBounds(int index, SDL_Rect * rect);
59ff7a2beb57 Added an API function to query geometry of multiple monitors: Sam Lantinga <slouken@libsdl.org> parents: 3523 diff changeset	331
59ff7a2beb57 Added an API function to query geometry of multiple monitors: Sam Lantinga <slouken@libsdl.org> parents: 3523 diff changeset	332 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	333 * \brief Set the index of the currently selected display.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	334 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	335 * \return 0 on success, or -1 if the index is out of range.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	336 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	337 * \sa SDL_GetNumVideoDisplays()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	338 * \sa SDL_GetCurrentVideoDisplay()
1963 2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	339 */
2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	340 extern DECLSPEC int SDLCALL SDL_SelectVideoDisplay(int index);
2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	341
2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	342 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	343 * \brief Get the index of the currently selected display.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	344 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	345 * \return The index of the currently selected display.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	346 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	347 * \sa SDL_GetNumVideoDisplays()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	348 * \sa SDL_SelectVideoDisplay()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	349 */
1963 2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	350 extern DECLSPEC int SDLCALL SDL_GetCurrentVideoDisplay(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	351
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	352 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	353 * \brief Returns the number of available display modes for the current display.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	354 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	355 * \sa SDL_GetDisplayMode()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	356 */
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	357 extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	358
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	359 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	360 * \brief Fill in information about a specific display mode.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	361 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	362 * \note The display modes are sorted in this priority:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	363 * \li bits per pixel -> more colors to fewer colors
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	364 * \li width -> largest to smallest
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	365 * \li height -> largest to smallest
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	366 * \li refresh rate -> highest to lowest
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	367 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	368 * \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	369 */
1967 01e29c3e9a29 In general, fill in pointers to structures, rather than return them. Sam Lantinga <slouken@libsdl.org> parents: 1966 diff changeset	370 extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int index,
01e29c3e9a29 In general, fill in pointers to structures, rather than return them. Sam Lantinga <slouken@libsdl.org> parents: 1966 diff changeset	371 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	372
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 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	374 * \brief Fill in information about the desktop display mode for the current
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	375 * display.
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	376 */
1967 01e29c3e9a29 In general, fill in pointers to structures, rather than return them. Sam Lantinga <slouken@libsdl.org> parents: 1966 diff changeset	377 extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(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	378
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	379 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	380 * \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	381 */
1967 01e29c3e9a29 In general, fill in pointers to structures, rather than return them. Sam Lantinga <slouken@libsdl.org> parents: 1966 diff changeset	382 extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(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	383
3400 4ec48602f1db iPhone interruption patch / SDL 1.3 Sam Lantinga <slouken@libsdl.org> parents: 3227 diff changeset	384
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	385 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	386 * \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	387 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	388 * \param mode The desired display mode
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	389 * \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	390 * match of the available display modes.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	391 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	392 * \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	393 * was available.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	394 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	395 * 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	396 * 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	397 * 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	398 * 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	399 * 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	400 * small, then NULL is returned.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	401 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	402 * \sa SDL_GetNumDisplayModes()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	403 * \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	404 */
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	405 extern DECLSPEC SDL_DisplayMode *SDLCALL SDL_GetClosestDisplayMode(const
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	406 SDL_DisplayMode
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	407 * 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	408 SDL_DisplayMode
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	409 * closest);
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
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 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	412 * \brief Set the display mode used when a fullscreen window is visible
3500 4b594623401b Work in progress on multi-display support: Sam Lantinga <slouken@libsdl.org> parents: 3493 diff changeset	413 * on the currently selected display. By default the window's
4b594623401b Work in progress on multi-display support: Sam Lantinga <slouken@libsdl.org> parents: 3493 diff changeset	414 * dimensions and the desktop format and refresh rate are used.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	415 *
3500 4b594623401b Work in progress on multi-display support: Sam Lantinga <slouken@libsdl.org> parents: 3493 diff changeset	416 * \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	417 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	418 * \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	419 *
3522 fa1abe1ff8b8 Added related functions Sam Lantinga <slouken@libsdl.org> parents: 3500 diff changeset	420 * \sa SDL_GetWindowDisplayMode()
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	421 * \sa SDL_SetWindowFullscreen()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	422 */
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	423 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	424 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	425 * mode);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	426
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	427 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	428 * \brief Fill in information about the display mode used when a fullscreen
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	429 * window is visible on the currently selected display.
3522 fa1abe1ff8b8 Added related functions Sam Lantinga <slouken@libsdl.org> parents: 3500 diff changeset	430 *
fa1abe1ff8b8 Added related functions Sam Lantinga <slouken@libsdl.org> parents: 3500 diff changeset	431 * \sa SDL_SetWindowDisplayMode()
fa1abe1ff8b8 Added related functions Sam Lantinga <slouken@libsdl.org> parents: 3500 diff changeset	432 * \sa SDL_SetWindowFullscreen()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	433 */
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	434 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	435 SDL_DisplayMode * mode);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	436
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	437 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	438 * \brief Set the palette entries for indexed display modes.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	439 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	440 * \return 0 on success, or -1 if the display mode isn't palettized or the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	441 * colors couldn't be set.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	442 */
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 extern DECLSPEC int SDLCALL SDL_SetDisplayPalette(const SDL_Color * colors,
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 int firstcolor,
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	445 int ncolors);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	446
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	447 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	448 * \brief Gets the palette entries for indexed display modes.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	449 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	450 * \return 0 on success, or -1 if the display mode isn't palettized
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	451 */
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	452 extern DECLSPEC int SDLCALL SDL_GetDisplayPalette(SDL_Color * colors,
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 int firstcolor,
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	454 int ncolors);
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	455
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 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	457 * \brief Set the gamma correction for each of the color channels on the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	458 * currently selected display.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	459 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	460 * \return 0 on success, or -1 if setting the gamma isn't supported.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	461 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	462 * \sa SDL_SetGammaRamp()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	463 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	464 extern DECLSPEC int SDLCALL SDL_SetGamma(float red, float green, float blue);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	465
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	466 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	467 * \brief Set the gamma ramp for the currently selected display.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	468 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	469 * \param red The translation table for the red channel, or NULL.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	470 * \param green The translation table for the green channel, or NULL.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	471 * \param blue The translation table for the blue channel, or NULL.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	472 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	473 * \return 0 on success, or -1 if gamma ramps are unsupported.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	474 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	475 * Set the gamma translation table for the red, green, and blue channels
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	476 * of the video hardware. Each table is an array of 256 16-bit quantities,
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	477 * representing a mapping between the input and output for that channel.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	478 * The input is the index into the array, and the output is the 16-bit
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	479 * gamma value at that index, scaled to the output color precision.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	480 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	481 * \sa SDL_GetGammaRamp()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	482 */
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	483 extern DECLSPEC int SDLCALL SDL_SetGammaRamp(const Uint16 * red,
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	484 const Uint16 * green,
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	485 const Uint16 * blue);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	486
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	487 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	488 * \brief Get the gamma ramp for the currently selected display.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	489 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	490 * \param red A pointer to a 256 element array of 16-bit quantities to hold
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	491 * the translation table for the red channel, or NULL.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	492 * \param green A pointer to a 256 element array of 16-bit quantities to hold
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	493 * the translation table for the green channel, or NULL.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	494 * \param blue A pointer to a 256 element array of 16-bit quantities to hold
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	495 * the translation table for the blue channel, or NULL.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	496 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	497 * \return 0 on success, or -1 if gamma ramps are unsupported.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	498 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	499 * \sa SDL_SetGammaRamp()
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	500 */
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	501 extern DECLSPEC int SDLCALL SDL_GetGammaRamp(Uint16 * red, Uint16 * green,
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	502 Uint16 * blue);
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	503
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
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	505 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	506 * \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	507 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	508 * \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	509 * \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	510 * ::SDL_WINDOWPOS_UNDEFINED.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	511 * \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	512 * ::SDL_WINDOWPOS_UNDEFINED.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	513 * \param w The width of the window.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	514 * \param h The height of the window.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	515 * \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	516 * ::SDL_WINDOW_FULLSCREEN, ::SDL_WINDOW_OPENGL,
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	517 * ::SDL_WINDOW_SHOWN, ::SDL_WINDOW_BORDERLESS,
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	518 * ::SDL_WINDOW_RESIZABLE, ::SDL_WINDOW_MAXIMIZED,
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	519 * ::SDL_WINDOW_MINIMIZED, ::SDL_WINDOW_INPUT_GRABBED.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	520 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	521 * \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	522 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	523 * \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	524 */
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	525 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	526 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	527 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	528
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	529 /**
3493 40b1f7cb2062 SDL_CreateWindowFrom() is actually going to be supported. :) Sam Lantinga <slouken@libsdl.org> parents: 3492 diff changeset	530 * \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	531 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	532 * \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	533 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	534 * \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	535 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	536 * \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	537 */
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	538 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	539
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	540 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	541 * \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	542 */
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	543 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	544
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	545 /**
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	546 * \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	547 */
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	548 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	549
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	550 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	551 * \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	552 */
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	553 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	554
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	555 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	556 * \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	557 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	558 * \sa SDL_GetWindowTitle()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	559 */
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	560 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	561 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	562
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	563 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	564 * \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	565 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	566 * \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	567 */
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	568 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	569
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	570 /**
4887 0a77d2fc95ad Fixed grammar, thanks to Sheena's suggestion. Sam Lantinga <slouken@libsdl.org> parents: 4883 diff changeset	571 * \brief Set the icon for a window.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	572 *
4887 0a77d2fc95ad Fixed grammar, thanks to Sheena's suggestion. Sam Lantinga <slouken@libsdl.org> parents: 4883 diff changeset	573 * \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	574 */
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	575 extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Window * window,
2990 502adab079a4 indent Sam Lantinga <slouken@libsdl.org> parents: 2967 diff changeset	576 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	577
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	578 /**
4869 2b1bcf74e4c4 Documentation clarification Sam Lantinga <slouken@libsdl.org> parents: 4862 diff changeset	579 * \brief Associate an arbitrary pointer with a window.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	580 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	581 * \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	582 */
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	583 extern DECLSPEC void SDLCALL SDL_SetWindowData(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	584 void *userdata);
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	585
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	586 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	587 * \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	588 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	589 * \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	590 */
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	591 extern DECLSPEC void SDLCALL SDL_GetWindowData(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	592
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	593 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	594 * \brief Set the position of a window.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	595 *
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	596 * \param window The window to reposition.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	597 * \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	598 ::SDL_WINDOWPOS_UNDEFINED.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	599 * \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	600 ::SDL_WINDOWPOS_UNDEFINED.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	601 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	602 * \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	603 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	604 * \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	605 */
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	606 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	607 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	608
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 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	610 * \brief Get the position of a window.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	611 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	612 * \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	613 */
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	614 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	615 int x, int y);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	616
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 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	618 * \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	619 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	620 * \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	621 * matches the size of the display mode.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	622 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	623 * \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	624 */
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	625 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	626 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	627
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	628 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	629 * \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	630 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	631 * \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	632 */
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	633 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	634 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	635
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	636 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	637 * \brief Show a window.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	638 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	639 * \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	640 */
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	641 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	642
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	643 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	644 * \brief Hide a window.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	645 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	646 * \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	647 */
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	648 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	649
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	650 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	651 * \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	652 */
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	653 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	654
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	655 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	656 * \brief Make a window as large as possible.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	657 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	658 * \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	659 */
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	660 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	661
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	662 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	663 * \brief Minimize a window to an iconic representation.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	664 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	665 * \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	666 */
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	667 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	668
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	669 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	670 * \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	671 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	672 * \sa SDL_MaximizeWindow()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	673 * \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	674 */
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	675 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	676
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	677 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	678 * \brief Set a window's fullscreen state.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	679 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	680 * \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	681 *
3522 fa1abe1ff8b8 Added related functions Sam Lantinga <slouken@libsdl.org> parents: 3500 diff changeset	682 * \sa SDL_SetWindowDisplayMode()
fa1abe1ff8b8 Added related functions Sam Lantinga <slouken@libsdl.org> parents: 3500 diff changeset	683 * \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	684 */
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	685 extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(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	686 int fullscreen);
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	687
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	688 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	689 * \brief Set a window's input grab mode.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	690 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	691 * \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	692 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	693 * \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	694 */
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	695 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	696 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	697
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	698 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	699 * \brief Get a window's input grab mode.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	700 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	701 * \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	702 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	703 * \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	704 */
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	705 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	706
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	707 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	708 * \brief Get driver specific information about a window.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	709 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	710 * \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	711 */
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	712 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	713 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	714 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	715 *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	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 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	719 */
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	720 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	721
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	722 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	723 * \brief Get the number of 2D rendering drivers available for the current
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	724 * display.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	725 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	726 * A render driver is a set of code that handles rendering and texture
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	727 * management on a particular display. Normally there is only one, but
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	728 * some drivers may have several available with different capabilities.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	729 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	730 * \sa SDL_GetRenderDriverInfo()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	731 * \sa SDL_CreateRenderer()
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	732 */
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	733 extern DECLSPEC int SDLCALL SDL_GetNumRenderDrivers(void);
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	734
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	735 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	736 * \brief Get information about a specific 2D rendering driver for the current
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	737 * display.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	738 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	739 * \param index The index of the driver to query information about.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	740 * \param info A pointer to an SDL_RendererInfo struct to be filled with
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	741 * information on the rendering driver.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	742 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	743 * \return 0 on success, -1 if the index was out of range.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	744 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	745 * \sa SDL_CreateRenderer()
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 */
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	747 extern DECLSPEC int SDLCALL SDL_GetRenderDriverInfo(int index,
5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	748 SDL_RendererInfo * info);
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	749
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	750 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	751 * \brief Create and make active a 2D rendering context for a window.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	752 *
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	753 * \param window The window where rendering is displayed.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	754 * \param index The index of the rendering driver to initialize, or -1 to
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	755 * initialize the first one supporting the requested flags.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	756 * \param flags ::SDL_RendererFlags.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	757 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	758 * \return 0 on success, -1 if there was an error creating the renderer.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	759 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	760 * \sa SDL_SelectRenderer()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	761 * \sa SDL_GetRendererInfo()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	762 * \sa SDL_DestroyRenderer()
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	763 */
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	764 extern DECLSPEC int SDLCALL SDL_CreateRenderer(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	765 int index, 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	766
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	767 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	768 * \brief Select the rendering context for a particular window.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	769 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	770 * \return 0 on success, -1 if the selected window doesn't have a
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	771 * rendering 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	772 */
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	773 extern DECLSPEC int SDLCALL SDL_SelectRenderer(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	774
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	775 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	776 * \brief Get information about the current rendering context.
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	777 */
5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	778 extern DECLSPEC int SDLCALL SDL_GetRendererInfo(SDL_RendererInfo * info);
5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	779
5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	780 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	781 * \brief Create a texture for the current rendering context.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	782 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	783 * \param format The format of the texture.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	784 * \param access One of the enumerated values in ::SDL_TextureAccess.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	785 * \param w The width of the texture in pixels.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	786 * \param h The height of the texture in pixels.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	787 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	788 * \return The created texture is returned, or 0 if no rendering context was
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	789 * active, the format was unsupported, or the width or height were out
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	790 * of range.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	791 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	792 * \sa SDL_QueryTexture()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	793 * \sa SDL_DestroyTexture()
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	794 */
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	795 extern DECLSPEC SDL_Texture * SDLCALL SDL_CreateTexture(Uint32 format,
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	796 int access, 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	797 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	798
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	799 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	800 * \brief Create a texture from an existing surface.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	801 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	802 * \param format The format of the texture, or 0 to pick an appropriate format.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	803 * \param surface The surface containing pixel data used to fill the texture.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	804 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	805 * \return The created texture is returned, or 0 if no rendering context was
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	806 * active, the format was unsupported, or the surface width or height
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	807 * were out of range.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	808 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	809 * \note The surface is not modified or freed by this function.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	810 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	811 * \sa SDL_QueryTexture()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	812 * \sa SDL_DestroyTexture()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	813 */
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	814 extern DECLSPEC SDL_Texture * SDLCALL SDL_CreateTextureFromSurface(Uint32
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	815 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	816 SDL_Surface
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	817 * surface);
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	818
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	819 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	820 * \brief Query the attributes of a texture
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	821 *
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	822 * \param texture A texture to be queried.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	823 * \param format A pointer filled in with the raw format of the texture. The
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	824 * actual format may differ, but pixel transfers will use this
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	825 * format.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	826 * \param access A pointer filled in with the actual access to the texture.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	827 * \param w A pointer filled in with the width of the texture in pixels.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	828 * \param h A pointer filled in with the height of the texture in pixels.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	829 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	830 * \return 0 on success, or -1 if the texture is not valid.
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	831 */
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	832 extern DECLSPEC int SDLCALL SDL_QueryTexture(SDL_Texture * texture,
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	833 Uint32 * format, int *access,
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	834 int w, 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	835
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	836 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	837 * \brief Query the pixels of a texture, if the texture does not need to be
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	838 * locked for pixel access.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	839 *
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	840 * \param texture A texture to be queried, which was created with
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	841 * ::SDL_TEXTUREACCESS_STREAMING.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	842 * \param pixels A pointer filled with a pointer to the pixels for the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	843 * texture.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	844 * \param pitch A pointer filled in with the pitch of the pixel data.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	845 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	846 * \return 0 on success, or -1 if the texture is not valid, or must be locked
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	847 * for pixel access.
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	848 */
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	849 extern DECLSPEC int SDLCALL SDL_QueryTexturePixels(SDL_Texture * texture,
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	850 void *pixels, int pitch);
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	851
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	852 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	853 * \brief Set the color palette of an indexed texture.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	854 *
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	855 * \param texture The texture to update.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	856 * \param colors The array of RGB color data.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	857 * \param firstcolor The first index to update.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	858 * \param ncolors The number of palette entries to fill with the color data.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	859 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	860 * \return 0 on success, or -1 if the texture is not valid or not an indexed
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	861 * texture.
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	862 */
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	863 extern DECLSPEC int SDLCALL SDL_SetTexturePalette(SDL_Texture * texture,
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	864 const SDL_Color * colors,
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	865 int firstcolor,
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	866 int ncolors);
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	867
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	868 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	869 * \brief Get the color palette from an indexed texture if it has one.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	870 *
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	871 * \param texture The texture to update.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	872 * \param colors The array to fill with RGB color data.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	873 * \param firstcolor The first index to retrieve.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	874 * \param ncolors The number of palette entries to retrieve.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	875 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	876 * \return 0 on success, or -1 if the texture is not valid or not an indexed
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	877 * texture.
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	878 */
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	879 extern DECLSPEC int SDLCALL SDL_GetTexturePalette(SDL_Texture * texture,
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	880 SDL_Color * colors,
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	881 int firstcolor,
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	882 int ncolors);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	883
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	884 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	885 * \brief Set an additional color value used in render copy operations.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	886 *
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	887 * \param texture The texture to update.
4971 158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4929 diff changeset	888 * \param r The red color value multiplied into copy operations.
158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4929 diff changeset	889 * \param g The green color value multiplied into copy operations.
158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4929 diff changeset	890 * \param b The blue color value multiplied into copy operations.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	891 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	892 * \return 0 on success, or -1 if the texture is not valid or color modulation
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	893 * is not supported.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	894 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	895 * \sa SDL_GetTextureColorMod()
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	896 */
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	897 extern DECLSPEC int SDLCALL SDL_SetTextureColorMod(SDL_Texture * texture,
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	898 Uint8 r, Uint8 g, Uint8 b);
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	899
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	900
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	901 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	902 * \brief Get the additional color value used in render copy operations.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	903 *
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	904 * \param texture The texture to query.
4971 158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4929 diff changeset	905 * \param r A pointer filled in with the current red color value.
158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4929 diff changeset	906 * \param g A pointer filled in with the current green color value.
158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4929 diff changeset	907 * \param b A pointer filled in with the current blue color value.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	908 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	909 * \return 0 on success, or -1 if the texture is not valid.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	910 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	911 * \sa SDL_SetTextureColorMod()
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	912 */
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	913 extern DECLSPEC int SDLCALL SDL_GetTextureColorMod(SDL_Texture * texture,
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	914 Uint8 * r, Uint8 * g,
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	915 Uint8 * b);
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	916
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	917 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	918 * \brief Set an additional alpha value used in render copy operations.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	919 *
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	920 * \param texture The texture to update.
4971 158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4929 diff changeset	921 * \param alpha The alpha value multiplied into copy operations.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	922 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	923 * \return 0 on success, or -1 if the texture is not valid or alpha modulation
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	924 * is not supported.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	925 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	926 * \sa SDL_GetTextureAlphaMod()
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	927 */
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	928 extern DECLSPEC int SDLCALL SDL_SetTextureAlphaMod(SDL_Texture * texture,
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	929 Uint8 alpha);
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	930
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	931 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	932 * \brief Get the additional alpha value used in render copy operations.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	933 *
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	934 * \param texture The texture to query.
4971 158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4929 diff changeset	935 * \param alpha A pointer filled in with the current alpha value.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	936 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	937 * \return 0 on success, or -1 if the texture is not valid.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	938 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	939 * \sa SDL_SetTextureAlphaMod()
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	940 */
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	941 extern DECLSPEC int SDLCALL SDL_GetTextureAlphaMod(SDL_Texture * texture,
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	942 Uint8 * alpha);
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	943
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	944 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	945 * \brief Set the blend mode used for texture copy operations.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	946 *
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	947 * \param texture The texture to update.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	948 * \param blendMode ::SDL_BlendMode to use for texture blending.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	949 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	950 * \return 0 on success, or -1 if the texture is not valid or the blend mode is
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	951 * not supported.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	952 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	953 * \note If the blend mode is not supported, the closest supported mode is
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	954 * chosen.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	955 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	956 * \sa SDL_GetTextureBlendMode()
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	957 */
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	958 extern DECLSPEC int SDLCALL SDL_SetTextureBlendMode(SDL_Texture * texture,
4929 aa8888658021 Use the enumerated type for blend and scale mode instead of int Sam Lantinga <slouken@libsdl.org> parents: 4887 diff changeset	959 SDL_BlendMode blendMode);
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	960
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	961 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	962 * \brief Get the blend mode used for texture copy operations.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	963 *
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	964 * \param texture The texture to query.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	965 * \param blendMode A pointer filled in with the current blend mode.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	966 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	967 * \return 0 on success, or -1 if the texture is not valid.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	968 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	969 * \sa SDL_SetTextureBlendMode()
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	970 */
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	971 extern DECLSPEC int SDLCALL SDL_GetTextureBlendMode(SDL_Texture * texture,
4929 aa8888658021 Use the enumerated type for blend and scale mode instead of int Sam Lantinga <slouken@libsdl.org> parents: 4887 diff changeset	972 SDL_BlendMode *blendMode);
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	973
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	974 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	975 * \brief Set the scale mode used for texture copy operations.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	976 *
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	977 * \param texture The texture to update.
4929 aa8888658021 Use the enumerated type for blend and scale mode instead of int Sam Lantinga <slouken@libsdl.org> parents: 4887 diff changeset	978 * \param scaleMode ::SDL_ScaleMode to use for texture scaling.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	979 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	980 * \return 0 on success, or -1 if the texture is not valid or the scale mode is
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	981 * not supported.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	982 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	983 * \note If the scale mode is not supported, the closest supported mode is
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	984 * chosen.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	985 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	986 * \sa SDL_GetTextureScaleMode()
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	987 */
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	988 extern DECLSPEC int SDLCALL SDL_SetTextureScaleMode(SDL_Texture * texture,
4929 aa8888658021 Use the enumerated type for blend and scale mode instead of int Sam Lantinga <slouken@libsdl.org> parents: 4887 diff changeset	989 SDL_ScaleMode scaleMode);
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	990
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	991 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	992 * \brief Get the scale mode used for texture copy operations.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	993 *
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	994 * \param texture The texture to query.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	995 * \param scaleMode A pointer filled in with the current scale mode.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	996 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	997 * \return 0 on success, or -1 if the texture is not valid.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	998 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	999 * \sa SDL_SetTextureScaleMode()
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1000 */
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	1001 extern DECLSPEC int SDLCALL SDL_GetTextureScaleMode(SDL_Texture * texture,
4929 aa8888658021 Use the enumerated type for blend and scale mode instead of int Sam Lantinga <slouken@libsdl.org> parents: 4887 diff changeset	1002 SDL_ScaleMode *scaleMode);
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1003
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1004 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1005 * \brief Update the given texture rectangle with new pixel data.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1006 *
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	1007 * \param texture The texture to update
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1008 * \param rect A pointer to the rectangle of pixels to update, or NULL to
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1009 * update the entire texture.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1010 * \param pixels The raw pixel data.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1011 * \param pitch The number of bytes between rows of pixel data.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1012 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1013 * \return 0 on success, or -1 if the texture is not valid.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1014 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1015 * \note This is a fairly slow function.
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	1016 */
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	1017 extern DECLSPEC int SDLCALL SDL_UpdateTexture(SDL_Texture * texture,
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	1018 const SDL_Rect * rect,
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	1019 const void *pixels, int pitch);
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	1020
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	1021 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1022 * \brief Lock a portion of the texture for pixel access.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1023 *
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	1024 * \param texture The texture to lock for access, which was created with
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1025 * ::SDL_TEXTUREACCESS_STREAMING.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1026 * \param rect A pointer to the rectangle to lock for access. If the rect
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1027 * is NULL, the entire texture will be locked.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1028 * \param markDirty If this is nonzero, the locked area will be marked dirty
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1029 * when the texture is unlocked.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1030 * \param pixels This is filled in with a pointer to the locked pixels,
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1031 * appropriately offset by the locked area.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1032 * \param pitch This is filled in with the pitch of the locked pixels.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1033 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1034 * \return 0 on success, or -1 if the texture is not valid or was created with
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1035 * ::SDL_TEXTUREACCESS_STATIC.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1036 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1037 * \sa SDL_DirtyTexture()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1038 * \sa SDL_UnlockTexture()
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	1039 */
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	1040 extern DECLSPEC int SDLCALL SDL_LockTexture(SDL_Texture * texture,
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	1041 const SDL_Rect * rect,
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	1042 int markDirty, void **pixels,
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	1043 int *pitch);
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	1044
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	1045 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1046 * \brief Unlock a texture, uploading the changes to video memory, if needed.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1047 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1048 * \sa SDL_LockTexture()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1049 * \sa SDL_DirtyTexture()
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	1050 */
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	1051 extern DECLSPEC void SDLCALL SDL_UnlockTexture(SDL_Texture * texture);
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	1052
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	1053 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1054 * \brief Mark the specified rectangles of the texture as dirty.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1055 *
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	1056 * \param texture The texture to mark dirty, which was created with
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1057 * ::SDL_TEXTUREACCESS_STREAMING.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1058 * \param numrects The number of rectangles pointed to by rects.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1059 * \param rects The pointer to an array of dirty rectangles.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1060 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1061 * \sa SDL_LockTexture()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1062 * \sa SDL_UnlockTexture()
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	1063 */
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	1064 extern DECLSPEC void SDLCALL SDL_DirtyTexture(SDL_Texture * texture,
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	1065 int numrects,
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	1066 const SDL_Rect * rects);
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	1067
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	1068 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1069 * \brief Set the color used for drawing operations (Fill and Line).
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1070 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1071 * \param r The red value used to draw on the rendering target.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1072 * \param g The green value used to draw on the rendering target.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1073 * \param b The blue value used to draw on the rendering target.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1074 * \param a The alpha value used to draw on the rendering target, usually
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1075 * ::SDL_ALPHA_OPAQUE (255).
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1076 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1077 * \return 0 on success, or -1 if there is no rendering context current.
2884 9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1078 */
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1079 extern DECLSPEC int SDL_SetRenderDrawColor(Uint8 r, Uint8 g, Uint8 b,
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1080 Uint8 a);
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1081
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1082 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1083 * \brief Get the color used for drawing operations (Fill and Line).
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1084 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1085 * \param r A pointer to the red value used to draw on the rendering target.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1086 * \param g A pointer to the green value used to draw on the rendering target.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1087 * \param b A pointer to the blue value used to draw on the rendering target.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1088 * \param a A pointer to the alpha value used to draw on the rendering target,
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1089 * usually ::SDL_ALPHA_OPAQUE (255).
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1090 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1091 * \return 0 on success, or -1 if there is no rendering context current.
2884 9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1092 */
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1093 extern DECLSPEC int SDL_GetRenderDrawColor(Uint8 * r, Uint8 * g, Uint8 * b,
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1094 Uint8 * a);
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1095
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1096 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1097 * \brief Set the blend mode used for drawing operations (Fill and Line).
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1098 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1099 * \param blendMode ::SDL_BlendMode to use for blending.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1100 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1101 * \return 0 on success, or -1 if there is no rendering context current.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1102 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1103 * \note If the blend mode is not supported, the closest supported mode is
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1104 * chosen.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1105 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1106 * \sa SDL_GetRenderDrawBlendMode()
2884 9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1107 */
4929 aa8888658021 Use the enumerated type for blend and scale mode instead of int Sam Lantinga <slouken@libsdl.org> parents: 4887 diff changeset	1108 extern DECLSPEC int SDLCALL SDL_SetRenderDrawBlendMode(SDL_BlendMode blendMode);
2884 9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1109
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1110 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1111 * \brief Get the blend mode used for drawing operations.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1112 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1113 * \param blendMode A pointer filled in with the current blend mode.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1114 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1115 * \return 0 on success, or -1 if there is no rendering context current.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1116 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1117 * \sa SDL_SetRenderDrawBlendMode()
2884 9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1118 */
4929 aa8888658021 Use the enumerated type for blend and scale mode instead of int Sam Lantinga <slouken@libsdl.org> parents: 4887 diff changeset	1119 extern DECLSPEC int SDLCALL SDL_GetRenderDrawBlendMode(SDL_BlendMode *blendMode);
2884 9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1120
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1121 /**
3596 f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1122 * \brief Clear the current rendering target with the drawing color
f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1123 */
3677 cec9ea711294 Fixed compiler warning Sam Lantinga <slouken@libsdl.org> parents: 3603 diff changeset	1124 extern DECLSPEC int SDLCALL SDL_RenderClear(void);
3596 f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1125
f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1126 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1127 * \brief Draw a point on the current rendering target.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1128 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1129 * \param x The x coordinate of the point.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1130 * \param y The y coordinate of the point.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1131 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1132 * \return 0 on success, or -1 if there is no rendering context current.
2901 133601e3b255 Added RenderPiont() API Sam Lantinga <slouken@libsdl.org> parents: 2886 diff changeset	1133 */
3596 f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1134 extern DECLSPEC int SDLCALL SDL_RenderDrawPoint(int x, int y);
2901 133601e3b255 Added RenderPiont() API Sam Lantinga <slouken@libsdl.org> parents: 2886 diff changeset	1135
133601e3b255 Added RenderPiont() API Sam Lantinga <slouken@libsdl.org> parents: 2886 diff changeset	1136 /**
4876 876f97bc7275 Documentation clarification Sam Lantinga <slouken@libsdl.org> parents: 4875 diff changeset	1137 * \brief Draw multiple points on the current rendering target.
3536 0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3528 diff changeset	1138 *
0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3528 diff changeset	1139 * \param points The points to draw
0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3528 diff changeset	1140 * \param count The number of points to draw
0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3528 diff changeset	1141 *
0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3528 diff changeset	1142 * \return 0 on success, or -1 if there is no rendering context current.
0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3528 diff changeset	1143 */
3596 f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1144 extern DECLSPEC int SDLCALL SDL_RenderDrawPoints(const SDL_Point * points,
f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1145 int count);
3536 0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3528 diff changeset	1146
0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3528 diff changeset	1147 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1148 * \brief Draw a line on the current rendering target.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1149 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1150 * \param x1 The x coordinate of the start point.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1151 * \param y1 The y coordinate of the start point.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1152 * \param x2 The x coordinate of the end point.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1153 * \param y2 The y coordinate of the end point.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1154 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1155 * \return 0 on success, or -1 if there is no rendering context current.
2884 9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1156 */
3596 f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1157 extern DECLSPEC int SDLCALL SDL_RenderDrawLine(int x1, int y1, int x2, int y2);
2884 9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1158
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1159 /**
3536 0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3528 diff changeset	1160 * \brief Draw a series of connected lines on the current rendering target.
0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3528 diff changeset	1161 *
0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3528 diff changeset	1162 * \param points The points along the lines
0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3528 diff changeset	1163 * \param count The number of points, drawing count-1 lines
0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3528 diff changeset	1164 *
0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3528 diff changeset	1165 * \return 0 on success, or -1 if there is no rendering context current.
0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3528 diff changeset	1166 */
3596 f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1167 extern DECLSPEC int SDLCALL SDL_RenderDrawLines(const SDL_Point * points,
f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1168 int count);
3536 0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3528 diff changeset	1169
0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3528 diff changeset	1170 /**
4878 e1f1b209c196 Documentation consistency Sam Lantinga <slouken@libsdl.org> parents: 4877 diff changeset	1171 * \brief Draw a rectangle on the current rendering target.
3596 f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1172 *
f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1173 * \param rect A pointer to the destination rectangle, or NULL to outline the entire rendering target.
f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1174 *
f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1175 * \return 0 on success, or -1 if there is no rendering context current.
f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1176 */
f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1177 extern DECLSPEC int SDLCALL SDL_RenderDrawRect(const SDL_Rect * rect);
f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1178
f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1179 /**
4878 e1f1b209c196 Documentation consistency Sam Lantinga <slouken@libsdl.org> parents: 4877 diff changeset	1180 * \brief Draw some number of rectangles on the current rendering target.
3596 f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1181 *
f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1182 * \param rects A pointer to an array of destination rectangles.
f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1183 * \param count The number of rectangles.
f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1184 *
f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1185 * \return 0 on success, or -1 if there is no rendering context current.
f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1186 */
4877 f191762fb5c6 Fixed typo in header Sam Lantinga <slouken@libsdl.org> parents: 4876 diff changeset	1187 extern DECLSPEC int SDLCALL SDL_RenderDrawRects(const SDL_Rect ** rects, int count);
3596 f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1188
f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1189 /**
f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1190 * \brief Fill a rectangle on the current rendering target with the drawing color.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1191 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1192 * \param rect A pointer to the destination rectangle, or NULL for the entire
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1193 * rendering target.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1194 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1195 * \return 0 on success, or -1 if there is no rendering context current.
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	1196 */
3596 f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1197 extern DECLSPEC int SDLCALL SDL_RenderFillRect(const SDL_Rect * rect);
3536 0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3528 diff changeset	1198
0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3528 diff changeset	1199 /**
4879 64a1db785f2c Documentation consistency Sam Lantinga <slouken@libsdl.org> parents: 4878 diff changeset	1200 * \brief Fill some number of rectangles on the current rendering target with the drawing color.
3536 0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3528 diff changeset	1201 *
0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3528 diff changeset	1202 * \param rects A pointer to an array of destination rectangles.
0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3528 diff changeset	1203 * \param count The number of rectangles.
0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3528 diff changeset	1204 *
0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3528 diff changeset	1205 * \return 0 on success, or -1 if there is no rendering context current.
0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3528 diff changeset	1206 */
3596 f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1207 extern DECLSPEC int SDLCALL SDL_RenderFillRects(const SDL_Rect ** rect, int count);
f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	1208
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	1209 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1210 * \brief Copy a portion of the texture to the current rendering target.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1211 *
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	1212 * \param texture The source texture.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1213 * \param srcrect A pointer to the source rectangle, or NULL for the entire
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1214 * texture.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1215 * \param dstrect A pointer to the destination rectangle, or NULL for the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1216 * entire rendering target.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1217 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1218 * \return 0 on success, or -1 if there is no rendering context current, or the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1219 * driver doesn't support the requested operation.
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	1220 */
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	1221 extern DECLSPEC int SDLCALL SDL_RenderCopy(SDL_Texture * texture,
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	1222 const SDL_Rect * srcrect,
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1223 const SDL_Rect * dstrect);
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	1224
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	1225 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1226 * \brief Read pixels from the current rendering target.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1227 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1228 * \param rect A pointer to the rectangle to read, or NULL for the entire
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1229 * render target.
3435 9f62f47d989b You can specify the format for pixel data in SDL_RenderReadPixels() and SDL_RenderWritePixels() Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	1230 * \param format The desired format of the pixel data, or 0 to use the format
9f62f47d989b You can specify the format for pixel data in SDL_RenderReadPixels() and SDL_RenderWritePixels() Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	1231 * of the rendering target
9f62f47d989b You can specify the format for pixel data in SDL_RenderReadPixels() and SDL_RenderWritePixels() Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	1232 * \param pixels A pointer to be filled in with the pixel data
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1233 * \param pitch The pitch of the pixels parameter.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1234 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1235 * \return 0 on success, or -1 if pixel reading is not supported.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1236 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1237 * \warning This is a very slow operation, and should not be used frequently.
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	1238 */
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	1239 extern DECLSPEC int SDLCALL SDL_RenderReadPixels(const SDL_Rect * rect,
3435 9f62f47d989b You can specify the format for pixel data in SDL_RenderReadPixels() and SDL_RenderWritePixels() Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	1240 Uint32 format,
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	1241 void *pixels, int pitch);
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	1242
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	1243 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1244 * \brief Write pixels to the current rendering target.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1245 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1246 * \param rect A pointer to the rectangle to write, or NULL for the entire
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1247 * render target.
3435 9f62f47d989b You can specify the format for pixel data in SDL_RenderReadPixels() and SDL_RenderWritePixels() Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	1248 * \param format The format of the pixel data, or 0 to use the format
9f62f47d989b You can specify the format for pixel data in SDL_RenderReadPixels() and SDL_RenderWritePixels() Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	1249 * of the rendering target
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1250 * \param pixels A pointer to the pixel data to write.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1251 * \param pitch The pitch of the pixels parameter.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1252 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1253 * \return 0 on success, or -1 if pixel writing is not supported.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1254 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1255 * \warning This is a very slow operation, and should not be used frequently.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1256 */
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	1257 extern DECLSPEC int SDLCALL SDL_RenderWritePixels(const SDL_Rect * rect,
3435 9f62f47d989b You can specify the format for pixel data in SDL_RenderReadPixels() and SDL_RenderWritePixels() Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	1258 Uint32 format,
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	1259 const void *pixels,
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	1260 int pitch);
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	1261
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	1262 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1263 * \brief Update the screen with rendering performed.
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	1264 */
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	1265 extern DECLSPEC void SDLCALL SDL_RenderPresent(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	1266
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	1267 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1268 * \brief Destroy the specified texture.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1269 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1270 * \sa SDL_CreateTexture()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1271 * \sa SDL_CreateTextureFromSurface()
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	1272 */
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	1273 extern DECLSPEC void SDLCALL SDL_DestroyTexture(SDL_Texture * texture);
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	1274
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	1275 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1276 * \brief Destroy the rendering context for a window and free associated
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1277 * textures.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1278 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1279 * \sa SDL_CreateRenderer()
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	1280 */
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	1281 extern DECLSPEC void SDLCALL SDL_DestroyRenderer(SDL_Window * window);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1282
3025 54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1283 /**
4875 22ce07e8e824 Suspending the screensaver defaults off. Sam Lantinga <slouken@libsdl.org> parents: 4869 diff changeset	1284 * \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	1285 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1286 * \sa SDL_EnableScreenSaver()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1287 * \sa SDL_DisableScreenSaver()
3025 54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1288 */
3033 4e4f47c5f941 Fix third party "-Wall -Werror" builds Couriersud <couriersud@arcor.de> parents: 3025 diff changeset	1289 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	1290
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1291 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1292 * \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	1293 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1294 * \sa SDL_IsScreenSaverEnabled()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1295 * \sa SDL_DisableScreenSaver()
3025 54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1296 */
3033 4e4f47c5f941 Fix third party "-Wall -Werror" builds Couriersud <couriersud@arcor.de> parents: 3025 diff changeset	1297 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	1298
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1299 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1300 * \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	1301 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1302 * \sa SDL_IsScreenSaverEnabled()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1303 * \sa SDL_EnableScreenSaver()
3025 54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1304 */
3033 4e4f47c5f941 Fix third party "-Wall -Werror" builds Couriersud <couriersud@arcor.de> parents: 3025 diff changeset	1305 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	1306
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1307
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1308 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1309 * \name OpenGL support functions
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1310 */
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1311 /@{/
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1312
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	1313 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1314 * \brief Dynamically load an OpenGL library.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1315 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1316 * \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	1317 * default OpenGL library.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1318 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1319 * \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	1320 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1321 * 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	1322 * 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	1323 * 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	1324 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1325 * \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	1326 * 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	1327 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1328 * \sa SDL_GL_GetProcAddress()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1329 * \sa SDL_GL_UnloadLibrary()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1330 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	1331 extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1332
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	1333 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1334 * \brief Get the address of an OpenGL function.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1335 */
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	1336 extern DECLSPEC void SDLCALL SDL_GL_GetProcAddress(const char proc);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1337
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	1338 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1339 * \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	1340 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1341 * \sa SDL_GL_LoadLibrary()
3057 089a77aebb7d Added test program for SDL_CreateWindowFrom() Sam Lantinga <slouken@libsdl.org> parents: 3033 diff changeset	1342 */
089a77aebb7d Added test program for SDL_CreateWindowFrom() Sam Lantinga <slouken@libsdl.org> parents: 3033 diff changeset	1343 extern DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void);
089a77aebb7d Added test program for SDL_CreateWindowFrom() Sam Lantinga <slouken@libsdl.org> parents: 3033 diff changeset	1344
089a77aebb7d Added test program for SDL_CreateWindowFrom() Sam Lantinga <slouken@libsdl.org> parents: 3033 diff changeset	1345 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1346 * \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	1347 * context.
1926 307355678142 Added SDL_GL_ExtensionSupported() Sam Lantinga <slouken@libsdl.org> parents: 1920 diff changeset	1348 */
307355678142 Added SDL_GL_ExtensionSupported() Sam Lantinga <slouken@libsdl.org> parents: 1920 diff changeset	1349 extern DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported(const char
307355678142 Added SDL_GL_ExtensionSupported() Sam Lantinga <slouken@libsdl.org> parents: 1920 diff changeset	1350 *extension);
307355678142 Added SDL_GL_ExtensionSupported() Sam Lantinga <slouken@libsdl.org> parents: 1920 diff changeset	1351
307355678142 Added SDL_GL_ExtensionSupported() Sam Lantinga <slouken@libsdl.org> parents: 1920 diff changeset	1352 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1353 * \brief Set an OpenGL window attribute before window creation.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1354 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	1355 extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1356
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	1357 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1358 * \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	1359 */
1936 83946ee0ff1f Implemented OpenGL support on Mac OS X Sam Lantinga <slouken@libsdl.org> parents: 1926 diff changeset	1360 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	1361
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	1362 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1363 * \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	1364 * current.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1365 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1366 * \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	1367 */
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	1368 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	1369 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	1370
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	1371 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1372 * \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	1373 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1374 * \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	1375 */
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	1376 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	1377 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	1378
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	1379 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1380 * \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	1381 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1382 * \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	1383 * vertical retrace.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1384 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1385 * \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	1386 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1387 * \sa SDL_GL_GetSwapInterval()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1388 */
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	1389 extern DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1390
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	1391 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1392 * \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	1393 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1394 * \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	1395 * 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	1396 * the swap interval is not supported.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1397 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1398 * \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	1399 */
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	1400 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	1401
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	1402 /**
4883 511948f4919e Fixed documentation Sam Lantinga <slouken@libsdl.org> parents: 4879 diff changeset	1403 * \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	1404 * supported.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1405 */
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	1406 extern DECLSPEC void SDLCALL SDL_GL_SwapWindow(SDL_Window * window);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1407
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	1408 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1409 * \brief Delete an OpenGL context.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1410 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1411 * \sa SDL_GL_CreateContext()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1412 */
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	1413 extern DECLSPEC void SDLCALL SDL_GL_DeleteContext(SDL_GLContext context);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1414
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1415 /@}//OpenGL support functions/
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3400 diff changeset	1416
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1417
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1418 /* Ends C function definitions when using C++ */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1419 #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	1420 /* INDENT-OFF */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1421 }
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	1422 /* INDENT-ON */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1423 #endif
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1424 #include "close_code.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1425
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1426 #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	1427
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	1428 /* vi: set ts=4 sw=4 expandtab: */

Mercurial > sdl-ios-xcode

annotate include/SDL_video.h @ 4981:55b82067815b