Interface Settings

interface Settings {
    content?: Content;
    h?: number;
    precision?: number;
    resizeMode?: null | ResizeMode;
    type?: typeof Lightning.textures.StaticCanvasTexture;
    w?: number;
    x?: number;
    y?: number;
}

Hierarchy (View Summary)

Properties

content? h? precision? resizeMode? type? w? x? y?

Properties

Optionalcontent

content?: Content

Optionalh

h?: number

Texture clipping height

Remarks

If 0 then shows full width.

This should not be set at the same time as resizeMode.

See Clipping for more information.

Optionalprecision

precision?: number

Texture render precision

See

OptionalresizeMode

resizeMode?: null | ResizeMode

Texture resize mode (Automatic resize + clipping)

Remarks

When set, enables automatic clipping to a specific rectangular area.

Note: resizeMode actually modifies the following texture clipping properties, so it should not be set at the same time as them:

See Clipping - ResizeMode for more information.

Default Value

null (disabled)

Optionaltype

type?: typeof Lightning.textures.StaticCanvasTexture

Optionalw

w?: number

Texture clipping width

Remarks

If 0 then shows full width.

This should not be set at the same time as resizeMode.

See Clipping for more information.

Optionalx

x?: number

Texture clipping x-offset

Remarks

This should not be set at the same time as resizeMode.

See Clipping for more information.

Optionaly

y?: number

Texture clipping x-offset

Remarks

This should not be set at the same time as resizeMode.

See Clipping for more information.

Settings

Member Visibility

On This Page

Properties