Class BuiltinResources

Holds references to built-in resources used by the core engine.

Index

Constructors

Accessors

defaultFont emojiFont whiteTexture

Methods

getApplicationIcon getApplicationMenuIcon getGizmo getMesh getShader getShaderAsync getShape getTexture precompileShaders reloadUISkin

Constructors

constructor

new BuiltinResources(): BuiltinResources
Returns BuiltinResources

Accessors

`Static`defaultFont

get defaultFont(): Font
Returns the default font used by the engine.

Returns Font

`Static`emojiFont

get emojiFont(): Font
Returns the Emoji fallback font.

Returns Font

`Static`whiteTexture

get whiteTexture(): SpriteImage
Returns a small entirely white texture.

Returns SpriteImage

Methods

`Static`getApplicationIcon

getApplicationIcon(): Image
Returns the default application icon.

Returns Image

`Static`getApplicationMenuIcon

getApplicationMenuIcon(): Image
Returns the application icon used in the main menu.

Returns Image

`Static`getGizmo

getGizmo(gizmoMeshFilename): Mesh
Get a bultin gizmo mesh.
Parameters
- gizmoMeshFilename: string
Returns Mesh

`Static`getMesh

getMesh(mesh): Mesh
Retrieves one of the builtin meshes.
Parameters
- mesh: EnumValue<BuiltinMesh, number>
Returns Mesh

`Static`getShader

getShader(type): Shader
Returns one of the builtin shader types.
Parameters
- type: EnumValue<BuiltinShader, number>
Returns Shader

`Static`getShaderAsync

getShaderAsync(type): UncertainAsyncOp<ResourceHandle<Shader>, string>
Parameters
- type: EnumValue<BuiltinShader, number>
Returns UncertainAsyncOp<ResourceHandle<Shader>, string>

`Static`getShape

getShape(shapeName): Shape
Retrieves one of the built in shapes.
Parameters
- shapeName: string
Returns Shape

`Static`getTexture

getTexture(textureFilename): Texture
Retrieves a builtin texture from it's filename.
Parameters
- textureFilename: string
Returns Texture

`Static`precompileShaders

precompileShaders(onProgress, onFinalize): void
Precompiles all built-in shaders.
Parameters
- onProgress: ((arg0: number) => void)
  - - (arg0): void
    - Parameters
      arg0: number
      Returns void
- onFinalize: (() => void)
  - - (): void
    - Returns void
Returns void

`Static`reloadUISkin

reloadUISkin(): void
Reimports UISkin raw json file and applies changes immediately.

Returns void