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

Latest commit

 

History

History
1391 lines (1250 loc) · 47.7 KB

SDL_video.h

File metadata and controls

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