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

Latest commit

 

History

History
1392 lines (1251 loc) · 47.7 KB

SDL_video.h

File metadata and controls

1392 lines (1251 loc) · 47.7 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
Uint32 num_texture_formats; /**< The number of available texture formats */
Jul 22, 2010
Jul 22, 2010
191
Uint32 texture_formats[50]; /**< The available texture formats */
Jul 10, 2006
Jul 10, 2006
192
193
194
195
196
int max_texture_width; /**< The maximimum texture width */
int max_texture_height; /**< The maximimum texture height */
} SDL_RendererInfo;
/**
Oct 19, 2009
Oct 19, 2009
197
* \brief The access pattern allowed for a texture.
Jul 10, 2006
Jul 10, 2006
198
199
200
*/
typedef enum
{
Aug 11, 2007
Aug 11, 2007
201
202
SDL_TEXTUREACCESS_STATIC, /**< Changes rarely, not lockable */
SDL_TEXTUREACCESS_STREAMING /**< Changes frequently, lockable */
Jul 10, 2006
Jul 10, 2006
203
204
} SDL_TextureAccess;
Aug 28, 2006
Aug 28, 2006
205
/**
Oct 19, 2009
Oct 19, 2009
206
* \brief The texture channel modulation used in SDL_RenderCopy().
Aug 28, 2006
Aug 28, 2006
207
208
209
210
211
*/
typedef enum
{
SDL_TEXTUREMODULATE_NONE = 0x00000000, /**< No modulation */
SDL_TEXTUREMODULATE_COLOR = 0x00000001, /**< srcC = srcC * color */
Jul 22, 2007
Jul 22, 2007
212
SDL_TEXTUREMODULATE_ALPHA = 0x00000002 /**< srcA = srcA * alpha */
Aug 28, 2006
Aug 28, 2006
213
214
} SDL_TextureModulate;
Jul 10, 2006
Jul 10, 2006
215
/**
Oct 19, 2009
Oct 19, 2009
216
* \brief An efficient driver-specific representation of pixel data
Jul 10, 2006
Jul 10, 2006
217
*/
Jan 21, 2010
Jan 21, 2010
218
219
struct SDL_Texture;
typedef struct SDL_Texture SDL_Texture;
Jul 10, 2006
Jul 10, 2006
220
221
/**
Oct 19, 2009
Oct 19, 2009
222
* \brief An opaque handle to an OpenGL context.
Jul 10, 2006
Jul 10, 2006
223
224
225
226
*/
typedef void *SDL_GLContext;
/**
Oct 19, 2009
Oct 19, 2009
227
* \brief OpenGL configuration attributes
Jul 10, 2006
Jul 10, 2006
228
229
230
*/
typedef enum
{
Apr 26, 2001
Apr 26, 2001
231
232
233
234
235
236
237
238
239
240
241
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
242
SDL_GL_ACCUM_ALPHA_SIZE,
Jul 22, 2003
Jul 22, 2003
243
SDL_GL_STEREO,
Jul 22, 2003
Jul 22, 2003
244
SDL_GL_MULTISAMPLEBUFFERS,
Apr 27, 2006
Apr 27, 2006
245
SDL_GL_MULTISAMPLESAMPLES,
Sep 2, 2008
Sep 2, 2008
246
SDL_GL_ACCELERATED_VISUAL,
Mar 24, 2009
Mar 24, 2009
247
SDL_GL_RETAINED_BACKING,
May 23, 2009
May 23, 2009
248
249
SDL_GL_CONTEXT_MAJOR_VERSION,
SDL_GL_CONTEXT_MINOR_VERSION
Apr 26, 2001
Apr 26, 2001
250
251
252
253
254
} SDL_GLattr;
/* Function prototypes */
Jul 10, 2006
Jul 10, 2006
255
/**
Oct 19, 2009
Oct 19, 2009
256
257
258
* \brief Get the number of video drivers compiled into SDL
*
* \sa SDL_GetVideoDriver()
Jul 10, 2006
Jul 10, 2006
259
260
261
262
*/
extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
/**
Oct 19, 2009
Oct 19, 2009
263
264
265
266
267
268
* \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
269
270
271
272
*/
extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index);
/**
Oct 19, 2009
Oct 19, 2009
273
274
275
276
277
278
279
280
281
282
283
284
* \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
285
*/
Jan 28, 2011
Jan 28, 2011
286
extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name);
Jul 10, 2006
Jul 10, 2006
287
288
/**
Oct 19, 2009
Oct 19, 2009
289
290
291
292
293
* \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
294
*/
Apr 11, 2002
Apr 11, 2002
295
extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
Apr 26, 2001
Apr 26, 2001
296
Jul 10, 2006
Jul 10, 2006
297
/**
Oct 19, 2009
Oct 19, 2009
298
299
300
301
302
303
304
* \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
305
*/
Jul 10, 2006
Jul 10, 2006
306
extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
Apr 26, 2001
Apr 26, 2001
307
Jul 10, 2006
Jul 10, 2006
308
/**
Oct 19, 2009
Oct 19, 2009
309
310
* \brief Returns the number of available video displays.
*
Dec 6, 2009
Dec 6, 2009
311
* \sa SDL_GetDisplayBounds()
Oct 19, 2009
Oct 19, 2009
312
* \sa SDL_SelectVideoDisplay()
Apr 26, 2001
Apr 26, 2001
313
*/
Jul 10, 2006
Jul 10, 2006
314
extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
Apr 26, 2001
Apr 26, 2001
315
Dec 6, 2009
Dec 6, 2009
316
317
318
319
320
321
322
323
324
325
/**
* \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
326
/**
Oct 19, 2009
Oct 19, 2009
327
328
329
330
331
332
* \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
333
*/
Jul 10, 2006
Jul 10, 2006
334
extern DECLSPEC int SDLCALL SDL_SelectVideoDisplay(int index);
Apr 26, 2001
Apr 26, 2001
335
Aug 2, 2006
Aug 2, 2006
336
/**
Oct 19, 2009
Oct 19, 2009
337
338
339
340
341
342
* \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
343
344
345
*/
extern DECLSPEC int SDLCALL SDL_GetCurrentVideoDisplay(void);
Jul 10, 2006
Jul 10, 2006
346
/**
Oct 19, 2009
Oct 19, 2009
347
348
349
* \brief Returns the number of available display modes for the current display.
*
* \sa SDL_GetDisplayMode()
Apr 26, 2001
Apr 26, 2001
350
*/
Jul 10, 2006
Jul 10, 2006
351
extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(void);
Apr 26, 2001
Apr 26, 2001
352
Jul 10, 2006
Jul 10, 2006
353
/**
Oct 19, 2009
Oct 19, 2009
354
355
356
357
358
359
360
361
362
* \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
363
*/
Aug 5, 2006
Aug 5, 2006
364
365
extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int index,
SDL_DisplayMode * mode);
Apr 26, 2001
Apr 26, 2001
366
Jul 10, 2006
Jul 10, 2006
367
/**
Oct 19, 2009
Oct 19, 2009
368
369
* \brief Fill in information about the desktop display mode for the current
* display.
Jul 10, 2006
Jul 10, 2006
370
*/
Aug 5, 2006
Aug 5, 2006
371
extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(SDL_DisplayMode * mode);
Apr 26, 2001
Apr 26, 2001
372
Jul 10, 2006
Jul 10, 2006
373
/**
Oct 19, 2009
Oct 19, 2009
374
* \brief Fill in information about the current display mode.
Apr 26, 2001
Apr 26, 2001
375
*/
Aug 5, 2006
Aug 5, 2006
376
extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(SDL_DisplayMode * mode);
Apr 26, 2001
Apr 26, 2001
377
Oct 17, 2009
Oct 17, 2009
378
Jul 10, 2006
Jul 10, 2006
379
/**
Oct 19, 2009
Oct 19, 2009
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
* \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
398
*/
Jul 10, 2006
Jul 10, 2006
399
400
401
402
403
404
405
extern DECLSPEC SDL_DisplayMode *SDLCALL SDL_GetClosestDisplayMode(const
SDL_DisplayMode
* mode,
SDL_DisplayMode
* closest);
/**
Oct 19, 2009
Oct 19, 2009
406
* \brief Set the display mode used when a fullscreen window is visible
Dec 1, 2009
Dec 1, 2009
407
408
* 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
409
*
Dec 1, 2009
Dec 1, 2009
410
* \param mode The mode to use, or NULL for the default mode.
Oct 19, 2009
Oct 19, 2009
411
412
413
*
* \return 0 on success, or -1 if setting the display mode failed.
*
Dec 5, 2009
Dec 5, 2009
414
* \sa SDL_GetWindowDisplayMode()
Oct 19, 2009
Oct 19, 2009
415
* \sa SDL_SetWindowFullscreen()
Jul 10, 2006
Jul 10, 2006
416
*/
Jan 21, 2010
Jan 21, 2010
417
extern DECLSPEC int SDLCALL SDL_SetWindowDisplayMode(SDL_Window * window,
Dec 1, 2009
Dec 1, 2009
418
const SDL_DisplayMode
Jul 10, 2006
Jul 10, 2006
419
* mode);
Apr 26, 2001
Apr 26, 2001
420
Jul 10, 2006
Jul 10, 2006
421
/**
Oct 19, 2009
Oct 19, 2009
422
423
* \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
424
425
426
*
* \sa SDL_SetWindowDisplayMode()
* \sa SDL_SetWindowFullscreen()
Jul 10, 2006
Jul 10, 2006
427
*/
Jan 21, 2010
Jan 21, 2010
428
extern DECLSPEC int SDLCALL SDL_GetWindowDisplayMode(SDL_Window * window,
Dec 1, 2009
Dec 1, 2009
429
SDL_DisplayMode * mode);
Jul 10, 2006
Jul 10, 2006
430
431
/**
Oct 19, 2009
Oct 19, 2009
432
433
434
435
* \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
436
437
438
439
440
441
*/
extern DECLSPEC int SDLCALL SDL_SetDisplayPalette(const SDL_Color * colors,
int firstcolor,
int ncolors);
/**
Oct 19, 2009
Oct 19, 2009
442
443
444
* \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
445
446
447
448
449
450
*/
extern DECLSPEC int SDLCALL SDL_GetDisplayPalette(SDL_Color * colors,
int firstcolor,
int ncolors);
/**
Oct 19, 2009
Oct 19, 2009
451
452
453
454
455
456
* \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
457
*/
Apr 11, 2002
Apr 11, 2002
458
extern DECLSPEC int SDLCALL SDL_SetGamma(float red, float green, float blue);
Apr 26, 2001
Apr 26, 2001
459
Jul 10, 2006
Jul 10, 2006
460
/**
Oct 19, 2009
Oct 19, 2009
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
* \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
476
*/
Jul 10, 2006
Jul 10, 2006
477
478
479
extern DECLSPEC int SDLCALL SDL_SetGammaRamp(const Uint16 * red,
const Uint16 * green,
const Uint16 * blue);
Apr 26, 2001
Apr 26, 2001
480
Jul 10, 2006
Jul 10, 2006
481
/**
Oct 19, 2009
Oct 19, 2009
482
483
484
485
486
487
488
489
490
491
492
493
* \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
494
*/
Jul 10, 2006
Jul 10, 2006
495
496
extern DECLSPEC int SDLCALL SDL_GetGammaRamp(Uint16 * red, Uint16 * green,
Uint16 * blue);
Apr 26, 2001
Apr 26, 2001
497
498
Jul 10, 2006
Jul 10, 2006
499
/**
Oct 19, 2009
Oct 19, 2009
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
* \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
518
*/
Jan 21, 2010
Jan 21, 2010
519
extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title,
Jul 10, 2006
Jul 10, 2006
520
521
522
523
int x, int y, int w,
int h, Uint32 flags);
/**
Nov 25, 2009
Nov 25, 2009
524
* \brief Create an SDL window from an existing native window.
Oct 19, 2009
Oct 19, 2009
525
526
527
528
529
530
*
* \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
531
*/
Jan 21, 2010
Jan 21, 2010
532
533
534
extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowFrom(const void *data);
/**
Sep 15, 2010
Sep 15, 2010
535
* \brief Get the numeric ID of a window, for logging purposes.
Jan 21, 2010
Jan 21, 2010
536
537
538
539
540
541
542
*/
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
543
544
/**
Oct 19, 2009
Oct 19, 2009
545
* \brief Get the window flags.
Jul 10, 2006
Jul 10, 2006
546
*/
Jan 21, 2010
Jan 21, 2010
547
extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_Window * window);
Jul 10, 2006
Jul 10, 2006
548
549
/**
Sep 15, 2010
Sep 15, 2010
550
* \brief Set the title of a window, in UTF-8 format.
Oct 19, 2009
Oct 19, 2009
551
552
*
* \sa SDL_GetWindowTitle()
Jul 10, 2006
Jul 10, 2006
553
*/
Jan 21, 2010
Jan 21, 2010
554
extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_Window * window,
Jul 10, 2006
Jul 10, 2006
555
556
557
const char *title);
/**
Sep 15, 2010
Sep 15, 2010
558
* \brief Get the title of a window, in UTF-8 format.
Oct 19, 2009
Oct 19, 2009
559
560
*
* \sa SDL_SetWindowTitle()
Jul 10, 2006
Jul 10, 2006
561
*/
Jan 21, 2010
Jan 21, 2010
562
extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_Window * window);
Jul 10, 2006
Jul 10, 2006
563
564
/**
Sep 19, 2010
Sep 19, 2010
565
* \brief Set the icon for a window.
Oct 19, 2009
Oct 19, 2009
566
*
Sep 19, 2010
Sep 19, 2010
567
* \param icon The icon for the window.
Jul 10, 2006
Jul 10, 2006
568
*/
Jan 21, 2010
Jan 21, 2010
569
extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Window * window,
Jan 4, 2009
Jan 4, 2009
570
SDL_Surface * icon);
Jul 10, 2006
Jul 10, 2006
571
572
/**
Aug 29, 2010
Aug 29, 2010
573
* \brief Associate an arbitrary pointer with a window.
Oct 19, 2009
Oct 19, 2009
574
575
*
* \sa SDL_GetWindowData()
Jul 10, 2006
Jul 10, 2006
576
*/
Jan 21, 2010
Jan 21, 2010
577
extern DECLSPEC void SDLCALL SDL_SetWindowData(SDL_Window * window,
Jul 10, 2006
Jul 10, 2006
578
579
580
void *userdata);
/**
Sep 15, 2010
Sep 15, 2010
581
* \brief Retrieve the data pointer associated with a window.
Oct 19, 2009
Oct 19, 2009
582
583
*
* \sa SDL_SetWindowData()
Jul 10, 2006
Jul 10, 2006
584
*/
Jan 21, 2010
Jan 21, 2010
585
extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_Window * window);
Jul 10, 2006
Jul 10, 2006
586
587
/**
Sep 15, 2010
Sep 15, 2010
588
* \brief Set the position of a window.
Oct 19, 2009
Oct 19, 2009
589
*
Jan 21, 2010
Jan 21, 2010
590
* \param window The window to reposition.
Oct 19, 2009
Oct 19, 2009
591
592
593
594
595
596
597
598
* \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
599
*/
Jan 21, 2010
Jan 21, 2010
600
extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_Window * window,
Jul 10, 2006
Jul 10, 2006
601
602
603
int x, int y);
/**
Sep 15, 2010
Sep 15, 2010
604
* \brief Get the position of a window.
Oct 19, 2009
Oct 19, 2009
605
606
*
* \sa SDL_SetWindowPosition()
Jul 10, 2006
Jul 10, 2006
607
*/
Jan 21, 2010
Jan 21, 2010
608
extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_Window * window,
Jul 10, 2006
Jul 10, 2006
609
610
611
int *x, int *y);
/**
Sep 15, 2010
Sep 15, 2010
612
* \brief Set the size of a window's client area.
Oct 19, 2009
Oct 19, 2009
613
614
615
616
617
*
* \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
618
*/
Jan 21, 2010
Jan 21, 2010
619
extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_Window * window, int w,
Jul 10, 2006
Jul 10, 2006
620
621
622
int h);
/**
Sep 15, 2010
Sep 15, 2010
623
* \brief Get the size of a window's client area.
Oct 19, 2009
Oct 19, 2009
624
625
*
* \sa SDL_SetWindowSize()
Jul 10, 2006
Jul 10, 2006
626
*/
Jan 21, 2010
Jan 21, 2010
627
extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_Window * window, int *w,
Jul 10, 2006
Jul 10, 2006
628
629
630
int *h);
/**
Sep 15, 2010
Sep 15, 2010
631
* \brief Show a window.
Oct 19, 2009
Oct 19, 2009
632
633
*
* \sa SDL_HideWindow()
Jul 10, 2006
Jul 10, 2006
634
*/
Jan 21, 2010
Jan 21, 2010
635
extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_Window * window);
Jul 10, 2006
Jul 10, 2006
636
637
/**
Sep 15, 2010
Sep 15, 2010
638
* \brief Hide a window.
Oct 19, 2009
Oct 19, 2009
639
640
*
* \sa SDL_ShowWindow()
Jul 10, 2006
Jul 10, 2006
641
*/
Jan 21, 2010
Jan 21, 2010
642
extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_Window * window);
Jul 10, 2006
Jul 10, 2006
643
644
/**
Sep 15, 2010
Sep 15, 2010
645
* \brief Raise a window above other windows and set the input focus.
Jul 10, 2006
Jul 10, 2006
646
*/
Jan 21, 2010
Jan 21, 2010
647
extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_Window * window);
Jul 10, 2006
Jul 10, 2006
648
649
/**
Sep 15, 2010
Sep 15, 2010
650
* \brief Make a window as large as possible.
Oct 19, 2009
Oct 19, 2009
651
652
*
* \sa SDL_RestoreWindow()
Jul 10, 2006
Jul 10, 2006
653
*/
Jan 21, 2010
Jan 21, 2010
654
extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_Window * window);
Jul 10, 2006
Jul 10, 2006
655
656
/**
Sep 15, 2010
Sep 15, 2010
657
* \brief Minimize a window to an iconic representation.
Oct 19, 2009
Oct 19, 2009
658
659
*
* \sa SDL_RestoreWindow()
Jul 10, 2006
Jul 10, 2006
660
*/
Jan 21, 2010
Jan 21, 2010
661
extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_Window * window);
Jul 10, 2006
Jul 10, 2006
662
663
/**
Oct 19, 2009
Oct 19, 2009
664
665
666
667
* \brief Restore the size and position of a minimized or maximized window.
*
* \sa SDL_MaximizeWindow()
* \sa SDL_MinimizeWindow()
Jul 10, 2006
Jul 10, 2006
668
*/
Jan 21, 2010
Jan 21, 2010
669
extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_Window * window);
Jul 10, 2006
Jul 10, 2006
670
671
/**
Sep 15, 2010
Sep 15, 2010
672
* \brief Set a window's fullscreen state.
Oct 19, 2009
Oct 19, 2009
673
674
675
*
* \return 0 on success, or -1 if setting the display mode failed.
*
Dec 5, 2009
Dec 5, 2009
676
677
* \sa SDL_SetWindowDisplayMode()
* \sa SDL_GetWindowDisplayMode()
Jul 10, 2006
Jul 10, 2006
678
*/
Jan 21, 2010
Jan 21, 2010
679
extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_Window * window,
Jul 10, 2006
Jul 10, 2006
680
681
682
int fullscreen);
/**
Sep 15, 2010
Sep 15, 2010
683
* \brief Set a window's input grab mode.
Oct 19, 2009
Oct 19, 2009
684
685
686
687
*
* \param mode This is 1 to grab input, and 0 to release input.
*
* \sa SDL_GetWindowGrab()
Jul 10, 2006
Jul 10, 2006
688
*/
Jan 21, 2010
Jan 21, 2010
689
extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_Window * window,
Jul 10, 2006
Jul 10, 2006
690
691
692
int mode);
/**
Sep 15, 2010
Sep 15, 2010
693
* \brief Get a window's input grab mode.
Oct 19, 2009
Oct 19, 2009
694
695
696
697
*
* \return This returns 1 if input is grabbed, and 0 otherwise.
*
* \sa SDL_SetWindowGrab()
Jul 10, 2006
Jul 10, 2006
698
*/
Jan 21, 2010
Jan 21, 2010
699
extern DECLSPEC int SDLCALL SDL_GetWindowGrab(SDL_Window * window);
Jul 10, 2006
Jul 10, 2006
700
701
/**
Oct 19, 2009
Oct 19, 2009
702
703
704
* \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
705
706
*/
struct SDL_SysWMinfo;
Jan 21, 2010
Jan 21, 2010
707
extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_Window * window,
Jul 10, 2006
Jul 10, 2006
708
709
710
711
struct SDL_SysWMinfo
*info);
/**
Oct 19, 2009
Oct 19, 2009
712
* \brief Destroy a window.
Jul 10, 2006
Jul 10, 2006
713
*/
Jan 21, 2010
Jan 21, 2010
714
extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_Window * window);
Jul 10, 2006
Jul 10, 2006
715
716
/**
Oct 19, 2009
Oct 19, 2009
717
718
719
720
721
722
723
724
725
* \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
726
*/
Aug 6, 2006
Aug 6, 2006
727
extern DECLSPEC int SDLCALL SDL_GetNumRenderDrivers(void);
Jul 10, 2006
Jul 10, 2006
728
729
/**
Oct 19, 2009
Oct 19, 2009
730
731
732
733
734
735
736
737
738
739
* \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
740
*/
Aug 6, 2006
Aug 6, 2006
741
742
extern DECLSPEC int SDLCALL SDL_GetRenderDriverInfo(int index,
SDL_RendererInfo * info);
Jul 10, 2006
Jul 10, 2006
743
744
/**
Oct 19, 2009
Oct 19, 2009
745
746
* \brief Create and make active a 2D rendering context for a window.
*
Jan 21, 2010
Jan 21, 2010
747
* \param window The window where rendering is displayed.
Oct 19, 2009
Oct 19, 2009
748
749
750
751
752
753
754
755
756
* \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
757
*/
Jan 21, 2010
Jan 21, 2010
758
extern DECLSPEC int SDLCALL SDL_CreateRenderer(SDL_Window * window,
Jul 10, 2006
Jul 10, 2006
759
760
761
int index, Uint32 flags);
/**
Oct 19, 2009
Oct 19, 2009
762
763
764
765
* \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
766
*/
Jan 21, 2010
Jan 21, 2010
767
extern DECLSPEC int SDLCALL SDL_SelectRenderer(SDL_Window * window);
Jul 10, 2006
Jul 10, 2006
768
Aug 6, 2006
Aug 6, 2006
769
/**
Oct 19, 2009
Oct 19, 2009
770
* \brief Get information about the current rendering context.
Aug 6, 2006
Aug 6, 2006
771
772
773
*/
extern DECLSPEC int SDLCALL SDL_GetRendererInfo(SDL_RendererInfo * info);
Jul 10, 2006
Jul 10, 2006
774
/**
Oct 19, 2009
Oct 19, 2009
775
776
777
778
779
780
781
782
783
784
785
786
787
* \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
788
*/
Jan 21, 2010
Jan 21, 2010
789
extern DECLSPEC SDL_Texture * SDLCALL SDL_CreateTexture(Uint32 format,
Jul 10, 2006
Jul 10, 2006
790
791
792
793
int access, int w,
int h);
/**
Oct 19, 2009
Oct 19, 2009
794
795
796
797
798
799
800
801
802
803
804
805
806
* \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
807
*/
Jan 21, 2010
Jan 21, 2010
808
extern DECLSPEC SDL_Texture * SDLCALL SDL_CreateTextureFromSurface(Uint32
Jul 10, 2006
Jul 10, 2006
809
810
811
812
813
format,
SDL_Surface
* surface);
/**
Oct 19, 2009
Oct 19, 2009
814
815
* \brief Query the attributes of a texture
*
Jan 21, 2010
Jan 21, 2010
816
* \param texture A texture to be queried.
Oct 19, 2009
Oct 19, 2009
817
818
819
820
821
822
823
824
* \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
825
*/
Jan 21, 2010
Jan 21, 2010
826
extern DECLSPEC int SDLCALL SDL_QueryTexture(SDL_Texture * texture,
Jul 10, 2006
Jul 10, 2006
827
828
829
830
Uint32 * format, int *access,
int *w, int *h);
/**
Oct 19, 2009
Oct 19, 2009
831
832
833
* \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
834
* \param texture A texture to be queried, which was created with
Oct 19, 2009
Oct 19, 2009
835
836
837
838
839
840
841
* ::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
842
*/
Jan 21, 2010
Jan 21, 2010
843
extern DECLSPEC int SDLCALL SDL_QueryTexturePixels(SDL_Texture * texture,
Jul 10, 2006
Jul 10, 2006
844
845
846
void **pixels, int *pitch);
/**
Oct 19, 2009
Oct 19, 2009
847
848
* \brief Set the color palette of an indexed texture.
*
Jan 21, 2010
Jan 21, 2010
849
* \param texture The texture to update.
Oct 19, 2009
Oct 19, 2009
850
851
852
853
854
855
* \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
856
*/
Jan 21, 2010
Jan 21, 2010
857
extern DECLSPEC int SDLCALL SDL_SetTexturePalette(SDL_Texture * texture,
Jul 10, 2006
Jul 10, 2006
858
859
860
861
862
const SDL_Color * colors,
int firstcolor,
int ncolors);
/**
Oct 19, 2009
Oct 19, 2009
863
864
* \brief Get the color palette from an indexed texture if it has one.
*
Jan 21, 2010
Jan 21, 2010
865
* \param texture The texture to update.
Oct 19, 2009
Oct 19, 2009
866
867
868
869
870
871
* \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
872
*/
Jan 21, 2010
Jan 21, 2010
873
extern DECLSPEC int SDLCALL SDL_GetTexturePalette(SDL_Texture * texture,
Jul 10, 2006
Jul 10, 2006
874
875
876
877
SDL_Color * colors,
int firstcolor,
int ncolors);
Aug 28, 2006
Aug 28, 2006
878
/**
Oct 19, 2009
Oct 19, 2009
879
880
* \brief Set an additional color value used in render copy operations.
*
Jan 21, 2010
Jan 21, 2010
881
* \param texture The texture to update.
Jan 12, 2011
Jan 12, 2011
882
883
884
* \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
885
886
887
888
889
*
* \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
890
*/
Jan 21, 2010
Jan 21, 2010
891
extern DECLSPEC int SDLCALL SDL_SetTextureColorMod(SDL_Texture * texture,
Aug 28, 2006
Aug 28, 2006
892
893
894
895
Uint8 r, Uint8 g, Uint8 b);
/**
Oct 19, 2009
Oct 19, 2009
896
897
* \brief Get the additional color value used in render copy operations.
*
Jan 21, 2010
Jan 21, 2010
898
* \param texture The texture to query.
Jan 12, 2011
Jan 12, 2011
899
900
901
* \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
902
903
904
905
*
* \return 0 on success, or -1 if the texture is not valid.
*
* \sa SDL_SetTextureColorMod()
Aug 28, 2006
Aug 28, 2006
906
*/
Jan 21, 2010
Jan 21, 2010
907
extern DECLSPEC int SDLCALL SDL_GetTextureColorMod(SDL_Texture * texture,
Aug 28, 2006
Aug 28, 2006
908
909
910
911
Uint8 * r, Uint8 * g,
Uint8 * b);
/**
Oct 19, 2009
Oct 19, 2009
912
913
* \brief Set an additional alpha value used in render copy operations.
*
Jan 21, 2010
Jan 21, 2010
914
* \param texture The texture to update.
Jan 12, 2011
Jan 12, 2011
915
* \param alpha The alpha value multiplied into copy operations.
Oct 19, 2009
Oct 19, 2009
916
917
918
919
920
*
* \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
921
*/
Jan 21, 2010
Jan 21, 2010
922
extern DECLSPEC int SDLCALL SDL_SetTextureAlphaMod(SDL_Texture * texture,
Aug 28, 2006
Aug 28, 2006
923
924
925
Uint8 alpha);
/**
Oct 19, 2009
Oct 19, 2009
926
927
* \brief Get the additional alpha value used in render copy operations.
*
Jan 21, 2010
Jan 21, 2010
928
* \param texture The texture to query.
Jan 12, 2011
Jan 12, 2011
929
* \param alpha A pointer filled in with the current alpha value.
Oct 19, 2009
Oct 19, 2009
930
931
932
933
*
* \return 0 on success, or -1 if the texture is not valid.
*
* \sa SDL_SetTextureAlphaMod()
Aug 28, 2006
Aug 28, 2006
934
*/
Jan 21, 2010
Jan 21, 2010
935
extern DECLSPEC int SDLCALL SDL_GetTextureAlphaMod(SDL_Texture * texture,
Aug 28, 2006
Aug 28, 2006
936
937
938
Uint8 * alpha);
/**
Oct 19, 2009
Oct 19, 2009
939
940
* \brief Set the blend mode used for texture copy operations.
*
Jan 21, 2010
Jan 21, 2010
941
* \param texture The texture to update.
Oct 19, 2009
Oct 19, 2009
942
943
944
945
946
947
948
949
950
* \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
951
*/
Jan 21, 2010
Jan 21, 2010
952
extern DECLSPEC int SDLCALL SDL_SetTextureBlendMode(SDL_Texture * texture,
Dec 12, 2010
Dec 12, 2010
953
SDL_BlendMode blendMode);
Aug 28, 2006
Aug 28, 2006
954
955
/**
Oct 19, 2009
Oct 19, 2009
956
957
* \brief Get the blend mode used for texture copy operations.
*
Jan 21, 2010
Jan 21, 2010
958
* \param texture The texture to query.
Oct 19, 2009
Oct 19, 2009
959
960
961
962
963
* \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
964
*/
Jan 21, 2010
Jan 21, 2010
965
extern DECLSPEC int SDLCALL SDL_GetTextureBlendMode(SDL_Texture * texture,
Dec 12, 2010
Dec 12, 2010
966
SDL_BlendMode *blendMode);
Aug 28, 2006
Aug 28, 2006
967
Jul 10, 2006
Jul 10, 2006
968
/**
Oct 19, 2009
Oct 19, 2009
969
970
* \brief Update the given texture rectangle with new pixel data.
*
Jan 21, 2010
Jan 21, 2010
971
* \param texture The texture to update
Oct 19, 2009
Oct 19, 2009
972
973
974
975
976
977
978
979
* \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
980
*/
Jan 21, 2010
Jan 21, 2010
981
extern DECLSPEC int SDLCALL SDL_UpdateTexture(SDL_Texture * texture,
Jul 10, 2006
Jul 10, 2006
982
983
984
985
const SDL_Rect * rect,
const void *pixels, int pitch);
/**
Oct 19, 2009
Oct 19, 2009
986
987
* \brief Lock a portion of the texture for pixel access.
*
Jan 21, 2010
Jan 21, 2010
988
* \param texture The texture to lock for access, which was created with
Oct 19, 2009
Oct 19, 2009
989
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.
*