Module fermium::video

source ·
Expand description

Module for interacting with the video subsystem.

Structs

Event subtype for display events.
The structure that defines a display mode
Orientations a display can have.
Window flash operation
A handle to an OpenGL context.
Affects GL’s behavior when the context is reset.
OpenGL configuration attributes
SDL Context Flags.
Affects GL’s behavior when you release the context.
The GL Profile: Core, Compatibility, or ES.
The results of a hit test.
The type used to identify a window (newtype’d c_void).
Event subtype for window events.
The flags on a window

Constants

Display has been added to the system
Display has been removed from the system
Display orientation has changed to data1
Flash the window briefly to get attention
Cancel any window flash state
Flash the window until it gets focus
Specifies that you want the window centered.
Specifies that you don’t care about the window position.

Functions

Create a window with the specified position, dimensions, and flags.
Creates a window from driver-dependent window creation data, typically a native window pointer.
Destroys a window.
Disables the screensaver.
Enables the screensaver.
Request a window to demand attention from the user.
Creates a new context for use with the window, and also makes it current.
Deletes a GL context.
If the given extension is supported in the current context.
Gets a GL attribute’s value (to the pointer given).
Gets the current context.
Gets the window associated with the current context.
Gets the drawable size (in pixels) of the client area.
Get a GL function pointer for a given function name.
Gets the swap interval setting.
Load a GL library using the file path given.
Make a context current and associated with the given window.
Resets all GL attributes to their default values.
Sets a GL attribute to the given value.
Sets the swap interval of GL swaps.
Swaps the front buffer and back buffer of a GL using window.
Unloads the previously loaded GL library.
Gets the closest display mode to the mode requested.
Gets info about the current display mode.
The name of the current video driver.
Gets info about the desktop’s display mode.
Writes the bounds of a given display to the rect given.
Get the diagonal, horizontal, and vertical DPI of a display.
Gets info about a display mode.
Gets the name of a display.
Gets the orientation of a display.
As SDL_GetDisplayBounds, but system reserved area (eg: the taskbar) is removed for you.
Gets which window has the mouse grab (if any).
Gets the number of available display modes.
The number of displays available.
The number of available video drivers.
Lookup the name of a video driver.
Gets the size of the border decoration around the client area.
Gets the brightness (gamma) of the display that owns the window.
Gets the named user data pointer of the window.
Gets the display index for the center of a given window.
Gets the display mode used when the given window is visible and fullscreen.
Gets the flags of the window.
Get a window from a stored ID, or NULL if it doesn’t exist.
Gets the gamma ramp of the window.
Gets if the window is grabbing the mouse.
Gets the window’s ID, or 0 on failure.
Get a window’s keyboard grab mode.
Gets the maximum client area size of the window.
Gets the minimum client area size of the window.
Get a window’s mouse grab mode.
Gets a window’s opacity (to the pointer given).
Gets the pixel format of the window.
Gets the window’s position.
Gets the window’s client area size (in screen coordinates).
Gets the surface of the window.
Gets the window’s title, or "" if there is no title.
Hides a window.
If the screensaver is currently enabled.
Maximize a window.
Minimize a window.
Raises a window to the front and sets it for input focus.
Restores a minimized/maximized window to its previous size and position.
Set the window to always be above the others.
Add/remove the border of the window.
Set the brightness (gamma) for the display that owns the window.
Associates a named user data pointer to the window.
Sets the display mode to use when the given window is visible and fullscreen.
Sets the window’s desired fullscreen state.
Sets a gamma ramp for the window.
Sets if the window “grabs” the mouse pointer (locking it inside the window).
Sets the hit test callback hit test user data for the window.
Sets the window’s icon.
Sets input focus to a given window.
Set a window’s keyboard grab mode.
Sets the maximum client area size of the window.
Sets the minimum client area size of the window.
Sets a window as a modal for another window (X11 only).
Set a window’s mouse grab mode.
Sets a window’s opacity.
Sets the window’s position.
Set if the window should allow resizing.
Sets the window’s client area size (in screen coordinates).
Sets the title of a window.
Shows a window.
Updates the window surface data for the user to see.
As SDL_UpdateWindowSurfaceRects, but limited to the list of rects given.
Initialize the video subsystem (and other subsystems it depends on)
Quit the video subsystem (and also other event subsystems)

Type Definitions

SDL’s “hit test” function pointer type.