This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_video.h
790 lines (702 loc) · 24.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
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
typedef struct SDL_Window SDL_Window;
92
93
/**
94
95
96
* \brief The flags on a window
*
* \sa SDL_GetWindowFlags()
97
98
99
100
101
102
103
104
*/
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 */
105
106
SDL_WINDOW_MINIMIZED = 0x00000020, /**< window is minimized */
SDL_WINDOW_MAXIMIZED = 0x00000040, /**< window is maximized */
107
108
SDL_WINDOW_INPUT_GRABBED = 0x00000100, /**< window has grabbed input focus */
SDL_WINDOW_INPUT_FOCUS = 0x00000200, /**< window has input focus */
109
110
SDL_WINDOW_MOUSE_FOCUS = 0x00000400, /**< window has mouse focus */
SDL_WINDOW_FOREIGN = 0x00000800 /**< window not created by SDL */
111
112
113
} SDL_WindowFlags;
/**
114
* \brief Used to indicate that you don't care what the window position is.
115
116
*/
#define SDL_WINDOWPOS_UNDEFINED 0x7FFFFFF
117
118
/**
119
* \brief Used to indicate that the window position should be centered.
120
121
122
123
*/
#define SDL_WINDOWPOS_CENTERED 0x7FFFFFE
/**
124
* \brief Event subtype for window events
125
126
127
*/
typedef enum
{
128
129
130
131
132
133
134
135
136
137
138
139
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 */
140
141
142
143
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 */
144
145
SDL_WINDOWEVENT_CLOSE /**< The window manager requests that the
window be closed */
146
147
148
} SDL_WindowEventID;
/**
149
* \brief An opaque handle to an OpenGL context.
150
151
152
153
*/
typedef void *SDL_GLContext;
/**
154
* \brief OpenGL configuration attributes
155
156
157
*/
typedef enum
{
158
159
160
161
162
163
164
165
166
167
168
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,
169
SDL_GL_ACCUM_ALPHA_SIZE,
170
SDL_GL_STEREO,
171
SDL_GL_MULTISAMPLEBUFFERS,
172
SDL_GL_MULTISAMPLESAMPLES,
173
SDL_GL_ACCELERATED_VISUAL,
174
SDL_GL_RETAINED_BACKING,
175
176
SDL_GL_CONTEXT_MAJOR_VERSION,
SDL_GL_CONTEXT_MINOR_VERSION
177
178
179
180
181
} SDL_GLattr;
/* Function prototypes */
182
/**
183
184
185
* \brief Get the number of video drivers compiled into SDL
*
* \sa SDL_GetVideoDriver()
186
187
188
189
*/
extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
/**
190
191
192
193
194
195
* \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()
196
197
198
199
*/
extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index);
/**
200
201
202
203
204
205
206
207
208
209
210
211
* \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()
212
*/
213
extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name);
214
215
/**
216
217
218
219
220
* \brief Shuts down the video subsystem.
*
* This function closes all windows, and restores the original video mode.
*
* \sa SDL_VideoInit()
221
*/
222
extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
223
224
/**
225
226
227
228
229
230
231
* \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()
232
*/
233
extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
234
235
/**
236
237
* \brief Returns the number of available video displays.
*
238
* \sa SDL_GetDisplayBounds()
239
* \sa SDL_SelectVideoDisplay()
240
*/
241
extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
242
243
244
245
246
247
248
249
250
251
252
/**
* \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);
253
/**
254
255
256
257
258
259
* \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()
260
*/
261
extern DECLSPEC int SDLCALL SDL_SelectVideoDisplay(int index);
262
263
/**
264
265
266
267
268
269
* \brief Get the index of the currently selected display.
*
* \return The index of the currently selected display.
*
* \sa SDL_GetNumVideoDisplays()
* \sa SDL_SelectVideoDisplay()
270
271
272
*/
extern DECLSPEC int SDLCALL SDL_GetCurrentVideoDisplay(void);
273
/**
274
275
276
* \brief Returns the number of available display modes for the current display.
*
* \sa SDL_GetDisplayMode()
277
*/
278
extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(void);
279
280
/**
281
282
283
284
285
286
287
288
289
* \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()
290
*/
291
292
extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int index,
SDL_DisplayMode * mode);
293
294
/**
295
296
* \brief Fill in information about the desktop display mode for the current
* display.
297
*/
298
extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(SDL_DisplayMode * mode);
299
300
/**
301
* \brief Fill in information about the current display mode.
302
*/
303
extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(SDL_DisplayMode * mode);
304
305
306
/**
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
* \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()
325
*/
326
327
328
329
330
331
332
extern DECLSPEC SDL_DisplayMode *SDLCALL SDL_GetClosestDisplayMode(const
SDL_DisplayMode
* mode,
SDL_DisplayMode
* closest);
/**
333
* \brief Set the display mode used when a fullscreen window is visible
334
335
* on the currently selected display. By default the window's
* dimensions and the desktop format and refresh rate are used.
336
*
337
* \param mode The mode to use, or NULL for the default mode.
338
339
340
*
* \return 0 on success, or -1 if setting the display mode failed.
*
341
* \sa SDL_GetWindowDisplayMode()
342
* \sa SDL_SetWindowFullscreen()
343
*/
344
extern DECLSPEC int SDLCALL SDL_SetWindowDisplayMode(SDL_Window * window,
345
const SDL_DisplayMode
346
* mode);
347
348
/**
349
350
* \brief Fill in information about the display mode used when a fullscreen
* window is visible on the currently selected display.
351
352
353
*
* \sa SDL_SetWindowDisplayMode()
* \sa SDL_SetWindowFullscreen()
354
*/
355
extern DECLSPEC int SDLCALL SDL_GetWindowDisplayMode(SDL_Window * window,
356
SDL_DisplayMode * mode);
357
358
359
360
361
362
/**
* \brief Get the pixel format associated with the window.
*/
extern DECLSPEC Uint32 SDLCALL SDL_GetWindowPixelFormat(SDL_Window * window);
363
/**
364
365
366
367
368
369
* \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()
370
*/
371
extern DECLSPEC int SDLCALL SDL_SetGamma(float red, float green, float blue);
372
373
/**
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
* \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()
389
*/
390
391
392
extern DECLSPEC int SDLCALL SDL_SetGammaRamp(const Uint16 * red,
const Uint16 * green,
const Uint16 * blue);
393
394
/**
395
396
397
398
399
400
401
402
403
404
405
406
* \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()
407
*/
408
409
extern DECLSPEC int SDLCALL SDL_GetGammaRamp(Uint16 * red, Uint16 * green,
Uint16 * blue);
410
411
412
/**
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
* \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()
431
*/
432
extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title,
433
434
435
436
int x, int y, int w,
int h, Uint32 flags);
/**
437
* \brief Create an SDL window from an existing native window.
438
439
440
441
442
443
*
* \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()
444
*/
445
446
447
extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowFrom(const void *data);
/**
448
* \brief Get the numeric ID of a window, for logging purposes.
449
450
451
452
453
454
455
*/
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);
456
457
/**
458
* \brief Get the window flags.
459
*/
460
extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_Window * window);
461
462
/**
463
* \brief Set the title of a window, in UTF-8 format.
464
465
*
* \sa SDL_GetWindowTitle()
466
*/
467
extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_Window * window,
468
469
470
const char *title);
/**
471
* \brief Get the title of a window, in UTF-8 format.
472
473
*
* \sa SDL_SetWindowTitle()
474
*/
475
extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_Window * window);
476
477
/**
478
* \brief Set the icon for a window.
479
*
480
* \param icon The icon for the window.
481
*/
482
extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Window * window,
483
SDL_Surface * icon);
484
485
/**
486
* \brief Associate an arbitrary named pointer with a window.
487
*
488
489
490
491
492
493
494
495
* \param window The window to associate with the pointer.
* \param name The name of the pointer.
* \param userdata The associated pointer.
*
* \return The previous value associated with 'name'
*
* \note The name is case-sensitive.
*
496
* \sa SDL_GetWindowData()
497
*/
498
499
500
extern DECLSPEC void* SDLCALL SDL_SetWindowData(SDL_Window * window,
const char *name,
void *userdata);
501
502
/**
503
* \brief Retrieve the data pointer associated with a window.
504
*
505
506
507
508
509
* \param window The window to query.
* \param name The name of the pointer.
*
* \return The value associated with 'name'
*
510
* \sa SDL_SetWindowData()
511
*/
512
513
extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_Window * window,
const char *name);
514
515
/**
516
* \brief Set the position of a window.
517
*
518
* \param window The window to reposition.
519
520
521
522
523
524
525
526
* \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()
527
*/
528
extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_Window * window,
529
530
531
int x, int y);
/**
532
* \brief Get the position of a window.
533
534
*
* \sa SDL_SetWindowPosition()
535
*/
536
extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_Window * window,
537
538
539
int *x, int *y);
/**
540
* \brief Set the size of a window's client area.
541
542
543
544
545
*
* \note You can't change the size of a fullscreen window, it automatically
* matches the size of the display mode.
*
* \sa SDL_GetWindowSize()
546
*/
547
extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_Window * window, int w,
548
549
550
int h);
/**
551
* \brief Get the size of a window's client area.
552
553
*
* \sa SDL_SetWindowSize()
554
*/
555
extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_Window * window, int *w,
556
557
558
int *h);
/**
559
* \brief Show a window.
560
561
*
* \sa SDL_HideWindow()
562
*/
563
extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_Window * window);
564
565
/**
566
* \brief Hide a window.
567
568
*
* \sa SDL_ShowWindow()
569
*/
570
extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_Window * window);
571
572
/**
573
* \brief Raise a window above other windows and set the input focus.
574
*/
575
extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_Window * window);
576
577
/**
578
* \brief Make a window as large as possible.
579
580
*
* \sa SDL_RestoreWindow()
581
*/
582
extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_Window * window);
583
584
/**
585
* \brief Minimize a window to an iconic representation.
586
587
*
* \sa SDL_RestoreWindow()
588
*/
589
extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_Window * window);
590
591
/**
592
593
594
595
* \brief Restore the size and position of a minimized or maximized window.
*
* \sa SDL_MaximizeWindow()
* \sa SDL_MinimizeWindow()
596
*/
597
extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_Window * window);
598
599
/**
600
* \brief Set a window's fullscreen state.
601
602
603
*
* \return 0 on success, or -1 if setting the display mode failed.
*
604
605
* \sa SDL_SetWindowDisplayMode()
* \sa SDL_GetWindowDisplayMode()
606
*/
607
extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_Window * window,
608
609
610
int fullscreen);
/**
611
* \brief Set a window's input grab mode.
612
613
614
615
*
* \param mode This is 1 to grab input, and 0 to release input.
*
* \sa SDL_GetWindowGrab()
616
*/
617
extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_Window * window,
618
619
620
int mode);
/**
621
* \brief Get a window's input grab mode.
622
623
624
625
*
* \return This returns 1 if input is grabbed, and 0 otherwise.
*
* \sa SDL_SetWindowGrab()
626
*/
627
extern DECLSPEC int SDLCALL SDL_GetWindowGrab(SDL_Window * window);
628
629
/**
630
631
632
* \brief Get driver specific information about a window.
*
* \note Include SDL_syswm.h for the declaration of SDL_SysWMinfo.
633
634
*/
struct SDL_SysWMinfo;
635
extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_Window * window,
636
637
638
639
struct SDL_SysWMinfo
*info);
/**
640
* \brief Destroy a window.
641
*/
642
extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_Window * window);
643
644
645
/**
646
* \brief Returns whether the screensaver is currently enabled (default on).
647
648
649
*
* \sa SDL_EnableScreenSaver()
* \sa SDL_DisableScreenSaver()
650
*/
651
extern DECLSPEC SDL_bool SDLCALL SDL_IsScreenSaverEnabled(void);
652
653
/**
654
655
656
657
* \brief Allow the screen to be blanked by a screensaver
*
* \sa SDL_IsScreenSaverEnabled()
* \sa SDL_DisableScreenSaver()
658
*/
659
extern DECLSPEC void SDLCALL SDL_EnableScreenSaver(void);
660
661
/**
662
663
664
665
* \brief Prevent the screen from being blanked by a screensaver
*
* \sa SDL_IsScreenSaverEnabled()
* \sa SDL_EnableScreenSaver()
666
*/
667
extern DECLSPEC void SDLCALL SDL_DisableScreenSaver(void);
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
/**
* \name OpenGL support functions
*/
/*@{*/
/**
* \brief Dynamically load an OpenGL library.
*
* \param path The platform dependent OpenGL library name, or NULL to open the
* default OpenGL library.
*
* \return 0 on success, or -1 if the library couldn't be loaded.
*
* This should be done after initializing the video driver, but before
* creating any OpenGL windows. If no OpenGL library is loaded, the default
* library will be loaded upon creation of the first OpenGL window.
*
* \note If you do this, you need to retrieve all of the GL functions used in
* your program from the dynamic library using SDL_GL_GetProcAddress().
*
* \sa SDL_GL_GetProcAddress()
* \sa SDL_GL_UnloadLibrary()
692
693
*/
extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path);
694
695
/**
696
* \brief Get the address of an OpenGL function.
697
698
*/
extern DECLSPEC void *SDLCALL SDL_GL_GetProcAddress(const char *proc);
699
700
/**
701
702
703
* \brief Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().
*
* \sa SDL_GL_LoadLibrary()
704
705
706
*/
extern DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void);
707
/**
708
709
* \brief Return true if an OpenGL extension is supported for the current
* context.
710
711
712
713
*/
extern DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported(const char
*extension);
714
/**
715
* \brief Set an OpenGL window attribute before window creation.
716
717
*/
extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value);
718
719
/**
720
* \brief Get the actual value for an attribute from the current context.
721
*/
722
extern DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int *value);
723
724
/**
725
726
727
728
* \brief Create an OpenGL context for use with an OpenGL window, and make it
* current.
*
* \sa SDL_GL_DeleteContext()
729
*/
730
731
extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window *
window);
732
733
/**
734
735
736
* \brief Set up an OpenGL context for rendering into an OpenGL window.
*
* \note The context must have been created with a compatible window.
737
*/
738
extern DECLSPEC int SDLCALL SDL_GL_MakeCurrent(SDL_Window * window,
739
SDL_GLContext context);
740
741
/**
742
743
744
745
746
747
748
749
* \brief Set the swap interval for the current OpenGL context.
*
* \param interval 0 for immediate updates, 1 for updates synchronized with the
* vertical retrace.
*
* \return 0 on success, or -1 if setting the swap interval is not supported.
*
* \sa SDL_GL_GetSwapInterval()
750
*/
751
extern DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval);
752
753
/**
754
755
756
757
758
759
760
* \brief Get the swap interval for the current OpenGL context.
*
* \return 0 if there is no vertical retrace synchronization, 1 if the buffer
* swap is synchronized with the vertical retrace, and -1 if getting
* the swap interval is not supported.
*
* \sa SDL_GL_SetSwapInterval()
761
*/
762
extern DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(void);
763
764
/**
765
* \brief Swap the OpenGL buffers for a window, if double-buffering is
766
* supported.
767
*/
768
extern DECLSPEC void SDLCALL SDL_GL_SwapWindow(SDL_Window * window);
769
770
/**
771
772
773
* \brief Delete an OpenGL context.
*
* \sa SDL_GL_CreateContext()
774
*/
775
extern DECLSPEC void SDLCALL SDL_GL_DeleteContext(SDL_GLContext context);
776
777
778
/*@}*//*OpenGL support functions*/
779
780
781
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
782
/* *INDENT-OFF* */
783
}
784
/* *INDENT-ON* */
785
786
787
788
#endif
#include "close_code.h"
#endif /* _SDL_video_h */
789
790
/* vi: set ts=4 sw=4 expandtab: */