Header menu logo Nu

SdlDeps Module

SdlDeps abstract data type module.

Types

Type Description

SdlDeps

The dependencies needed to initialize SDL.

Functions and values

Function or value Description

SdlDeps.empty

Full Usage: SdlDeps.empty

Returns: SdlDeps

An empty SdlDeps.

Returns: SdlDeps

SdlDeps.getConfig sdlDeps

Full Usage: SdlDeps.getConfig sdlDeps

Parameters:
Returns: SdlConfig

Get an sdlDep's config.

sdlDeps : SdlDeps
Returns: SdlConfig

SdlDeps.getWindowOpt sdlDeps

Full Usage: SdlDeps.getWindowOpt sdlDeps

Parameters:
Returns: nativeptr<SDL_Window> option

Get an sdlDep's optional window.

sdlDeps : SdlDeps
Returns: nativeptr<SDL_Window> option

SdlDeps.tryGetDisplayMode sdlDeps

Full Usage: SdlDeps.tryGetDisplayMode sdlDeps

Parameters:
Returns: SDL_DisplayMode option

Attempt to get the display mode for the desktop occupied by any current window.

sdlDeps : SdlDeps
Returns: SDL_DisplayMode option

SdlDeps.tryMake sdlConfig accompanied windowSize

Full Usage: SdlDeps.tryMake sdlConfig accompanied windowSize

Parameters:
Returns: Either<string, SdlDeps>

Attempt to make an SdlDeps instance.

sdlConfig : SdlConfig
accompanied : bool
windowSize : Vector2i
Returns: Either<string, SdlDeps>

SdlDeps.trySetWindowFullScreen fullScreen sdlDeps

Full Usage: SdlDeps.trySetWindowFullScreen fullScreen sdlDeps

Parameters:
Returns: SdlDeps

Attempt to set the window's full screen state.

fullScreen : SDLBool
sdlDeps : SdlDeps
Returns: SdlDeps

Type something to start searching.