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