Interface WLVirtualKeyboardRootProperties

Optional WLVirtualKeyboardRoot constructor properties.

Hierarchy

Properties

canvasStartingHeight? canvasStartingWidth? collisionGroup? constraints? keyboardDriver? keyboardTemplate? pointerStyleHandler? preventBleeding? registerKeyboardDriver? registerPointerDriver? resolution? 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 collisionGroup

collisionGroup?: number

The collision group that this root's collider will belong to. If null, collider and cursor-target will not be added. 1 by default.

Optional constraints

constraints?: LayoutConstraints

The starting layout constraints of the Root.

Optional keyboardDriver

keyboardDriver?: KeyboardDriver

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 pointerStyleHandler

pointerStyleHandler?: null | PointerStyleHandler

Sets Root#pointerStyleHandler.

Optional preventBleeding

preventBleeding?: boolean

Sets Root#preventBleeding.

Optional registerKeyboardDriver

registerKeyboardDriver?: boolean

Register the default keyboard driver to this root? true by default.

Optional registerPointerDriver

registerPointerDriver?: boolean

Register the default pointer driver to this root? If collisionGroup is null, this is forced to false. true by default.

Optional resolution

resolution?: number

Sets Root#resolution.

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. 0.01 by default.

Settings

Member Visibility

Theme

Generated using TypeDoc