sdl-ios-xcode: include/SDL

annotate include/SDL_video.h @ 1675:d33dcfc3fde7 SDL-1.3

Overlay functions are being replaced by YUV textures. If the driver doesn't support YUV textures, they can be emulated by backing the texture with an RGB texture and using the software conversion routines. Note that it doesn't make sense to lock a portion of a YV12 texture, since you'd need to return three pixel pointers and pitch values instead of the one that's available through the API. I'm guessing that's one of the reasons DirectX 9 doesn't support this format at all.

author	Sam Lantinga <slouken@libsdl.org>
date	Sun, 11 Jun 2006 07:30:16 +0000
parents	eef792d31de8
children	e136f3ffdc1b

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

Mercurial > sdl-ios-xcode

annotate include/SDL_video.h @ 1675:d33dcfc3fde7 SDL-1.3