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