Skip to content
This repository has been archived by the owner on Feb 11, 2021. It is now read-only.

Latest commit

 

History

History
1393 lines (1252 loc) · 47.8 KB

SDL_video.h

File metadata and controls

1393 lines (1252 loc) · 47.8 KB
 
Apr 26, 2001
Apr 26, 2001
1
2
/*
SDL - Simple DirectMedia Layer
Jan 24, 2010
Jan 24, 2010
3
Copyright (C) 1997-2010 Sam Lantinga
Apr 26, 2001
Apr 26, 2001
4
5
This library is free software; you can redistribute it and/or
Feb 1, 2006
Feb 1, 2006
6
modify it under the terms of the GNU Lesser General Public
Apr 26, 2001
Apr 26, 2001
7
License as published by the Free Software Foundation; either
Feb 1, 2006
Feb 1, 2006
8
version 2.1 of the License, or (at your option) any later version.
Apr 26, 2001
Apr 26, 2001
9
10
11
12
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Feb 1, 2006
Feb 1, 2006
13
Lesser General Public License for more details.
Apr 26, 2001
Apr 26, 2001
14
Feb 1, 2006
Feb 1, 2006
15
16
17
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Apr 26, 2001
Apr 26, 2001
18
19
Sam Lantinga
Dec 14, 2001
Dec 14, 2001
20
slouken@libsdl.org
Apr 26, 2001
Apr 26, 2001
21
22
*/
Jul 10, 2006
Jul 10, 2006
23
/**
Oct 19, 2009
Oct 19, 2009
24
25
26
* \file SDL_video.h
*
* Header file for SDL video functions.
Jul 10, 2006
Jul 10, 2006
27
*/
Apr 26, 2001
Apr 26, 2001
28
29
30
31
#ifndef _SDL_video_h
#define _SDL_video_h
Feb 10, 2006
Feb 10, 2006
32
#include "SDL_stdinc.h"
Jul 10, 2006
Jul 10, 2006
33
#include "SDL_pixels.h"
Sep 10, 2007
Sep 10, 2007
34
#include "SDL_rect.h"
Dec 12, 2010
Dec 12, 2010
35
#include "SDL_blendmode.h"
Sep 10, 2007
Sep 10, 2007
36
#include "SDL_surface.h"
Apr 26, 2001
Apr 26, 2001
37
38
39
40
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
Jul 10, 2006
Jul 10, 2006
41
/* *INDENT-OFF* */
Apr 26, 2001
Apr 26, 2001
42
extern "C" {
Jul 10, 2006
Jul 10, 2006
43
/* *INDENT-ON* */
Apr 26, 2001
Apr 26, 2001
44
45
#endif
Jul 10, 2006
Jul 10, 2006
46
/**
Oct 19, 2009
Oct 19, 2009
47
48
49
50
51
52
53
* \brief The structure that defines a display mode
*
* \sa SDL_GetNumDisplayModes()
* \sa SDL_GetDisplayMode()
* \sa SDL_GetDesktopDisplayMode()
* \sa SDL_GetCurrentDisplayMode()
* \sa SDL_GetClosestDisplayMode()
Dec 1, 2009
Dec 1, 2009
54
55
* \sa SDL_SetWindowDisplayMode()
* \sa SDL_GetWindowDisplayMode()
Jul 10, 2006
Jul 10, 2006
56
57
58
59
60
61
62
63
64
65
66
*/
typedef struct
{
Uint32 format; /**< pixel format */
int w; /**< width */
int h; /**< height */
int refresh_rate; /**< refresh rate (or zero for unspecified) */
void *driverdata; /**< driver-specific data, initialize to 0 */
} SDL_DisplayMode;
/**
Oct 19, 2009
Oct 19, 2009
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
* \brief The type used to identify a window
*
* \sa SDL_CreateWindow()
* \sa SDL_CreateWindowFrom()
* \sa SDL_DestroyWindow()
* \sa SDL_GetWindowData()
* \sa SDL_GetWindowFlags()
* \sa SDL_GetWindowGrab()
* \sa SDL_GetWindowPosition()
* \sa SDL_GetWindowSize()
* \sa SDL_GetWindowTitle()
* \sa SDL_HideWindow()
* \sa SDL_MaximizeWindow()
* \sa SDL_MinimizeWindow()
* \sa SDL_RaiseWindow()
* \sa SDL_RestoreWindow()
* \sa SDL_SetWindowData()
* \sa SDL_SetWindowFullscreen()
* \sa SDL_SetWindowGrab()
* \sa SDL_SetWindowIcon()
* \sa SDL_SetWindowPosition()
* \sa SDL_SetWindowSize()
* \sa SDL_SetWindowTitle()
* \sa SDL_ShowWindow()
Jul 10, 2006
Jul 10, 2006
91
*/
Jan 21, 2010
Jan 21, 2010
92
typedef struct SDL_Window SDL_Window;
Jul 10, 2006
Jul 10, 2006
93
94
/**
Oct 19, 2009
Oct 19, 2009
95
96
97
* \brief The flags on a window
*
* \sa SDL_GetWindowFlags()
Jul 10, 2006
Jul 10, 2006
98
99
100
101
102
103
104
105
*/
typedef enum
{
SDL_WINDOW_FULLSCREEN = 0x00000001, /**< fullscreen window, implies borderless */
SDL_WINDOW_OPENGL = 0x00000002, /**< window usable with OpenGL context */
SDL_WINDOW_SHOWN = 0x00000004, /**< window is visible */
SDL_WINDOW_BORDERLESS = 0x00000008, /**< no window decoration */
SDL_WINDOW_RESIZABLE = 0x00000010, /**< window can be resized */
Dec 5, 2009
Dec 5, 2009
106
107
SDL_WINDOW_MINIMIZED = 0x00000020, /**< window is minimized */
SDL_WINDOW_MAXIMIZED = 0x00000040, /**< window is maximized */
Jul 10, 2006
Jul 10, 2006
108
109
SDL_WINDOW_INPUT_GRABBED = 0x00000100, /**< window has grabbed input focus */
SDL_WINDOW_INPUT_FOCUS = 0x00000200, /**< window has input focus */
Feb 9, 2009
Feb 9, 2009
110
111
SDL_WINDOW_MOUSE_FOCUS = 0x00000400, /**< window has mouse focus */
SDL_WINDOW_FOREIGN = 0x00000800 /**< window not created by SDL */
Jul 10, 2006
Jul 10, 2006
112
113
114
} SDL_WindowFlags;
/**
Oct 19, 2009
Oct 19, 2009
115
* \brief Used to indicate that you don't care what the window position is.
Jul 10, 2006
Jul 10, 2006
116
117
*/
#define SDL_WINDOWPOS_UNDEFINED 0x7FFFFFF
Oct 19, 2009
Oct 19, 2009
118
Jul 10, 2006
Jul 10, 2006
119
/**
Oct 19, 2009
Oct 19, 2009
120
* \brief Used to indicate that the window position should be centered.
Jul 10, 2006
Jul 10, 2006
121
122
123
124
*/
#define SDL_WINDOWPOS_CENTERED 0x7FFFFFE
/**
Oct 19, 2009
Oct 19, 2009
125
* \brief Event subtype for window events
Jul 10, 2006
Jul 10, 2006
126
127
128
*/
typedef enum
{
Oct 19, 2009
Oct 19, 2009
129
130
131
132
133
134
135
136
137
138
139
140
SDL_WINDOWEVENT_NONE, /**< Never used */
SDL_WINDOWEVENT_SHOWN, /**< Window has been shown */
SDL_WINDOWEVENT_HIDDEN, /**< Window has been hidden */
SDL_WINDOWEVENT_EXPOSED, /**< Window has been exposed and should be
redrawn */
SDL_WINDOWEVENT_MOVED, /**< Window has been moved to data1, data2
*/
SDL_WINDOWEVENT_RESIZED, /**< Window size changed to data1xdata2 */
SDL_WINDOWEVENT_MINIMIZED, /**< Window has been minimized */
SDL_WINDOWEVENT_MAXIMIZED, /**< Window has been maximized */
SDL_WINDOWEVENT_RESTORED, /**< Window has been restored to normal size
and position */
Jan 22, 2010
Jan 22, 2010
141
142
143
144
SDL_WINDOWEVENT_ENTER, /**< Window has gained mouse focus */
SDL_WINDOWEVENT_LEAVE, /**< Window has lost mouse focus */
SDL_WINDOWEVENT_FOCUS_GAINED, /**< Window has gained keyboard focus */
SDL_WINDOWEVENT_FOCUS_LOST, /**< Window has lost keyboard focus */
Oct 19, 2009
Oct 19, 2009
145
146
SDL_WINDOWEVENT_CLOSE /**< The window manager requests that the
window be closed */
Jul 10, 2006
Jul 10, 2006
147
148
149
} SDL_WindowEventID;
/**
Oct 19, 2009
Oct 19, 2009
150
* \brief Flags used when creating a rendering context
Jul 10, 2006
Jul 10, 2006
151
152
153
*/
typedef enum
{
Oct 19, 2009
Oct 19, 2009
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
SDL_RENDERER_SINGLEBUFFER = 0x00000001, /**< Render directly to the
window, if possible */
SDL_RENDERER_PRESENTCOPY = 0x00000002, /**< Present uses a copy from
back buffer to the front
buffer */
SDL_RENDERER_PRESENTFLIP2 = 0x00000004, /**< Present uses a flip,
swapping back buffer and
front buffer */
SDL_RENDERER_PRESENTFLIP3 = 0x00000008, /**< Present uses a flip,
rotating between two back
buffers and a front buffer
*/
SDL_RENDERER_PRESENTDISCARD = 0x00000010, /**< Present leaves the contents
of the backbuffer undefined
*/
SDL_RENDERER_PRESENTVSYNC = 0x00000020, /**< Present is synchronized
with the refresh rate */
SDL_RENDERER_ACCELERATED = 0x00000040 /**< The renderer uses hardware
acceleration */
} SDL_RendererFlags;
/**
* \brief Information on the capabilities of a render driver or context.
Jul 10, 2006
Jul 10, 2006
184
185
186
187
*/
typedef struct SDL_RendererInfo
{
const char *name; /**< The name of the renderer */
Oct 19, 2009
Oct 19, 2009
188
Uint32 flags; /**< Supported ::SDL_RendererFlags */
Aug 28, 2006
Aug 28, 2006
189
Uint32 mod_modes; /**< A mask of supported channel modulation */
Jul 10, 2006
Jul 10, 2006
190
191
Uint32 blend_modes; /**< A mask of supported blend modes */
Uint32 num_texture_formats; /**< The number of available texture formats */
Jul 22, 2010
Jul 22, 2010
192
Uint32 texture_formats[50]; /**< The available texture formats */
Jul 10, 2006
Jul 10, 2006
193
194
195
196
197
int max_texture_width; /**< The maximimum texture width */
int max_texture_height; /**< The maximimum texture height */
} SDL_RendererInfo;
/**
Oct 19, 2009
Oct 19, 2009
198
* \brief The access pattern allowed for a texture.
Jul 10, 2006
Jul 10, 2006
199
200
201
*/
typedef enum
{
Aug 11, 2007
Aug 11, 2007
202
203
SDL_TEXTUREACCESS_STATIC, /**< Changes rarely, not lockable */
SDL_TEXTUREACCESS_STREAMING /**< Changes frequently, lockable */
Jul 10, 2006
Jul 10, 2006
204
205
} SDL_TextureAccess;
Aug 28, 2006
Aug 28, 2006
206
/**
Oct 19, 2009
Oct 19, 2009
207
* \brief The texture channel modulation used in SDL_RenderCopy().
Aug 28, 2006
Aug 28, 2006
208
209
210
211
212
*/
typedef enum
{
SDL_TEXTUREMODULATE_NONE = 0x00000000, /**< No modulation */
SDL_TEXTUREMODULATE_COLOR = 0x00000001, /**< srcC = srcC * color */
Jul 22, 2007
Jul 22, 2007
213
SDL_TEXTUREMODULATE_ALPHA = 0x00000002 /**< srcA = srcA * alpha */
Aug 28, 2006
Aug 28, 2006
214
215
} SDL_TextureModulate;
Jul 10, 2006
Jul 10, 2006
216
/**
Oct 19, 2009
Oct 19, 2009
217
* \brief An efficient driver-specific representation of pixel data
Jul 10, 2006
Jul 10, 2006
218
*/
Jan 21, 2010
Jan 21, 2010
219
220
struct SDL_Texture;
typedef struct SDL_Texture SDL_Texture;
Jul 10, 2006
Jul 10, 2006
221
222
/**
Oct 19, 2009
Oct 19, 2009
223
* \brief An opaque handle to an OpenGL context.
Jul 10, 2006
Jul 10, 2006
224
225
226
227
*/
typedef void *SDL_GLContext;
/**
Oct 19, 2009
Oct 19, 2009
228
* \brief OpenGL configuration attributes
Jul 10, 2006
Jul 10, 2006
229
230
231
*/
typedef enum
{
Apr 26, 2001
Apr 26, 2001
232
233
234
235
236
237
238
239
240
241
242
SDL_GL_RED_SIZE,
SDL_GL_GREEN_SIZE,
SDL_GL_BLUE_SIZE,
SDL_GL_ALPHA_SIZE,
SDL_GL_BUFFER_SIZE,
SDL_GL_DOUBLEBUFFER,
SDL_GL_DEPTH_SIZE,
SDL_GL_STENCIL_SIZE,
SDL_GL_ACCUM_RED_SIZE,
SDL_GL_ACCUM_GREEN_SIZE,
SDL_GL_ACCUM_BLUE_SIZE,
Aug 19, 2002
Aug 19, 2002
243
SDL_GL_ACCUM_ALPHA_SIZE,
Jul 22, 2003
Jul 22, 2003
244
SDL_GL_STEREO,
Jul 22, 2003
Jul 22, 2003
245
SDL_GL_MULTISAMPLEBUFFERS,
Apr 27, 2006
Apr 27, 2006
246
SDL_GL_MULTISAMPLESAMPLES,
Sep 2, 2008
Sep 2, 2008
247
SDL_GL_ACCELERATED_VISUAL,
Mar 24, 2009
Mar 24, 2009
248
SDL_GL_RETAINED_BACKING,
May 23, 2009
May 23, 2009
249
250
SDL_GL_CONTEXT_MAJOR_VERSION,
SDL_GL_CONTEXT_MINOR_VERSION
Apr 26, 2001
Apr 26, 2001
251
252
253
254
255
} SDL_GLattr;
/* Function prototypes */
Jul 10, 2006
Jul 10, 2006
256
/**
Oct 19, 2009
Oct 19, 2009
257
258
259
* \brief Get the number of video drivers compiled into SDL
*
* \sa SDL_GetVideoDriver()
Jul 10, 2006
Jul 10, 2006
260
261
262
263
*/
extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
/**
Oct 19, 2009
Oct 19, 2009
264
265
266
267
268
269
* \brief Get the name of a built in video driver.
*
* \note The video drivers are presented in the order in which they are
* normally checked during initialization.
*
* \sa SDL_GetNumVideoDrivers()
Jul 10, 2006
Jul 10, 2006
270
271
272
273
*/
extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index);
/**
Oct 19, 2009
Oct 19, 2009
274
275
276
277
278
279
280
281
282
283
284
285
* \brief Initialize the video subsystem, optionally specifying a video driver.
*
* \param driver_name Initialize a specific driver by name, or NULL for the
* default video driver.
*
* \return 0 on success, -1 on error
*
* This function initializes the video subsystem; setting up a connection
* to the window manager, etc, and determines the available display modes
* and pixel formats, but does not initialize a window or graphics mode.
*
* \sa SDL_VideoQuit()
Jul 10, 2006
Jul 10, 2006
286
*/
Jan 28, 2011
Jan 28, 2011
287
extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name);
Jul 10, 2006
Jul 10, 2006
288
289
/**
Oct 19, 2009
Oct 19, 2009
290
291
292
293
294
* \brief Shuts down the video subsystem.
*
* This function closes all windows, and restores the original video mode.
*
* \sa SDL_VideoInit()
Apr 26, 2001
Apr 26, 2001
295
*/
Apr 11, 2002
Apr 11, 2002
296
extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
Apr 26, 2001
Apr 26, 2001
297
Jul 10, 2006
Jul 10, 2006
298
/**
Oct 19, 2009
Oct 19, 2009
299
300
301
302
303
304
305
* \brief Returns the name of the currently initialized video driver.
*
* \return The name of the current video driver or NULL if no driver
* has been initialized
*
* \sa SDL_GetNumVideoDrivers()
* \sa SDL_GetVideoDriver()
Apr 26, 2001
Apr 26, 2001
306
*/
Jul 10, 2006
Jul 10, 2006
307
extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
Apr 26, 2001
Apr 26, 2001
308
Jul 10, 2006
Jul 10, 2006
309
/**
Oct 19, 2009
Oct 19, 2009
310
311
* \brief Returns the number of available video displays.
*
Dec 6, 2009
Dec 6, 2009
312
* \sa SDL_GetDisplayBounds()
Oct 19, 2009
Oct 19, 2009
313
* \sa SDL_SelectVideoDisplay()
Apr 26, 2001
Apr 26, 2001
314
*/
Jul 10, 2006
Jul 10, 2006
315
extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
Apr 26, 2001
Apr 26, 2001
316
Dec 6, 2009
Dec 6, 2009
317
318
319
320
321
322
323
324
325
326
/**
* \brief Get the desktop area represented by a display, with the primary
* display located at 0,0
*
* \return 0 on success, or -1 if the index is out of range.
*
* \sa SDL_GetNumVideoDisplays()
*/
extern DECLSPEC int SDLCALL SDL_GetDisplayBounds(int index, SDL_Rect * rect);
Jul 10, 2006
Jul 10, 2006
327
/**
Oct 19, 2009
Oct 19, 2009
328
329
330
331
332
333
* \brief Set the index of the currently selected display.
*
* \return 0 on success, or -1 if the index is out of range.
*
* \sa SDL_GetNumVideoDisplays()
* \sa SDL_GetCurrentVideoDisplay()
Apr 26, 2001
Apr 26, 2001
334
*/
Jul 10, 2006
Jul 10, 2006
335
extern DECLSPEC int SDLCALL SDL_SelectVideoDisplay(int index);
Apr 26, 2001
Apr 26, 2001
336
Aug 2, 2006
Aug 2, 2006
337
/**
Oct 19, 2009
Oct 19, 2009
338
339
340
341
342
343
* \brief Get the index of the currently selected display.
*
* \return The index of the currently selected display.
*
* \sa SDL_GetNumVideoDisplays()
* \sa SDL_SelectVideoDisplay()
Aug 2, 2006
Aug 2, 2006
344
345
346
*/
extern DECLSPEC int SDLCALL SDL_GetCurrentVideoDisplay(void);
Jul 10, 2006
Jul 10, 2006
347
/**
Oct 19, 2009
Oct 19, 2009
348
349
350
* \brief Returns the number of available display modes for the current display.
*
* \sa SDL_GetDisplayMode()
Apr 26, 2001
Apr 26, 2001
351
*/
Jul 10, 2006
Jul 10, 2006
352
extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(void);
Apr 26, 2001
Apr 26, 2001
353
Jul 10, 2006
Jul 10, 2006
354
/**
Oct 19, 2009
Oct 19, 2009
355
356
357
358
359
360
361
362
363
* \brief Fill in information about a specific display mode.
*
* \note The display modes are sorted in this priority:
* \li bits per pixel -> more colors to fewer colors
* \li width -> largest to smallest
* \li height -> largest to smallest
* \li refresh rate -> highest to lowest
*
* \sa SDL_GetNumDisplayModes()
Apr 26, 2001
Apr 26, 2001
364
*/
Aug 5, 2006
Aug 5, 2006
365
366
extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int index,
SDL_DisplayMode * mode);
Apr 26, 2001
Apr 26, 2001
367
Jul 10, 2006
Jul 10, 2006
368
/**
Oct 19, 2009
Oct 19, 2009
369
370
* \brief Fill in information about the desktop display mode for the current
* display.
Jul 10, 2006
Jul 10, 2006
371
*/
Aug 5, 2006
Aug 5, 2006
372
extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(SDL_DisplayMode * mode);
Apr 26, 2001
Apr 26, 2001
373
Jul 10, 2006
Jul 10, 2006
374
/**
Oct 19, 2009
Oct 19, 2009
375
* \brief Fill in information about the current display mode.
Apr 26, 2001
Apr 26, 2001
376
*/
Aug 5, 2006
Aug 5, 2006
377
extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(SDL_DisplayMode * mode);
Apr 26, 2001
Apr 26, 2001
378
Oct 17, 2009
Oct 17, 2009
379
Jul 10, 2006
Jul 10, 2006
380
/**
Oct 19, 2009
Oct 19, 2009
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
* \brief Get the closest match to the requested display mode.
*
* \param mode The desired display mode
* \param closest A pointer to a display mode to be filled in with the closest
* match of the available display modes.
*
* \return The passed in value \c closest, or NULL if no matching video mode
* was available.
*
* The available display modes are scanned, and \c 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.
*
* \sa SDL_GetNumDisplayModes()
* \sa SDL_GetDisplayMode()
Apr 26, 2001
Apr 26, 2001
399
*/
Jul 10, 2006
Jul 10, 2006
400
401
402
403
404
405
406
extern DECLSPEC SDL_DisplayMode *SDLCALL SDL_GetClosestDisplayMode(const
SDL_DisplayMode
* mode,
SDL_DisplayMode
* closest);
/**
Oct 19, 2009
Oct 19, 2009
407
* \brief Set the display mode used when a fullscreen window is visible
Dec 1, 2009
Dec 1, 2009
408
409
* on the currently selected display. By default the window's
* dimensions and the desktop format and refresh rate are used.
Oct 19, 2009
Oct 19, 2009
410
*
Dec 1, 2009
Dec 1, 2009
411
* \param mode The mode to use, or NULL for the default mode.
Oct 19, 2009
Oct 19, 2009
412
413
414
*
* \return 0 on success, or -1 if setting the display mode failed.
*
Dec 5, 2009
Dec 5, 2009
415
* \sa SDL_GetWindowDisplayMode()
Oct 19, 2009
Oct 19, 2009
416
* \sa SDL_SetWindowFullscreen()
Jul 10, 2006
Jul 10, 2006
417
*/
Jan 21, 2010
Jan 21, 2010
418
extern DECLSPEC int SDLCALL SDL_SetWindowDisplayMode(SDL_Window * window,
Dec 1, 2009
Dec 1, 2009
419
const SDL_DisplayMode
Jul 10, 2006
Jul 10, 2006
420
* mode);
Apr 26, 2001
Apr 26, 2001
421
Jul 10, 2006
Jul 10, 2006
422
/**
Oct 19, 2009
Oct 19, 2009
423
424
* \brief Fill in information about the display mode used when a fullscreen
* window is visible on the currently selected display.
Dec 5, 2009
Dec 5, 2009
425
426
427
*
* \sa SDL_SetWindowDisplayMode()
* \sa SDL_SetWindowFullscreen()
Jul 10, 2006
Jul 10, 2006
428
*/
Jan 21, 2010
Jan 21, 2010
429
extern DECLSPEC int SDLCALL SDL_GetWindowDisplayMode(SDL_Window * window,
Dec 1, 2009
Dec 1, 2009
430
SDL_DisplayMode * mode);
Jul 10, 2006
Jul 10, 2006
431
432
/**
Oct 19, 2009
Oct 19, 2009
433
434
435
436
* \brief Set the palette entries for indexed display modes.
*
* \return 0 on success, or -1 if the display mode isn't palettized or the
* colors couldn't be set.
Jul 10, 2006
Jul 10, 2006
437
438
439
440
441
442
*/
extern DECLSPEC int SDLCALL SDL_SetDisplayPalette(const SDL_Color * colors,
int firstcolor,
int ncolors);
/**
Oct 19, 2009
Oct 19, 2009
443
444
445
* \brief Gets the palette entries for indexed display modes.
*
* \return 0 on success, or -1 if the display mode isn't palettized
Jul 10, 2006
Jul 10, 2006
446
447
448
449
450
451
*/
extern DECLSPEC int SDLCALL SDL_GetDisplayPalette(SDL_Color * colors,
int firstcolor,
int ncolors);
/**
Oct 19, 2009
Oct 19, 2009
452
453
454
455
456
457
* \brief Set the gamma correction for each of the color channels on the
* currently selected display.
*
* \return 0 on success, or -1 if setting the gamma isn't supported.
*
* \sa SDL_SetGammaRamp()
Apr 26, 2001
Apr 26, 2001
458
*/
Apr 11, 2002
Apr 11, 2002
459
extern DECLSPEC int SDLCALL SDL_SetGamma(float red, float green, float blue);
Apr 26, 2001
Apr 26, 2001
460
Jul 10, 2006
Jul 10, 2006
461
/**
Oct 19, 2009
Oct 19, 2009
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
* \brief Set the gamma ramp for the currently selected display.
*
* \param red The translation table for the red channel, or NULL.
* \param green The translation table for the green channel, or NULL.
* \param blue The translation table for the blue channel, or NULL.
*
* \return 0 on success, or -1 if gamma ramps are unsupported.
*
* Set the gamma translation table for the red, green, and blue channels
* of the video hardware. Each table is an array of 256 16-bit quantities,
* representing a mapping between the input and output for that channel.
* The input is the index into the array, and the output is the 16-bit
* gamma value at that index, scaled to the output color precision.
*
* \sa SDL_GetGammaRamp()
Apr 26, 2001
Apr 26, 2001
477
*/
Jul 10, 2006
Jul 10, 2006
478
479
480
extern DECLSPEC int SDLCALL SDL_SetGammaRamp(const Uint16 * red,
const Uint16 * green,
const Uint16 * blue);
Apr 26, 2001
Apr 26, 2001
481
Jul 10, 2006
Jul 10, 2006
482
/**
Oct 19, 2009
Oct 19, 2009
483
484
485
486
487
488
489
490
491
492
493
494
* \brief Get the gamma ramp for the currently selected display.
*
* \param red A pointer to a 256 element array of 16-bit quantities to hold
* the translation table for the red channel, or NULL.
* \param green A pointer to a 256 element array of 16-bit quantities to hold
* the translation table for the green channel, or NULL.
* \param blue A pointer to a 256 element array of 16-bit quantities to hold
* the translation table for the blue channel, or NULL.
*
* \return 0 on success, or -1 if gamma ramps are unsupported.
*
* \sa SDL_SetGammaRamp()
Apr 26, 2001
Apr 26, 2001
495
*/
Jul 10, 2006
Jul 10, 2006
496
497
extern DECLSPEC int SDLCALL SDL_GetGammaRamp(Uint16 * red, Uint16 * green,
Uint16 * blue);
Apr 26, 2001
Apr 26, 2001
498
499
Jul 10, 2006
Jul 10, 2006
500
/**
Oct 19, 2009
Oct 19, 2009
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
* \brief Create a window with the specified position, dimensions, and flags.
*
* \param title The title of the window, in UTF-8 encoding.
* \param x The x position of the window, ::SDL_WINDOWPOS_CENTERED, or
* ::SDL_WINDOWPOS_UNDEFINED.
* \param y The y position of the window, ::SDL_WINDOWPOS_CENTERED, or
* ::SDL_WINDOWPOS_UNDEFINED.
* \param w The width of the window.
* \param h The height of the window.
* \param flags The flags for the window, a mask of any of the following:
* ::SDL_WINDOW_FULLSCREEN, ::SDL_WINDOW_OPENGL,
* ::SDL_WINDOW_SHOWN, ::SDL_WINDOW_BORDERLESS,
* ::SDL_WINDOW_RESIZABLE, ::SDL_WINDOW_MAXIMIZED,
* ::SDL_WINDOW_MINIMIZED, ::SDL_WINDOW_INPUT_GRABBED.
*
* \return The id of the window created, or zero if window creation failed.
*
* \sa SDL_DestroyWindow()
Jul 10, 2006
Jul 10, 2006
519
*/
Jan 21, 2010
Jan 21, 2010
520
extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title,
Jul 10, 2006
Jul 10, 2006
521
522
523
524
int x, int y, int w,
int h, Uint32 flags);
/**
Nov 25, 2009
Nov 25, 2009
525
* \brief Create an SDL window from an existing native window.
Oct 19, 2009
Oct 19, 2009
526
527
528
529
530
531
*
* \param data A pointer to driver-dependent window creation data
*
* \return The id of the window created, or zero if window creation failed.
*
* \sa SDL_DestroyWindow()
Jul 10, 2006
Jul 10, 2006
532
*/
Jan 21, 2010
Jan 21, 2010
533
534
535
extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowFrom(const void *data);
/**
Sep 15, 2010
Sep 15, 2010
536
* \brief Get the numeric ID of a window, for logging purposes.
Jan 21, 2010
Jan 21, 2010
537
538
539
540
541
542
543
*/
extern DECLSPEC Uint32 SDLCALL SDL_GetWindowID(SDL_Window * window);
/**
* \brief Get a window from a stored ID, or NULL if it doesn't exist.
*/
extern DECLSPEC SDL_Window * SDLCALL SDL_GetWindowFromID(Uint32 id);
Jul 10, 2006
Jul 10, 2006
544
545
/**
Oct 19, 2009
Oct 19, 2009
546
* \brief Get the window flags.
Jul 10, 2006
Jul 10, 2006
547
*/
Jan 21, 2010
Jan 21, 2010
548
extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_Window * window);
Jul 10, 2006
Jul 10, 2006
549
550
/**
Sep 15, 2010
Sep 15, 2010
551
* \brief Set the title of a window, in UTF-8 format.
Oct 19, 2009
Oct 19, 2009
552
553
*
* \sa SDL_GetWindowTitle()
Jul 10, 2006
Jul 10, 2006
554
*/
Jan 21, 2010
Jan 21, 2010
555
extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_Window * window,
Jul 10, 2006
Jul 10, 2006
556
557
558
const char *title);
/**
Sep 15, 2010
Sep 15, 2010
559
* \brief Get the title of a window, in UTF-8 format.
Oct 19, 2009
Oct 19, 2009
560
561
*
* \sa SDL_SetWindowTitle()
Jul 10, 2006
Jul 10, 2006
562
*/
Jan 21, 2010
Jan 21, 2010
563
extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_Window * window);
Jul 10, 2006
Jul 10, 2006
564
565
/**
Sep 19, 2010
Sep 19, 2010
566
* \brief Set the icon for a window.
Oct 19, 2009
Oct 19, 2009
567
*
Sep 19, 2010
Sep 19, 2010
568
* \param icon The icon for the window.
Jul 10, 2006
Jul 10, 2006
569
*/
Jan 21, 2010
Jan 21, 2010
570
extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Window * window,
Jan 4, 2009
Jan 4, 2009
571
SDL_Surface * icon);
Jul 10, 2006
Jul 10, 2006
572
573
/**
Aug 29, 2010
Aug 29, 2010
574
* \brief Associate an arbitrary pointer with a window.
Oct 19, 2009
Oct 19, 2009
575
576
*
* \sa SDL_GetWindowData()
Jul 10, 2006
Jul 10, 2006
577
*/
Jan 21, 2010
Jan 21, 2010
578
extern DECLSPEC void SDLCALL SDL_SetWindowData(SDL_Window * window,
Jul 10, 2006
Jul 10, 2006
579
580
581
void *userdata);
/**
Sep 15, 2010
Sep 15, 2010
582
* \brief Retrieve the data pointer associated with a window.
Oct 19, 2009
Oct 19, 2009
583
584
*
* \sa SDL_SetWindowData()
Jul 10, 2006
Jul 10, 2006
585
*/
Jan 21, 2010
Jan 21, 2010
586
extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_Window * window);
Jul 10, 2006
Jul 10, 2006
587
588
/**
Sep 15, 2010
Sep 15, 2010
589
* \brief Set the position of a window.
Oct 19, 2009
Oct 19, 2009
590
*
Jan 21, 2010
Jan 21, 2010
591
* \param window The window to reposition.
Oct 19, 2009
Oct 19, 2009
592
593
594
595
596
597
598
599
* \param x The x coordinate of the window, ::SDL_WINDOWPOS_CENTERED, or
::SDL_WINDOWPOS_UNDEFINED.
* \param y The y coordinate of the window, ::SDL_WINDOWPOS_CENTERED, or
::SDL_WINDOWPOS_UNDEFINED.
*
* \note The window coordinate origin is the upper left of the display.
*
* \sa SDL_GetWindowPosition()
Jul 10, 2006
Jul 10, 2006
600
*/
Jan 21, 2010
Jan 21, 2010
601
extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_Window * window,
Jul 10, 2006
Jul 10, 2006
602
603
604
int x, int y);
/**
Sep 15, 2010
Sep 15, 2010
605
* \brief Get the position of a window.
Oct 19, 2009
Oct 19, 2009
606
607
*
* \sa SDL_SetWindowPosition()
Jul 10, 2006
Jul 10, 2006
608
*/
Jan 21, 2010
Jan 21, 2010
609
extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_Window * window,
Jul 10, 2006
Jul 10, 2006
610
611
612
int *x, int *y);
/**
Sep 15, 2010
Sep 15, 2010
613
* \brief Set the size of a window's client area.
Oct 19, 2009
Oct 19, 2009
614
615
616
617
618
*
* \note You can't change the size of a fullscreen window, it automatically
* matches the size of the display mode.
*
* \sa SDL_GetWindowSize()
Jul 10, 2006
Jul 10, 2006
619
*/
Jan 21, 2010
Jan 21, 2010
620
extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_Window * window, int w,
Jul 10, 2006
Jul 10, 2006
621
622
623
int h);
/**
Sep 15, 2010
Sep 15, 2010
624
* \brief Get the size of a window's client area.
Oct 19, 2009
Oct 19, 2009
625
626
*
* \sa SDL_SetWindowSize()
Jul 10, 2006
Jul 10, 2006
627
*/
Jan 21, 2010
Jan 21, 2010
628
extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_Window * window, int *w,
Jul 10, 2006
Jul 10, 2006
629
630
631
int *h);
/**
Sep 15, 2010
Sep 15, 2010
632
* \brief Show a window.
Oct 19, 2009
Oct 19, 2009
633
634
*
* \sa SDL_HideWindow()
Jul 10, 2006
Jul 10, 2006
635
*/
Jan 21, 2010
Jan 21, 2010
636
extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_Window * window);
Jul 10, 2006
Jul 10, 2006
637
638
/**
Sep 15, 2010
Sep 15, 2010
639
* \brief Hide a window.
Oct 19, 2009
Oct 19, 2009
640
641
*
* \sa SDL_ShowWindow()
Jul 10, 2006
Jul 10, 2006
642
*/
Jan 21, 2010
Jan 21, 2010
643
extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_Window * window);
Jul 10, 2006
Jul 10, 2006
644
645
/**
Sep 15, 2010
Sep 15, 2010
646
* \brief Raise a window above other windows and set the input focus.
Jul 10, 2006
Jul 10, 2006
647
*/
Jan 21, 2010
Jan 21, 2010
648
extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_Window * window);
Jul 10, 2006
Jul 10, 2006
649
650
/**
Sep 15, 2010
Sep 15, 2010
651
* \brief Make a window as large as possible.
Oct 19, 2009
Oct 19, 2009
652
653
*
* \sa SDL_RestoreWindow()
Jul 10, 2006
Jul 10, 2006
654
*/
Jan 21, 2010
Jan 21, 2010
655
extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_Window * window);
Jul 10, 2006
Jul 10, 2006
656
657
/**
Sep 15, 2010
Sep 15, 2010
658
* \brief Minimize a window to an iconic representation.
Oct 19, 2009
Oct 19, 2009
659
660
*
* \sa SDL_RestoreWindow()
Jul 10, 2006
Jul 10, 2006
661
*/
Jan 21, 2010
Jan 21, 2010
662
extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_Window * window);
Jul 10, 2006
Jul 10, 2006
663
664
/**
Oct 19, 2009
Oct 19, 2009
665
666
667
668
* \brief Restore the size and position of a minimized or maximized window.
*
* \sa SDL_MaximizeWindow()
* \sa SDL_MinimizeWindow()
Jul 10, 2006
Jul 10, 2006
669
*/
Jan 21, 2010
Jan 21, 2010
670
extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_Window * window);
Jul 10, 2006
Jul 10, 2006
671
672
/**
Sep 15, 2010
Sep 15, 2010
673
* \brief Set a window's fullscreen state.
Oct 19, 2009
Oct 19, 2009
674
675
676
*
* \return 0 on success, or -1 if setting the display mode failed.
*
Dec 5, 2009
Dec 5, 2009
677
678
* \sa SDL_SetWindowDisplayMode()
* \sa SDL_GetWindowDisplayMode()
Jul 10, 2006
Jul 10, 2006
679
*/
Jan 21, 2010
Jan 21, 2010
680
extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_Window * window,
Jul 10, 2006
Jul 10, 2006
681
682
683
int fullscreen);
/**
Sep 15, 2010
Sep 15, 2010
684
* \brief Set a window's input grab mode.
Oct 19, 2009
Oct 19, 2009
685
686
687
688
*
* \param mode This is 1 to grab input, and 0 to release input.
*
* \sa SDL_GetWindowGrab()
Jul 10, 2006
Jul 10, 2006
689
*/
Jan 21, 2010
Jan 21, 2010
690
extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_Window * window,
Jul 10, 2006
Jul 10, 2006
691
692
693
int mode);
/**
Sep 15, 2010
Sep 15, 2010
694
* \brief Get a window's input grab mode.
Oct 19, 2009
Oct 19, 2009
695
696
697
698
*
* \return This returns 1 if input is grabbed, and 0 otherwise.
*
* \sa SDL_SetWindowGrab()
Jul 10, 2006
Jul 10, 2006
699
*/
Jan 21, 2010
Jan 21, 2010
700
extern DECLSPEC int SDLCALL SDL_GetWindowGrab(SDL_Window * window);
Jul 10, 2006
Jul 10, 2006
701
702
/**
Oct 19, 2009
Oct 19, 2009
703
704
705
* \brief Get driver specific information about a window.
*
* \note Include SDL_syswm.h for the declaration of SDL_SysWMinfo.
Jul 10, 2006
Jul 10, 2006
706
707
*/
struct SDL_SysWMinfo;
Jan 21, 2010
Jan 21, 2010
708
extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_Window * window,
Jul 10, 2006
Jul 10, 2006
709
710
711
712
struct SDL_SysWMinfo
*info);
/**
Oct 19, 2009
Oct 19, 2009
713
* \brief Destroy a window.
Jul 10, 2006
Jul 10, 2006
714
*/
Jan 21, 2010
Jan 21, 2010
715
extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_Window * window);
Jul 10, 2006
Jul 10, 2006
716
717
/**
Oct 19, 2009
Oct 19, 2009
718
719
720
721
722
723
724
725
726
* \brief Get the number of 2D rendering drivers available for the current
* display.
*
* A render driver is a set of code that handles rendering and texture
* management on a particular display. Normally there is only one, but
* some drivers may have several available with different capabilities.
*
* \sa SDL_GetRenderDriverInfo()
* \sa SDL_CreateRenderer()
Jul 10, 2006
Jul 10, 2006
727
*/
Aug 6, 2006
Aug 6, 2006
728
extern DECLSPEC int SDLCALL SDL_GetNumRenderDrivers(void);
Jul 10, 2006
Jul 10, 2006
729
730
/**
Oct 19, 2009
Oct 19, 2009
731
732
733
734
735
736
737
738
739
740
* \brief Get information about a specific 2D rendering driver for the current
* display.
*
* \param index The index of the driver to query information about.
* \param info A pointer to an SDL_RendererInfo struct to be filled with
* information on the rendering driver.
*
* \return 0 on success, -1 if the index was out of range.
*
* \sa SDL_CreateRenderer()
Jul 10, 2006
Jul 10, 2006
741
*/
Aug 6, 2006
Aug 6, 2006
742
743
extern DECLSPEC int SDLCALL SDL_GetRenderDriverInfo(int index,
SDL_RendererInfo * info);
Jul 10, 2006
Jul 10, 2006
744
745
/**
Oct 19, 2009
Oct 19, 2009
746
747
* \brief Create and make active a 2D rendering context for a window.
*
Jan 21, 2010
Jan 21, 2010
748
* \param window The window where rendering is displayed.
Oct 19, 2009
Oct 19, 2009
749
750
751
752
753
754
755
756
757
* \param index The index of the rendering driver to initialize, or -1 to
* initialize the first one supporting the requested flags.
* \param flags ::SDL_RendererFlags.
*
* \return 0 on success, -1 if there was an error creating the renderer.
*
* \sa SDL_SelectRenderer()
* \sa SDL_GetRendererInfo()
* \sa SDL_DestroyRenderer()
Jul 10, 2006
Jul 10, 2006
758
*/
Jan 21, 2010
Jan 21, 2010
759
extern DECLSPEC int SDLCALL SDL_CreateRenderer(SDL_Window * window,
Jul 10, 2006
Jul 10, 2006
760
761
762
int index, Uint32 flags);
/**
Oct 19, 2009
Oct 19, 2009
763
764
765
766
* \brief Select the rendering context for a particular window.
*
* \return 0 on success, -1 if the selected window doesn't have a
* rendering context.
Jul 10, 2006
Jul 10, 2006
767
*/
Jan 21, 2010
Jan 21, 2010
768
extern DECLSPEC int SDLCALL SDL_SelectRenderer(SDL_Window * window);
Jul 10, 2006
Jul 10, 2006
769
Aug 6, 2006
Aug 6, 2006
770
/**
Oct 19, 2009
Oct 19, 2009
771
* \brief Get information about the current rendering context.
Aug 6, 2006
Aug 6, 2006
772
773
774
*/
extern DECLSPEC int SDLCALL SDL_GetRendererInfo(SDL_RendererInfo * info);
Jul 10, 2006
Jul 10, 2006
775
/**
Oct 19, 2009
Oct 19, 2009
776
777
778
779
780
781
782
783
784
785
786
787
788
* \brief Create a texture for the current rendering context.
*
* \param format The format of the texture.
* \param access One of the enumerated values in ::SDL_TextureAccess.
* \param w The width of the texture in pixels.
* \param h The height of the texture in pixels.
*
* \return The created texture is returned, or 0 if no rendering context was
* active, the format was unsupported, or the width or height were out
* of range.
*
* \sa SDL_QueryTexture()
* \sa SDL_DestroyTexture()
Jul 10, 2006
Jul 10, 2006
789
*/
Jan 21, 2010
Jan 21, 2010
790
extern DECLSPEC SDL_Texture * SDLCALL SDL_CreateTexture(Uint32 format,
Jul 10, 2006
Jul 10, 2006
791
792
793
794
int access, int w,
int h);
/**
Oct 19, 2009
Oct 19, 2009
795
796
797
798
799
800
801
802
803
804
805
806
807
* \brief Create a texture from an existing surface.
*
* \param format The format of the texture, or 0 to pick an appropriate format.
* \param surface The surface containing pixel data used to fill the texture.
*
* \return The created texture is returned, or 0 if no rendering context was
* active, the format was unsupported, or the surface width or height
* were out of range.
*
* \note The surface is not modified or freed by this function.
*
* \sa SDL_QueryTexture()
* \sa SDL_DestroyTexture()
Jul 10, 2006
Jul 10, 2006
808
*/
Jan 21, 2010
Jan 21, 2010
809
extern DECLSPEC SDL_Texture * SDLCALL SDL_CreateTextureFromSurface(Uint32
Jul 10, 2006
Jul 10, 2006
810
811
812
813
814
format,
SDL_Surface
* surface);
/**
Oct 19, 2009
Oct 19, 2009
815
816
* \brief Query the attributes of a texture
*
Jan 21, 2010
Jan 21, 2010
817
* \param texture A texture to be queried.
Oct 19, 2009
Oct 19, 2009
818
819
820
821
822
823
824
825
* \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.
* \param access A pointer filled in with the actual access to the texture.
* \param w A pointer filled in with the width of the texture in pixels.
* \param h A pointer filled in with the height of the texture in pixels.
*
* \return 0 on success, or -1 if the texture is not valid.
Jul 10, 2006
Jul 10, 2006
826
*/
Jan 21, 2010
Jan 21, 2010
827
extern DECLSPEC int SDLCALL SDL_QueryTexture(SDL_Texture * texture,
Jul 10, 2006
Jul 10, 2006
828
829
830
831
Uint32 * format, int *access,
int *w, int *h);
/**
Oct 19, 2009
Oct 19, 2009
832
833
834
* \brief Query the pixels of a texture, if the texture does not need to be
* locked for pixel access.
*
Jan 21, 2010
Jan 21, 2010
835
* \param texture A texture to be queried, which was created with
Oct 19, 2009
Oct 19, 2009
836
837
838
839
840
841
842
* ::SDL_TEXTUREACCESS_STREAMING.
* \param pixels A pointer filled with a pointer to the pixels for the
* texture.
* \param pitch A pointer filled in with the pitch of the pixel data.
*
* \return 0 on success, or -1 if the texture is not valid, or must be locked
* for pixel access.
Jul 10, 2006
Jul 10, 2006
843
*/
Jan 21, 2010
Jan 21, 2010
844
extern DECLSPEC int SDLCALL SDL_QueryTexturePixels(SDL_Texture * texture,
Jul 10, 2006
Jul 10, 2006
845
846
847
void **pixels, int *pitch);
/**
Oct 19, 2009
Oct 19, 2009
848
849
* \brief Set the color palette of an indexed texture.
*
Jan 21, 2010
Jan 21, 2010
850
* \param texture The texture to update.
Oct 19, 2009
Oct 19, 2009
851
852
853
854
855
856
* \param colors The array of RGB color data.
* \param firstcolor The first index to update.
* \param ncolors The number of palette entries to fill with the color data.
*
* \return 0 on success, or -1 if the texture is not valid or not an indexed
* texture.
Jul 10, 2006
Jul 10, 2006
857
*/
Jan 21, 2010
Jan 21, 2010
858
extern DECLSPEC int SDLCALL SDL_SetTexturePalette(SDL_Texture * texture,
Jul 10, 2006
Jul 10, 2006
859
860
861
862
863
const SDL_Color * colors,
int firstcolor,
int ncolors);
/**
Oct 19, 2009
Oct 19, 2009
864
865
* \brief Get the color palette from an indexed texture if it has one.
*
Jan 21, 2010
Jan 21, 2010
866
* \param texture The texture to update.
Oct 19, 2009
Oct 19, 2009
867
868
869
870
871
872
* \param colors The array to fill with RGB color data.
* \param firstcolor The first index to retrieve.
* \param ncolors The number of palette entries to retrieve.
*
* \return 0 on success, or -1 if the texture is not valid or not an indexed
* texture.
Jul 10, 2006
Jul 10, 2006
873
*/
Jan 21, 2010
Jan 21, 2010
874
extern DECLSPEC int SDLCALL SDL_GetTexturePalette(SDL_Texture * texture,
Jul 10, 2006
Jul 10, 2006
875
876
877
878
SDL_Color * colors,
int firstcolor,
int ncolors);
Aug 28, 2006
Aug 28, 2006
879
/**
Oct 19, 2009
Oct 19, 2009
880
881
* \brief Set an additional color value used in render copy operations.
*
Jan 21, 2010
Jan 21, 2010
882
* \param texture The texture to update.
Jan 12, 2011
Jan 12, 2011
883
884
885
* \param r The red color value multiplied into copy operations.
* \param g The green color value multiplied into copy operations.
* \param b The blue color value multiplied into copy operations.
Oct 19, 2009
Oct 19, 2009
886
887
888
889
890
*
* \return 0 on success, or -1 if the texture is not valid or color modulation
* is not supported.
*
* \sa SDL_GetTextureColorMod()
Aug 28, 2006
Aug 28, 2006
891
*/
Jan 21, 2010
Jan 21, 2010
892
extern DECLSPEC int SDLCALL SDL_SetTextureColorMod(SDL_Texture * texture,
Aug 28, 2006
Aug 28, 2006
893
894
895
896
Uint8 r, Uint8 g, Uint8 b);
/**
Oct 19, 2009
Oct 19, 2009
897
898
* \brief Get the additional color value used in render copy operations.
*
Jan 21, 2010
Jan 21, 2010
899
* \param texture The texture to query.
Jan 12, 2011
Jan 12, 2011
900
901
902
* \param r A pointer filled in with the current red color value.
* \param g A pointer filled in with the current green color value.
* \param b A pointer filled in with the current blue color value.
Oct 19, 2009
Oct 19, 2009
903
904
905
906
*
* \return 0 on success, or -1 if the texture is not valid.
*
* \sa SDL_SetTextureColorMod()
Aug 28, 2006
Aug 28, 2006
907
*/
Jan 21, 2010
Jan 21, 2010
908
extern DECLSPEC int SDLCALL SDL_GetTextureColorMod(SDL_Texture * texture,
Aug 28, 2006
Aug 28, 2006
909
910
911
912
Uint8 * r, Uint8 * g,
Uint8 * b);
/**
Oct 19, 2009
Oct 19, 2009
913
914
* \brief Set an additional alpha value used in render copy operations.
*
Jan 21, 2010
Jan 21, 2010
915
* \param texture The texture to update.
Jan 12, 2011
Jan 12, 2011
916
* \param alpha The alpha value multiplied into copy operations.
Oct 19, 2009
Oct 19, 2009
917
918
919
920
921
*
* \return 0 on success, or -1 if the texture is not valid or alpha modulation
* is not supported.
*
* \sa SDL_GetTextureAlphaMod()
Aug 28, 2006
Aug 28, 2006
922
*/
Jan 21, 2010
Jan 21, 2010
923
extern DECLSPEC int SDLCALL SDL_SetTextureAlphaMod(SDL_Texture * texture,
Aug 28, 2006
Aug 28, 2006
924
925
926
Uint8 alpha);
/**
Oct 19, 2009
Oct 19, 2009
927
928
* \brief Get the additional alpha value used in render copy operations.
*
Jan 21, 2010
Jan 21, 2010
929
* \param texture The texture to query.
Jan 12, 2011
Jan 12, 2011
930
* \param alpha A pointer filled in with the current alpha value.
Oct 19, 2009
Oct 19, 2009
931
932
933
934
*
* \return 0 on success, or -1 if the texture is not valid.
*
* \sa SDL_SetTextureAlphaMod()
Aug 28, 2006
Aug 28, 2006
935
*/
Jan 21, 2010
Jan 21, 2010
936
extern DECLSPEC int SDLCALL SDL_GetTextureAlphaMod(SDL_Texture * texture,
Aug 28, 2006
Aug 28, 2006
937
938
939
Uint8 * alpha);
/**
Oct 19, 2009
Oct 19, 2009
940
941
* \brief Set the blend mode used for texture copy operations.
*
Jan 21, 2010
Jan 21, 2010
942
* \param texture The texture to update.
Oct 19, 2009
Oct 19, 2009
943
944
945
946
947
948
949
950
951
* \param blendMode ::SDL_BlendMode to use for texture blending.
*
* \return 0 on success, or -1 if the texture is not valid or the blend mode is
* not supported.
*
* \note If the blend mode is not supported, the closest supported mode is
* chosen.
*
* \sa SDL_GetTextureBlendMode()
Aug 28, 2006
Aug 28, 2006
952
*/
Jan 21, 2010
Jan 21, 2010
953
extern DECLSPEC int SDLCALL SDL_SetTextureBlendMode(SDL_Texture * texture,
Dec 12, 2010
Dec 12, 2010
954
SDL_BlendMode blendMode);
Aug 28, 2006
Aug 28, 2006
955
956
/**
Oct 19, 2009
Oct 19, 2009
957
958
* \brief Get the blend mode used for texture copy operations.
*
Jan 21, 2010
Jan 21, 2010
959
* \param texture The texture to query.
Oct 19, 2009
Oct 19, 2009
960
961
962
963
964
* \param blendMode A pointer filled in with the current blend mode.
*
* \return 0 on success, or -1 if the texture is not valid.
*
* \sa SDL_SetTextureBlendMode()
Aug 28, 2006
Aug 28, 2006
965
*/
Jan 21, 2010
Jan 21, 2010
966
extern DECLSPEC int SDLCALL SDL_GetTextureBlendMode(SDL_Texture * texture,
Dec 12, 2010
Dec 12, 2010
967
SDL_BlendMode *blendMode);
Aug 28, 2006
Aug 28, 2006
968
Jul 10, 2006
Jul 10, 2006
969
/**
Oct 19, 2009
Oct 19, 2009
970
971
* \brief Update the given texture rectangle with new pixel data.
*
Jan 21, 2010
Jan 21, 2010
972
* \param texture The texture to update
Oct 19, 2009
Oct 19, 2009
973
974
975
976
977
978
979
980
* \param rect A pointer to the rectangle of pixels to update, or NULL to
* update the entire texture.
* \param pixels The raw pixel data.
* \param pitch The number of bytes between rows of pixel data.
*
* \return 0 on success, or -1 if the texture is not valid.
*
* \note This is a fairly slow function.
Jul 10, 2006
Jul 10, 2006
981
*/
Jan 21, 2010
Jan 21, 2010
982
extern DECLSPEC int SDLCALL SDL_UpdateTexture(SDL_Texture * texture,
Jul 10, 2006
Jul 10, 2006
983
984
985
986
const SDL_Rect * rect,
const void *pixels, int pitch);
/**
Oct 19, 2009
Oct 19, 2009
987
988
* \brief Lock a portion of the texture for pixel access.
*
Jan 21, 2010
Jan 21, 2010
989
* \param texture The texture to lock for access, which was created with
Oct 19, 2009
Oct 19, 2009
990
991
992
993
994
995
996
997
998
999
1000
* ::SDL_TEXTUREACCESS_STREAMING.
* \param rect A pointer to the rectangle to lock for access. If the rect
* is NULL, the entire texture will be locked.
* \param markDirty If this is nonzero, the locked area will be marked dirty
* when the texture is unlocked.
* \param pixels This is filled in with a pointer to the locked pixels,
* appropriately offset by the locked area.
* \param pitch This is filled in with the pitch of the locked pixels.
*
* \return 0 on success, or -1 if the texture is not valid or was created with
* ::SDL_TEXTUREACCESS_STATIC.