Class ApplicationStartupInformation

Structure containing parameters for starting the application.

Constructors

constructor

new ApplicationStartupInformation(mode?, renderAPI?, renderer?, physics?, audio?, input?, librariesPath?, applicationCompanyName?, applicationName?, isPhysicsCookingRequired?, isAsyncAnimationEnabled?, isHighDPIAware?, primaryWindowInformation?, inputInformation?, plugins?): ApplicationStartupInformation
Parameters
- Optionalmode: EnumValue<ApplicationMode, number>
- OptionalrenderAPI: string
- Optionalrenderer: string
- Optionalphysics: string
- Optionalaudio: string
- Optionalinput: string
- OptionallibrariesPath: FilePath
- OptionalapplicationCompanyName: string
- OptionalapplicationName: string
- OptionalisPhysicsCookingRequired: boolean
- OptionalisAsyncAnimationEnabled: boolean
- 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`_isAsyncAnimationEnabled

_isAsyncAnimationEnabled: boolean

`Protected`_isHighDPIAware

_isHighDPIAware: boolean

`Protected`_isPhysicsCookingRequired

_isPhysicsCookingRequired: boolean

`Protected`_librariesPath

_librariesPath: FilePath

`Protected`_mode

_mode: EnumValue<ApplicationMode, number>

`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): void
Parameters
- value: string
Returns void

applicationName

get applicationName(): string
The name of the application.

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

audio

get audio(): string
Name of the audio plugin to use.

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

input

get input(): string
Name of the input plugin to use.

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

inputInformation

get inputInformation(): InputInformation
Describes how to initialize the input sub-system.

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

isAsyncAnimationEnabled

get isAsyncAnimationEnabled(): boolean
True if animation should be evaluated at the same time while rendering is happening. This introduces a one frame delay to all animations but can result in better performance. If false the animation will be forced to finish evaluating before rendering starts, ensuring up-to-date frame but potentially blocking the rendering thread from moving forward until the animation finishes.

Returns boolean
set isAsyncAnimationEnabled(value): void
Parameters
- value: boolean
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): void
Parameters
- value: boolean
Returns void

isPhysicsCookingRequired

get isPhysicsCookingRequired(): boolean
True if physics cooking library should be loaded. Cooking is useful for creating collision meshes during development, but might be unnecessary in the final application. When turned off you can save on space by not shipping the cooking library.

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

librariesPath

get librariesPath(): FilePath
Filesystem path of the plugins.

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

mode

get mode(): EnumValue<ApplicationMode, number>
The mode of the application.

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

physics

get physics(): string
Name of physics plugin to use.

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

plugins

get plugins(): Iterable<string>
A list of plugins to load.

Returns Iterable<string>
set plugins(value): 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): void
Parameters
- value: Immutable<RenderWindowInformation>
Returns void

renderAPI

get renderAPI(): string
Name of the render system plugin to use.

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

renderer

get renderer(): string
Name of the renderer plugin to use.

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

Methods

assign

assign(other): 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, other): 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, rhs): boolean
Determines if both ApplicationStartupInformation instances are equal.
Parameters
- lhs: Immutable<ApplicationStartupInformation>
- rhs: Immutable<ApplicationStartupInformation>
Returns boolean