Edit

SDL.SDLVideo

Types

TypeDescription
TSDLWindowAn SDL Window.
TSDLGLContextAn Open GL context.
TSDLDisplayRepresents an indexed video display.
TSDLDisplayModeThe description of a display mode.

Functions

Function SDLGetVideoDrivers:String[]()

Returns the list of built-in video drivers.

The video drivers are presented in the order in which they are normally checked during initialization.


Function SDLVideoInit:Int(driver:String)

Initializes the video subsystem, optionally specifying a video driver.

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.


Function SDLVideoQuit()

Shuts down the video subsystem.

Closes all windows, and restores the original video mode.


Function SDLGetCurrentVideoDriver:String()

Gets the name of the currently initialized video driver.

Returns

The name of the current video driver or NULL if no driver has been initialized.


Function SDLGetNumVideoDisplays:Int()

Gets the number of available video displays.

Returns

A number >= 1 or a negative error code on failure. Call SDLGetError() for more information.


Function SDLGetGrabbedWindow:TSDLWindow()

Gets the window that currently has an input grab enabled.

Returns

The window if input is grabbed, and Null otherwise.


Function SDLIsScreenSaverEnabled:Int()

Returns whether the screensaver is currently enabled (Default off).

The screensaver is disabled by default since SDL 2.0.2. Before SDL 2.0.2 the screensaver was enabled by default.


Function SDLEnableScreenSaver()

Allows the screen to be blanked by a screensaver.


Function SDLDisableScreenSaver()

Prevents the screen from being blanked by a screensaver.

If you disable the screensaver, it is automatically re-enabled when SDL quits.


Consts

Const SDL_WINDOW_FULLSCREEN:UInt = $00000001

fullscreen window


Const SDL_WINDOW_OPENGL:UInt = $00000002

window usable with OpenGL context


Const SDL_WINDOW_SHOWN:UInt = $00000004

window is visible


Const SDL_WINDOW_HIDDEN:UInt = $00000008

window is not visible


Const SDL_WINDOW_BORDERLESS:UInt = $00000010

no window decoration


Const SDL_WINDOW_RESIZABLE:UInt = $00000020

window can be resized


Const SDL_WINDOW_MINIMIZED:UInt = $00000040

window is minimized


Const SDL_WINDOW_MAXIMIZED:UInt = $00000080

window is maximized


Const SDL_WINDOW_INPUT_GRABBED:UInt = $00000100

window has grabbed input focus


Const SDL_WINDOW_INPUT_FOCUS:UInt = $00000200

window has input focus


Const SDL_WINDOW_MOUSE_FOCUS:UInt = $00000400

window has mouse focus


Const SDL_WINDOW_FULLSCREEN_DESKTOP:UInt = SDL_WINDOW_FULLSCREEN | $00001000

full screen desktop


Const SDL_WINDOW_FOREIGN:UInt = $00000800

window not created by SDL


Const SDL_WINDOW_ALLOW_HIGHDPI:UInt = $00002000

window should be created in high-DPI mode if supported


Const SDL_WINDOW_MOUSE_CAPTURE:UInt = $00004000

window has mouse captured (unrelated to INPUT_GRABBED)


Const SDL_WINDOW_ALWAYS_ON_TOP:UInt = $00008000

window should always be above others


Const SDL_WINDOW_SKIP_TASKBAR:UInt = $00010000

window should not be added to the taskbar


Const SDL_WINDOW_UTILITY:UInt = $00020000

window should be treated as a utility window


Const SDL_WINDOW_TOOLTIP:UInt = $00040000

window should be treated as a tooltip


Const SDL_WINDOW_POPUP_MENU:UInt = $00080000

window should be treated as a popup menu


Const SDL_WINDOW_VULKAN:UInt = $10000000

window usable for Vulkan surface


Const SDL_GL_RED_SIZE:Int = 0

the minimum number of bits for the red channel of the color buffer; defaults to 3


Const SDL_GL_GREEN_SIZE:Int = 1

the minimum number of bits for the green channel of the color buffer; defaults to 3


Const SDL_GL_BLUE_SIZE:Int = 2

the minimum number of bits for the blue channel of the color buffer; defaults to 2


Const SDL_GL_ALPHA_SIZE:Int = 3

the minimum number of bits for the alpha channel of the color buffer; defaults to 0


Const SDL_GL_BUFFER_SIZE:Int = 4

the minimum number of bits for frame buffer size; defaults to 0


Const SDL_GL_DOUBLEBUFFER:Int = 5

whether the output is single or double buffered; defaults to double buffering on


Const SDL_GL_DEPTH_SIZE:Int = 6

the minimum number of bits in the depth buffer; defaults to 16


Const SDL_GL_STENCIL_SIZE:Int = 7

the minimum number of bits in the stencil buffer; defaults to 0


Const SDL_GL_ACCUM_RED_SIZE:Int = 8

the minimum number of bits for the red channel of the accumulation buffer; defaults to 0


Const SDL_GL_ACCUM_GREEN_SIZE:Int = 9

the minimum number of bits for the green channel of the accumulation buffer; defaults to 0


Const SDL_GL_ACCUM_BLUE_SIZE:Int = 10

the minimum number of bits for the blue channel of the accumulation buffer; defaults to 0


Const SDL_GL_ACCUM_ALPHA_SIZE:Int = 11

the minimum number of bits for the alpha channel of the accumulation buffer; defaults to 0


Const SDL_GL_STEREO:Int = 12

whether the output is stereo 3D; defaults to off


Const SDL_GL_MULTISAMPLEBUFFERS:Int = 13

the number of buffers used for multisample anti-aliasing; defaults to 0; see Remarks for details


Const SDL_GL_MULTISAMPLESAMPLES:Int = 14

the number of samples used around the current pixel used for multisample anti-aliasing; defaults to 0; see Remarks for details


Const SDL_GL_ACCELERATED_VISUAL:Int = 15

set to 1 to require hardware acceleration, set to 0 to force software rendering; defaults to allow either


Const SDL_GL_RETAINED_BACKING:Int = 16

not used (deprecated)


Const SDL_GL_CONTEXT_MAJOR_VERSION:Int = 17

OpenGL context major version; see Remarks for details


Const SDL_GL_CONTEXT_MINOR_VERSION:Int = 18

OpenGL context minor version; see Remarks for details


Const SDL_GL_CONTEXT_FLAGS:Int = 19

some combination of 0 or more of elements of the SDL_GLcontextFlag enumeration; defaults to 0


Const SDL_GL_CONTEXT_PROFILE_MASK:Int = 20

type of GL context (Core, Compatibility, ES). See SDL_GLprofile; default value depends on platform


Const SDL_GL_SHARE_WITH_CURRENT_CONTEXT:Int = 21

OpenGL context sharing; defaults to 0


Const SDL_GL_FRAMEBUFFER_SRGB_CAPABLE:Int = 22

requests sRGB capable visual; defaults to 0


Const SDL_GL_CONTEXT_RELEASE_BEHAVIOR:Int = 23

sets context the release behavior; defaults to 1


← TSDLMultiGestureTSDLDisplay →