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