sdl-ios-xcode: include/SDL

annotate include/SDL_video.h @ 1985:8055185ae4ed

Added source color and alpha modulation support. Added perl script to generate optimized render copy functions.

author	Sam Lantinga <slouken@libsdl.org>
date	Mon, 28 Aug 2006 03:17:39 +0000
parents	5d3724f64f2b
children	f4c65e3bfaed

rev	line source
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	2 SDL - Simple DirectMedia Layer
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1020 diff changeset	3 Copyright (C) 1997-2006 Sam Lantinga
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	4
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	5 This library is free software; you can redistribute it and/or
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1020 diff changeset	6 modify it under the terms of the GNU Lesser General Public
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	7 License as published by the Free Software Foundation; either
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1020 diff changeset	8 version 2.1 of the License, or (at your option) any later version.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	9
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	10 This library is distributed in the hope that it will be useful,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	11 but WITHOUT ANY WARRANTY; without even the implied warranty of
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1020 diff changeset	13 Lesser General Public License for more details.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	14
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1020 diff changeset	15 You should have received a copy of the GNU Lesser General Public
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1020 diff changeset	16 License along with this library; if not, write to the Free Software
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1020 diff changeset	17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	18
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	19 Sam Lantinga
251 b8688cfdc232 Updated the headers with the correct e-mail address Sam Lantinga <slouken@libsdl.org> parents: 130 diff changeset	20 slouken@libsdl.org
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	21 */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	22
1895 c121d94672cb SDL 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 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	26 * Header file for access to the SDL raw framebuffer 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	27 */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	28
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	29 #ifndef _SDL_video_h
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	30 #define _SDL_video_h
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	31
1356 67114343400d * empty log message * Sam Lantinga <slouken@libsdl.org> parents: 1330 diff changeset	32 #include "SDL_stdinc.h"
1358 c71e05b4dc2e More header massaging... works great on Windows. ;-) Sam Lantinga <slouken@libsdl.org> parents: 1356 diff changeset	33 #include "SDL_error.h"
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	34 #include "SDL_pixels.h"
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	35 #include "SDL_rwops.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	36
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	37 #include "begin_code.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	38 /* Set up for C function definitions, even when using C++ */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	39 #ifdef __cplusplus
1895 c121d94672cb SDL 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
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	45 /* Transparency definitions: These define alpha as the opacity of a surface */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	46 #define SDL_ALPHA_OPAQUE 255
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	47 #define SDL_ALPHA_TRANSPARENT 0
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	48
1895 c121d94672cb SDL 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 * \struct SDL_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	51 *
c121d94672cb SDL 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 * \brief A rectangle, with the origin at the upper left.
c121d94672cb SDL 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 */
c121d94672cb SDL 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 typedef struct SDL_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	55 {
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	56 int x, 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	57 int w, h;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	58 } SDL_Rect;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	59
1895 c121d94672cb SDL 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 /**
c121d94672cb SDL 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 * \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	62 *
c121d94672cb SDL 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 * \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	64 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	65 * \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	66 * \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	67 * \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	68 * \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	69 * \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	70 * \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	71 */
c121d94672cb SDL 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 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	73 {
c121d94672cb SDL 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 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	75 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	76 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	77 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	78 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	79 } SDL_DisplayMode;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	80
1895 c121d94672cb SDL 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 /**
c121d94672cb SDL 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 * \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	83 *
c121d94672cb SDL 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 * \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	85 *
c121d94672cb SDL 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_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	87 * \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	88 * \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	89 * \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	90 * \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	91 * \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	92 * \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	93 * \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	94 * \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	95 * \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	96 * \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	97 * \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	98 * \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	99 * \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	100 * \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	101 * \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	102 * \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	103 * \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	104 * \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	105 * \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	106 * \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	107 * \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	108 */
c121d94672cb SDL 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 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	110
c121d94672cb SDL 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 /**
c121d94672cb SDL 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 * \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	113 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	114 * \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	115 *
c121d94672cb SDL 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 * \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	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 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	119 {
c121d94672cb SDL 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 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	121 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	122 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	123 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	124 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	125 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	126 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	127 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	128 SDL_WINDOW_INPUT_FOCUS = 0x00000200, /*< window has 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	129 SDL_WINDOW_MOUSE_FOCUS = 0x00000400, /*< window has 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	130 } 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	131
c121d94672cb SDL 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 * \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	134 * \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	135 */
c121d94672cb SDL 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 #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	137 /**
c121d94672cb SDL 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 * \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	139 * \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	140 */
c121d94672cb SDL 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 #define SDL_WINDOWPOS_CENTERED 0x7FFFFFE
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	142
1895 c121d94672cb SDL 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 /**
c121d94672cb SDL 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 * \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	145 *
c121d94672cb SDL 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 * \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	147 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	148 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	149 {
c121d94672cb SDL 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 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	151 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	152 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	153 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	154 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	155 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	156 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	157 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	158 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	159 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	160 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	161 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	162 SDL_WINDOWEVENT_FOCUS_LOST, /*< The window has lost 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	163 SDL_WINDOWEVENT_CLOSE, /*< The window manager requests that the window be closed /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	164 } 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	165
c121d94672cb SDL 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 * \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	168 *
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	169 * \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	170 */
c121d94672cb SDL 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 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	172 {
1965 a788656ca29a SDL constants are all uppercase. Sam Lantinga <slouken@libsdl.org> parents: 1963 diff changeset	173 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	174 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	175 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	176 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	177 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	178 SDL_RENDERER_PRESENTVSYNC = 0x00000020, /*< Present is synchronized with the refresh rate /
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	179 SDL_RENDERER_ACCELERATED = 0x0000040, /*< 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	180 } 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	181
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	182 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	183 * \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	184 *
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	185 * \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	186 */
c121d94672cb SDL 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 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	188 {
c121d94672cb SDL 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 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	190 Uint32 flags; /*< Supported SDL_RendererFlags /
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	191 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	192 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	193 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	194 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	195 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	196 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	197 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	198 } SDL_RendererInfo;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	199
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	200 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	201 * \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	202 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	203 * \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	204 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	205 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	206 {
1965 a788656ca29a SDL constants are all uppercase. Sam Lantinga <slouken@libsdl.org> parents: 1963 diff changeset	207 SDL_TEXTUREACCESS_LOCAL, /*< Lockable system memory /
a788656ca29a SDL constants are all uppercase. Sam Lantinga <slouken@libsdl.org> parents: 1963 diff changeset	208 SDL_TEXTUREACCESS_REMOTE, /*< Unlockable video memory /
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	209 } 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	210
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	211 /**
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	212 * \enum SDL_TextureModulate
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	213 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	214 * \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	215 */
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	216 typedef enum
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	217 {
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	218 SDL_TEXTUREMODULATE_NONE = 0x00000000, /*< No modulation /
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	219 SDL_TEXTUREMODULATE_COLOR = 0x00000001, /*< srcC = srcC color */
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	220 SDL_TEXTUREMODULATE_ALPHA = 0x00000002, /*< srcA = srcA alpha */
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	221 } SDL_TextureModulate;
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	222
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	223 /**
1895 c121d94672cb SDL 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 * \enum SDL_TextureBlendMode
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	225 *
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	226 * \brief The texture blend 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	227 */
c121d94672cb SDL 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 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	229 {
1965 a788656ca29a SDL constants are all uppercase. Sam Lantinga <slouken@libsdl.org> parents: 1963 diff changeset	230 SDL_TEXTUREBLENDMODE_NONE = 0x00000000, /*< No blending /
a788656ca29a SDL constants are all uppercase. Sam Lantinga <slouken@libsdl.org> parents: 1963 diff changeset	231 SDL_TEXTUREBLENDMODE_MASK = 0x00000001, /*< dst = A ? src : dst (alpha is mask) /
a788656ca29a SDL constants are all uppercase. Sam Lantinga <slouken@libsdl.org> parents: 1963 diff changeset	232 SDL_TEXTUREBLENDMODE_BLEND = 0x00000002, /*< dst = (src A) + (dst * (1-A)) */
a788656ca29a SDL constants are all uppercase. Sam Lantinga <slouken@libsdl.org> parents: 1963 diff changeset	233 SDL_TEXTUREBLENDMODE_ADD = 0x00000004, /*< dst = (src A) + dst */
a788656ca29a SDL constants are all uppercase. Sam Lantinga <slouken@libsdl.org> parents: 1963 diff changeset	234 SDL_TEXTUREBLENDMODE_MOD = 0x00000008, /*< dst = src dst */
1895 c121d94672cb SDL 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 } SDL_TextureBlendMode;
c121d94672cb SDL 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
c121d94672cb SDL 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 * \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	239 *
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	240 * \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	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 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	243 {
1965 a788656ca29a SDL constants are all uppercase. Sam Lantinga <slouken@libsdl.org> parents: 1963 diff changeset	244 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	245 SDL_TEXTURESCALEMODE_FAST = 0x00000001, /*< Point sampling or equivalent algorithm /
a788656ca29a SDL constants are all uppercase. Sam Lantinga <slouken@libsdl.org> parents: 1963 diff changeset	246 SDL_TEXTURESCALEMODE_SLOW = 0x00000002, /*< Linear filtering or equivalent algorithm /
a788656ca29a SDL constants are all uppercase. Sam Lantinga <slouken@libsdl.org> parents: 1963 diff changeset	247 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	248 } 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	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 /**
c121d94672cb SDL 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 * \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	252 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	253 * \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	254 */
c121d94672cb SDL 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 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	256
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	257 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	258 * \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	259 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	260 * \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	261 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	262 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	263
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	264
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	265 /* These are the currently supported flags for the 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	266 /* Used internally (read-only) */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	267 #define SDL_HWSURFACE 0x00000001 /* Surface represents 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	268 #define SDL_PREALLOC 0x00000002 /* Surface uses preallocated memory */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	269 #define SDL_SRCALPHA 0x00000004 /* Blit uses source alpha blending */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	270 #define SDL_SRCCOLORKEY 0x00000008 /* Blit uses a source color key */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	271 #define SDL_RLEACCELOK 0x00000010 /* Private flag */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	272 #define SDL_RLEACCEL 0x00000020 /* Surface is RLE encoded */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	273
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	274 /* Evaluates to true if the surface needs to be locked before 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	275 #define SDL_MUSTLOCK(S) (((S)->flags & (SDL_HWSURFACE\|SDL_RLEACCEL)) != 0)
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	276
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	277 /* This structure should be treated as read-only, except for 'pixels',
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	278 which, if not NULL, contains the raw pixel data for the surface.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	279 */
1895 c121d94672cb SDL 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 typedef struct 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	281 {
c121d94672cb SDL 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 Uint32 flags; /* Read-only */
c121d94672cb SDL 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 SDL_PixelFormat format; / Read-only */
c121d94672cb SDL 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 int w, h; /* Read-only */
c121d94672cb SDL 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 int pitch; /* Read-only */
c121d94672cb SDL 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 void pixels; / Read-write */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	287
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	288 /* Application data associated with the surfade */
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	289 void userdata; / Read-write */
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	290
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	291 /* texture associated with the surface, if any */
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	292 SDL_TextureID textureID; /* Read-only */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	293
1895 c121d94672cb SDL 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 /* information needed for surfaces requiring locks */
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	295 int locked; /* Read-only */
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	296 void lock_data; / Read-only */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	297
1895 c121d94672cb SDL 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 /* clipping information */
c121d94672cb SDL 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 SDL_Rect clip_rect; /* Read-only */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	300
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	301 /* info for fast blit mapping to other surfaces */
c121d94672cb SDL 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 struct SDL_BlitMap map; / Private */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	303
1895 c121d94672cb SDL 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 /* format version, bumped at every change to invalidate blit maps */
c121d94672cb SDL 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 unsigned int format_version; /* Private */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	306
1895 c121d94672cb SDL 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 /* Reference count -- used when freeing 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	308 int refcount; /* Read-mostly */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	309 } SDL_Surface;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	310
1020 5b1cb1e9140d Allow SDL to be loaded by Matlab Sam Lantinga <slouken@libsdl.org> parents: 911 diff changeset	311 /* typedef for private surface blitting 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	312 typedef int (SDL_blit) (struct SDL_Surface src, SDL_Rect * srcrect,
c121d94672cb SDL 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 struct SDL_Surface * dst, SDL_Rect * dstrect);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	314
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	315
1895 c121d94672cb SDL 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 /**
c121d94672cb SDL 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 * \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	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 * \brief OpenGL configuration attributes
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	320 */
1895 c121d94672cb SDL 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 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	322 {
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	323 SDL_GL_RED_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	324 SDL_GL_GREEN_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	325 SDL_GL_BLUE_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	326 SDL_GL_ALPHA_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	327 SDL_GL_BUFFER_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	328 SDL_GL_DOUBLEBUFFER,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	329 SDL_GL_DEPTH_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	330 SDL_GL_STENCIL_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	331 SDL_GL_ACCUM_RED_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	332 SDL_GL_ACCUM_GREEN_SIZE,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	333 SDL_GL_ACCUM_BLUE_SIZE,
450 8a43e0cbf02f Added SDL_GL_STEREO for stereoscopic OpenGL contexts Sam Lantinga <slouken@libsdl.org> parents: 432 diff changeset	334 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	335 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	336 SDL_GL_MULTISAMPLEBUFFERS,
1736 3b2a92126f4d Implemented bug #2, 117: Sam Lantinga <slouken@libsdl.org> parents: 1545 diff changeset	337 SDL_GL_MULTISAMPLESAMPLES,
1895 c121d94672cb SDL 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 SDL_GL_ACCELERATED_VISUAL
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	339 } SDL_GLattr;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	340
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	341
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	342 /* Function prototypes */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	343
1895 c121d94672cb SDL 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 * \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	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 * \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	348 *
c121d94672cb SDL 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 * \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	350 */
c121d94672cb SDL 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 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	352
c121d94672cb SDL 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 * \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	355 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	356 * \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	357 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	358 * \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	359 * 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	360 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	361 * \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	362 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	363 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	364
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	365 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	366 * \fn int SDL_VideoInit(const char *driver_name, Uint32 flags)
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: 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 * \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	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 * \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	371 * \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	372 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	373 * \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	374 *
c121d94672cb SDL 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 * 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	376 * 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	377 * and pixel formats, but does not initialize a window or graphics mode.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	378 *
1895 c121d94672cb SDL 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 * \sa SDL_VideoQuit()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	380 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	381 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	382 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	383
c121d94672cb SDL 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 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	385 * \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	386 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	387 * \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	388 *
c121d94672cb SDL 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 * 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	390 *
c121d94672cb SDL 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 * \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	392 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	393 extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
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 /**
c121d94672cb SDL 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 * \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	397 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	398 * \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	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 * \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	401 * 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	402 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	403 * \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	404 * \sa SDL_GetVideoDriver()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	405 */
1895 c121d94672cb SDL 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 extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	407
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	408 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	409 * \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	410 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	411 * \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	412 *
c121d94672cb SDL 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 * \sa SDL_SelectVideoDisplay()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	414 */
1895 c121d94672cb SDL 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 extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
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 /**
c121d94672cb SDL 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 * \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	419 *
c121d94672cb SDL 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 * \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	421 *
1963 2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	422 * \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	423 *
2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	424 * \sa SDL_GetNumVideoDisplays()
2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	425 * \sa SDL_GetCurrentVideoDisplay()
2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	426 */
2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	427 extern DECLSPEC int SDLCALL SDL_SelectVideoDisplay(int index);
2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	428
2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	429 /**
2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	430 * \fn int SDL_GetCurrentVideoDisplay(void)
2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	431 *
2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	432 * \brief Get the index of the currently selected display.
2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	433 *
1895 c121d94672cb SDL 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 * \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	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 * \sa SDL_GetNumVideoDisplays()
1963 2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	437 * \sa SDL_SelectVideoDisplay()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	438 */
1963 2590b68531ef Added SDL_GetCurrentVideoDisplay() Sam Lantinga <slouken@libsdl.org> parents: 1956 diff changeset	439 extern DECLSPEC int SDLCALL SDL_GetCurrentVideoDisplay(void);
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 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	442 * \fn int SDL_GetNumDisplayModes(void)
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	443 *
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	444 * \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	445 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	446 * \sa SDL_GetDisplayMode()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	447 */
1895 c121d94672cb SDL 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 extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(void);
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_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	452 *
1968 9f589a1f74a5 Updated header documentation Sam Lantinga <slouken@libsdl.org> parents: 1967 diff changeset	453 * \brief Fill in information about a specific display mode.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	454 *
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	455 * \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	456 * \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	457 * \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	458 * \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	459 * \li refresh rate -> highest to lowest
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	460 *
1895 c121d94672cb SDL 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 * \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	462 */
1967 01e29c3e9a29 In general, fill in pointers to structures, rather than return them. Sam Lantinga <slouken@libsdl.org> parents: 1966 diff changeset	463 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	464 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	465
c121d94672cb SDL 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 /**
1967 01e29c3e9a29 In general, fill in pointers to structures, rather than return them. Sam Lantinga <slouken@libsdl.org> parents: 1966 diff changeset	467 * \fn int SDL_GetDesktopDisplayMode(SDL_DisplayMode *mode)
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	468 *
1968 9f589a1f74a5 Updated header documentation Sam Lantinga <slouken@libsdl.org> parents: 1967 diff changeset	469 * \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	470 */
1967 01e29c3e9a29 In general, fill in pointers to structures, rather than return them. Sam Lantinga <slouken@libsdl.org> parents: 1966 diff changeset	471 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	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 /**
1967 01e29c3e9a29 In general, fill in pointers to structures, rather than return them. Sam Lantinga <slouken@libsdl.org> parents: 1966 diff changeset	474 * \fn int SDL_GetCurrentDisplayMode(SDL_DisplayMode *mode)
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	475 *
1968 9f589a1f74a5 Updated header documentation Sam Lantinga <slouken@libsdl.org> parents: 1967 diff changeset	476 * \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	477 */
1967 01e29c3e9a29 In general, fill in pointers to structures, rather than return them. Sam Lantinga <slouken@libsdl.org> parents: 1966 diff changeset	478 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	479
c121d94672cb SDL 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 * \fn SDL_DisplayMode SDL_GetClosestDisplayMode(const SDL_DisplayMode mode, SDL_DisplayMode *closest)
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	482 *
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	483 * \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	484 *
c121d94672cb SDL 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 * \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	486 * \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	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 * \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	489 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	490 * 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	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 * \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	493 * \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	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 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	496 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	497 * 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	498 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	499 * 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	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 /**
c121d94672cb SDL 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 * \fn int SDL_SetFullscreenDisplayMode(const SDL_DisplayMode *mode)
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	503 *
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	504 * \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	505 * on the currently selected display.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	506 *
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	507 * \param mode The mode to use, or NULL for the desktop mode.
0 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 * \return 0 on success, or -1 if setting the display mode failed.
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 * \sa SDL_SetWindowFullscreen()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	512 */
1895 c121d94672cb SDL 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 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	514 * mode);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	515
1895 c121d94672cb SDL 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 /**
1967 01e29c3e9a29 In general, fill in pointers to structures, rather than return them. Sam Lantinga <slouken@libsdl.org> parents: 1966 diff changeset	517 * \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	518 *
1968 9f589a1f74a5 Updated header documentation Sam Lantinga <slouken@libsdl.org> parents: 1967 diff changeset	519 * \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	520 * window is visible on the currently selected display.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	521 */
1967 01e29c3e9a29 In general, fill in pointers to structures, rather than return them. Sam Lantinga <slouken@libsdl.org> parents: 1966 diff changeset	522 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	523 mode);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	524
1895 c121d94672cb SDL 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 * \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	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 * \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	529 *
c121d94672cb SDL 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 * \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	531 */
1895 c121d94672cb SDL 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 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	533 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	534 int ncolors);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	535
1895 c121d94672cb SDL 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 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	537 * \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	538 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	539 * \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	540 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	541 * \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	542 */
c121d94672cb SDL 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 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	544 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	545 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	546
c121d94672cb SDL 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 * \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	549 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	550 * \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	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 * \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	553 *
c121d94672cb SDL 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 * \sa SDL_SetGammaRamp()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	555 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	556 extern DECLSPEC int SDLCALL SDL_SetGamma(float red, float green, float blue);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	557
1895 c121d94672cb SDL 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 * \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	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 * \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	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 * \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	564 * \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	565 * \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	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 * \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	568 *
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	569 * Set the gamma translation table for the red, green, and blue channels
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	570 * 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	571 * representing a mapping between the input and output for that channel.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	572 * 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	573 * gamma value at that index, scaled to the output color precision.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	574 *
1895 c121d94672cb SDL 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 * \sa SDL_GetGammaRamp()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	576 */
1895 c121d94672cb SDL 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 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	578 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	579 const Uint16 * blue);
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 /**
c121d94672cb SDL 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 * \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	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 * \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	585 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	586 * \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	587 * \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	588 * \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	589 *
1895 c121d94672cb SDL 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 * \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	591 *
c121d94672cb SDL 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 * \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	593 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	594 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	595 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	596
c121d94672cb SDL 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 /**
c121d94672cb SDL 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 * \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	600 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	601 * \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	602 *
1956 ba0d62354872 Simplified driver window creation code. Sam Lantinga <slouken@libsdl.org> parents: 1936 diff changeset	603 * \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	604 * \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	605 * \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	606 * \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	607 * \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	608 * \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	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 * \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	611 *
c121d94672cb SDL 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 * \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	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 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	615 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	616 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	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 /**
c121d94672cb SDL 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 * \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	620 *
c121d94672cb SDL 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 * \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	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 * \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	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 * \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	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 * \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	628 *
c121d94672cb SDL 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 * \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	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 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	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 /**
c121d94672cb SDL 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 * \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	635 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	636 * \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	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 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	639
c121d94672cb SDL 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 * \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	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 * \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	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 * \sa SDL_GetWindowTitle()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	646 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	647 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	648 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	649
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	650 /**
c121d94672cb SDL 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 * \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	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 * \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	654 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	655 * \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	656 */
c121d94672cb SDL 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 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	658
c121d94672cb SDL 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 /**
c121d94672cb SDL 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 * \fn void SDL_SetWindowIcon(SDL_Surface *icon)
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	661 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	662 * \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	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 * \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	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 * FIXME: The icon needs to be set before the window is first shown. Should some icon representation be part of the 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	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_SetWindowIcon(SDL_Surface * icon);
c121d94672cb SDL 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
c121d94672cb SDL 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 * \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	672 *
c121d94672cb SDL 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 * \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	674 *
c121d94672cb SDL 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 * \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	676 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	677 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	678 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	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_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	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 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	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_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	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_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	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_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	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 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	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 * \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	695 * \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	696 * \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	697 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	698 * \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	699 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	700 * \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	701 */
c121d94672cb SDL 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 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	703 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	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_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	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 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	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_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	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_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	713 int x, int y);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	714
1895 c121d94672cb SDL 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 /**
c121d94672cb SDL 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 * \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	717 *
c121d94672cb SDL 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 * \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	719 *
c121d94672cb SDL 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 * \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	721 * 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	722 *
c121d94672cb SDL 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 * \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	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 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	726 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	727
c121d94672cb SDL 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 * \fn void SDL_GetWindowSize(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	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 * \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	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 * \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	734 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	735 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	736 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	737
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	738 /**
c121d94672cb SDL 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 * \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	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 * \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	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_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	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_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	746
c121d94672cb SDL 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 * \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	749 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	750 * \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	751 *
c121d94672cb SDL 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 * \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	753 */
c121d94672cb SDL 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 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	755
c121d94672cb SDL 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 * \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	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 * \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	760 */
c121d94672cb SDL 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 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	762
c121d94672cb SDL 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 * \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	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 * \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	767 *
c121d94672cb SDL 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 * \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	769 */
c121d94672cb SDL 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 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	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 /**
c121d94672cb SDL 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 * \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	774 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	775 * \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	776 *
c121d94672cb SDL 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 * \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	778 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	779 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	780
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	781 /**
c121d94672cb SDL 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 * \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	783 *
c121d94672cb SDL 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 * \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	785 *
c121d94672cb SDL 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 * \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	787 * \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	788 */
c121d94672cb SDL 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 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	790
c121d94672cb SDL 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 * \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	793 *
c121d94672cb SDL 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 * \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	795 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	796 * \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	797 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	798 * \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	799 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	800 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	801 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	802
c121d94672cb SDL 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 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	804 * \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	805 *
c121d94672cb SDL 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 * \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	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 * \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	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 * \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	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 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	813 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	814
c121d94672cb SDL 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 * \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	817 *
c121d94672cb SDL 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 * \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	819 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	820 * \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	821 *
c121d94672cb SDL 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 * \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	823 */
c121d94672cb SDL 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 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	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 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	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 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	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 * \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	832 */
c121d94672cb SDL 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 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	834 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	835 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	836 *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	837
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	838 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	839 * \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	840 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	841 * \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	842 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	843 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	844
c121d94672cb SDL 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 /**
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	846 * \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	847 *
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	848 * \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	849 *
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	850 * 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	851 * 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	852 * 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	853 *
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	854 * \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	855 * \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	856 */
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	857 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	858
c121d94672cb SDL 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 /**
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	860 * \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	861 *
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	862 * \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	863 *
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	864 * \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	865 * \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	866 *
06c27a737b7a Streamlined the API a bit and optimized the software renderer. Sam Lantinga <slouken@libsdl.org> parents: 1897 diff changeset	867 * \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	868 *
1895 c121d94672cb SDL 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 * \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	870 */
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	871 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	872 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	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 /**
c121d94672cb SDL 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 * \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	876 *
c121d94672cb SDL 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 * \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	878 *
c121d94672cb SDL 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 * \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	880 * \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	881 * \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	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 * \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	884 * 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	885 *
c121d94672cb SDL 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 * \sa SDL_SelectRenderer()
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	887 * \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	888 * \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	889 */
c121d94672cb SDL 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 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	891 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	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 /**
c121d94672cb SDL 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 * \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	895 *
c121d94672cb SDL 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 * \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	897 *
c121d94672cb SDL 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 * \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	899 * 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	900 */
c121d94672cb SDL 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 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	902
c121d94672cb SDL 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 /**
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	904 * \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	905 *
5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	906 * \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	907 */
5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	908 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	909
5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	910 /**
1895 c121d94672cb SDL 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 * \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	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 * \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	914 *
c121d94672cb SDL 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 * \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	916 * \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	917 * \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	918 * \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	919 *
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	920 * \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	921 *
c121d94672cb SDL 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 * \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	923 * \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	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 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	926 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	927 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	928
c121d94672cb SDL 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 * \fn SDL_TextureID SDL_CreateTextureFromSurface(Uint32 format, int access, SDL_Surface *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	931 *
c121d94672cb SDL 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 * \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	933 *
c121d94672cb SDL 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 * \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	935 * \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	936 * \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	937 *
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	938 * \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	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 * \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	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 * \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	943 * \sa SDL_DestroyTexture()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	944 */
1895 c121d94672cb SDL 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 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	946 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	947 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	948 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	949 * 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	950
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	951 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	952 * \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	953 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	954 * \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	955 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	956 * \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	957 * \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	958 * \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	959 * \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	960 * \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	961 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	962 * \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	963 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	964 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	965 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	966 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	967
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	968 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	969 * \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	970 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	971 * \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	972 *
1966 6472256c21eb Removed old function Sam Lantinga <slouken@libsdl.org> parents: 1965 diff changeset	973 * \param texture A texture to be queried, which was created with SDL_TEXTUREACCESS_LOCAL
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	974 * \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	975 * \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	976 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	977 * \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	978 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	979 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	980 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	981
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	982 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	983 * \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	984 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	985 * \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	986 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	987 * \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	988 * \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	989 * \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	990 * \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	991 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	992 * \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	993 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	994 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	995 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	996 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	997 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	998
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	999 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1000 * \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	1001 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1002 * \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	1003 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1004 * \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	1005 * \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	1006 * \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	1007 * \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	1008 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1009 * \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	1010 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1011 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	1012 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	1013 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	1014 int ncolors);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1015
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1016 /**
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1017 * \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	1018 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1019 * \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	1020 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1021 * \param texture The texture to update
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1022 * \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	1023 * \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	1024 * \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	1025 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1026 * \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	1027 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1028 * \sa SDL_GetTextureColorMod()
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 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	1031 Uint8 r, Uint8 g, Uint8 b);
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
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 * \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	1036 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1037 * \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	1038 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1039 * \param texture The texture to query
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1040 * \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	1041 * \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	1042 * \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	1043 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1044 * \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	1045 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1046 * \sa SDL_SetTextureColorMod()
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 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	1049 Uint8 * r, Uint8 * g,
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1050 Uint8 * b);
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1051
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 * \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	1054 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1055 * \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	1056 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1057 * \param texture The texture to update
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1058 * \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	1059 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1060 * \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	1061 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1062 * \sa SDL_GetTextureAlphaMod()
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1063 */
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1064 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	1065 Uint8 alpha);
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 /**
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1068 * \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	1069 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1070 * \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	1071 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1072 * \param texture The texture to query
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1073 * \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	1074 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1075 * \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	1076 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1077 * \sa SDL_SetTextureAlphaMod()
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1078 */
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1079 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	1080 Uint8 * alpha);
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1081
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1082 /**
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1083 * \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	1084 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1085 * \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	1086 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1087 * \param texture The texture to update
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1088 * \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	1089 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1090 * \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	1091 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1092 * \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	1093 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1094 * \sa SDL_GetTextureBlendMode()
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1095 */
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1096 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	1097 int blendMode);
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1098
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1099 /**
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1100 * \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	1101 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1102 * \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	1103 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1104 * \param texture The texture to query
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1105 * \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	1106 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1107 * \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	1108 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1109 * \sa SDL_SetTextureBlendMode()
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1110 */
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1111 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	1112 int *blendMode);
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1113
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1114 /**
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1115 * \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	1116 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1117 * \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	1118 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1119 * \param texture The texture to update
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1120 * \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	1121 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1122 * \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	1123 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1124 * \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	1125 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1126 * \sa SDL_GetTextureScaleMode()
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1127 */
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1128 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	1129 int scaleMode);
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1130
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1131 /**
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1132 * \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	1133 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1134 * \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	1135 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1136 * \param texture The texture to query
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1137 * \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	1138 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1139 * \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	1140 *
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1141 * \sa SDL_SetTextureScaleMode()
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1142 */
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1143 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	1144 int *scaleMode);
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1145
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1146 /**
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1147 * \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	1148 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1149 * \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	1150 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1151 * \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	1152 * \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	1153 * \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	1154 * \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	1155 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1156 * \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	1157 *
1966 6472256c21eb Removed old function Sam Lantinga <slouken@libsdl.org> parents: 1965 diff changeset	1158 * \note This is a very slow function for textures not created with SDL_TEXTUREACCESS_LOCAL.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1159 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1160 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	1161 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	1162 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	1163
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1164 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1165 * \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	1166 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1167 * \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	1168 *
1966 6472256c21eb Removed old function Sam Lantinga <slouken@libsdl.org> parents: 1965 diff changeset	1169 * \param texture The texture to lock for access, which must have been created with SDL_TEXTUREACCESS_LOCAL.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1170 * \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	1171 * \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	1172 * \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	1173 * \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	1174 *
1966 6472256c21eb Removed old function Sam Lantinga <slouken@libsdl.org> parents: 1965 diff changeset	1175 * \return 0 on success, or -1 if the texture is not valid or was created with SDL_TEXTUREACCESS_REMOTe
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1176 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1177 * \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	1178 * \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	1179 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1180 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	1181 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	1182 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	1183 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	1184
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1185 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1186 * \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	1187 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1188 * \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	1189 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1190 * \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	1191 * \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	1192 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1193 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	1194
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1195 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1196 * \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	1197 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1198 * \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	1199 *
1966 6472256c21eb Removed old function Sam Lantinga <slouken@libsdl.org> parents: 1965 diff changeset	1200 * \note The texture must have been created with SDL_TEXTUREACCESS_LOCAL.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1201 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1202 * \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	1203 * \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	1204 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1205 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	1206 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	1207 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	1208
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1209 /**
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1210 * \fn void SDL_RenderFill(Uint8 r, Uint8 g, Uint8 b, Uint8 a, 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	1211 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1212 * \brief Fill the current rendering target with the specified color.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1213 *
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1214 * \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	1215 * \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	1216 * \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	1217 * \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	1218 * \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	1219 *
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	1220 * \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	1221 */
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1222 extern DECLSPEC int SDLCALL SDL_RenderFill(Uint8 r, Uint8 g, Uint8 b, Uint8 a,
8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1223 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	1224
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1225 /**
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1226 * \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	1227 *
c121d94672cb SDL 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 * \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	1229 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1230 * \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	1231 * \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	1232 * \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	1233 *
1969 5d3724f64f2b Clarified the difference between render drivers and render contexts Sam Lantinga <slouken@libsdl.org> parents: 1968 diff changeset	1234 * \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	1235 */
c121d94672cb SDL 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 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	1237 const SDL_Rect * srcrect,
1985 8055185ae4ed Added source color and alpha modulation support. Sam Lantinga <slouken@libsdl.org> parents: 1969 diff changeset	1238 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	1239
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1240 /**
c121d94672cb SDL 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 * \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	1242 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1243 * \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	1244 *
c121d94672cb SDL 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 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	1246 * \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	1247 * \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	1248 *
c121d94672cb SDL 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 * \return 0 on success, or -1 if pixel reading is not supported.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1250 *
1895 c121d94672cb SDL 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 * \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	1252 */
c121d94672cb SDL 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 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	1254 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	1255
c121d94672cb SDL 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 * \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	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 * \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	1260 *
c121d94672cb SDL 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 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	1262 * \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	1263 * \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	1264 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1265 * \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	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 * \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	1268 */
1895 c121d94672cb SDL 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 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	1270 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	1271 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 /**
c121d94672cb SDL 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 * \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	1275 *
c121d94672cb SDL 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 * \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	1277 */
c121d94672cb SDL 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 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	1279
c121d94672cb SDL 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 * \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	1282 *
c121d94672cb SDL 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 * \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	1284 *
c121d94672cb SDL 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 * \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	1286 * \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	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 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	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 /**
c121d94672cb SDL 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 * \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	1292 *
c121d94672cb SDL 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 * \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	1294 * 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	1295 *
c121d94672cb SDL 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 * \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	1297 */
c121d94672cb SDL 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 extern DECLSPEC void SDLCALL SDL_DestroyRenderer(SDL_WindowID windowID);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1299
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1300 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1301 * Maps an RGB triple to an opaque pixel value for a given pixel format
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1302 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	1303 extern DECLSPEC Uint32 SDLCALL SDL_MapRGB
1895 c121d94672cb SDL 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 (SDL_PixelFormat * format, Uint8 r, Uint8 g, Uint8 b);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1305
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1306 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1307 * Maps an RGBA quadruple to a pixel value for a given pixel format
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1308 */
1895 c121d94672cb SDL 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 extern DECLSPEC Uint32 SDLCALL SDL_MapRGBA(SDL_PixelFormat * 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	1310 Uint8 r, Uint8 g, Uint8 b,
c121d94672cb SDL 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 Uint8 a);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1312
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1313 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1314 * Maps a pixel value into the RGB components for a given pixel format
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1315 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1316 extern DECLSPEC void SDLCALL SDL_GetRGB(Uint32 pixel, SDL_PixelFormat * fmt,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1317 Uint8 * r, Uint8 * g, Uint8 * b);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1318
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1319 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1320 * Maps a pixel value into the RGBA components for a given pixel format
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1321 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1322 extern DECLSPEC void SDLCALL SDL_GetRGBA(Uint32 pixel, SDL_PixelFormat * fmt,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1323 Uint8 * r, Uint8 * g, Uint8 * b,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1324 Uint8 * a);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1325
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1326 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1327 * Allocate and free an RGB surface (must be called after SDL_SetVideoMode)
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1328 * If the depth is 4 or 8 bits, an empty palette is allocated for the surface.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1329 * If the depth is greater than 8 bits, the pixel format is set using the
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1330 * flags '[RGB]mask'.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1331 * If the function runs out of memory, it will return NULL.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1332 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1333 * The 'flags' tell what kind of surface to create.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1334 * SDL_SRCCOLORKEY indicates that the surface will be used for colorkey blits.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1335 * SDL_SRCALPHA means that the surface will be used for alpha blits.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1336 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1337 extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateRGBSurface
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1338 (Uint32 flags, int width, int height, int depth,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1339 Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1340 extern DECLSPEC SDL_Surface SDLCALL SDL_CreateRGBSurfaceFrom(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	1341 int 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	1342 int 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	1343 int depth,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1344 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	1345 Uint32 Rmask,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1346 Uint32 Gmask,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1347 Uint32 Bmask,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1348 Uint32 Amask);
c121d94672cb SDL 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 extern DECLSPEC SDL_Surface *SDLCALL
c121d94672cb SDL 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 SDL_CreateRGBSurfaceFromTexture(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	1351 extern DECLSPEC void SDLCALL SDL_FreeSurface(SDL_Surface * 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	1352
c121d94672cb SDL 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 * \fn int SDL_SetSurfacePalette(SDL_Surface surface, SDL_Palette 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	1355 *
c121d94672cb SDL 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 * \brief Set the palette used by a 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	1357 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1358 * \return 0, or -1 if the surface format doesn't use a 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	1359 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1360 * \note A single palette can be shared with many surfaces.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1361 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1362 extern DECLSPEC int SDLCALL SDL_SetSurfacePalette(SDL_Surface * 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	1363 SDL_Palette * palette);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1364
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1365 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1366 * SDL_LockSurface() sets up a surface for directly accessing the pixels.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1367 * Between calls to SDL_LockSurface()/SDL_UnlockSurface(), you can write
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1368 * to and read from 'surface->pixels', using the pixel format stored in
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1369 * 'surface->format'. Once you are done accessing the surface, you should
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1370 * use SDL_UnlockSurface() to release it.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1371 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1372 * Not all surfaces require locking. If SDL_MUSTLOCK(surface) evaluates
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1373 * to 0, then you can read and write to the surface at any time, and the
1895 c121d94672cb SDL 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 * pixel format of the surface will not change.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1375 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1376 * No operating system or library calls should be made between lock/unlock
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1377 * pairs, as critical system locks may be held during this time.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1378 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1379 * SDL_LockSurface() returns 0, or -1 if the surface couldn't be locked.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1380 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1381 extern DECLSPEC int SDLCALL SDL_LockSurface(SDL_Surface * 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	1382 extern DECLSPEC void SDLCALL SDL_UnlockSurface(SDL_Surface * surface);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1383
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1384 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1385 * Load a surface from a seekable SDL data source (memory or file.)
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1386 * If 'freesrc' is non-zero, the source will be closed after being read.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1387 * Returns the new surface, or NULL if there was an error.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1388 * The new surface should be freed with SDL_FreeSurface().
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1389 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1390 extern DECLSPEC SDL_Surface SDLCALL SDL_LoadBMP_RW(SDL_RWops src,
c121d94672cb SDL 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 int freesrc);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1392
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1393 /* Convenience macro -- load a surface from a file */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1394 #define SDL_LoadBMP(file) SDL_LoadBMP_RW(SDL_RWFromFile(file, "rb"), 1)
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1395
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1396 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1397 * Save a surface to a seekable SDL data source (memory or file.)
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1398 * If 'freedst' is non-zero, the source will be closed after being written.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1399 * Returns 0 if successful or -1 if there was an error.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1400 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	1401 extern DECLSPEC int SDLCALL SDL_SaveBMP_RW
1895 c121d94672cb SDL 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 (SDL_Surface * surface, SDL_RWops * dst, int freedst);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1403
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1404 /* Convenience macro -- save a surface to a file */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1405 #define SDL_SaveBMP(surface, file) \
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1406 SDL_SaveBMP_RW(surface, SDL_RWFromFile(file, "wb"), 1)
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1407
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1408 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1409 * Sets the color key (transparent pixel) in a blittable surface.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1410 * If 'flag' is SDL_SRCCOLORKEY (optionally OR'd with SDL_RLEACCEL),
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1411 * 'key' will be the transparent pixel in the source image of a blit.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1412 * SDL_RLEACCEL requests RLE acceleration for the surface if present,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1413 * and removes RLE acceleration if absent.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1414 * If 'flag' is 0, this function clears any current color key.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1415 * This function returns 0, or -1 if there was an error.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1416 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	1417 extern DECLSPEC int SDLCALL SDL_SetColorKey
1895 c121d94672cb SDL 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 (SDL_Surface * surface, Uint32 flag, Uint32 key);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1419
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1420 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1421 * This function sets the alpha value for the entire surface, as opposed to
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1422 * using the alpha component of each pixel. This value measures the range
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1423 * of transparency of the surface, 0 being completely transparent to 255
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1424 * being completely opaque. An 'alpha' value of 255 causes blits to be
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1425 * opaque, the source pixels copied to the destination (the default). Note
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1426 * that per-surface alpha can be combined with colorkey transparency.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1427 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1428 * If 'flag' is 0, alpha blending is disabled for the surface.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1429 * If 'flag' is SDL_SRCALPHA, alpha blending is enabled for the surface.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1430 * OR:ing the flag with SDL_RLEACCEL requests RLE acceleration for the
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1431 * surface; if SDL_RLEACCEL is not specified, the RLE accel will be removed.
432 80a35d43a58f * empty log message * Sam Lantinga <slouken@libsdl.org> parents: 431 diff changeset	1432 *
80a35d43a58f * empty log message * Sam Lantinga <slouken@libsdl.org> parents: 431 diff changeset	1433 * The 'alpha' parameter is ignored for surfaces that have an alpha channel.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1434 */
1895 c121d94672cb SDL 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 extern DECLSPEC int SDLCALL SDL_SetAlpha(SDL_Surface * surface, Uint32 flag,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1436 Uint8 alpha);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1437
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1438 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1439 * Sets the clipping rectangle for the destination surface in a blit.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1440 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1441 * If the clip rectangle is NULL, clipping will be disabled.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1442 * If the clip rectangle doesn't intersect the surface, the function will
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1443 * return SDL_FALSE and blits will be completely clipped. Otherwise the
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1444 * function returns SDL_TRUE and blits to the surface will be clipped to
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1445 * the intersection of the surface area and the clipping rectangle.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1446 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1447 * Note that blits are automatically clipped to the edges of the source
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1448 * and destination surfaces.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1449 */
1895 c121d94672cb SDL 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 extern DECLSPEC SDL_bool SDLCALL SDL_SetClipRect(SDL_Surface * 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	1451 const SDL_Rect * rect);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1452
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1453 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1454 * Gets the clipping rectangle for the destination surface in a blit.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1455 * 'rect' must be a pointer to a valid rectangle which will be filled
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1456 * with the correct values.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1457 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1458 extern DECLSPEC void SDLCALL SDL_GetClipRect(SDL_Surface * 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	1459 SDL_Rect * rect);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1460
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1461 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1462 * Creates a new surface of the specified format, and then copies and maps
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1463 * the given surface to it so the blit of the converted surface will be as
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1464 * fast as possible. If this function fails, it returns NULL.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1465 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1466 * The 'flags' parameter is passed to SDL_CreateRGBSurface() and has those
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1467 * semantics. You can also pass SDL_RLEACCEL in the flags parameter and
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1468 * SDL will try to RLE accelerate colorkey and alpha blits in the resulting
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1469 * surface.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1470 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1471 * This function is used internally by SDL_DisplayFormat().
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1472 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1473 extern DECLSPEC SDL_Surface *SDLCALL SDL_ConvertSurface
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1474 (SDL_Surface * src, SDL_PixelFormat * fmt, 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	1475
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1476 /*
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1477 * This function performs a fast fill of the given rectangle with 'color'
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1478 * The given rectangle is clipped to the destination surface clip 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	1479 * and the final fill rectangle is saved in the passed in pointer.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1480 * If 'dstrect' is NULL, the whole surface will be filled with 'color'
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1481 * The color should be a pixel of the format used by the surface, and
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1482 * can be generated by the SDL_MapRGB() 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	1483 * This function returns 0 on success, or -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	1484 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1485 extern DECLSPEC int SDLCALL SDL_FillRect
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1486 (SDL_Surface * dst, SDL_Rect * dstrect, Uint32 color);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1487
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1488 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1489 * This performs a fast blit from the source surface to the destination
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1490 * surface. It assumes that the source and destination rectangles are
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1491 * the same size. If either 'srcrect' or 'dstrect' are NULL, the entire
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1492 * surface (src or dst) is copied. The final blit rectangles are saved
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1493 * in 'srcrect' and 'dstrect' after all clipping is performed.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1494 * If the blit is successful, it returns 0, otherwise it returns -1.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1495 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1496 * The blit function should not be called on a locked surface.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1497 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1498 * The blit semantics for surfaces with and without alpha and colorkey
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1499 * are defined as follows:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1500 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1501 * RGBA->RGB:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1502 * SDL_SRCALPHA set:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1503 * alpha-blend (using alpha-channel).
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1504 * SDL_SRCCOLORKEY ignored.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1505 * SDL_SRCALPHA not set:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1506 * copy RGB.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1507 * if SDL_SRCCOLORKEY set, only copy the pixels matching the
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1508 * RGB values of the source colour key, ignoring alpha in the
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1509 * comparison.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1510 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1511 * RGB->RGBA:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1512 * SDL_SRCALPHA set:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1513 * alpha-blend (using the source per-surface alpha value);
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1514 * set destination alpha to opaque.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1515 * SDL_SRCALPHA not set:
431 41cadcba32e8 Fixed SDL_DisplayFormatAlpha() on RGB surfaces with alpha Sam Lantinga <slouken@libsdl.org> parents: 337 diff changeset	1516 * copy RGB, set destination alpha to source per-surface alpha value.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1517 * both:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1518 * if SDL_SRCCOLORKEY set, only copy the pixels matching the
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1519 * source colour key.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1520 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1521 * RGBA->RGBA:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1522 * SDL_SRCALPHA set:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1523 * alpha-blend (using the source alpha channel) the RGB values;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1524 * leave destination alpha untouched. [Note: is this correct?]
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1525 * SDL_SRCCOLORKEY ignored.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1526 * SDL_SRCALPHA not set:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1527 * copy all of RGBA to the destination.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1528 * if SDL_SRCCOLORKEY set, only copy the pixels matching the
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1529 * RGB values of the source colour key, ignoring alpha in the
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1530 * comparison.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1531 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1532 * RGB->RGB:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1533 * SDL_SRCALPHA set:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1534 * alpha-blend (using the source per-surface alpha value).
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1535 * SDL_SRCALPHA not set:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1536 * copy RGB.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1537 * both:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1538 * if SDL_SRCCOLORKEY set, only copy the pixels matching the
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1539 * source colour key.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1540 *
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1541 * If either of the surfaces were in video memory, and the blit returns -2,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1542 * the video memory was lost, so it should be reloaded with artwork and
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1543 * re-blitted:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1544 while ( SDL_BlitSurface(image, imgrect, screen, dstrect) == -2 ) {
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1545 while ( SDL_LockSurface(image) < 0 )
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1546 Sleep(10);
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1547 -- Write image pixels to image->pixels --
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1548 SDL_UnlockSurface(image);
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1549 }
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1550 * This happens under DirectX 5.0 when the system switches away from your
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1551 * fullscreen application. The lock will also fail until you have access
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1552 * to the video memory again.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1553 */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1554 /* You should call SDL_BlitSurface() unless you know exactly how SDL
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1555 blitting works internally and how to use the other blit functions.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1556 */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1557 #define SDL_BlitSurface SDL_UpperBlit
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1558
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1559 /* This is the public blit function, SDL_BlitSurface(), and it performs
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1560 rectangle validation and clipping before passing it to SDL_LowerBlit()
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1561 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	1562 extern DECLSPEC int SDLCALL SDL_UpperBlit
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1563 (SDL_Surface * src, SDL_Rect * srcrect,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1564 SDL_Surface * dst, SDL_Rect * dstrect);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1565 /* This is a semi-private blit function and it performs low-level surface
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1566 blitting only.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1567 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	1568 extern DECLSPEC int SDLCALL SDL_LowerBlit
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1569 (SDL_Surface * src, SDL_Rect * srcrect,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1570 SDL_Surface * dst, SDL_Rect * dstrect);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1571
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1572 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1573 * \fn int SDL_SoftStretch(SDL_Surface * src, SDL_Rect * srcrect, SDL_Surface * dst, SDL_Rect * dstrect)
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1574 *
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1575 * \brief Perform a fast, low quality, stretch blit between two surfaces of the same pixel format.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1576 *
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1577 * \note This function uses a static buffer, and is not thread-safe.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1578 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1579 extern DECLSPEC int SDLCALL SDL_SoftStretch(SDL_Surface * src,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1580 SDL_Rect * srcrect,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1581 SDL_Surface * dst,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1582 SDL_Rect * dstrect);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1583
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1584 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1585 /* OpenGL support functions. */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1586 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1587
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1588 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1589 * \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	1590 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1591 * \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	1592 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1593 * \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	1594 *
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1595 * \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	1596 *
1936 83946ee0ff1f Implemented OpenGL support on Mac OS X Sam Lantinga <slouken@libsdl.org> parents: 1926 diff changeset	1597 * 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	1598 * 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	1599 * 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	1600 *
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1601 * \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	1602 * 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	1603 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1604 * \sa SDL_GL_GetProcAddress()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1605 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	1606 extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1607
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1608 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1609 * \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	1610 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1611 * \brief Get the address of an OpenGL function.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1612 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1613 extern DECLSPEC void SDLCALL SDL_GL_GetProcAddress(const char proc);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1614
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1615 /**
1926 307355678142 Added SDL_GL_ExtensionSupported() Sam Lantinga <slouken@libsdl.org> parents: 1920 diff changeset	1616 * \fn SDL_bool SDL_GL_ExtensionSupported(const char *extension)
307355678142 Added SDL_GL_ExtensionSupported() Sam Lantinga <slouken@libsdl.org> parents: 1920 diff changeset	1617 *
307355678142 Added SDL_GL_ExtensionSupported() Sam Lantinga <slouken@libsdl.org> parents: 1920 diff changeset	1618 * \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	1619 */
307355678142 Added SDL_GL_ExtensionSupported() Sam Lantinga <slouken@libsdl.org> parents: 1920 diff changeset	1620 extern DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported(const char
307355678142 Added SDL_GL_ExtensionSupported() Sam Lantinga <slouken@libsdl.org> parents: 1920 diff changeset	1621 *extension);
307355678142 Added SDL_GL_ExtensionSupported() Sam Lantinga <slouken@libsdl.org> parents: 1920 diff changeset	1622
307355678142 Added SDL_GL_ExtensionSupported() Sam Lantinga <slouken@libsdl.org> parents: 1920 diff changeset	1623 /**
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1624 * \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	1625 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1626 * \brief Set an OpenGL window attribute before window creation.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1627 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	1628 extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1629
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1630 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1631 * \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	1632 *
1936 83946ee0ff1f Implemented OpenGL support on Mac OS X Sam Lantinga <slouken@libsdl.org> parents: 1926 diff changeset	1633 * \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	1634 */
1936 83946ee0ff1f Implemented OpenGL support on Mac OS X Sam Lantinga <slouken@libsdl.org> parents: 1926 diff changeset	1635 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	1636
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1637 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1638 * \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	1639 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1640 * \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	1641 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1642 * \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	1643 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1644 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	1645 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	1646
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1647 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1648 * \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	1649 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1650 * \brief Set up an OpenGL context for rendering into an OpenGL window.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1651 *
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1652 * \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	1653 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1654 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	1655 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	1656
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1657 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1658 * \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	1659 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1660 * \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	1661 *
1912 8d384b647307 Setting up the OpenGL support Sam Lantinga <slouken@libsdl.org> parents: 1907 diff changeset	1662 * \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	1663 *
8d384b647307 Setting up the OpenGL support Sam Lantinga <slouken@libsdl.org> parents: 1907 diff changeset	1664 * \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	1665 *
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1666 * \sa SDL_GL_GetSwapInterval()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1667 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1668 extern DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1669
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1670 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1671 * \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	1672 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1673 * \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	1674 *
1912 8d384b647307 Setting up the OpenGL support Sam Lantinga <slouken@libsdl.org> parents: 1907 diff changeset	1675 * \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	1676 *
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1677 * \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	1678 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1679 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	1680
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1681 /**
1912 8d384b647307 Setting up the OpenGL support Sam Lantinga <slouken@libsdl.org> parents: 1907 diff changeset	1682 * \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	1683 *
1912 8d384b647307 Setting up the OpenGL support Sam Lantinga <slouken@libsdl.org> parents: 1907 diff changeset	1684 * \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	1685 */
1912 8d384b647307 Setting up the OpenGL support Sam Lantinga <slouken@libsdl.org> parents: 1907 diff changeset	1686 extern DECLSPEC void SDLCALL SDL_GL_SwapWindow(SDL_WindowID windowID);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1687
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1688 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1689 * \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	1690 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1691 * \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	1692 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1693 * \sa SDL_GL_CreateContext()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1694 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1695 extern DECLSPEC void SDLCALL SDL_GL_DeleteContext(SDL_GLContext context);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1696
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1697 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1698 * \def SDL_RectEmpty()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1699 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1700 * \brief Returns true if the rectangle has no area.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1701 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1702 #define SDL_RectEmpty(X) (((X)->w <= 0) \|\| ((X)->h <= 0))
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1703
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1704 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1705 * \def SDL_RectEquals()
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1706 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1707 * \brief Returns true if the two rectangles are equal.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1708 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1709 #define SDL_RectEquals(A, B) (((A)->x == (B)->x) && ((A)->y == (B)->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	1710 ((A)->w == (B)->w) && ((A)->h == (B)->h))
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1711
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1712 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1713 * \fn SDL_bool SDL_HasIntersection(const SDL_Rect * A, const SDL_Rect * B);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1714 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1715 * \brief Determine whether two rectangles intersect.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1716 *
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1717 * \return SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1718 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1719 extern DECLSPEC SDL_bool SDLCALL SDL_HasIntersection(const SDL_Rect * 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	1720 const SDL_Rect * B);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1721
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1722 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1723 * \fn SDL_bool SDL_IntersectRect(const SDL_Rect * A, const SDL_Rect * B, SDL_Rect * result)
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1724 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1725 * \brief Calculate the intersection of two rectangles.
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1726 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1727 * \return SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1728 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1729 extern DECLSPEC SDL_bool SDLCALL SDL_IntersectRect(const SDL_Rect * 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	1730 const SDL_Rect * B,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1731 SDL_Rect * result);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1732
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1733 /**
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1734 * \fn void SDL_UnionRect(const SDL_Rect * A, const SDL_Rect * B, SDL_Rect * result)
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1735 *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1736 * \brief Calculate the union of two rectangles
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1737 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1738 extern DECLSPEC void SDLCALL SDL_UnionRect(const SDL_Rect * 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	1739 const SDL_Rect * B,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1740 SDL_Rect * result);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1741
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1742 /* Ends C function definitions when using C++ */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1743 #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	1744 /* INDENT-OFF */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1745 }
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1746 /* INDENT-ON */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1747 #endif
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1748 #include "close_code.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1749
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1750 #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	1751
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1737 diff changeset	1752 /* vi: set ts=4 sw=4 expandtab: */

Mercurial > sdl-ios-xcode

annotate include/SDL_video.h @ 1985:8055185ae4ed