sdl-ios-xcode: include/SDL

annotate include/SDL_video.h @ 3025:54fac87e1f34

Added an API to enable/disable the screen saver. The screensaver is disabled by default when using SDL 1.2 compatibility. Use the new XScreenSaver extension, removed unused DPMS extension.

author	Sam Lantinga <slouken@libsdl.org>
date	Mon, 12 Jan 2009 06:19:05 +0000
parents	502adab079a4
children	4e4f47c5f941

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
2859 99210400e8b9 Updated copyright date Sam Lantinga <slouken@libsdl.org> parents: 2747 diff changeset	3 Copyright (C) 1997-2009 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 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	24 * \file SDL_video.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	25 *
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: 2267 diff changeset	26 * Header file for SDL video functions.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	27 */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	28
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	29 #ifndef _SDL_video_h
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	30 #define _SDL_video_h
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	31
1356 67114343400d * empty log message * Sam Lantinga <slouken@libsdl.org> parents: 1330 diff changeset	32 #include "SDL_stdinc.h"
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	33 #include "SDL_pixels.h"
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: 2267 diff changeset	34 #include "SDL_rect.h"
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: 2267 diff changeset	35 #include "SDL_surface.h"
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	36
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	37 #include "begin_code.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	38 /* Set up for C function definitions, even when using C++ */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	39 #ifdef __cplusplus
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	40 /* INDENT-OFF */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	41 extern "C" {
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	42 /* INDENT-ON */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	43 #endif
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	44
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	45 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	46 * \struct 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	47 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	48 * \brief The structure that defines a display 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	49 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	50 * \sa SDL_GetNumDisplayModes()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	51 * \sa SDL_GetDisplayMode()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	52 * \sa SDL_GetDesktopDisplayMode()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	53 * \sa SDL_GetCurrentDisplayMode()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	54 * \sa SDL_GetClosestDisplayMode()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	55 * \sa SDL_SetDisplayMode()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	56 */
c121d94672cb SDL 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 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	58 {
c121d94672cb SDL 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 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	60 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	61 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	62 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	63 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	64 } SDL_DisplayMode;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	65
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	66 /**
c121d94672cb SDL 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 * \typedef SDL_WindowID
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	68 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	69 * \brief The type used to identify a window
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	70 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	71 * \sa SDL_CreateWindow()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	72 * \sa SDL_CreateWindowFrom()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	73 * \sa SDL_DestroyWindow()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	74 * \sa SDL_GetWindowData()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	75 * \sa SDL_GetWindowFlags()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	76 * \sa SDL_GetWindowGrab()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	77 * \sa SDL_GetWindowPosition()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	78 * \sa SDL_GetWindowSize()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	79 * \sa SDL_GetWindowTitle()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	80 * \sa SDL_HideWindow()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	81 * \sa SDL_MaximizeWindow()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	82 * \sa SDL_MinimizeWindow()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	83 * \sa SDL_RaiseWindow()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	84 * \sa SDL_RestoreWindow()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	85 * \sa SDL_SetWindowData()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	86 * \sa SDL_SetWindowFullscreen()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	87 * \sa SDL_SetWindowGrab()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	88 * \sa SDL_SetWindowIcon()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	89 * \sa SDL_SetWindowPosition()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	90 * \sa SDL_SetWindowSize()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	91 * \sa SDL_SetWindowTitle()
c121d94672cb SDL 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 * \sa SDL_ShowWindow()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	93 */
c121d94672cb SDL 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 typedef Uint32 SDL_WindowID;
c121d94672cb SDL 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
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	96 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	97 * \enum 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	98 *
c121d94672cb SDL 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 * \brief The flags on a window
c121d94672cb SDL 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 *
c121d94672cb SDL 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 * \sa SDL_GetWindowFlags()
c121d94672cb SDL 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 */
c121d94672cb SDL 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 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	104 {
c121d94672cb SDL 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_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	106 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	107 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	108 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	109 SDL_WINDOW_RESIZABLE = 0x00000010, /*< window can be resized /
c121d94672cb SDL 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_MINIMIZED = 0x00000020, /*< minimized /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	111 SDL_WINDOW_MAXIMIZED = 0x00000040, /*< maximized /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	112 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	113 SDL_WINDOW_INPUT_FOCUS = 0x00000200, /*< window has input focus /
2208 b03710fb0333 Fixed bug #467 Sam Lantinga <slouken@libsdl.org> parents: 2131 diff changeset	114 SDL_WINDOW_MOUSE_FOCUS = 0x00000400 /*< window has mouse 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	115 } 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	116
c121d94672cb SDL 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 * \def SDL_WINDOWPOS_UNDEFINED
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	119 * \brief Used to indicate that you don't care what the window position is.
c121d94672cb SDL 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 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	121 #define SDL_WINDOWPOS_UNDEFINED 0x7FFFFFF
c121d94672cb SDL 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 * \def SDL_WINDOWPOS_CENTERED
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	124 * \brief Used to indicate that the window position should be centered.
c121d94672cb SDL 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 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	126 #define SDL_WINDOWPOS_CENTERED 0x7FFFFFE
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	127
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	128 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	129 * \enum SDL_WindowEventID
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	130 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	131 * \brief Event subtype for window events
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	132 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	133 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	134 {
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	135 SDL_WINDOWEVENT_NONE, /*< Never used /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	136 SDL_WINDOWEVENT_SHOWN, /*< Window has been shown /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	137 SDL_WINDOWEVENT_HIDDEN, /*< Window has been hidden /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	138 SDL_WINDOWEVENT_EXPOSED, /*< Window has been exposed and should be redrawn /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	139 SDL_WINDOWEVENT_MOVED, /*< Window has been moved to data1,data2 /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	140 SDL_WINDOWEVENT_RESIZED, /*< Window size changed to data1xdata2 /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	141 SDL_WINDOWEVENT_MINIMIZED, /*< Window has been minimized /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	142 SDL_WINDOWEVENT_MAXIMIZED, /*< Window has been maximized /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	143 SDL_WINDOWEVENT_RESTORED, /*< Window has been restored to normal size and position /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	144 SDL_WINDOWEVENT_ENTER, /*< The window has gained mouse 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	145 SDL_WINDOWEVENT_LEAVE, /*< The window has lost mouse 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	146 SDL_WINDOWEVENT_FOCUS_GAINED, /*< The window has gained keyboard 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	147 SDL_WINDOWEVENT_FOCUS_LOST, /*< The window has lost keyboard focus /
2208 b03710fb0333 Fixed bug #467 Sam Lantinga <slouken@libsdl.org> parents: 2131 diff changeset	148 SDL_WINDOWEVENT_CLOSE /*< The window manager requests that the window be closed /
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	149 } SDL_WindowEventID;
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	150
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	151 /**
c121d94672cb SDL 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 * \enum SDL_RendererFlags
c121d94672cb SDL 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 *
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	154 * \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	155 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	156 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	157 {
1965 a788656ca29a SDL constants are all uppercase. Sam Lantinga <slouken@libsdl.org> parents: 1963 diff changeset	158 SDL_RENDERER_SINGLEBUFFER = 0x00000001, /*< Render directly to the window, if possible /
a788656ca29a SDL constants are all uppercase. Sam Lantinga <slouken@libsdl.org> parents: 1963 diff changeset	159 SDL_RENDERER_PRESENTCOPY = 0x00000002, /*< Present uses a copy from back buffer to the front buffer /
a788656ca29a SDL constants are all uppercase. Sam Lantinga <slouken@libsdl.org> parents: 1963 diff changeset	160 SDL_RENDERER_PRESENTFLIP2 = 0x00000004, /*< Present uses a flip, swapping back buffer and front buffer /
a788656ca29a SDL constants are all uppercase. Sam Lantinga <slouken@libsdl.org> parents: 1963 diff changeset	161 SDL_RENDERER_PRESENTFLIP3 = 0x00000008, /*< Present uses a flip, rotating between two back buffers and a front buffer /
a788656ca29a SDL constants are all uppercase. Sam Lantinga <slouken@libsdl.org> parents: 1963 diff changeset	162 SDL_RENDERER_PRESENTDISCARD = 0x00000010, /*< Present leaves the contents of the backbuffer undefined /
a788656ca29a SDL constants are all uppercase. Sam Lantinga <slouken@libsdl.org> parents: 1963 diff changeset	163 SDL_RENDERER_PRESENTVSYNC = 0x00000020, /*< Present is synchronized with the refresh rate /
2208 b03710fb0333 Fixed bug #467 Sam Lantinga <slouken@libsdl.org> parents: 2131 diff changeset	164 SDL_RENDERER_ACCELERATED = 0x00000040 /*< The renderer uses hardware acceleration /
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	165 } SDL_RendererFlags;
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	166
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	167 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	168 * \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	169 *
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	170 * \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	171 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	172 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	173 {
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	174 const char name; /< The name of the renderer /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	175 Uint32 flags; /*< Supported SDL_RendererFlags /
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	176 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	177 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	178 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	179 Uint32 num_texture_formats; /*< The number of available texture formats /
1920 8a162bfdc838 Convert SDL_malloc to SDL_calloc if appropriate, slightly faster on operating systems which map the zero page for memory allocations. Sam Lantinga <slouken@libsdl.org> parents: 1912 diff changeset	180 Uint32 texture_formats[20]; /*< 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	181 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	182 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	183 } SDL_RendererInfo;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	184
1895 c121d94672cb SDL 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 * \enum 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	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 * \brief The access pattern allowed for a texture
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	189 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	190 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	191 {
2222 926294b2bb4e Emphasized the separation between SDL_Surface and SDL_Texture Sam Lantinga <slouken@libsdl.org> parents: 2208 diff changeset	192 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	193 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	194 } 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	195
c121d94672cb SDL 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 /**
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	197 * \enum SDL_TextureModulate
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	198 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	199 * \brief The texture channel modulation used in SDL_RenderCopy()
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	200 */
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	201 typedef enum
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	202 {
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	203 SDL_TEXTUREMODULATE_NONE = 0x00000000, /*< No modulation /
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	204 SDL_TEXTUREMODULATE_COLOR = 0x00000001, /*< srcC = srcC color */
2208 b03710fb0333 Fixed bug #467 Sam Lantinga <slouken@libsdl.org> parents: 2131 diff changeset	205 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	206 } SDL_TextureModulate;
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	207
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	208 /**
2884 9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	209 * \enum SDL_BlendMode
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	210 *
2884 9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	211 * \brief The blend mode used in SDL_RenderCopy() and drawing operations
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	212 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	213 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	214 {
2884 9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	215 SDL_BLENDMODE_NONE = 0x00000000, /*< No blending /
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	216 SDL_BLENDMODE_MASK = 0x00000001, /*< dst = A ? src : dst (alpha is mask) /
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	217 SDL_BLENDMODE_BLEND = 0x00000002, /*< dst = (src A) + (dst * (1-A)) */
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	218 SDL_BLENDMODE_ADD = 0x00000004, /*< dst = (src A) + dst */
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	219 SDL_BLENDMODE_MOD = 0x00000008 /*< dst = src dst */
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	220 } SDL_BlendMode;
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	221
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	222 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	223 * \enum SDL_TextureScaleMode
c121d94672cb SDL 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 *
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	225 * \brief The texture scale mode used in SDL_RenderCopy()
1895 c121d94672cb SDL 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 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	228 {
1965 a788656ca29a SDL constants are all uppercase. Sam Lantinga <slouken@libsdl.org> parents: 1963 diff changeset	229 SDL_TEXTURESCALEMODE_NONE = 0x00000000, /*< No scaling, rectangles must match dimensions /
a788656ca29a SDL constants are all uppercase. Sam Lantinga <slouken@libsdl.org> parents: 1963 diff changeset	230 SDL_TEXTURESCALEMODE_FAST = 0x00000001, /*< Point sampling or equivalent algorithm /
a788656ca29a SDL constants are all uppercase. Sam Lantinga <slouken@libsdl.org> parents: 1963 diff changeset	231 SDL_TEXTURESCALEMODE_SLOW = 0x00000002, /*< Linear filtering or equivalent algorithm /
2208 b03710fb0333 Fixed bug #467 Sam Lantinga <slouken@libsdl.org> parents: 2131 diff changeset	232 SDL_TEXTURESCALEMODE_BEST = 0x00000004 /*< Bicubic filtering or equivalent algorithm /
1895 c121d94672cb SDL 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 } SDL_TextureScaleMode;
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	234
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	235 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	236 * \typedef SDL_TextureID
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	237 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	238 * \brief An efficient driver-specific representation of pixel data
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	239 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	240 typedef Uint32 SDL_TextureID;
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	241
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	242 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	243 * \typedef 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	244 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	245 * \brief An opaque handle to an 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	246 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	247 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	248
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	249 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	250 * \enum SDL_GLattr
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	251 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	252 * \brief OpenGL configuration attributes
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	253 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	254 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	255 {
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	256 SDL_GL_RED_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	257 SDL_GL_GREEN_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	258 SDL_GL_BLUE_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	259 SDL_GL_ALPHA_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	260 SDL_GL_BUFFER_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	261 SDL_GL_DOUBLEBUFFER,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	262 SDL_GL_DEPTH_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	263 SDL_GL_STENCIL_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	264 SDL_GL_ACCUM_RED_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	265 SDL_GL_ACCUM_GREEN_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	266 SDL_GL_ACCUM_BLUE_SIZE,
450 8a43e0cbf02f Added SDL_GL_STEREO for stereoscopic OpenGL contexts Sam Lantinga <slouken@libsdl.org> parents: 432 diff changeset	267 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	268 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	269 SDL_GL_MULTISAMPLEBUFFERS,
1736 3b2a92126f4d Implemented bug #2, 117: Sam Lantinga <slouken@libsdl.org> parents: 1545 diff changeset	270 SDL_GL_MULTISAMPLESAMPLES,
2747 47519ce71def Added SDL_GL_RETAINED_BACKING attribute to SDL_GLattr Holmes Futrell <hfutrell@umail.ucsb.edu> parents: 2275 diff changeset	271 SDL_GL_ACCELERATED_VISUAL,
47519ce71def Added SDL_GL_RETAINED_BACKING attribute to SDL_GLattr Holmes Futrell <hfutrell@umail.ucsb.edu> parents: 2275 diff changeset	272 SDL_GL_RETAINED_BACKING
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	273 } SDL_GLattr;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	274
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	275
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	276 /* Function prototypes */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	277
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	278 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	279 * \fn int 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	280 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	281 * \brief Get the number of video drivers compiled into SDL
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	282 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	283 * \sa SDL_GetVideoDriver()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	284 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	285 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	286
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	287 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	288 * \fn const char *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	289 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	290 * \brief Get the name of a built in video driver.
c121d94672cb SDL 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 *
c121d94672cb SDL 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 * \note The video drivers are presented in the order in which they are
c121d94672cb SDL 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 * normally checked during initialization.
c121d94672cb SDL 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 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	295 * \sa SDL_GetNumVideoDrivers()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	296 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	297 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	298
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	299 /**
c121d94672cb SDL 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 * \fn int SDL_VideoInit(const char *driver_name, Uint32 flags)
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	301 *
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	302 * \brief Initialize the video subsystem, optionally specifying a video driver.
c121d94672cb SDL 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 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	304 * \param driver_name Initialize a specific driver by name, or NULL for the default video driver.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	305 * \param flags FIXME: Still needed?
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	306 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	307 * \return 0 on success, -1 on error
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	308 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	309 * This function initializes the video subsystem; setting up a connection
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	310 * to the window manager, etc, and determines the available display 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	311 * and pixel formats, but does not initialize a window or graphics mode.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	312 *
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	313 * \sa SDL_VideoQuit()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	314 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	315 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	316 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	317
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	318 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	319 * \fn void SDL_VideoQuit(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	320 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	321 * \brief Shuts down the video subsystem.
c121d94672cb SDL 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 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	323 * This function closes all windows, and restores the original video 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	324 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	325 * \sa SDL_VideoInit()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	326 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	327 extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	328
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	329 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	330 * \fn const char *SDL_GetCurrentVideoDriver(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	331 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	332 * \brief Returns the name of the currently initialized video driver.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	333 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	334 * \return The name of the current video driver or NULL if no driver
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	335 * has been initialized
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	336 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	337 * \sa SDL_GetNumVideoDrivers()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	338 * \sa SDL_GetVideoDriver()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	339 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	340 extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	341
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	342 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	343 * \fn int SDL_GetNumVideoDisplays(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	344 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	345 * \brief Returns the number of available video displays.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	346 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	347 * \sa SDL_SelectVideoDisplay()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	348 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	349 extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	350
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	351 /**
c121d94672cb SDL 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 * \fn int SDL_SelectVideoDisplay(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	353 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	354 * \brief Set the index of the currently selected display.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	355 *
1963 2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	356 * \return 0 on success, or -1 if the index is out of range.
2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	357 *
2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	358 * \sa SDL_GetNumVideoDisplays()
2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	359 * \sa SDL_GetCurrentVideoDisplay()
2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	360 */
2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	361 extern DECLSPEC int SDLCALL SDL_SelectVideoDisplay(int index);
2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	362
2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	363 /**
2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	364 * \fn int SDL_GetCurrentVideoDisplay(void)
2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	365 *
2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	366 * \brief Get the index of the currently selected display.
2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	367 *
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	368 * \return The index of the currently selected display.
c121d94672cb SDL 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 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	370 * \sa SDL_GetNumVideoDisplays()
1963 2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	371 * \sa SDL_SelectVideoDisplay()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	372 */
1963 2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	373 extern DECLSPEC int SDLCALL SDL_GetCurrentVideoDisplay(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	374
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	375 /**
c121d94672cb SDL 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 * \fn int SDL_GetNumDisplayModes(void)
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	377 *
1895 c121d94672cb SDL 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 * \brief Returns the number of available display modes for the current display.
c121d94672cb SDL 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 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	380 * \sa SDL_GetDisplayMode()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	381 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	382 extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	383
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	384 /**
1967 01e29c3e9a29 In general, fill in pointers to structures, rather than return them. Sam Lantinga <slouken@libsdl.org> parents: 1966 diff changeset	385 * \fn int SDL_GetDisplayMode(int index, 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	386 *
1968 9f589a1f74a5 Updated header documentation Sam Lantinga <slouken@libsdl.org> parents: 1967 diff changeset	387 * \brief Fill in information about a specific display mode.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	388 *
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	389 * \note The display modes are sorted in this priority:
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	390 * \li bits per pixel -> more colors to fewer 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	391 * \li width -> largest to smallest
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	392 * \li height -> largest to smallest
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	393 * \li refresh rate -> highest to lowest
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	394 *
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	395 * \sa SDL_GetNumDisplayModes()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	396 */
1967 01e29c3e9a29 In general, fill in pointers to structures, rather than return them. Sam Lantinga <slouken@libsdl.org> parents: 1966 diff changeset	397 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	398 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	399
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	400 /**
1967 01e29c3e9a29 In general, fill in pointers to structures, rather than return them. Sam Lantinga <slouken@libsdl.org> parents: 1966 diff changeset	401 * \fn int SDL_GetDesktopDisplayMode(SDL_DisplayMode *mode)
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	402 *
1968 9f589a1f74a5 Updated header documentation Sam Lantinga <slouken@libsdl.org> parents: 1967 diff changeset	403 * \brief Fill in information about the desktop display mode for the current 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	404 */
1967 01e29c3e9a29 In general, fill in pointers to structures, rather than return them. Sam Lantinga <slouken@libsdl.org> parents: 1966 diff changeset	405 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	406
c121d94672cb SDL 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 /**
1967 01e29c3e9a29 In general, fill in pointers to structures, rather than return them. Sam Lantinga <slouken@libsdl.org> parents: 1966 diff changeset	408 * \fn int SDL_GetCurrentDisplayMode(SDL_DisplayMode *mode)
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	409 *
1968 9f589a1f74a5 Updated header documentation Sam Lantinga <slouken@libsdl.org> parents: 1967 diff changeset	410 * \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	411 */
1967 01e29c3e9a29 In general, fill in pointers to structures, rather than return them. Sam Lantinga <slouken@libsdl.org> parents: 1966 diff changeset	412 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	413
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	414 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	415 * \fn SDL_DisplayMode SDL_GetClosestDisplayMode(const SDL_DisplayMode mode, SDL_DisplayMode *closest)
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	416 *
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	417 * \brief Get the closest match to the requested display 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	418 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	419 * \param mode The desired display 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	420 * \param closest A pointer to a display mode to be filled in with the closest match of the available display 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	421 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	422 * \return The passed in value 'closest', or NULL if no matching video mode was available.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	423 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	424 * The available display modes are scanned, and 'closest' is filled in with the closest mode matching the requested mode and returned. The mode format and refresh_rate default to the desktop mode if they are 0. The modes are scanned with size being first priority, format being second priority, and finally checking the refresh_rate. If all the available modes are too small, then NULL is returned.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	425 *
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	426 * \sa SDL_GetNumDisplayModes()
c121d94672cb SDL 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 * \sa SDL_GetDisplayMode()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	428 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	429 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	430 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	431 * 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	432 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	433 * 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	434
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	435 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	436 * \fn int SDL_SetFullscreenDisplayMode(const SDL_DisplayMode *mode)
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	437 *
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	438 * \brief Set the display mode used when a fullscreen 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	439 * on the currently selected display.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	440 *
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	441 * \param mode The mode to use, or NULL for the desktop mode.
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 * \return 0 on success, or -1 if setting the display mode failed.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	444 *
1895 c121d94672cb SDL 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 * \sa SDL_SetWindowFullscreen()
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 extern DECLSPEC int SDLCALL SDL_SetFullscreenDisplayMode(const 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	448 * mode);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	449
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	450 /**
1967 01e29c3e9a29 In general, fill in pointers to structures, rather than return them. Sam Lantinga <slouken@libsdl.org> parents: 1966 diff changeset	451 * \fn int SDL_GetFullscreenDisplayMode(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	452 *
1968 9f589a1f74a5 Updated header documentation Sam Lantinga <slouken@libsdl.org> parents: 1967 diff changeset	453 * \brief Fill in information about the display mode used when a fullscreen
9f589a1f74a5 Updated header documentation Sam Lantinga <slouken@libsdl.org> parents: 1967 diff changeset	454 * window is visible on the currently selected display.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	455 */
1967 01e29c3e9a29 In general, fill in pointers to structures, rather than return them. Sam Lantinga <slouken@libsdl.org> parents: 1966 diff changeset	456 extern DECLSPEC int SDLCALL SDL_GetFullscreenDisplayMode(SDL_DisplayMode *
01e29c3e9a29 In general, fill in pointers to structures, rather than return them. Sam Lantinga <slouken@libsdl.org> parents: 1966 diff changeset	457 mode);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	458
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	459 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	460 * \fn int SDL_SetDisplayPalette(const SDL_Color *colors, int firstcolor, 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	461 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	462 * \brief Set the palette entries for indexed display 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	463 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	464 * \return 0 on success, or -1 if the display mode isn't palettized or the colors couldn't be set.
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 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	467 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	468 int ncolors);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	469
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	470 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	471 * \fn int SDL_GetDisplayPalette(SDL_Color *colors, int firstcolor, 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	472 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	473 * \brief Gets the palette entries for indexed display 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	474 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	475 * \return 0 on success, or -1 if the display mode isn't palettized
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	476 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	477 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	478 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	479 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	480
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	481 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	482 * \fn int SDL_SetGamma(float red, float green, float 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	483 *
c121d94672cb SDL 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 * \brief Set the gamma correction for each of the color channels on the currently selected display.
c121d94672cb SDL 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 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	486 * \return 0 on success, or -1 if setting the gamma isn't supported.
c121d94672cb SDL 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 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	488 * \sa SDL_SetGammaRamp()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	489 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	490 extern DECLSPEC int SDLCALL SDL_SetGamma(float red, float green, float blue);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	491
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	492 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	493 * \fn int SDL_SetGammaRamp(const Uint16 * red, const Uint16 * green, const 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	494 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	495 * \brief Set the gamma ramp for the currently selected display.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	496 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	497 * \param red The translation table for the red channel, or NULL
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	498 * \param green The translation table for the green channel, or NULL
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	499 * \param blue The translation table for the blue channel, or NULL
c121d94672cb SDL 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 * \return 0 on success, or -1 if gamma ramps are unsupported.
c121d94672cb SDL 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 *
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	503 * Set the gamma translation table for the red, green, and blue channels
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	504 * of the video hardware. Each table is an array of 256 16-bit quantities,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	505 * representing a mapping between the input and output for that channel.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	506 * The input is the index into the array, and the output is the 16-bit
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	507 * gamma value at that index, scaled to the output color precision.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	508 *
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	509 * \sa SDL_GetGammaRamp()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	510 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	511 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	512 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	513 const Uint16 * blue);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	514
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	515 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	516 * \fn int SDL_GetGammaRamp(Uint16 * red, Uint16 * green, 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	517 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	518 * \brief Get the gamma ramp for the currently selected display.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	519 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	520 * \param red A pointer to a 256 element array of 16-bit quantities to hold the translation table for the red channel, or NULL.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	521 * \param green A pointer to a 256 element array of 16-bit quantities to hold the translation table for the green channel, or NULL.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	522 * \param blue A pointer to a 256 element array of 16-bit quantities to hold the translation table for the blue channel, or NULL.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	523 *
1895 c121d94672cb SDL 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 * \return 0 on success, or -1 if gamma ramps are unsupported.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	525 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	526 * \sa SDL_SetGammaRamp()
c121d94672cb SDL 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 */
c121d94672cb SDL 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 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	529 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	530
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	531
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	532 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	533 * \fn SDL_WindowID SDL_CreateWindow(const char *title, int x, int y, int w, 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	534 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	535 * \brief Create a window with the specified position, dimensions, and 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	536 *
1956 ba0d62354872 Simplified driver window creation code. Sam Lantinga <slouken@libsdl.org> parents: 1936 diff changeset	537 * \param title The title of the window, in UTF-8 encoding
ba0d62354872 Simplified driver window creation code. Sam Lantinga <slouken@libsdl.org> parents: 1936 diff changeset	538 * \param x The x position of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED
ba0d62354872 Simplified driver window creation code. Sam Lantinga <slouken@libsdl.org> parents: 1936 diff changeset	539 * \param y The y position of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	540 * \param w The width of the window
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	541 * \param h The height of the window
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	542 * \param flags The flags for the window, a mask of any of the following: SDL_WINDOW_FULLSCREEN, SDL_WINDOW_OPENGL, SDL_WINDOW_SHOWN, SDL_WINDOW_BORDERLESS, SDL_WINDOW_RESIZABLE, SDL_WINDOW_MAXIMIZED, SDL_WINDOW_MINIMIZED, SDL_WINDOW_INPUT_GRABBED
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	543 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	544 * \return The id of the window created, or zero if window creation failed.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	545 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	546 * \sa SDL_DestroyWindow()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	547 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	548 extern DECLSPEC SDL_WindowID SDLCALL SDL_CreateWindow(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	549 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	550 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	551
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	552 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	553 * \fn SDL_WindowID SDL_CreateWindowFrom(void *data)
c121d94672cb SDL 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 * \brief Create an SDL window struct from an existing native window.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	556 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	557 * \param data A pointer to driver-dependent window creation data
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	558 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	559 * \return The id of the window created, or zero if window creation failed.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	560 *
c121d94672cb SDL 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 * \warning This function is NOT SUPPORTED, use at your own risk!
c121d94672cb SDL 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 * \sa SDL_DestroyWindow()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	564 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	565 extern DECLSPEC SDL_WindowID SDLCALL SDL_CreateWindowFrom(const void *data);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	566
c121d94672cb SDL 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 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	568 * \fn Uint32 SDL_GetWindowFlags(SDL_WindowID windowID)
c121d94672cb SDL 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 * \brief Get the window 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	571 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	572 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_WindowID windowID);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	573
c121d94672cb SDL 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 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	575 * \fn void SDL_SetWindowTitle(SDL_WindowID windowID, 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	576 *
c121d94672cb SDL 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 * \brief Set the title of the window, in UTF-8 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	578 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	579 * \sa SDL_GetWindowTitle()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	580 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	581 extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_WindowID windowID,
c121d94672cb SDL 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 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	583
c121d94672cb SDL 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 /**
c121d94672cb SDL 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 * \fn const char *SDL_GetWindowTitle(SDL_WindowID windowID)
c121d94672cb SDL 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 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	587 * \brief Get the title of the window, in UTF-8 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	588 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	589 * \sa SDL_SetWindowTitle()
c121d94672cb SDL 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 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	591 extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_WindowID windowID);
c121d94672cb SDL 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 /**
2967 e4a469d6ddab Implemented SDL_SetWindowIcon(), with translucent icon support under X11. Sam Lantinga <slouken@libsdl.org> parents: 2961 diff changeset	594 * \fn void SDL_SetWindowIcon(SDL_WindowID windowID, 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	595 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	596 * \brief Set the icon of the window.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	597 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	598 * \param icon The icon for the window
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	599 */
2990 502adab079a4 indent Sam Lantinga <slouken@libsdl.org> parents: 2967 diff changeset	600 extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_WindowID windowID,
502adab079a4 indent Sam Lantinga <slouken@libsdl.org> parents: 2967 diff changeset	601 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	602
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	603 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	604 * \fn void SDL_SetWindowData(SDL_WindowID windowID, 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	605 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	606 * \brief Associate an arbitrary pointer with the window.
c121d94672cb SDL 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 *
c121d94672cb SDL 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 * \sa SDL_GetWindowData()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	609 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	610 extern DECLSPEC void SDLCALL SDL_SetWindowData(SDL_WindowID windowID,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	611 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	612
c121d94672cb SDL 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 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	614 * \fn void *SDL_GetWindowData(SDL_WindowID windowID)
c121d94672cb SDL 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 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	616 * \brief Retrieve the data pointer associated with the window.
c121d94672cb SDL 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 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	618 * \sa SDL_SetWindowData()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	619 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	620 extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_WindowID windowID);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	621
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	622 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	623 * \fn void SDL_SetWindowPosition(SDL_WindowID windowID, 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	624 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	625 * \brief Set the position of the window.
c121d94672cb SDL 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 *
c121d94672cb SDL 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 * \param windowID The window to reposition
c121d94672cb SDL 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 * \param x The x coordinate of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	629 * \param y The y coordinate of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	630 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	631 * \note The window coordinate origin is the upper left of the display.
c121d94672cb SDL 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 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	633 * \sa SDL_GetWindowPosition()
c121d94672cb SDL 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 */
c121d94672cb SDL 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 extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_WindowID windowID,
c121d94672cb SDL 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 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	637
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	638 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	639 * \fn void SDL_GetWindowPosition(SDL_WindowID windowID, 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	640 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	641 * \brief Get the position of the window.
c121d94672cb SDL 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 * \sa SDL_SetWindowPosition()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	644 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	645 extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_WindowID windowID,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	646 int x, int y);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	647
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	648 /**
c121d94672cb SDL 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 * \fn void SDL_SetWindowSize(SDL_WindowID windowID, int w, 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	650 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	651 * \brief Set the size of the window's client area.
c121d94672cb SDL 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 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	653 * \note You can't change the size of a fullscreen window, it automatically
c121d94672cb SDL 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 * matches the size of the display 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	655 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	656 * \sa SDL_GetWindowSize()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	657 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	658 extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_WindowID windowID, 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	659 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	660
c121d94672cb SDL 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 /**
2907 5f89d3751ce7 typo fix Sam Lantinga <slouken@libsdl.org> parents: 2901 diff changeset	662 * \fn void SDL_GetWindowSize(SDL_WindowID windowID, int w, int 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	663 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	664 * \brief Get the size of the window's client area.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	665 *
c121d94672cb SDL 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 * \sa SDL_SetWindowSize()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	667 */
c121d94672cb SDL 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 extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_WindowID windowID, 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	669 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	670
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	671 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	672 * \fn void SDL_ShowWindow(SDL_WindowID windowID)
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	673 *
c121d94672cb SDL 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 * \brief Show the window
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	675 *
c121d94672cb SDL 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 * \sa SDL_HideWindow()
c121d94672cb SDL 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 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	678 extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_WindowID windowID);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	679
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	680 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	681 * \fn void SDL_HideWindow(SDL_WindowID windowID)
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	682 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	683 * \brief Hide the window
c121d94672cb SDL 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 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	685 * \sa SDL_ShowWindow()
c121d94672cb SDL 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 */
c121d94672cb SDL 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 extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_WindowID windowID);
c121d94672cb SDL 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
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	689 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	690 * \fn void SDL_RaiseWindow(SDL_WindowID windowID)
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	691 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	692 * \brief Raise the window above other windows and set the 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	693 */
c121d94672cb SDL 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 extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_WindowID windowID);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	695
c121d94672cb SDL 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 /**
c121d94672cb SDL 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 * \fn void SDL_MaximizeWindow(SDL_WindowID windowID)
c121d94672cb SDL 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 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	699 * \brief Make the window as large as possible.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	700 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	701 * \sa SDL_RestoreWindow()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	702 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	703 extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_WindowID windowID);
c121d94672cb SDL 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
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	705 /**
c121d94672cb SDL 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 * \fn void SDL_MinimizeWindow(SDL_WindowID windowID)
c121d94672cb SDL 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 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	708 * \brief Minimize the window to an iconic representation.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	709 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	710 * \sa SDL_RestoreWindow()
c121d94672cb SDL 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 extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_WindowID windowID);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	713
c121d94672cb SDL 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 /**
c121d94672cb SDL 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 * \fn void SDL_RestoreWindow(SDL_WindowID windowID)
c121d94672cb SDL 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 * \brief Restore the size and position of a minimized or maximized window.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	718 *
c121d94672cb SDL 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 * \sa SDL_MaximizeWindow()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	720 * \sa SDL_MinimizeWindow()
c121d94672cb SDL 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 extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_WindowID windowID);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	723
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	724 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	725 * \fn int SDL_SetWindowFullscreen(SDL_WindowID windowID, 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	726 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	727 * \brief Set the window's fullscreen state.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	728 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	729 * \return 0 on success, or -1 if setting the display mode failed.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	730 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	731 * \sa SDL_SetFullscreenDisplayMode()
c121d94672cb SDL 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 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	733 extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_WindowID windowID,
c121d94672cb SDL 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 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	735
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	736 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	737 * \fn void SDL_SetWindowGrab(SDL_WindowID windowID, 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	738 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	739 * \brief Set the window's input grab 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	740 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	741 * \param mode This is 1 to grab input, and 0 to release input.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	742 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	743 * \sa SDL_GetWindowGrab()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	744 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	745 extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_WindowID windowID,
c121d94672cb SDL 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 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	747
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	748 /**
c121d94672cb SDL 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 * \fn int SDL_GetWindowGrab(SDL_WindowID windowID)
c121d94672cb SDL 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 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	751 * \brief Get the window's input grab 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	752 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	753 * \return This returns 1 if input is grabbed, and 0 otherwise.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	754 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	755 * \sa SDL_SetWindowGrab()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	756 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	757 extern DECLSPEC int SDLCALL SDL_GetWindowGrab(SDL_WindowID windowID);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	758
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	759 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	760 * \fn SDL_bool SDL_GetWindowWMInfo(SDL_WindowID windowID, struct SDL_SysWMinfo * 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	761 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	762 * \brief Get driver specific information about a window.
c121d94672cb SDL 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 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	764 * \note Include SDL_syswm.h for the declaration of 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	765 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	766 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	767 extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_WindowID windowID,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	768 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	769 *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	770
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	771 /**
c121d94672cb SDL 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 * \fn void SDL_DestroyWindow(SDL_WindowID windowID)
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	773 *
c121d94672cb SDL 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 * \brief Destroy a window.
c121d94672cb SDL 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 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	776 extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_WindowID windowID);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	777
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	778 /**
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	779 * \fn int 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	780 *
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	781 * \brief Get the number of 2D rendering drivers available for the current 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	782 *
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	783 * A render driver is a set of code that handles rendering and 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	784 * management on a particular display. Normally there is only one, but
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	785 * some drivers may have several available with different capabilities.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	786 *
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	787 * \sa SDL_GetRenderDriverInfo()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	788 * \sa SDL_CreateRenderer()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	789 */
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	790 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	791
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	792 /**
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	793 * \fn int SDL_GetRenderDriverInfo(int index, 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	794 *
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	795 * \brief Get information about a specific 2D rendering driver for the current display.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	796 *
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	797 * \param index The index of the driver to query information about.
5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	798 * \param info A pointer to an SDL_RendererInfo struct to be filled with information on the rendering driver.
1907 06c27a737b7a Streamlined the API a bit and optimized the software renderer. Sam Lantinga <slouken@libsdl.org> parents: 1897 diff changeset	799 *
06c27a737b7a Streamlined the API a bit and optimized the software renderer. Sam Lantinga <slouken@libsdl.org> parents: 1897 diff changeset	800 * \return 0 on success, -1 if the index was out of range
06c27a737b7a Streamlined the API a bit and optimized the software renderer. Sam Lantinga <slouken@libsdl.org> parents: 1897 diff changeset	801 *
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	802 * \sa SDL_CreateRenderer()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	803 */
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	804 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	805 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	806
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	807 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	808 * \fn int SDL_CreateRenderer(SDL_WindowID window, 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	809 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	810 * \brief Create and make active a 2D rendering context for a window.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	811 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	812 * \param windowID The window used for rendering
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	813 * \param index The index of the rendering driver to initialize, or -1 to initialize the first one supporting the requested 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	814 * \param flags SDL_RendererFlags
c121d94672cb SDL 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 *
c121d94672cb SDL 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 * \return 0 on success, -1 if the flags were not supported, or -2 if
c121d94672cb SDL 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 * there isn't enough memory to support the requested 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	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 * \sa SDL_SelectRenderer()
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	820 * \sa SDL_GetRendererInfo()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	821 * \sa SDL_DestroyRenderer()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	822 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	823 extern DECLSPEC int SDLCALL SDL_CreateRenderer(SDL_WindowID windowID,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	824 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	825
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	826 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	827 * \fn int SDL_SelectRenderer(SDL_WindowID windowID)
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	828 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	829 * \brief Select the rendering context for a particular window.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	830 *
c121d94672cb SDL 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 * \return 0 on success, -1 if the selected window doesn't have a
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	832 * rendering 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	833 */
c121d94672cb SDL 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 extern DECLSPEC int SDLCALL SDL_SelectRenderer(SDL_WindowID windowID);
c121d94672cb SDL 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 /**
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	837 * \fn int SDL_GetRendererInfo(SDL_RendererInfo *info)
5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	838 *
5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	839 * \brief Get information about the current rendering context.
5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	840 */
5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	841 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	842
5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	843 /**
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	844 * \fn SDL_TextureID SDL_CreateTexture(Uint32 format, int access, 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	845 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	846 * \brief Create a texture for the current rendering 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	847 *
c121d94672cb SDL 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 * \param format The format of the texture
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	849 * \param access One of the enumerated values in 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	850 * \param w The width of the texture in 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	851 * \param h The height of the texture in 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	852 *
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	853 * \return The created texture is returned, or 0 if no rendering context was active, the format was unsupported, or the width or height were out of range.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	854 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	855 * \sa SDL_QueryTexture()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	856 * \sa SDL_DestroyTexture()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	857 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	858 extern DECLSPEC SDL_TextureID SDLCALL SDL_CreateTexture(Uint32 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	859 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	860 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	861
c121d94672cb SDL 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 /**
2222 926294b2bb4e Emphasized the separation between SDL_Surface and SDL_Texture Sam Lantinga <slouken@libsdl.org> parents: 2208 diff changeset	863 * \fn SDL_TextureID SDL_CreateTextureFromSurface(Uint32 format, SDL_Surface *surface)
1895 c121d94672cb SDL 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 *
c121d94672cb SDL 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 * \brief Create a texture from an existing 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	866 *
c121d94672cb SDL 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 * \param format The format of the texture, or 0 to pick an appropriate 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	868 * \param surface The surface containing pixel data used to fill the texture
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	869 *
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	870 * \return The created texture is returned, or 0 if no rendering context was active, the format was unsupported, or the surface width or height were out of range.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	871 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	872 * \note The surface is not modified or freed by this function.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	873 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	874 * \sa SDL_QueryTexture()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	875 * \sa SDL_DestroyTexture()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	876 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	877 extern DECLSPEC SDL_TextureID SDLCALL SDL_CreateTextureFromSurface(Uint32
c121d94672cb SDL 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 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	879 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	880 * 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	881
c121d94672cb SDL 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 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	883 * \fn int SDL_QueryTexture(SDL_TextureID textureID, Uint32 format, int access, 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	884 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	885 * \brief Query the attributes of a texture
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	886 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	887 * \param texture A texture to be queried
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	888 * \param format A pointer filled in with the raw format of the texture. The actual format may differ, but pixel transfers will use this format.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	889 * \param access A pointer filled in with the actual access to the texture.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	890 * \param w A pointer filled in with the width of the texture in 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	891 * \param h A pointer filled in with the height of the texture in 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	892 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	893 * \return 0 on success, or -1 if the texture is not valid
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	894 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	895 extern DECLSPEC int SDLCALL SDL_QueryTexture(SDL_TextureID textureID,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	896 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	897 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	898
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	899 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	900 * \fn int SDL_QueryTexturePixels(SDL_TextureID textureID, 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	901 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	902 * \brief Query the pixels of a texture, if the texture does not need to be locked for pixel 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	903 *
2222 926294b2bb4e Emphasized the separation between SDL_Surface and SDL_Texture Sam Lantinga <slouken@libsdl.org> parents: 2208 diff changeset	904 * \param texture A texture to be queried, which was created with SDL_TEXTUREACCESS_STREAMING
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	905 * \param pixels A pointer filled with a pointer to the pixels for the texture
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	906 * \param pitch A pointer filled in with the pitch of the pixel data
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	907 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	908 * \return 0 on success, or -1 if the texture is not valid, or must be locked for pixel 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	909 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	910 extern DECLSPEC int SDLCALL SDL_QueryTexturePixels(SDL_TextureID textureID,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	911 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	912
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	913 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	914 * \fn int SDL_SetTexturePalette(SDL_TextureID textureID, const SDL_Color * colors, int firstcolor, 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	915 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	916 * \brief Update an indexed texture with a color palette
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	917 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	918 * \param texture The texture to update
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	919 * \param colors The array of RGB color data
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	920 * \param firstcolor The first index to update
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	921 * \param ncolors The number of palette entries to fill with the color data
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	922 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	923 * \return 0 on success, or -1 if the texture is not valid or not an indexed texture
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	924 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	925 extern DECLSPEC int SDLCALL SDL_SetTexturePalette(SDL_TextureID textureID,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	926 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	927 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	928 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	929
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	930 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	931 * \fn int SDL_GetTexturePalette(SDL_TextureID textureID, SDL_Color * colors, int firstcolor, 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	932 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	933 * \brief Update an indexed texture with a color palette
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	934 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	935 * \param texture The texture to update
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	936 * \param colors The array to fill with RGB color data
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	937 * \param firstcolor The first index to retrieve
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	938 * \param ncolors The number of palette entries to retrieve
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	939 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	940 * \return 0 on success, or -1 if the texture is not valid or not an indexed texture
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	941 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	942 extern DECLSPEC int SDLCALL SDL_GetTexturePalette(SDL_TextureID textureID,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	943 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	944 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	945 int ncolors);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	946
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	947 /**
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	948 * \fn int SDL_SetTextureColorMod(SDL_TextureID textureID, Uint8 r, Uint8 g, Uint8 b)
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	949 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	950 * \brief Set an additional color value used in render copy operations
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	951 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	952 * \param texture The texture to update
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	953 * \param r The red source color value multiplied into copy operations
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	954 * \param g The green source color value multiplied into copy operations
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	955 * \param b The blue source color value multiplied into copy operations
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	956 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	957 * \return 0 on success, or -1 if the texture is not valid or color modulation is not supported
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	958 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	959 * \sa SDL_GetTextureColorMod()
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 extern DECLSPEC int SDLCALL SDL_SetTextureColorMod(SDL_TextureID textureID,
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	962 Uint8 r, Uint8 g, Uint8 b);
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	963
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	964
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	965 /**
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	966 * \fn int SDL_GetTextureColorMod(SDL_TextureID textureID, Uint8 r, Uint8 g, Uint8 *b)
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	967 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	968 * \brief Get the additional color value used in render copy operations
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	969 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	970 * \param texture The texture to query
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	971 * \param r A pointer filled in with the source red color value
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	972 * \param g A pointer filled in with the source green color value
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	973 * \param b A pointer filled in with the source blue color value
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	974 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	975 * \return 0 on success, or -1 if the texture is not valid
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	976 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	977 * \sa SDL_SetTextureColorMod()
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	978 */
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	979 extern DECLSPEC int SDLCALL SDL_GetTextureColorMod(SDL_TextureID textureID,
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	980 Uint8 * r, Uint8 * g,
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	981 Uint8 * b);
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	982
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	983 /**
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	984 * \fn int SDL_SetTextureAlphaMod(SDL_TextureID textureID, Uint8 alpha)
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	985 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	986 * \brief Set an additional alpha value used in render copy operations
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	987 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	988 * \param texture The texture to update
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	989 * \param alpha The source alpha value multiplied into copy operations.
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 * \return 0 on success, or -1 if the texture is not valid or alpha modulation is not supported
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	992 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	993 * \sa SDL_GetTextureAlphaMod()
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	994 */
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	995 extern DECLSPEC int SDLCALL SDL_SetTextureAlphaMod(SDL_TextureID textureID,
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	996 Uint8 alpha);
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	997
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	998 /**
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	999 * \fn int SDL_GetTextureAlphaMod(SDL_TextureID textureID, Uint8 *alpha)
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1000 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1001 * \brief Get the additional alpha value used in render copy operations
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1002 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1003 * \param texture The texture to query
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1004 * \param alpha A pointer filled in with the source alpha value
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1005 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1006 * \return 0 on success, or -1 if the texture is not valid
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1007 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1008 * \sa SDL_SetTextureAlphaMod()
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1009 */
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1010 extern DECLSPEC int SDLCALL SDL_GetTextureAlphaMod(SDL_TextureID textureID,
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1011 Uint8 * alpha);
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1012
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1013 /**
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1014 * \fn int SDL_SetTextureBlendMode(SDL_TextureID textureID, int blendMode)
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1015 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1016 * \brief Set the blend mode used for texture copy operations
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1017 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1018 * \param texture The texture to update
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1019 * \param blendMode SDL_TextureBlendMode to use for texture blending
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1020 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1021 * \return 0 on success, or -1 if the texture is not valid or the blend mode is not supported
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1022 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1023 * \note If the blend mode is not supported, the closest supported mode is chosen.
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1024 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1025 * \sa SDL_GetTextureBlendMode()
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1026 */
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1027 extern DECLSPEC int SDLCALL SDL_SetTextureBlendMode(SDL_TextureID textureID,
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1028 int blendMode);
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1029
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1030 /**
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1031 * \fn int SDL_GetTextureBlendMode(SDL_TextureID textureID, int *blendMode)
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1032 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1033 * \brief Get the blend mode used for texture copy operations
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1034 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1035 * \param texture The texture to query
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1036 * \param blendMode A pointer filled in with the current blend mode
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1037 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1038 * \return 0 on success, or -1 if the texture is not valid
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1039 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1040 * \sa SDL_SetTextureBlendMode()
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1041 */
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1042 extern DECLSPEC int SDLCALL SDL_GetTextureBlendMode(SDL_TextureID textureID,
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1043 int *blendMode);
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1044
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1045 /**
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1046 * \fn int SDL_SetTextureScaleMode(SDL_TextureID textureID, int scaleMode)
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1047 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1048 * \brief Set the scale mode used for texture copy operations
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1049 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1050 * \param texture The texture to update
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1051 * \param scaleMode SDL_TextureScaleMode to use for texture scaling
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1052 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1053 * \return 0 on success, or -1 if the texture is not valid or the scale mode is not supported
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1054 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1055 * \note If the scale mode is not supported, the closest supported mode is chosen.
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1056 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1057 * \sa SDL_GetTextureScaleMode()
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1058 */
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1059 extern DECLSPEC int SDLCALL SDL_SetTextureScaleMode(SDL_TextureID textureID,
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1060 int scaleMode);
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1061
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1062 /**
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1063 * \fn int SDL_GetTextureScaleMode(SDL_TextureID textureID, int *scaleMode)
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1064 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1065 * \brief Get the scale mode used for texture copy operations
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1066 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1067 * \param texture The texture to query
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1068 * \param scaleMode A pointer filled in with the current scale mode
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1069 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1070 * \return 0 on success, or -1 if the texture is not valid
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1071 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1072 * \sa SDL_SetTextureScaleMode()
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1073 */
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1074 extern DECLSPEC int SDLCALL SDL_GetTextureScaleMode(SDL_TextureID textureID,
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1075 int *scaleMode);
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1076
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1077 /**
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1078 * \fn int SDL_UpdateTexture(SDL_TextureID textureID, const SDL_Rect rect, 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	1079 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1080 * \brief Update the given texture rectangle with new pixel data.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1081 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1082 * \param texture The texture to update
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1083 * \param rect A pointer to the rectangle of pixels to update, or NULL to update the entire texture.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1084 * \param pixels The raw pixel data
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1085 * \param pitch The number of bytes between rows of pixel data
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1086 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1087 * \return 0 on success, or -1 if the texture is not valid
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1088 *
2222 926294b2bb4e Emphasized the separation between SDL_Surface and SDL_Texture Sam Lantinga <slouken@libsdl.org> parents: 2208 diff changeset	1089 * \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	1090 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1091 extern DECLSPEC int SDLCALL SDL_UpdateTexture(SDL_TextureID textureID,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1092 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	1093 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	1094
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1095 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1096 * \fn void SDL_LockTexture(SDL_TextureID textureID, const SDL_Rect rect, int markDirty, 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	1097 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1098 * \brief Lock a portion of the texture for pixel 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	1099 *
2222 926294b2bb4e Emphasized the separation between SDL_Surface and SDL_Texture Sam Lantinga <slouken@libsdl.org> parents: 2208 diff changeset	1100 * \param textureID The texture to lock for access, which was created with SDL_TEXTUREACCESS_STREAMING.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1101 * \param rect A pointer to the rectangle to lock for access. If the rect is NULL, the entire texture will be locked.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1102 * \param markDirty If this is nonzero, the locked area will be marked dirty when the texture is unlocked.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1103 * \param pixels This is filled in with a pointer to the locked pixels, appropriately offset by the locked area.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1104 * \param pitch This is filled in with the pitch of the locked 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	1105 *
2222 926294b2bb4e Emphasized the separation between SDL_Surface and SDL_Texture Sam Lantinga <slouken@libsdl.org> parents: 2208 diff changeset	1106 * \return 0 on success, or -1 if the texture is not valid or was created with SDL_TEXTUREACCESS_STATIC
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1107 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1108 * \sa SDL_DirtyTexture()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1109 * \sa SDL_UnlockTexture()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1110 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1111 extern DECLSPEC int SDLCALL SDL_LockTexture(SDL_TextureID textureID,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1112 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	1113 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	1114 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	1115
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1116 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1117 * \fn void SDL_UnlockTexture(SDL_TextureID textureID)
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1118 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1119 * \brief Unlock a texture, uploading the changes to video memory, if needed.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1120 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1121 * \sa SDL_LockTexture()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1122 * \sa SDL_DirtyTexture()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1123 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1124 extern DECLSPEC void SDLCALL SDL_UnlockTexture(SDL_TextureID textureID);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1125
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1126 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1127 * \fn void SDL_DirtyTexture(SDL_TextureID textureID, int numrects, 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	1128 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1129 * \brief Mark the specified rectangles of the texture as dirty.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1130 *
2222 926294b2bb4e Emphasized the separation between SDL_Surface and SDL_Texture Sam Lantinga <slouken@libsdl.org> parents: 2208 diff changeset	1131 * \param textureID The texture to mark dirty, which was created with SDL_TEXTUREACCESS_STREAMING.
926294b2bb4e Emphasized the separation between SDL_Surface and SDL_Texture Sam Lantinga <slouken@libsdl.org> parents: 2208 diff changeset	1132 * \param numrects The number of rectangles pointed to by rects.
926294b2bb4e Emphasized the separation between SDL_Surface and SDL_Texture Sam Lantinga <slouken@libsdl.org> parents: 2208 diff changeset	1133 * \param rects The pointer to an array of dirty rectangles.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1134 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1135 * \sa SDL_LockTexture()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1136 * \sa SDL_UnlockTexture()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1137 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1138 extern DECLSPEC void SDLCALL SDL_DirtyTexture(SDL_TextureID textureID,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1139 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	1140 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	1141
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1142 /**
2884 9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1143 * \fn void SDL_SetRenderDrawColor(Uint8 r, Uint8 g, Uint8 b, Uint8 a)
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1144 *
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1145 * \brief Set the color used for drawing operations (Fill and Line).
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1146 *
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1147 * \param r The red value used to draw on the rendering target
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1148 * \param g The green value used to draw on the rendering target
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1149 * \param b The blue value used to draw on the rendering target
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1150 * \param a The alpha value used to draw on the rendering target, usually SDL_ALPHA_OPAQUE (255)
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1151 * \return 0 on success, or -1 if there is no rendering context current
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1152 */
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1153 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	1154 Uint8 a);
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1155
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1156 /**
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1157 * \fn void SDL_GetRenderDrawColor(Uint8 r, Uint8 g, Uint8 b, Uint8 a)
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 * \brief Get the color used for drawing operations (Fill and Line).
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1160 *
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1161 * \param r A pointer to the red value used to draw on the rendering target
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1162 * \param g A pointer to the green value used to draw on the rendering target
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1163 * \param b A pointer to the blue value used to draw on the rendering target
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1164 * \param a A pointer to the alpha value used to draw on the rendering target, usually SDL_ALPHA_OPAQUE (255)
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1165 * \return 0 on success, or -1 if there is no rendering context current
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1166 */
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1167 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	1168 Uint8 * a);
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1169
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1170 /**
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1171 * \fn int SDL_SetRenderDrawBlendMode(int blendMode)
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1172 *
2886 633ce79b7a5b Minor corrections Sam Lantinga <slouken@libsdl.org> parents: 2884 diff changeset	1173 * \brief Set the blend mode used for drawing operations (Fill and Line).
2884 9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1174 *
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1175 * \param blendMode SDL_BlendMode to use for blending
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1176 *
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1177 * \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	1178 *
2884 9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1179 * \note If the blend mode is not supported, the closest supported mode is chosen.
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1180 *
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1181 * \sa SDL_SetRenderDrawBlendMode()
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1182 */
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1183 extern DECLSPEC int SDLCALL SDL_SetRenderDrawBlendMode(int blendMode);
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1184
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1185 /**
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1186 * \fn int SDL_GetRenderDrawBlendMode(int *blendMode)
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1187 *
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1188 * \brief Get the blend mode used for drawing operations
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1189 *
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1190 * \param blendMode A pointer filled in with the current blend mode
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1191 *
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1192 * \return 0 on success, or -1 if there is no rendering context current
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1193 *
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1194 * \sa SDL_SetRenderDrawBlendMode()
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1195 */
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1196 extern DECLSPEC int SDLCALL SDL_GetRenderDrawBlendMode(int *blendMode);
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1197
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1198 /**
2901 133601e3b255 Added RenderPiont() API Sam Lantinga <slouken@libsdl.org> parents: 2886 diff changeset	1199 * \fn int SDL_RenderPoint(int x, int y)
133601e3b255 Added RenderPiont() API Sam Lantinga <slouken@libsdl.org> parents: 2886 diff changeset	1200 *
133601e3b255 Added RenderPiont() API Sam Lantinga <slouken@libsdl.org> parents: 2886 diff changeset	1201 * \brief Draw a point on the current rendering target.
133601e3b255 Added RenderPiont() API Sam Lantinga <slouken@libsdl.org> parents: 2886 diff changeset	1202 *
133601e3b255 Added RenderPiont() API Sam Lantinga <slouken@libsdl.org> parents: 2886 diff changeset	1203 * \param x The x coordinate of the point
133601e3b255 Added RenderPiont() API Sam Lantinga <slouken@libsdl.org> parents: 2886 diff changeset	1204 * \param y The y coordinate of the point
133601e3b255 Added RenderPiont() API Sam Lantinga <slouken@libsdl.org> parents: 2886 diff changeset	1205 *
133601e3b255 Added RenderPiont() API Sam Lantinga <slouken@libsdl.org> parents: 2886 diff changeset	1206 * \return 0 on success, or -1 if there is no rendering context current
133601e3b255 Added RenderPiont() API Sam Lantinga <slouken@libsdl.org> parents: 2886 diff changeset	1207 */
133601e3b255 Added RenderPiont() API Sam Lantinga <slouken@libsdl.org> parents: 2886 diff changeset	1208 extern DECLSPEC int SDLCALL SDL_RenderPoint(int x, int y);
133601e3b255 Added RenderPiont() API Sam Lantinga <slouken@libsdl.org> parents: 2886 diff changeset	1209
133601e3b255 Added RenderPiont() API Sam Lantinga <slouken@libsdl.org> parents: 2886 diff changeset	1210 /**
2886 633ce79b7a5b Minor corrections Sam Lantinga <slouken@libsdl.org> parents: 2884 diff changeset	1211 * \fn int SDL_RenderLine(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	1212 *
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1213 * \brief Draw a line on the current rendering target.
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1214 *
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1215 * \param x1 The x coordinate of the start point
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1216 * \param y1 The y coordinate of the start point
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1217 * \param x2 The x coordinate of the end point
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1218 * \param y2 The y coordinate of the end point
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1219 *
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1220 * \return 0 on success, or -1 if there is no rendering context current
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1221 */
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1222 extern DECLSPEC int SDLCALL SDL_RenderLine(int x1, int y1, int x2, int y2);
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1223
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1224 /**
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1225 * \fn void SDL_RenderFill(const SDL_Rect *rect)
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1226 *
9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1227 * \brief Fill the current rendering target with the drawing color.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1228 *
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1229 * \param r The red value used to fill the rendering target
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1230 * \param g The green value used to fill the rendering target
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1231 * \param b The blue value used to fill the rendering target
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1232 * \param a The alpha value used to fill the rendering target, usually SDL_ALPHA_OPAQUE (255)
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1233 * \param rect A pointer to the destination rectangle, or NULL for the entire rendering target.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1234 *
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	1235 * \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	1236 */
2884 9dde605c7540 Date: Fri, 19 Dec 2008 20:17:35 +0100 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	1237 extern DECLSPEC int SDLCALL SDL_RenderFill(const SDL_Rect * rect);
1895 c121d94672cb SDL 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 /**
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1240 * \fn int SDL_RenderCopy(SDL_TextureID textureID, const SDL_Rect srcrect, 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	1241 *
c121d94672cb SDL 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 * \brief Copy a portion of the texture to the current rendering target.
c121d94672cb SDL 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 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1244 * \param texture The source texture.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1245 * \param srcrect A pointer to the source rectangle, or NULL for the entire texture.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1246 * \param dstrect A pointer to the destination rectangle, or NULL for the entire rendering target.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1247 *
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	1248 * \return 0 on success, or -1 if there is no rendering context current, or the 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	1249 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1250 extern DECLSPEC int SDLCALL SDL_RenderCopy(SDL_TextureID textureID,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1251 const SDL_Rect * srcrect,
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1252 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	1253
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1254 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1255 * \fn int SDL_RenderReadPixels(const SDL_Rect rect, 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	1256 *
c121d94672cb SDL 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 * \brief Read pixels from the current rendering target.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1258 *
c121d94672cb SDL 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 * \param rect A pointer to the rectangle to read, or NULL for the entire render target
c121d94672cb SDL 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 * \param pixels A pointer to be filled in with the pixel data
c121d94672cb SDL 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 * \param pitch The pitch of the pixels parameter
c121d94672cb SDL 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 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1263 * \return 0 on success, or -1 if pixel reading is not supported.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1264 *
1895 c121d94672cb SDL 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 * \warning This is a very slow operation, and should not be used frequently.
c121d94672cb SDL 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 extern DECLSPEC int SDLCALL SDL_RenderReadPixels(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	1268 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	1269
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1270 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1271 * \fn int SDL_RenderWritePixels(const SDL_Rect rect, 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	1272 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1273 * \brief Write pixels to the current rendering target.
c121d94672cb SDL 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 * \param rect A pointer to the rectangle to write, or NULL for the entire render target
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1276 * \param pixels A pointer to the pixel data to write
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1277 * \param pitch The pitch of the pixels parameter
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1278 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1279 * \return 0 on success, or -1 if pixel writing is not supported.
c121d94672cb SDL 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 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1281 * \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	1282 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1283 extern DECLSPEC int SDLCALL SDL_RenderWritePixels(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	1284 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	1285 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	1286
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1287 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1288 * \fn void 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	1289 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1290 * \brief Update the screen with rendering performed.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1291 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1292 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	1293
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1294 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1295 * \fn void SDL_DestroyTexture(SDL_TextureID textureID);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1296 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1297 * \brief Destroy the specified texture.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1298 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1299 * \sa SDL_CreateTexture()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1300 * \sa SDL_CreateTextureFromSurface()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1301 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1302 extern DECLSPEC void SDLCALL SDL_DestroyTexture(SDL_TextureID textureID);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1303
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1304 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1305 * \fn void SDL_DestroyRenderer(SDL_WindowID windowID);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1306 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1307 * \brief Destroy the rendering context for a window and free associated
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1308 * textures.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1309 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1310 * \sa SDL_CreateRenderer()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1311 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1312 extern DECLSPEC void SDLCALL SDL_DestroyRenderer(SDL_WindowID windowID);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1313
3025 54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1314 /**
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1315 * \fn SDL_bool SDL_IsScreenSaverEnabled();
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1316 *
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1317 * \brief Returns whether the screensaver is currently enabled (default off).
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1318 *
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1319 * \sa SDL_EnableScreenSaver()
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1320 * \sa SDL_DisableScreenSaver()
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1321 */
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1322 extern DECLSPEC SDL_bool SDLCALL SDL_IsScreenSaverEnabled();
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1323
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1324 /**
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1325 * \fn void SDL_EnableScreenSaver();
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1326 *
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1327 * \brief Allow the screen to be blanked by a screensaver
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1328 *
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1329 * \sa SDL_IsScreenSaverEnabled()
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1330 * \sa SDL_DisableScreenSaver()
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1331 */
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1332 extern DECLSPEC void SDLCALL SDL_EnableScreenSaver();
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1333
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1334 /**
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1335 * \fn void SDL_DisableScreenSaver();
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1336 *
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1337 * \brief Prevent the screen from being blanked by a screensaver
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1338 *
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1339 * \sa SDL_IsScreenSaverEnabled()
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1340 * \sa SDL_EnableScreenSaver()
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1341 */
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1342 extern DECLSPEC void SDLCALL SDL_DisableScreenSaver();
54fac87e1f34 Added an API to enable/disable the screen saver. Sam Lantinga <slouken@libsdl.org> parents: 2990 diff changeset	1343
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1344
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1345 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1346 /* OpenGL support functions. */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1347 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1348
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1349 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1350 * \fn int SDL_GL_LoadLibrary(const char *path)
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1351 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1352 * \brief Dynamically load an OpenGL library.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1353 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1354 * \param path The platform dependent OpenGL library name, or NULL to open the default OpenGL library
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1355 *
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1356 * \return 0 on success, or -1 if the library couldn't be loaded
c121d94672cb SDL 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 *
1936 83946ee0ff1f Implemented OpenGL support on Mac OS X Sam Lantinga <slouken@libsdl.org> parents: 1926 diff changeset	1358 * This should be done after initializing the video driver, but before
83946ee0ff1f Implemented OpenGL support on Mac OS X Sam Lantinga <slouken@libsdl.org> parents: 1926 diff changeset	1359 * creating any OpenGL windows. If no OpenGL library is loaded, the default
83946ee0ff1f Implemented OpenGL support on Mac OS X Sam Lantinga <slouken@libsdl.org> parents: 1926 diff changeset	1360 * library will be loaded upon creation of the first OpenGL window.
83946ee0ff1f Implemented OpenGL support on Mac OS X Sam Lantinga <slouken@libsdl.org> parents: 1926 diff changeset	1361 *
1895 c121d94672cb SDL 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 * \note If you do this, you need to retrieve all of the GL functions used in
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1363 * your program from the dynamic library using SDL_GL_GetProcAddress().
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1364 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1365 * \sa SDL_GL_GetProcAddress()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1366 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	1367 extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1368
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1369 /**
c121d94672cb SDL 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 * \fn void SDL_GL_GetProcAddress(const char proc)
c121d94672cb SDL 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 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1372 * \brief Get the address of an OpenGL function.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1373 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1374 extern DECLSPEC void SDLCALL SDL_GL_GetProcAddress(const char proc);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1375
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1376 /**
1926 307355678142 Added SDL_GL_ExtensionSupported() Sam Lantinga <slouken@libsdl.org> parents: 1920 diff changeset	1377 * \fn SDL_bool SDL_GL_ExtensionSupported(const char *extension)
307355678142 Added SDL_GL_ExtensionSupported() Sam Lantinga <slouken@libsdl.org> parents: 1920 diff changeset	1378 *
307355678142 Added SDL_GL_ExtensionSupported() Sam Lantinga <slouken@libsdl.org> parents: 1920 diff changeset	1379 * \brief Return true if an OpenGL extension is supported for the current context.
307355678142 Added SDL_GL_ExtensionSupported() Sam Lantinga <slouken@libsdl.org> parents: 1920 diff changeset	1380 */
307355678142 Added SDL_GL_ExtensionSupported() Sam Lantinga <slouken@libsdl.org> parents: 1920 diff changeset	1381 extern DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported(const char
307355678142 Added SDL_GL_ExtensionSupported() Sam Lantinga <slouken@libsdl.org> parents: 1920 diff changeset	1382 *extension);
307355678142 Added SDL_GL_ExtensionSupported() Sam Lantinga <slouken@libsdl.org> parents: 1920 diff changeset	1383
307355678142 Added SDL_GL_ExtensionSupported() Sam Lantinga <slouken@libsdl.org> parents: 1920 diff changeset	1384 /**
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1385 * \fn int SDL_GL_SetAttribute(SDL_GLattr attr, int value)
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1386 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1387 * \brief Set an OpenGL window attribute before window creation.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1388 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	1389 extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value);
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 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1392 * \fn int SDL_GL_GetWindowAttribute(SDL_WindowID windowID, SDL_GLattr attr, int *value)
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1393 *
1936 83946ee0ff1f Implemented OpenGL support on Mac OS X Sam Lantinga <slouken@libsdl.org> parents: 1926 diff changeset	1394 * \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	1395 */
1936 83946ee0ff1f Implemented OpenGL support on Mac OS X Sam Lantinga <slouken@libsdl.org> parents: 1926 diff changeset	1396 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	1397
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1398 /**
c121d94672cb SDL 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 * \fn SDL_GLContext SDL_GL_CreateContext(SDL_WindowID windowID)
c121d94672cb SDL 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 *
c121d94672cb SDL 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 * \brief Create an OpenGL context for use with an OpenGL window, and make it current.
c121d94672cb SDL 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 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1403 * \sa SDL_GL_DeleteContext()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1404 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1405 extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_WindowID
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1406 windowID);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1407
c121d94672cb SDL 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 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1409 * \fn int SDL_GL_MakeCurrent(SDL_WindowID windowID, 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	1410 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1411 * \brief Set up an OpenGL context for rendering into an OpenGL window.
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 * \note The context must have been created with a compatible window.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1414 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1415 extern DECLSPEC int SDLCALL SDL_GL_MakeCurrent(SDL_WindowID windowID,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1416 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	1417
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1418 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1419 * \fn int SDL_GL_SetSwapInterval(int interval)
c121d94672cb SDL 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 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1421 * \brief Set the swap interval for the current 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	1422 *
1912 8d384b647307 Setting up the OpenGL support Sam Lantinga <slouken@libsdl.org> parents: 1907 diff changeset	1423 * \param interval 0 for immediate updates, 1 for updates synchronized with the vertical retrace
8d384b647307 Setting up the OpenGL support Sam Lantinga <slouken@libsdl.org> parents: 1907 diff changeset	1424 *
8d384b647307 Setting up the OpenGL support Sam Lantinga <slouken@libsdl.org> parents: 1907 diff changeset	1425 * \return 0 on success, or -1 if setting the swap interval is not supported.
8d384b647307 Setting up the OpenGL support Sam Lantinga <slouken@libsdl.org> parents: 1907 diff changeset	1426 *
1895 c121d94672cb SDL 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 * \sa SDL_GL_GetSwapInterval()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1428 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1429 extern DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1430
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1431 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1432 * \fn int 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	1433 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1434 * \brief Get the swap interval for the current 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	1435 *
1912 8d384b647307 Setting up the OpenGL support Sam Lantinga <slouken@libsdl.org> parents: 1907 diff changeset	1436 * \return 0 if there is no vertical retrace synchronization, 1 if the buffer swap is synchronized with the vertical retrace, and -1 if getting the swap interval is not supported.
8d384b647307 Setting up the OpenGL support Sam Lantinga <slouken@libsdl.org> parents: 1907 diff changeset	1437 *
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1438 * \sa SDL_GL_SetSwapInterval()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1439 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1440 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	1441
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1442 /**
1912 8d384b647307 Setting up the OpenGL support Sam Lantinga <slouken@libsdl.org> parents: 1907 diff changeset	1443 * \fn void SDL_GL_SwapWindow(SDL_WindowID windowID)
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1444 *
1912 8d384b647307 Setting up the OpenGL support Sam Lantinga <slouken@libsdl.org> parents: 1907 diff changeset	1445 * \brief Swap the OpenGL buffers for the window, if double-buffering is supported.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1446 */
1912 8d384b647307 Setting up the OpenGL support Sam Lantinga <slouken@libsdl.org> parents: 1907 diff changeset	1447 extern DECLSPEC void SDLCALL SDL_GL_SwapWindow(SDL_WindowID windowID);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1448
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1449 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1450 * \fn void SDL_GL_DeleteContext(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	1451 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1452 * \brief Delete an 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	1453 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1454 * \sa SDL_GL_CreateContext()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1455 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1456 extern DECLSPEC void SDLCALL SDL_GL_DeleteContext(SDL_GLContext context);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1457
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1458
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1459 /* Ends C function definitions when using C++ */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1460 #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	1461 /* INDENT-OFF */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1462 }
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1463 /* INDENT-ON */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1464 #endif
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1465 #include "close_code.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1466
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1467 #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	1468
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1469 /* vi: set ts=4 sw=4 expandtab: */

Mercurial > sdl-ios-xcode

annotate include/SDL_video.h @ 3025:54fac87e1f34