Interface WLVirtualKeyboardRootProperties

Optional WLVirtualKeyboardRoot constructor properties.

interface WLVirtualKeyboardRootProperties {
    canvasStartingHeight?: number;
    canvasStartingWidth?: number;
    cloneMaterial?: boolean;
    collisionGroupsMask?: number;
    collisionOverextensionPixels?: number;
    constraints?: LayoutConstraints;
    cursorStyleManager?: null | ICursorStyleManager;
    destroyTextureWhenDisabled?: boolean;
    enablePasteEvents?: boolean;
    keyboardDriver?: KeyboardDriver<KeyboardDriverGroup, KeyboardDriverGroupOptions>;
    keyboardTemplate?: VirtualKeyboardTemplate;
    maxCanvasHeight?: number;
    maxCanvasWidth?: number;
    overextendCollisionOnCursorCapture?: boolean;
    pointerStyleHandler?: null | PointerStyleHandler;
    preventAtlasBleeding?: boolean;
    preventBleeding?: boolean;
    registerKeyboardDriver?: boolean;
    registerPointerDriver?: boolean;
    resolution?: number;
    tabFocusable?: boolean;
    textureUniformName?: string;
    theme?: Theme;
    unitsPerPixel?: number;
}

Hierarchy

Properties

canvasStartingHeight? canvasStartingWidth? cloneMaterial? collisionGroupsMask? collisionOverextensionPixels? constraints? cursorStyleManager? destroyTextureWhenDisabled? enablePasteEvents? keyboardDriver? keyboardTemplate? maxCanvasHeight? maxCanvasWidth? overextendCollisionOnCursorCapture? pointerStyleHandler? preventAtlasBleeding? preventBleeding? registerKeyboardDriver? registerPointerDriver? resolution? tabFocusable? textureUniformName? theme? unitsPerPixel?

Properties

Optional canvasStartingHeight

canvasStartingHeight?: number

The starting height of the Root#viewport's canvas.

Optional canvasStartingWidth

canvasStartingWidth?: number

The starting width of the Root#viewport's canvas.

Optional cloneMaterial

cloneMaterial?: boolean

Should the material used for the Root be cloned? If false, then the actual material will be used, which will lead to issues if the material is also used elsewhere.

Optional collisionGroupsMask

collisionGroupsMask?: number

The collision groups that this root's collider will belong to. If 0, collider and cursor-target will not be added.

Optional collisionOverextensionPixels

collisionOverextensionPixels?: number

How many pixels to over-extend the collision by. For example, if 2, and the units-per-pixel is 0.01, then the collision extents will be expanded by 0.02 game units on all sides.

Optional constraints

constraints?: LayoutConstraints

The starting layout constraints of the Root.

Optional cursorStyleManager

cursorStyleManager?: null | ICursorStyleManager

A cursor style manager for sharing the cursor style with other components without having a glitchy cursor style. If omitted and the pointer style handler is not overridden, then the cursor style is set directly.

Even if the pointerStyleHandler is overridden, this should still be passed if it's available, so that the root can clear the pointer style when it's disabled.

Optional destroyTextureWhenDisabled

destroyTextureWhenDisabled?: boolean

When true, the UI texture will be destroyed to clear up space in the texture atlas whenever the UI root is disabled. Note that this will cause additional texture updates when re-enabling the UI root.

Optional enablePasteEvents

enablePasteEvents?: boolean

Should contentEditable be set to true? Needed for paste events, but creates issues on mobile; virtual keyboard is opened whenever the canvas is clicked. Disabled by default

Optional keyboardDriver

keyboardDriver?: KeyboardDriver<KeyboardDriverGroup, KeyboardDriverGroupOptions>

The KeyboardDriver to dispatch key events to. If null (default), WLRoot.keyboardDriver is used.

Optional keyboardTemplate

keyboardTemplate?: VirtualKeyboardTemplate

The keyboard template to use for the VirtualKeyboard Widget in a VirtualKeyboardRoot.

Optional maxCanvasHeight

maxCanvasHeight?: number

Sets Root#maxCanvasHeight.

Optional maxCanvasWidth

maxCanvasWidth?: number

Sets Root#maxCanvasWidth.

Optional overextendCollisionOnCursorCapture

overextendCollisionOnCursorCapture?: boolean

Should the collision extents only be expanded when the cursor is being captured?

Optional pointerStyleHandler

pointerStyleHandler?: null | PointerStyleHandler

Sets Root#pointerStyleHandler.

Optional preventAtlasBleeding

preventAtlasBleeding?: boolean

Sets CanvasViewport#preventAtlasBleeding in the internal viewport (Root#viewport).

Optional preventBleeding

preventBleeding?: boolean

Sets Root#preventBleeding.

Optional registerKeyboardDriver

registerKeyboardDriver?: boolean

Register the default keyboard driver to this root?

Optional registerPointerDriver

registerPointerDriver?: boolean

Register the default pointer driver to this root? If collisionGroupsMask is 0, this is forced to false.

Optional resolution

resolution?: number

Sets Root#resolution.

Optional tabFocusable

tabFocusable?: boolean

Sets Root#tabFocusable.

Optional textureUniformName

textureUniformName?: string

Which uniform name should be used for setting the material's texture? If not passed, then the uniform name will be guessed from the pipeline name, which will result in an error when an unknown pipeline is used.

Optional theme

theme?: Theme

Sets Root#child's Widget#inheritedTheme.

Optional unitsPerPixel

unitsPerPixel?: number

The amount of world units per canvas pixel. Determines the pixel density of the mesh.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc