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