Class BuiltinResources

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

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`getEmoji

getEmoji(emojiCode: number): Image
Returns an Image that represents the given Emoji. The code is the UTF32 representation of the emoji.
Parameters
- emojiCode: number
Returns Image

`Static`getGizmo

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

`Static`getMaterial

getMaterial(material: EnumValue<BuiltinMaterial>): Material
Retrieves one of the builtin materials.
Parameters
- material: EnumValue<BuiltinMaterial>
Returns Material

`Static`getMesh

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

`Static`getShader

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

`Static`getShaderAsync

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

`Static`getShape

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

`Static`getStockIcon

getStockIcon(icon: EnumValue<StockIcon>, size?: number): Image
Returns a Image for the at the requested in points. Uses the default style for the icon.
Parameters
- icon: EnumValue<StockIcon>
- Optionalsize: number
Returns Image

`Static`getStockIconFont

getStockIconFont(): Font

Returns the builtin font icon for the given style.

Returns Font

`Static`getStockIconInPixels

getStockIconInPixels(icon: EnumValue<StockIcon>, size?: number): Image
Returns a Image for the at the requested in pixels. Uses the default style for the icon.
Parameters
- icon: EnumValue<StockIcon>
- Optionalsize: number
Returns Image

`Static`getTexture

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

`Static`makeStockIconString

makeStockIconString(icon: EnumValue<StockIcon>): string
Makes a string that contains the given font awesome unicode code.
Parameters
- icon: EnumValue<StockIcon>
Returns string

`Static`precompileShaders

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

`Static`reloadUISkin

reloadUISkin(): void

Reimports UISkin raw json file and applies changes immediately.

Returns void