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

Latest commit

 

History

History
1369 lines (1229 loc) · 47.1 KB

SDL_video.h

File metadata and controls

1369 lines (1229 loc) · 47.1 KB
 
Apr 26, 2001
Apr 26, 2001
1
2
/*
SDL - Simple DirectMedia Layer
Dec 8, 2008
Dec 8, 2008
3
Copyright (C) 1997-2009 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
35
#include "SDL_rect.h"
#include "SDL_surface.h"
Apr 26, 2001
Apr 26, 2001
36
37
38
39
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
Jul 10, 2006
Jul 10, 2006
40
/* *INDENT-OFF* */
Apr 26, 2001
Apr 26, 2001
41
extern "C" {
Jul 10, 2006
Jul 10, 2006
42
/* *INDENT-ON* */
Apr 26, 2001
Apr 26, 2001
43
44
#endif
Jul 10, 2006
Jul 10, 2006
45
/**
Oct 19, 2009
Oct 19, 2009
46
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()
* \sa SDL_SetDisplayMode()
Jul 10, 2006
Jul 10, 2006
54
55
56
57
58
59
60
61
62
63
64
*/
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
* \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
89
90
91
92
*/
typedef Uint32 SDL_WindowID;
/**
Oct 19, 2009
Oct 19, 2009
93
94
95
* \brief The flags on a window
*
* \sa SDL_GetWindowFlags()
Jul 10, 2006
Jul 10, 2006
96
97
98
99
100
101
102
103
104
105
106
107
*/
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 */
SDL_WINDOW_MINIMIZED = 0x00000020, /**< minimized */
SDL_WINDOW_MAXIMIZED = 0x00000040, /**< maximized */
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
108
109
SDL_WINDOW_MOUSE_FOCUS = 0x00000400, /**< window has mouse focus */
SDL_WINDOW_FOREIGN = 0x00000800 /**< window not created by SDL */
Jul 10, 2006
Jul 10, 2006
110
111
112
} SDL_WindowFlags;
/**
Oct 19, 2009
Oct 19, 2009
113
* \brief Used to indicate that you don't care what the window position is.
Jul 10, 2006
Jul 10, 2006
114
115
*/
#define SDL_WINDOWPOS_UNDEFINED 0x7FFFFFF
Oct 19, 2009
Oct 19, 2009
116
Jul 10, 2006
Jul 10, 2006
117
/**
Oct 19, 2009
Oct 19, 2009
118
* \brief Used to indicate that the window position should be centered.
Jul 10, 2006
Jul 10, 2006
119
120
121
122
*/
#define SDL_WINDOWPOS_CENTERED 0x7FFFFFE
/**
Oct 19, 2009
Oct 19, 2009
123
* \brief Event subtype for window events
Jul 10, 2006
Jul 10, 2006
124
125
126
*/
typedef enum
{
Oct 19, 2009
Oct 19, 2009
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
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 */
SDL_WINDOWEVENT_ENTER, /**< The window has gained mouse focus */
SDL_WINDOWEVENT_LEAVE, /**< The window has lost mouse focus */
SDL_WINDOWEVENT_FOCUS_GAINED, /**< The window has gained keyboard focus */
SDL_WINDOWEVENT_FOCUS_LOST, /**< The window has lost keyboard focus */
SDL_WINDOWEVENT_CLOSE /**< The window manager requests that the
window be closed */
Jul 10, 2006
Jul 10, 2006
145
146
147
} SDL_WindowEventID;
/**
Oct 19, 2009
Oct 19, 2009
148
* \brief Flags used when creating a rendering context
Jul 10, 2006
Jul 10, 2006
149
150
151
*/
typedef enum
{
Oct 19, 2009
Oct 19, 2009
152
153
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
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
182
183
184
185
*/
typedef struct SDL_RendererInfo
{
const char *name; /**< The name of the renderer */
Oct 19, 2009
Oct 19, 2009
186
Uint32 flags; /**< Supported ::SDL_RendererFlags */
Aug 28, 2006
Aug 28, 2006
187
Uint32 mod_modes; /**< A mask of supported channel modulation */
Jul 10, 2006
Jul 10, 2006
188
189
190
Uint32 blend_modes; /**< A mask of supported blend modes */
Uint32 scale_modes; /**< A mask of supported scale modes */
Uint32 num_texture_formats; /**< The number of available texture formats */
Jul 22, 2006
Jul 22, 2006
191
Uint32 texture_formats[20]; /**< 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 The blend mode used in SDL_RenderCopy() and drawing operations.
Jul 10, 2006
Jul 10, 2006
217
218
219
*/
typedef enum
{
Dec 20, 2008
Dec 20, 2008
220
SDL_BLENDMODE_NONE = 0x00000000, /**< No blending */
Oct 19, 2009
Oct 19, 2009
221
222
223
SDL_BLENDMODE_MASK = 0x00000001, /**< dst = A ? src : dst
(alpha is mask) */
Dec 20, 2008
Dec 20, 2008
224
225
226
227
SDL_BLENDMODE_BLEND = 0x00000002, /**< dst = (src * A) + (dst * (1-A)) */
SDL_BLENDMODE_ADD = 0x00000004, /**< dst = (src * A) + dst */
SDL_BLENDMODE_MOD = 0x00000008 /**< dst = src * dst */
} SDL_BlendMode;
Jul 10, 2006
Jul 10, 2006
228
229
/**
Oct 19, 2009
Oct 19, 2009
230
* \brief The texture scale mode used in SDL_RenderCopy().
Jul 10, 2006
Jul 10, 2006
231
232
233
*/
typedef enum
{
Oct 19, 2009
Oct 19, 2009
234
235
236
237
238
239
240
241
242
243
244
SDL_TEXTURESCALEMODE_NONE = 0x00000000, /**< No scaling, rectangles must
match dimensions */
SDL_TEXTURESCALEMODE_FAST = 0x00000001, /**< Point sampling or
equivalent algorithm */
SDL_TEXTURESCALEMODE_SLOW = 0x00000002, /**< Linear filtering or
equivalent algorithm */
SDL_TEXTURESCALEMODE_BEST = 0x00000004 /**< Bicubic filtering or
equivalent algorithm */
Jul 10, 2006
Jul 10, 2006
245
246
247
} SDL_TextureScaleMode;
/**
Oct 19, 2009
Oct 19, 2009
248
* \brief An efficient driver-specific representation of pixel data
Jul 10, 2006
Jul 10, 2006
249
250
251
252
*/
typedef Uint32 SDL_TextureID;
/**
Oct 19, 2009
Oct 19, 2009
253
* \brief An opaque handle to an OpenGL context.
Jul 10, 2006
Jul 10, 2006
254
255
256
257
*/
typedef void *SDL_GLContext;
/**
Oct 19, 2009
Oct 19, 2009
258
* \brief OpenGL configuration attributes
Jul 10, 2006
Jul 10, 2006
259
260
261
*/
typedef enum
{
Apr 26, 2001
Apr 26, 2001
262
263
264
265
266
267
268
269
270
271
272
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
273
SDL_GL_ACCUM_ALPHA_SIZE,
Jul 22, 2003
Jul 22, 2003
274
SDL_GL_STEREO,
Jul 22, 2003
Jul 22, 2003
275
SDL_GL_MULTISAMPLEBUFFERS,
Apr 27, 2006
Apr 27, 2006
276
SDL_GL_MULTISAMPLESAMPLES,
Sep 2, 2008
Sep 2, 2008
277
SDL_GL_ACCELERATED_VISUAL,
Mar 24, 2009
Mar 24, 2009
278
SDL_GL_RETAINED_BACKING,
May 23, 2009
May 23, 2009
279
280
SDL_GL_CONTEXT_MAJOR_VERSION,
SDL_GL_CONTEXT_MINOR_VERSION
Apr 26, 2001
Apr 26, 2001
281
282
283
284
285
} SDL_GLattr;
/* Function prototypes */
Jul 10, 2006
Jul 10, 2006
286
/**
Oct 19, 2009
Oct 19, 2009
287
288
289
* \brief Get the number of video drivers compiled into SDL
*
* \sa SDL_GetVideoDriver()
Jul 10, 2006
Jul 10, 2006
290
291
292
293
*/
extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
/**
Oct 19, 2009
Oct 19, 2009
294
295
296
297
298
299
* \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
300
301
302
303
*/
extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index);
/**
Oct 19, 2009
Oct 19, 2009
304
305
306
307
308
309
310
311
312
313
314
315
316
317
* \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.
*
* \param flags FIXME: Still needed?
*
* \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
318
319
320
321
322
*/
extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name,
Uint32 flags);
/**
Oct 19, 2009
Oct 19, 2009
323
324
325
326
327
* \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
328
*/
Apr 11, 2002
Apr 11, 2002
329
extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
Apr 26, 2001
Apr 26, 2001
330
Jul 10, 2006
Jul 10, 2006
331
/**
Oct 19, 2009
Oct 19, 2009
332
333
334
335
336
337
338
* \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
339
*/
Jul 10, 2006
Jul 10, 2006
340
extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
Apr 26, 2001
Apr 26, 2001
341
Jul 10, 2006
Jul 10, 2006
342
/**
Oct 19, 2009
Oct 19, 2009
343
344
345
* \brief Returns the number of available video displays.
*
* \sa SDL_SelectVideoDisplay()
Apr 26, 2001
Apr 26, 2001
346
*/
Jul 10, 2006
Jul 10, 2006
347
extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
Apr 26, 2001
Apr 26, 2001
348
Jul 10, 2006
Jul 10, 2006
349
/**
Oct 19, 2009
Oct 19, 2009
350
351
352
353
354
355
* \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
356
*/
Jul 10, 2006
Jul 10, 2006
357
extern DECLSPEC int SDLCALL SDL_SelectVideoDisplay(int index);
Apr 26, 2001
Apr 26, 2001
358
Aug 2, 2006
Aug 2, 2006
359
/**
Oct 19, 2009
Oct 19, 2009
360
361
362
363
364
365
* \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
366
367
368
*/
extern DECLSPEC int SDLCALL SDL_GetCurrentVideoDisplay(void);
Jul 10, 2006
Jul 10, 2006
369
/**
Oct 19, 2009
Oct 19, 2009
370
371
372
* \brief Returns the number of available display modes for the current display.
*
* \sa SDL_GetDisplayMode()
Apr 26, 2001
Apr 26, 2001
373
*/
Jul 10, 2006
Jul 10, 2006
374
extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(void);
Apr 26, 2001
Apr 26, 2001
375
Jul 10, 2006
Jul 10, 2006
376
/**
Oct 19, 2009
Oct 19, 2009
377
378
379
380
381
382
383
384
385
* \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
386
*/
Aug 5, 2006
Aug 5, 2006
387
388
extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int index,
SDL_DisplayMode * mode);
Apr 26, 2001
Apr 26, 2001
389
Jul 10, 2006
Jul 10, 2006
390
/**
Oct 19, 2009
Oct 19, 2009
391
392
* \brief Fill in information about the desktop display mode for the current
* display.
Jul 10, 2006
Jul 10, 2006
393
*/
Aug 5, 2006
Aug 5, 2006
394
extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(SDL_DisplayMode * mode);
Apr 26, 2001
Apr 26, 2001
395
Jul 10, 2006
Jul 10, 2006
396
/**
Oct 19, 2009
Oct 19, 2009
397
* \brief Fill in information about the current display mode.
Apr 26, 2001
Apr 26, 2001
398
*/
Aug 5, 2006
Aug 5, 2006
399
extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(SDL_DisplayMode * mode);
Apr 26, 2001
Apr 26, 2001
400
Oct 17, 2009
Oct 17, 2009
401
Jul 10, 2006
Jul 10, 2006
402
/**
Oct 19, 2009
Oct 19, 2009
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
* \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
421
*/
Jul 10, 2006
Jul 10, 2006
422
423
424
425
426
427
428
extern DECLSPEC SDL_DisplayMode *SDLCALL SDL_GetClosestDisplayMode(const
SDL_DisplayMode
* mode,
SDL_DisplayMode
* closest);
/**
Oct 19, 2009
Oct 19, 2009
429
430
431
432
433
434
435
436
* \brief Set the display mode used when a fullscreen window is visible
* on the currently selected display.
*
* \param mode The mode to use, or NULL for the desktop mode.
*
* \return 0 on success, or -1 if setting the display mode failed.
*
* \sa SDL_SetWindowFullscreen()
Jul 10, 2006
Jul 10, 2006
437
438
439
*/
extern DECLSPEC int SDLCALL SDL_SetFullscreenDisplayMode(const SDL_DisplayMode
* mode);
Apr 26, 2001
Apr 26, 2001
440
Jul 10, 2006
Jul 10, 2006
441
/**
Oct 19, 2009
Oct 19, 2009
442
443
* \brief Fill in information about the display mode used when a fullscreen
* window is visible on the currently selected display.
Jul 10, 2006
Jul 10, 2006
444
*/
Aug 5, 2006
Aug 5, 2006
445
446
extern DECLSPEC int SDLCALL SDL_GetFullscreenDisplayMode(SDL_DisplayMode *
mode);
Jul 10, 2006
Jul 10, 2006
447
448
/**
Oct 19, 2009
Oct 19, 2009
449
450
451
452
* \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
453
454
455
456
457
458
*/
extern DECLSPEC int SDLCALL SDL_SetDisplayPalette(const SDL_Color * colors,
int firstcolor,
int ncolors);
/**
Oct 19, 2009
Oct 19, 2009
459
460
461
* \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
462
463
464
465
466
467
*/
extern DECLSPEC int SDLCALL SDL_GetDisplayPalette(SDL_Color * colors,
int firstcolor,
int ncolors);
/**
Oct 19, 2009
Oct 19, 2009
468
469
470
471
472
473
* \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
474
*/
Apr 11, 2002
Apr 11, 2002
475
extern DECLSPEC int SDLCALL SDL_SetGamma(float red, float green, float blue);
Apr 26, 2001
Apr 26, 2001
476
Jul 10, 2006
Jul 10, 2006
477
/**
Oct 19, 2009
Oct 19, 2009
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
* \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
493
*/
Jul 10, 2006
Jul 10, 2006
494
495
496
extern DECLSPEC int SDLCALL SDL_SetGammaRamp(const Uint16 * red,
const Uint16 * green,
const Uint16 * blue);
Apr 26, 2001
Apr 26, 2001
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
* \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
511
*/
Jul 10, 2006
Jul 10, 2006
512
513
extern DECLSPEC int SDLCALL SDL_GetGammaRamp(Uint16 * red, Uint16 * green,
Uint16 * blue);
Apr 26, 2001
Apr 26, 2001
514
515
Jul 10, 2006
Jul 10, 2006
516
/**
Oct 19, 2009
Oct 19, 2009
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
* \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
535
536
537
538
539
540
*/
extern DECLSPEC SDL_WindowID SDLCALL SDL_CreateWindow(const char *title,
int x, int y, int w,
int h, Uint32 flags);
/**
Oct 19, 2009
Oct 19, 2009
541
542
543
544
545
546
547
548
549
* \brief Create an SDL window struct from an existing native window.
*
* \param data A pointer to driver-dependent window creation data
*
* \return The id of the window created, or zero if window creation failed.
*
* \warning This function is NOT SUPPORTED, use at your own risk!
*
* \sa SDL_DestroyWindow()
Jul 10, 2006
Jul 10, 2006
550
551
552
553
*/
extern DECLSPEC SDL_WindowID SDLCALL SDL_CreateWindowFrom(const void *data);
/**
Oct 19, 2009
Oct 19, 2009
554
* \brief Get the window flags.
Jul 10, 2006
Jul 10, 2006
555
556
557
558
*/
extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_WindowID windowID);
/**
Oct 19, 2009
Oct 19, 2009
559
560
561
* \brief Set the title of the window, in UTF-8 format.
*
* \sa SDL_GetWindowTitle()
Jul 10, 2006
Jul 10, 2006
562
563
564
565
566
*/
extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_WindowID windowID,
const char *title);
/**
Oct 19, 2009
Oct 19, 2009
567
568
569
* \brief Get the title of the window, in UTF-8 format.
*
* \sa SDL_SetWindowTitle()
Jul 10, 2006
Jul 10, 2006
570
571
572
573
*/
extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_WindowID windowID);
/**
Oct 19, 2009
Oct 19, 2009
574
575
576
* \brief Set the icon of the window.
*
* \param icon The icon for the window.
Jul 10, 2006
Jul 10, 2006
577
*/
Jan 4, 2009
Jan 4, 2009
578
579
extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_WindowID windowID,
SDL_Surface * icon);
Jul 10, 2006
Jul 10, 2006
580
581
/**
Oct 19, 2009
Oct 19, 2009
582
583
584
* \brief Associate an arbitrary pointer with the window.
*
* \sa SDL_GetWindowData()
Jul 10, 2006
Jul 10, 2006
585
586
587
588
589
*/
extern DECLSPEC void SDLCALL SDL_SetWindowData(SDL_WindowID windowID,
void *userdata);
/**
Oct 19, 2009
Oct 19, 2009
590
591
592
* \brief Retrieve the data pointer associated with the window.
*
* \sa SDL_SetWindowData()
Jul 10, 2006
Jul 10, 2006
593
594
595
596
*/
extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_WindowID windowID);
/**
Oct 19, 2009
Oct 19, 2009
597
598
599
600
601
602
603
604
605
606
607
* \brief Set the position of the window.
*
* \param windowID The window to reposition.
* \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
608
609
610
611
612
*/
extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_WindowID windowID,
int x, int y);
/**
Oct 19, 2009
Oct 19, 2009
613
614
615
* \brief Get the position of the window.
*
* \sa SDL_SetWindowPosition()
Jul 10, 2006
Jul 10, 2006
616
617
618
619
620
*/
extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_WindowID windowID,
int *x, int *y);
/**
Oct 19, 2009
Oct 19, 2009
621
622
623
624
625
626
* \brief Set the size of the window's client area.
*
* \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
627
628
629
630
631
*/
extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_WindowID windowID, int w,
int h);
/**
Oct 19, 2009
Oct 19, 2009
632
633
634
* \brief Get the size of the window's client area.
*
* \sa SDL_SetWindowSize()
Jul 10, 2006
Jul 10, 2006
635
636
637
638
639
*/
extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_WindowID windowID, int *w,
int *h);
/**
Oct 19, 2009
Oct 19, 2009
640
641
642
* \brief Show the window.
*
* \sa SDL_HideWindow()
Jul 10, 2006
Jul 10, 2006
643
644
645
646
*/
extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_WindowID windowID);
/**
Oct 19, 2009
Oct 19, 2009
647
648
649
* \brief Hide the window.
*
* \sa SDL_ShowWindow()
Jul 10, 2006
Jul 10, 2006
650
651
652
653
*/
extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_WindowID windowID);
/**
Oct 19, 2009
Oct 19, 2009
654
* \brief Raise the window above other windows and set the input focus.
Jul 10, 2006
Jul 10, 2006
655
656
657
658
*/
extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_WindowID windowID);
/**
Oct 19, 2009
Oct 19, 2009
659
660
661
* \brief Make the window as large as possible.
*
* \sa SDL_RestoreWindow()
Jul 10, 2006
Jul 10, 2006
662
663
664
665
*/
extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_WindowID windowID);
/**
Oct 19, 2009
Oct 19, 2009
666
667
668
* \brief Minimize the window to an iconic representation.
*
* \sa SDL_RestoreWindow()
Jul 10, 2006
Jul 10, 2006
669
670
671
672
*/
extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_WindowID windowID);
/**
Oct 19, 2009
Oct 19, 2009
673
674
675
676
* \brief Restore the size and position of a minimized or maximized window.
*
* \sa SDL_MaximizeWindow()
* \sa SDL_MinimizeWindow()
Jul 10, 2006
Jul 10, 2006
677
678
679
680
*/
extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_WindowID windowID);
/**
Oct 19, 2009
Oct 19, 2009
681
682
683
684
685
* \brief Set the window's fullscreen state.
*
* \return 0 on success, or -1 if setting the display mode failed.
*
* \sa SDL_SetFullscreenDisplayMode()
Jul 10, 2006
Jul 10, 2006
686
687
688
689
690
*/
extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_WindowID windowID,
int fullscreen);
/**
Oct 19, 2009
Oct 19, 2009
691
692
693
694
695
* \brief Set the window's input grab mode.
*
* \param mode This is 1 to grab input, and 0 to release input.
*
* \sa SDL_GetWindowGrab()
Jul 10, 2006
Jul 10, 2006
696
697
698
699
700
*/
extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_WindowID windowID,
int mode);
/**
Oct 19, 2009
Oct 19, 2009
701
702
703
704
705
* \brief Get the window's input grab mode.
*
* \return This returns 1 if input is grabbed, and 0 otherwise.
*
* \sa SDL_SetWindowGrab()
Jul 10, 2006
Jul 10, 2006
706
707
708
709
*/
extern DECLSPEC int SDLCALL SDL_GetWindowGrab(SDL_WindowID windowID);
/**
Oct 19, 2009
Oct 19, 2009
710
711
712
* \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
713
714
715
716
717
718
719
*/
struct SDL_SysWMinfo;
extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_WindowID windowID,
struct SDL_SysWMinfo
*info);
/**
Oct 19, 2009
Oct 19, 2009
720
* \brief Destroy a window.
Jul 10, 2006
Jul 10, 2006
721
722
723
724
*/
extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_WindowID windowID);
/**
Oct 19, 2009
Oct 19, 2009
725
726
727
728
729
730
731
732
733
* \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
734
*/
Aug 6, 2006
Aug 6, 2006
735
extern DECLSPEC int SDLCALL SDL_GetNumRenderDrivers(void);
Jul 10, 2006
Jul 10, 2006
736
737
/**
Oct 19, 2009
Oct 19, 2009
738
739
740
741
742
743
744
745
746
747
* \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
748
*/
Aug 6, 2006
Aug 6, 2006
749
750
extern DECLSPEC int SDLCALL SDL_GetRenderDriverInfo(int index,
SDL_RendererInfo * info);
Jul 10, 2006
Jul 10, 2006
751
752
/**
Oct 19, 2009
Oct 19, 2009
753
754
755
756
757
758
759
760
761
762
763
764
* \brief Create and make active a 2D rendering context for a window.
*
* \param windowID The window used for rendering.
* \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
765
766
767
768
769
*/
extern DECLSPEC int SDLCALL SDL_CreateRenderer(SDL_WindowID windowID,
int index, Uint32 flags);
/**
Oct 19, 2009
Oct 19, 2009
770
771
772
773
* \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
774
775
776
*/
extern DECLSPEC int SDLCALL SDL_SelectRenderer(SDL_WindowID windowID);
Aug 6, 2006
Aug 6, 2006
777
/**
Oct 19, 2009
Oct 19, 2009
778
* \brief Get information about the current rendering context.
Aug 6, 2006
Aug 6, 2006
779
780
781
*/
extern DECLSPEC int SDLCALL SDL_GetRendererInfo(SDL_RendererInfo * info);
Jul 10, 2006
Jul 10, 2006
782
/**
Oct 19, 2009
Oct 19, 2009
783
784
785
786
787
788
789
790
791
792
793
794
795
* \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
796
797
798
799
800
801
*/
extern DECLSPEC SDL_TextureID SDLCALL SDL_CreateTexture(Uint32 format,
int access, int w,
int h);
/**
Oct 19, 2009
Oct 19, 2009
802
803
804
805
806
807
808
809
810
811
812
813
814
* \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
815
816
817
818
819
820
821
*/
extern DECLSPEC SDL_TextureID SDLCALL SDL_CreateTextureFromSurface(Uint32
format,
SDL_Surface
* surface);
/**
Oct 19, 2009
Oct 19, 2009
822
823
824
825
826
827
828
829
830
831
832
* \brief Query the attributes of a texture
*
* \param textureID A texture to be queried.
* \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
833
834
835
836
837
838
*/
extern DECLSPEC int SDLCALL SDL_QueryTexture(SDL_TextureID textureID,
Uint32 * format, int *access,
int *w, int *h);
/**
Oct 19, 2009
Oct 19, 2009
839
840
841
842
843
844
845
846
847
848
849
* \brief Query the pixels of a texture, if the texture does not need to be
* locked for pixel access.
*
* \param textureID A texture to be queried, which was created with
* ::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
850
851
852
853
854
*/
extern DECLSPEC int SDLCALL SDL_QueryTexturePixels(SDL_TextureID textureID,
void **pixels, int *pitch);
/**
Oct 19, 2009
Oct 19, 2009
855
856
857
858
859
860
861
862
863
* \brief Set the color palette of an indexed texture.
*
* \param textureID The texture to update.
* \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
864
865
866
867
868
869
870
*/
extern DECLSPEC int SDLCALL SDL_SetTexturePalette(SDL_TextureID textureID,
const SDL_Color * colors,
int firstcolor,
int ncolors);
/**
Oct 19, 2009
Oct 19, 2009
871
872
873
874
875
876
877
878
879
* \brief Get the color palette from an indexed texture if it has one.
*
* \param textureID The texture to update.
* \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
880
881
882
883
884
885
*/
extern DECLSPEC int SDLCALL SDL_GetTexturePalette(SDL_TextureID textureID,
SDL_Color * colors,
int firstcolor,
int ncolors);
Aug 28, 2006
Aug 28, 2006
886
/**
Oct 19, 2009
Oct 19, 2009
887
888
889
890
891
892
893
894
895
896
897
* \brief Set an additional color value used in render copy operations.
*
* \param textureID The texture to update.
* \param r The red source color value multiplied into copy operations.
* \param g The green source color value multiplied into copy operations.
* \param b The blue source color value multiplied into copy operations.
*
* \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
898
899
900
901
902
903
*/
extern DECLSPEC int SDLCALL SDL_SetTextureColorMod(SDL_TextureID textureID,
Uint8 r, Uint8 g, Uint8 b);
/**
Oct 19, 2009
Oct 19, 2009
904
905
906
907
908
909
910
911
912
913
* \brief Get the additional color value used in render copy operations.
*
* \param textureID The texture to query.
* \param r A pointer filled in with the source red color value.
* \param g A pointer filled in with the source green color value.
* \param b A pointer filled in with the source blue color value.
*
* \return 0 on success, or -1 if the texture is not valid.
*
* \sa SDL_SetTextureColorMod()
Aug 28, 2006
Aug 28, 2006
914
915
916
917
918
919
*/
extern DECLSPEC int SDLCALL SDL_GetTextureColorMod(SDL_TextureID textureID,
Uint8 * r, Uint8 * g,
Uint8 * b);
/**
Oct 19, 2009
Oct 19, 2009
920
921
922
923
924
925
926
927
928
* \brief Set an additional alpha value used in render copy operations.
*
* \param textureID The texture to update.
* \param alpha The source alpha value multiplied into copy operations.
*
* \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
929
930
931
932
933
*/
extern DECLSPEC int SDLCALL SDL_SetTextureAlphaMod(SDL_TextureID textureID,
Uint8 alpha);
/**
Oct 19, 2009
Oct 19, 2009
934
935
936
937
938
939
940
941
* \brief Get the additional alpha value used in render copy operations.
*
* \param textureID The texture to query.
* \param alpha A pointer filled in with the source alpha value.
*
* \return 0 on success, or -1 if the texture is not valid.
*
* \sa SDL_SetTextureAlphaMod()
Aug 28, 2006
Aug 28, 2006
942
943
944
945
946
*/
extern DECLSPEC int SDLCALL SDL_GetTextureAlphaMod(SDL_TextureID textureID,
Uint8 * alpha);
/**
Oct 19, 2009
Oct 19, 2009
947
948
949
950
951
952
953
954
955
956
957
958
* \brief Set the blend mode used for texture copy operations.
*
* \param textureID The texture to update.
* \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
959
960
961
962
963
*/
extern DECLSPEC int SDLCALL SDL_SetTextureBlendMode(SDL_TextureID textureID,
int blendMode);
/**
Oct 19, 2009
Oct 19, 2009
964
965
966
967
968
969
970
971
* \brief Get the blend mode used for texture copy operations.
*
* \param textureID The texture to query.
* \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
972
973
974
975
976
*/
extern DECLSPEC int SDLCALL SDL_GetTextureBlendMode(SDL_TextureID textureID,
int *blendMode);
/**
Oct 19, 2009
Oct 19, 2009
977
978
979
980
981
982
983
984
985
986
987
988
* \brief Set the scale mode used for texture copy operations.
*
* \param textureID The texture to update.
* \param scaleMode ::SDL_TextureScaleMode to use for texture scaling.
*
* \return 0 on success, or -1 if the texture is not valid or the scale mode is
* not supported.
*
* \note If the scale mode is not supported, the closest supported mode is
* chosen.
*
* \sa SDL_GetTextureScaleMode()
Aug 28, 2006
Aug 28, 2006
989
990
991
992
993
*/
extern DECLSPEC int SDLCALL SDL_SetTextureScaleMode(SDL_TextureID textureID,
int scaleMode);
/**
Oct 19, 2009
Oct 19, 2009
994
995
996
997
998
999
1000
* \brief Get the scale mode used for texture copy operations.
*
* \param textureID The texture to query.
* \param scaleMode A pointer filled in with the current scale mode.
*
* \return 0 on success, or -1 if the texture is not valid.
*