OSDKeyboard
- Last UpdatedFeb 19, 2025
- 2 minute read
The OSDKeyboard node enables you to display an onscreen keyboard.
When running an application on a touch environment, it is necessary to access the system on-screen keyboard to get key inputs.
Platform support
This node is supported on all platforms, except XR-Portable WASM platform.
|
XR-WIN |
XR-P-WIN |
XR-P-IOS |
XR-P-AND |
XR-P-WASM |
|---|---|---|---|---|
|
Full support |
Full support |
Full support |
Full support |
No support |
|
|
|
|
|
|
Interacting with the OSDKeyboard
By script, you can only show/hide the OSD keyboard by using the visible field. The system on which you’re executing the application is responsible to render and position the keyboard.
Note: If the keyboard is closed by its own exit functionality or started-up by another process, the visible field may not be updated accordingly.
Code example
This is a code example for OSDKeyboard node.
<OSDKeyboard name="keyboard" />OSDKeyboard Fields
OSDKeyboard fields
These are the fields for the OSDKeyboard node. Only the node-specific fields are indicated, not fields obtained by inheritance.
Field inheritance: NodeBase > OSDKeyboardSensor
|
Fields |
Type |
Use |
Default value |
Description |
|---|---|---|---|---|
|
visible |
sbool |
Optional |
false |
Shows/hides the OSD keyboard. |