Class ApplicationStartupInformation

Structure containing parameters for starting the application.

Constructors

constructor

new ApplicationStartupInformation(
    mode?: EnumValue<ApplicationMode>,
    renderAPI?: string,
    renderer?: string,
    physics?: string,
    audio?: string,
    input?: string,
    librariesPath?: FilePath,
    applicationCompanyName?: string,
    applicationName?: string,
    isHighDPIAware?: boolean,
    primaryWindowInformation?: Immutable<RenderWindowInformation>,
    inputInformation?: Immutable<InputInformation>,
    plugins?: Iterable<string>,
): ApplicationStartupInformation
Parameters
- Optionalmode: EnumValue<ApplicationMode>
- OptionalrenderAPI: string
- Optionalrenderer: string
- Optionalphysics: string
- Optionalaudio: string
- Optionalinput: string
- OptionallibrariesPath: FilePath
- OptionalapplicationCompanyName: string
- OptionalapplicationName: string
- OptionalisHighDPIAware: boolean
- OptionalprimaryWindowInformation: Immutable<RenderWindowInformation>
- OptionalinputInformation: Immutable<InputInformation>
- Optionalplugins: Iterable<string>
Returns ApplicationStartupInformation

Properties

`Protected`_applicationCompanyName

_applicationCompanyName: string

`Protected`_applicationName

_applicationName: string

`Protected`_audio

_audio: string

`Protected`_input

_input: string

`Protected`_inputInformation

_inputInformation: InputInformation

`Protected`_isHighDPIAware

_isHighDPIAware: boolean

`Protected`_librariesPath

_librariesPath: FilePath

`Protected`_mode

_mode: EnumValue<ApplicationMode>

`Protected`_physics

_physics: string

`Protected`_plugins

_plugins: string[]

`Protected`_primaryWindowInformation

_primaryWindowInformation: RenderWindowInformation

`Protected`_renderAPI

_renderAPI: string

`Protected`_renderer

_renderer: string

Accessors

applicationCompanyName

get applicationCompanyName(): string

The name of the developer.

Returns string
set applicationCompanyName(value: string): void
Parameters
- value: string
Returns void

applicationName

get applicationName(): string

The name of the application.

Returns string
set applicationName(value: string): void
Parameters
- value: string
Returns void

audio

get audio(): string

Name of the audio plugin to use.

Returns string
set audio(value: string): void
Parameters
- value: string
Returns void

input

get input(): string

Name of the input plugin to use.

Returns string
set input(value: string): void
Parameters
- value: string
Returns void

inputInformation

get inputInformation(): InputInformation

Describes how to initialize the input sub-system.

Returns InputInformation
set inputInformation(value: Immutable<InputInformation>): void
Parameters
- value: Immutable<InputInformation>
Returns void

isHighDPIAware

get isHighDPIAware(): boolean

True if RSX should be aware of operating system DPI settings. If false, the UI and other graphical elements might look pixelated on high resolution displays.

Returns boolean
set isHighDPIAware(value: boolean): void
Parameters
- value: boolean
Returns void

librariesPath

get librariesPath(): FilePath

Filesystem path of the plugins.

Returns FilePath
set librariesPath(value: FilePath): void
Parameters
- value: FilePath
Returns void

mode

get mode(): EnumValue<ApplicationMode>

The mode of the application.

Returns EnumValue<ApplicationMode>
set mode(value: EnumValue<ApplicationMode>): void
Parameters
- value: EnumValue<ApplicationMode>
Returns void

physics

get physics(): string

Name of physics plugin to use.

Returns string
set physics(value: string): void
Parameters
- value: string
Returns void

plugins

get plugins(): Iterable<string>

A list of plugins to load.

Returns Iterable<string>
set plugins(value: string[] | Iterable<string>): void
Parameters
- value: string[] | Iterable<string>
Returns void

primaryWindowInformation

get primaryWindowInformation(): RenderWindowInformation

Describes the window to create during start-up.

Returns RenderWindowInformation
set primaryWindowInformation(value: Immutable<RenderWindowInformation>): void
Parameters
- value: Immutable<RenderWindowInformation>
Returns void

renderAPI

get renderAPI(): string

Name of the render system plugin to use.

Returns string
set renderAPI(value: string): void
Parameters
- value: string
Returns void

renderer

get renderer(): string

Name of the renderer plugin to use.

Returns string
set renderer(value: string): void
Parameters
- value: string
Returns void

Methods

assign

assign(
other: Immutable<ApplicationStartupInformation>,
): ApplicationStartupInformation
Copies all properties defined by the prototype of ApplicationStartupInformation from other to this instance.
Parameters
- other: Immutable<ApplicationStartupInformation>
Returns ApplicationStartupInformation

clone

clone(): ApplicationStartupInformation

Clones this instance and returns a new ApplicationStartupInformation with identical values.

Returns ApplicationStartupInformation

isEqual

isEqual(
this: Immutable<ApplicationStartupInformation>,
other: Immutable<ApplicationStartupInformation>,
): boolean
Determines if this ApplicationStartupInformation instance is equal to the other instance.
Parameters
- this: Immutable<ApplicationStartupInformation>
- other: Immutable<ApplicationStartupInformation>
Returns boolean

`Static`isEqual

isEqual(
lhs: Immutable<ApplicationStartupInformation>,
rhs: Immutable<ApplicationStartupInformation>,
): boolean
Determines if both ApplicationStartupInformation instances are equal.
Parameters
- lhs: Immutable<ApplicationStartupInformation>
- rhs: Immutable<ApplicationStartupInformation>
Returns boolean

Class ApplicationStartupInformation

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ApplicationStartupInformation

Properties

Protected_applicationCompanyName

Protected_applicationName

Protected_audio

Protected_input

Protected_inputInformation

Protected_isHighDPIAware

Protected_librariesPath

Protected_mode

Protected_physics

Protected_plugins

Protected_primaryWindowInformation

Protected_renderAPI

Protected_renderer

Accessors

applicationCompanyName

Returns string

Parameters

Returns void

applicationName

Returns string

Parameters

Returns void

audio

Returns string

Parameters

Returns void

input

Returns string

Parameters

Returns void

inputInformation

Returns InputInformation

Parameters

Returns void

isHighDPIAware

Returns boolean

Parameters

Returns void

librariesPath

Returns FilePath

Parameters

Returns void

mode

Returns EnumValue<ApplicationMode>

Parameters

Returns void

physics

Returns string

Parameters

Returns void

plugins

Returns Iterable<string>

Parameters

Returns void

primaryWindowInformation

Returns RenderWindowInformation

Parameters

Returns void

renderAPI

Returns string

Parameters

Returns void

renderer

Returns string

Parameters

Returns void

Methods

assign

Parameters

`Protected`_applicationCompanyName

`Protected`_applicationName

`Protected`_audio

`Protected`_input

`Protected`_inputInformation

`Protected`_isHighDPIAware

`Protected`_librariesPath

`Protected`_mode

`Protected`_physics

`Protected`_plugins

`Protected`_primaryWindowInformation

`Protected`_renderAPI

`Protected`_renderer

`Static`isEqual