Header menu logo Nu

SdlDeps 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: Window option

Get an sdlDep's optional window.

sdlDeps : SdlDeps
Returns: Window 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:
    fullScreen : bool
    sdlDeps : SdlDeps

Returns: SdlDeps

Attempt to set the window's full screen state.

fullScreen : bool
sdlDeps : SdlDeps
Returns: SdlDeps

Type something to start searching.