This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
SDL_video.h
1
2
/*
SDL - Simple DirectMedia Layer
3
Copyright (C) 1997-2006 Sam Lantinga
4
5
This library is free software; you can redistribute it and/or
6
modify it under the terms of the GNU Lesser General Public
7
License as published by the Free Software Foundation; either
8
version 2.1 of the License, or (at your option) any later version.
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
13
Lesser General Public License for more details.
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
18
19
Sam Lantinga
20
slouken@libsdl.org
21
22
*/
23
24
25
26
27
/**
* \file SDL_video.h
*
* Header file for access to the SDL raw framebuffer window
*/
28
29
30
31
#ifndef _SDL_video_h
#define _SDL_video_h
32
#include "SDL_stdinc.h"
33
#include "SDL_error.h"
34
#include "SDL_pixels.h"
35
36
37
38
39
#include "SDL_rwops.h"
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
40
/* *INDENT-OFF* */
41
extern "C" {
42
/* *INDENT-ON* */
43
44
45
46
47
48
#endif
/* Transparency definitions: These define alpha as the opacity of a surface */
#define SDL_ALPHA_OPAQUE 255
#define SDL_ALPHA_TRANSPARENT 0
49
50
51
52
53
/**
* \struct SDL_Rect
*
* \brief A rectangle, with the origin at the upper left.
*/
54
55
56
57
typedef struct SDL_Rect
{
Sint16 x, y;
Uint16 w, h;
58
59
} SDL_Rect;
60
61
62
63
64
65
66
67
68
69
70
/**
* \struct SDL_DisplayMode
*
* \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()
71
*/
72
73
74
75
76
77
typedef struct
{
Uint32 format; /**< pixel format */
int w; /**< width */
int h; /**< height */
int refresh_rate; /**< refresh rate (or zero for unspecified) */
78
void *driverdata; /**< driver-specific data, initialize to 0 */
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
} SDL_DisplayMode;
/**
* \typedef SDL_WindowID
*
* \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()
101
* \sa SDL_SetWindowFullscreen()
102
103
104
105
106
107
108
109
* \sa SDL_SetWindowGrab()
* \sa SDL_SetWindowIcon()
* \sa SDL_SetWindowPosition()
* \sa SDL_SetWindowSize()
* \sa SDL_SetWindowTitle()
* \sa SDL_ShowWindow()
*/
typedef Uint32 SDL_WindowID;
111
112
113
114
/**
* \enum SDL_WindowFlags
*
* \brief The flags on a window
115
116
*
* \sa SDL_GetWindowFlags()
117
118
119
120
*/
typedef enum
{
SDL_WINDOW_FULLSCREEN = 0x00000001, /**< fullscreen window, implies borderless */
121
SDL_WINDOW_OPENGL = 0x00000002, /**< window usable with OpenGL context */
122
SDL_WINDOW_SHOWN = 0x00000004, /**< window is visible */
123
SDL_WINDOW_BORDERLESS = 0x00000008, /**< no window decoration */
124
SDL_WINDOW_RESIZABLE = 0x00000010, /**< window can be resized */
125
126
SDL_WINDOW_MINIMIZED = 0x00000020, /**< minimized */
SDL_WINDOW_MAXIMIZED = 0x00000040, /**< maximized */
127
SDL_WINDOW_INPUT_GRABBED = 0x00000100, /**< window has grabbed input focus */
128
SDL_WINDOW_INPUT_FOCUS = 0x00000200, /**< window has input focus */
129
SDL_WINDOW_MOUSE_FOCUS = 0x00000400, /**< window has mouse focus */
130
131
} SDL_WindowFlags;
132
133
134
135
136
137
138
139
140
141
142
/**
* \def SDL_WINDOWPOS_UNDEFINED
* \brief Used to indicate that you don't care what the window position is.
*/
#define SDL_WINDOWPOS_UNDEFINED 0x7FFFFFF
/**
* \def SDL_WINDOWPOS_CENTERED
* \brief Used to indicate that the window position should be centered.
*/
#define SDL_WINDOWPOS_CENTERED 0x7FFFFFE
143
144
145
146
147
148
149
150
151
152
/**
* \enum SDL_WindowEventID
*
* \brief Event subtype for window events
*/
typedef enum
{
SDL_WINDOWEVENT_NONE, /**< Never used */
SDL_WINDOWEVENT_SHOWN, /**< Window has been shown */
SDL_WINDOWEVENT_HIDDEN, /**< Window has been hidden */
153
SDL_WINDOWEVENT_EXPOSED, /**< Window has been exposed and should be redrawn */
154
155
156
157
158
159
160
161
162
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 */
163
SDL_WINDOWEVENT_CLOSE, /**< The window manager requests that the window be closed */
164
165
} SDL_WindowEventID;
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
/**
* \enum SDL_RendererFlags
*
* \brief Flags used when initializing a render manager.
*/
typedef enum
{
SDL_Renderer_PresentDiscard = 0x00000001, /**< Present leaves the contents of the backbuffer undefined */
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_PresentVSync = 0x00000010, /**< Present is synchronized with the refresh rate */
SDL_Renderer_RenderTarget = 0x00000020, /**< The renderer can create texture render targets */
SDL_Renderer_Accelerated = 0x00000040, /**< The renderer uses hardware acceleration */
SDL_Renderer_Minimal = 0x00000080, /**< The renderer only supports the read/write pixel and present functions */
} SDL_RendererFlags;
/**
* \struct SDL_RendererInfo
*
* \brief Information on the capabilities of a render manager.
*/
typedef struct SDL_RendererInfo
{
const char *name; /**< The name of the renderer */
Uint32 flags; /**< Supported SDL_RendererFlags */
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 */
Uint32 texture_formats[32]; /**< The available texture formats */
int max_texture_width; /**< The maximimum texture width */
int max_texture_height; /**< The maximimum texture height */
} SDL_RendererInfo;
/**
* \enum SDL_TextureAccess
*
* \brief The access pattern allowed for a texture
*/
typedef enum
{
SDL_TextureAccess_Render, /**< Unlockable video memory, rendering allowed */
SDL_TextureAccess_Remote, /**< Unlockable video memory */
SDL_TextureAccess_Local, /**< Lockable system memory */
} SDL_TextureAccess;
/**
* \enum SDL_TextureBlendMode
*
* \brief The blend mode used in SDL_RenderCopy()
*/
typedef enum
{
219
220
221
222
223
SDL_TextureBlendMode_None = 0x00000000, /**< No blending */
SDL_TextureBlendMode_Mask = 0x00000001, /**< dst = A ? src : dst (alpha is mask) */
SDL_TextureBlendMode_Blend = 0x00000002, /**< dst = (src * A) + (dst * (1-A)) */
SDL_TextureBlendMode_Add = 0x00000004, /**< dst = (src * A) + dst */
SDL_TextureBlendMode_Mod = 0x00000008, /**< dst = src * dst */
224
225
226
227
228
229
230
231
232
} SDL_TextureBlendMode;
/**
* \enum SDL_TextureScaleMode
*
* \brief The scale mode used in SDL_RenderCopy()
*/
typedef enum
{
233
234
235
236
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 */
237
238
239
240
241
242
243
244
245
} SDL_TextureScaleMode;
/**
* \typedef SDL_TextureID
*
* \brief An efficient driver-specific representation of pixel data
*/
typedef Uint32 SDL_TextureID;
246
247
248
249
250
251
252
/**
* \typedef SDL_GLContext
*
* \brief An opaque handle to an OpenGL context.
*/
typedef void *SDL_GLContext;
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
/* These are the currently supported flags for the SDL_surface */
/* Used internally (read-only) */
#define SDL_HWSURFACE 0x00000001 /* Surface represents a texture */
#define SDL_PREALLOC 0x00000002 /* Surface uses preallocated memory */
#define SDL_SRCALPHA 0x00000004 /* Blit uses source alpha blending */
#define SDL_SRCCOLORKEY 0x00000008 /* Blit uses a source color key */
#define SDL_RLEACCELOK 0x00000010 /* Private flag */
#define SDL_RLEACCEL 0x00000020 /* Surface is RLE encoded */
/* Evaluates to true if the surface needs to be locked before access */
#define SDL_MUSTLOCK(S) (((S)->flags & (SDL_HWSURFACE|SDL_RLEACCEL)) != 0)
/* This structure should be treated as read-only, except for 'pixels',
which, if not NULL, contains the raw pixel data for the surface.
*/
typedef struct SDL_Surface
{
Uint32 flags; /* Read-only */
SDL_PixelFormat *format; /* Read-only */
int w, h; /* Read-only */
int pitch; /* Read-only */
void *pixels; /* Read-write */
277
278
279
/* texture associated with the surface, if any */
SDL_TextureID textureID;
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
/* information needed for surfaces requiring locks */
int locked;
void *lock_data;
/* clipping information */
SDL_Rect clip_rect; /* Read-only */
/* info for fast blit mapping to other surfaces */
struct SDL_BlitMap *map; /* Private */
/* format version, bumped at every change to invalidate blit maps */
unsigned int format_version; /* Private */
/* Reference count -- used when freeing surface */
int refcount; /* Read-mostly */
} SDL_Surface;
/* typedef for private surface blitting functions */
typedef int (*SDL_blit) (struct SDL_Surface * src, SDL_Rect * srcrect,
struct SDL_Surface * dst, SDL_Rect * dstrect);
302
303
304
305
306
307
308
/**
* \enum SDL_GLattr
*
* \brief OpenGL configuration attributes
*/
typedef enum
{
309
310
311
312
313
314
315
316
317
318
319
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,
320
SDL_GL_ACCUM_ALPHA_SIZE,
321
SDL_GL_STEREO,
322
SDL_GL_MULTISAMPLEBUFFERS,
323
SDL_GL_MULTISAMPLESAMPLES,
324
SDL_GL_ACCELERATED_VISUAL
325
326
327
328
329
} SDL_GLattr;
/* Function prototypes */
330
331
332
333
334
335
/**
* \fn int SDL_GetNumVideoDrivers(void)
*
* \brief Get the number of video drivers compiled into SDL
*
* \sa SDL_GetVideoDriver()
337
extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
339
340
/**
* \fn const char *SDL_GetVideoDriver(int index)
341
*
342
* \brief Get the name of a built in video driver.
343
*
344
345
346
347
* \note The video drivers are presented in the order in which they are
* normally checked during initialization.
*
* \sa SDL_GetNumVideoDrivers()
348
*/
349
extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index);
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
/**
* \fn int SDL_VideoInit(const char *driver_name, Uint32 flags)
*
* \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()
366
*/
367
368
extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name,
Uint32 flags);
370
371
372
373
374
375
376
377
/**
* \fn void SDL_VideoQuit(void)
*
* \brief Shuts down the video subsystem.
*
* This function closes all windows, and restores the original video mode.
*
* \sa SDL_VideoInit()
378
*/
379
extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
381
382
383
384
385
386
387
388
389
390
/**
* \fn const char *SDL_GetCurrentVideoDriver(void)
*
* \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()
391
*/
392
extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
394
395
396
397
/**
* \fn int SDL_GetNumVideoDisplays(void)
*
* \brief Returns the number of available video displays.
398
*
399
* \sa SDL_SelectVideoDisplay()
400
*/
401
extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
403
404
405
406
407
/**
* \fn int SDL_SelectVideoDisplay(int index)
*
* \brief Set the index of the currently selected display.
*
408
409
* \return The index of the currently selected display.
*
410
411
412
413
* \note You can query the currently selected display by passing an index of -1.
*
* \sa SDL_GetNumVideoDisplays()
*/
414
extern DECLSPEC int SDLCALL SDL_SelectVideoDisplay(int index);
415
416
417
418
419
420
421
422
/**
* \fn int SDL_GetNumDisplayModes(void)
*
* \brief Returns the number of available display modes for the current display.
*
* \sa SDL_GetDisplayMode()
*/
423
extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(void);
424
425
426
427
428
429
430
431
432
433
434
435
436
437
/**
* \fn const SDL_DisplayMode *SDL_GetDisplayMode(int index)
*
* \brief Retrieve 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()
*/
438
extern DECLSPEC const SDL_DisplayMode *SDLCALL SDL_GetDisplayMode(int index);
439
440
441
442
443
444
445
/**
* \fn const SDL_DisplayMode *SDL_GetDesktopDisplayMode(void)
*
* \brief Retrieve information about the desktop display mode for the current display.
*/
extern DECLSPEC const SDL_DisplayMode *SDLCALL
446
SDL_GetDesktopDisplayMode(void);
447
448
449
450
451
452
453
/**
* \fn const SDL_DisplayMode *SDL_GetCurrentDisplayMode(void)
*
* \brief Retrieve information about the current display mode.
*/
extern DECLSPEC const SDL_DisplayMode *SDLCALL
454
SDL_GetCurrentDisplayMode(void);
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
/**
* \fn SDL_DisplayMode *SDL_GetClosestDisplayMode(const SDL_DisplayMode *mode, SDL_DisplayMode *closest)
*
* \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 'closest', or NULL if no matching video mode was available.
*
* The available display modes are scanned, and 'closest' is filled in with the closest mode matching the requested mode and returned. The mode format and refresh_rate default to the desktop mode if they are 0. The modes are scanned with size being first priority, format being second priority, and finally checking the refresh_rate. If all the available modes are too small, then NULL is returned.
*
* \sa SDL_GetNumDisplayModes()
* \sa SDL_GetDisplayMode()
*/
471
472
473
474
475
extern DECLSPEC SDL_DisplayMode *SDLCALL SDL_GetClosestDisplayMode(const
SDL_DisplayMode
* mode,
SDL_DisplayMode
* closest);
478
* \fn int SDL_SetFullscreenDisplayMode(const SDL_DisplayMode *mode)
480
481
* \brief Set the display mode used when a fullscreen window is visible
* on the currently selected display.
483
* \param mode The mode to use, or NULL for the desktop mode.
484
485
*
* \return 0 on success, or -1 if setting the display mode failed.
486
487
*
* \sa SDL_SetWindowFullscreen()
489
490
491
492
493
494
495
496
497
498
499
extern DECLSPEC int SDLCALL SDL_SetFullscreenDisplayMode(const SDL_DisplayMode
* mode);
/**
* \fn const SDL_DisplayMode *SDL_GetFullscreenDisplayMode(void)
*
* \brief Query the display mode used when a fullscreen window is visible
* on the currently selected display.
*/
extern DECLSPEC const SDL_DisplayMode *SDLCALL
SDL_GetFullscreenDisplayMode(void);
501
/**
502
* \fn int SDL_SetDisplayPalette(const SDL_Color *colors, int firstcolor, int ncolors)
503
*
504
* \brief Set the palette entries for indexed display modes.
505
*
506
* \return 0 on success, or -1 if the display mode isn't palettized or the colors couldn't be set.
507
*/
508
509
510
511
512
513
514
515
516
517
518
519
520
521
extern DECLSPEC int SDLCALL SDL_SetDisplayPalette(const SDL_Color * colors,
int firstcolor,
int ncolors);
/**
* \fn int SDL_GetDisplayPalette(SDL_Color *colors, int firstcolor, int ncolors)
*
* \brief Gets the palette entries for indexed display modes.
*
* \return 0 on success, or -1 if the display mode isn't palettized
*/
extern DECLSPEC int SDLCALL SDL_GetDisplayPalette(SDL_Color * colors,
int firstcolor,
int ncolors);
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
/**
* \fn int SDL_SetGamma(float red, float green, float blue)
*
* \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()
*/
extern DECLSPEC int SDLCALL SDL_SetGamma(float red, float green, float blue);
/**
* \fn int SDL_SetGammaRamp(const Uint16 * red, const Uint16 * green, const Uint16 * blue)
*
* \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()
*/
extern DECLSPEC int SDLCALL SDL_SetGammaRamp(const Uint16 * red,
const Uint16 * green,
const Uint16 * blue);
/**
* \fn int SDL_GetGammaRamp(Uint16 * red, Uint16 * green, Uint16 * blue)
*
* \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()
*/
extern DECLSPEC int SDLCALL SDL_GetGammaRamp(Uint16 * red, Uint16 * green,
Uint16 * blue);
574
575
576
577
578
579
580
581
582
583
/**
* \fn SDL_WindowID SDL_CreateWindow(const char *title, int x, int y, int w, int h, Uint32 flags)
*
* \brief Create a window with the specified position, dimensions, and flags.
*
* \param title The title of the window
* \param x The x position of the window
* \param y The y position of the window
* \param w The width of the window
* \param h The height of the window
584
* \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
585
586
587
588
589
590
591
*
* \return The id of the window created, or zero if window creation failed.
*
* \note Setting the position to -1, -1, indicates any position is fine.
*
* \sa SDL_DestroyWindow()
*/
592
593
594
extern DECLSPEC SDL_WindowID SDLCALL SDL_CreateWindow(const char *title,
int x, int y, int w,
int h, Uint32 flags);
595
596
597
598
599
600
601
602
603
604
605
606
607
608
/**
* \fn SDL_WindowID SDL_CreateWindowFrom(void *data)
*
* \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()
*/
609
extern DECLSPEC SDL_WindowID SDLCALL SDL_CreateWindowFrom(const void *data);
610
611
612
613
614
615
/**
* \fn Uint32 SDL_GetWindowFlags(SDL_WindowID windowID)
*
* \brief Get the window flags.
*/
616
extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_WindowID windowID);
617
618
619
620
621
622
623
624
/**
* \fn void SDL_SetWindowTitle(SDL_WindowID windowID, const char *title)
*
* \brief Set the title of the window, in UTF-8 format.
*
* \sa SDL_GetWindowTitle()
*/
625
626
extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_WindowID windowID,
const char *title);
627
628
629
630
631
632
633
634
/**
* \fn const char *SDL_GetWindowTitle(SDL_WindowID windowID)
*
* \brief Get the title of the window, in UTF-8 format.
*
* \sa SDL_SetWindowTitle()
*/
635
extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_WindowID windowID);
636
637
638
639
640
641
642
643
644
645
/**
* \fn void SDL_SetWindowIcon(SDL_Surface *icon)
*
* \brief Set the icon of the window.
*
* \param icon The icon for the window
*
* FIXME: The icon needs to be set before the window is first shown. Should some icon representation be part of the window creation data?
*/
646
extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Surface * icon);
647
648
649
650
651
652
653
654
/**
* \fn void SDL_SetWindowData(SDL_WindowID windowID, void *userdata)
*
* \brief Associate an arbitrary pointer with the window.
*
* \sa SDL_GetWindowData()
*/
655
656
extern DECLSPEC void SDLCALL SDL_SetWindowData(SDL_WindowID windowID,
void *userdata);
657
658
659
660
661
662
663
664
/**
* \fn void *SDL_GetWindowData(SDL_WindowID windowID)
*
* \brief Retrieve the data pointer associated with the window.
*
* \sa SDL_SetWindowData()
*/
665
extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_WindowID windowID);
666
667
668
669
670
671
/**
* \fn void SDL_SetWindowPosition(SDL_WindowID windowID, int x, int y)
*
* \brief Set the position of the window.
*
672
673
674
675
676
677
* \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.
*
678
679
* \sa SDL_GetWindowPosition()
*/
680
681
extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_WindowID windowID,
int x, int y);
682
683
684
685
686
687
688
689
/**
* \fn void SDL_GetWindowPosition(SDL_WindowID windowID, int *x, int *y)
*
* \brief Get the position of the window.
*
* \sa SDL_SetWindowPosition()
*/
690
691
extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_WindowID windowID,
int *x, int *y);
692
693
694
695
696
697
698
699
700
701
702
/**
* \fn void SDL_SetWindowSize(SDL_WindowID windowID, int w, int w)
*
* \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()
*/
703
704
extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_WindowID windowID, int w,
int h);
705
706
707
708
709
710
711
712
/**
* \fn void SDL_GetWindowSize(SDL_WindowID windowID, int *w, int *w)
*
* \brief Get the size of the window's client area.
*
* \sa SDL_SetWindowSize()
*/
713
714
extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_WindowID windowID, int *w,
int *h);
715
716
717
718
719
720
721
722
/**
* \fn void SDL_ShowWindow(SDL_WindowID windowID)
*
* \brief Show the window
*
* \sa SDL_HideWindow()
*/
723
extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_WindowID windowID);
724
725
726
727
728
729
730
731
/**
* \fn void SDL_HideWindow(SDL_WindowID windowID)
*
* \brief Hide the window
*
* \sa SDL_ShowWindow()
*/
732
extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_WindowID windowID);
733
734
735
736
/**
* \fn void SDL_RaiseWindow(SDL_WindowID windowID)
*
737
* \brief Raise the window above other windows and set the input focus.
739
extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_WindowID windowID);
740
741
742
743
744
745
746
747
/**
* \fn void SDL_MaximizeWindow(SDL_WindowID windowID)
*
* \brief Make the window as large as possible.
*
* \sa SDL_RestoreWindow()
*/
748
extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_WindowID windowID);
749
750
751
752
753
754
755
756
/**
* \fn void SDL_MinimizeWindow(SDL_WindowID windowID)
*
* \brief Minimize the window to an iconic representation.
*
* \sa SDL_RestoreWindow()
*/
757
extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_WindowID windowID);
758
759
760
761
762
763
764
765
766
/**
* \fn void SDL_RestoreWindow(SDL_WindowID windowID)
*
* \brief Restore the size and position of a minimized or maximized window.
*
* \sa SDL_MaximizeWindow()
* \sa SDL_MinimizeWindow()
*/
767
extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_WindowID windowID);
769
770
771
772
773
774
775
776
777
778
779
780
/**
* \fn int SDL_SetWindowFullscreen(SDL_WindowID windowID, int fullscreen)
*
* \brief Set the window's fullscreen state.
*
* \return 0 on success, or -1 if setting the display mode failed.
*
* \sa SDL_SetFullscreenDisplayMode()
*/
extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_WindowID windowID,
int fullscreen);
781
782
783
784
785
786
787
788
789
/**
* \fn void SDL_SetWindowGrab(SDL_WindowID windowID, int mode)
*
* \brief Set the window's input grab mode.
*
* \param mode This is 1 to grab input, and 0 to release input.
*
* \sa SDL_GetWindowGrab()
*/
790
791
extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_WindowID windowID,
int mode);
792
793
794
795
796
797
798
799
800
801
/**
* \fn int SDL_GetWindowGrab(SDL_WindowID windowID)
*
* \brief Get the window's input grab mode.
*
* \return This returns 1 if input is grabbed, and 0 otherwise.
*
* \sa SDL_SetWindowGrab()
*/
802
extern DECLSPEC int SDLCALL SDL_GetWindowGrab(SDL_WindowID windowID);
804
805
806
807
808
809
810
811
812
813
814
815
/**
* \fn SDL_bool SDL_GetWindowWMInfo(SDL_WindowID windowID, struct SDL_SysWMinfo * info)
*
* \brief Get driver specific information about a window.
*
* \note Include SDL_syswm.h for the declaration of SDL_SysWMinfo.
*/
struct SDL_SysWMinfo;
extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_WindowID windowID,
struct SDL_SysWMinfo
*info);
816
817
818
819
820
/**
* \fn void SDL_DestroyWindow(SDL_WindowID windowID)
*
* \brief Destroy a window.
*/
821
extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_WindowID windowID);
824
* \fn int SDL_GetNumRenderers(void)
826
827
828
829
830
831
832
833
* \brief Get the number of render managers on the current display.
*
* A render manager 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_GetRendererInfo()
* \sa SDL_CreateRenderer()
835
extern DECLSPEC int SDLCALL SDL_GetNumRenderers(void);
837
838
839
840
841
842
843
/**
* \fn SDL_RendererInfo *SDL_GetRendererInfo(int index)
*
* \brief Get information about a specific render manager on the current
* display.
*
* \sa SDL_CreateRenderer()
844
*/
845
846
extern DECLSPEC int SDLCALL SDL_GetRendererInfo(int index,
SDL_RendererInfo * info);
848
849
850
851
852
/**
* \fn int SDL_CreateRenderer(SDL_WindowID window, int index, Uint32 flags)
*
* \brief Create and make active a 2D rendering context for a window.
*
853
* \param windowID The window used for rendering
854
855
856
857
858
859
860
861
* \param index The index of the render manager to initialize, or -1 to initialize the first one supporting the requested flags.
* \param flags SDL_RendererFlags
*
* \return 0 on success, -1 if the flags were not supported, or -2 if
* there isn't enough memory to support the requested flags
*
* \sa SDL_SelectRenderer()
* \sa SDL_DestroyRenderer()
862
*/
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
extern DECLSPEC int SDLCALL SDL_CreateRenderer(SDL_WindowID windowID,
int index, Uint32 flags);
/**
* \fn int SDL_SelectRenderer(SDL_WindowID windowID)
*
* \brief Select the rendering context for a particular window.
*
* \return 0 on success, -1 if the selected window doesn't have a
* rendering context.
*/
extern DECLSPEC int SDLCALL SDL_SelectRenderer(SDL_WindowID windowID);
/**
* \fn SDL_TextureID SDL_CreateTexture(Uint32 format, int access, int w, int h)
*
879
* \brief Create a texture for the current rendering context.
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
*
* \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 render manager was active, the format was unsupported, or the width or height were out of range.
*
* \sa SDL_QueryTexture()
* \sa SDL_DestroyTexture()
*/
extern DECLSPEC SDL_TextureID SDLCALL SDL_CreateTexture(Uint32 format,
int access, int w,
int h);
/**
* \fn SDL_TextureID SDL_CreateTextureFromSurface(Uint32 format, int access, SDL_Surface *surface)
*
898
* \brief Create a texture from an existing surface.
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
*
* \param format The format of the texture, or 0 to pick an appropriate format
* \param access One of the enumerated values in SDL_TextureAccess
* \param surface The surface containing pixel data used to fill the texture
*
* \return The created texture is returned, or 0 if no render manager was active, the format was unsupported, or the surface width or height were out of range.
*
* \note The surface is not modified or freed by this function.
*
* \sa SDL_QueryTexture()
* \sa SDL_DestroyTexture()
*/
extern DECLSPEC SDL_TextureID SDLCALL SDL_CreateTextureFromSurface(Uint32
format,
int access,
SDL_Surface
* surface);
/**
* \fn int SDL_QueryTexture(SDL_TextureID textureID, Uint32 *format, int *access, int *w, int *h)
*
* \brief Query the attributes of a texture
*
* \param texture 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
*/
extern DECLSPEC int SDLCALL SDL_QueryTexture(SDL_TextureID textureID,
Uint32 * format, int *access,
int *w, int *h);
934
935
936
937
938
939
940
941
942
943
944
945
946
947
/**
* \fn int SDL_QueryTexturePixels(SDL_TextureID textureID, void **pixels, int pitch)
*
* \brief Query the pixels of a texture, if the texture does not need to be locked for pixel access.
*
* \param texture A texture to be queried, which was created with SDL_TextureAccess_Local
* \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.
*/
extern DECLSPEC int SDLCALL SDL_QueryTexturePixels(SDL_TextureID textureID,
void **pixels, int *pitch);
948
/**
949
* \fn int SDL_SetTexturePalette(SDL_TextureID textureID, const SDL_Color * colors, int firstcolor, int ncolors)
950
951
952
953
954
955
956
957
958
959
960
*
* \brief Update an indexed texture with a color palette
*
* \param texture 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
*/
extern DECLSPEC int SDLCALL SDL_SetTexturePalette(SDL_TextureID textureID,
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
const SDL_Color * colors,
int firstcolor,
int ncolors);
/**
* \fn int SDL_GetTexturePalette(SDL_TextureID textureID, SDL_Color * colors, int firstcolor, int ncolors)
*
* \brief Update an indexed texture with a color palette
*
* \param texture 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
*/
extern DECLSPEC int SDLCALL SDL_GetTexturePalette(SDL_TextureID textureID,
978
979
980
981
982
SDL_Color * colors,
int firstcolor,
int ncolors);
/**
983
* \fn int SDL_UpdateTexture(SDL_TextureID textureID, const SDL_Rect *rect, const void *pixels, int pitch)
984
985
986
987
988
989
990
991
992
993
994
995
996
*
* \brief Update the given texture rectangle with new pixel data.
*
* \param texture The texture to update
* \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 very slow function for textures not created with SDL_TextureAccess_Local.
*/
extern DECLSPEC int SDLCALL SDL_UpdateTexture(SDL_TextureID textureID,
997
const SDL_Rect * rect,
998
999
1000
const void *pixels, int pitch);
/**