Core Functions
oskLoadAsync
Open the on-screen keyboard.Memory container ID. Typical size is 4 MB.
Pointer to OSK parameters structure defining keyboard appearance and behavior.
Pointer to input field information structure.
Returns 0 on success, nonzero on error.
oskUnloadAsync
Close the on-screen keyboard.Pointer to structure receiving the keyboard results.
Returns 0 on success, nonzero on error.
oskGetInputText
Get the current input text from the keyboard.Pointer to structure receiving the input text and status.
Returns 0 on success, nonzero on error.
oskAbort
Abort the currently opened keyboard.Returns 0 on success, nonzero on error.
Configuration Functions
oskSetInitialInputDevice
Set the initial input device for the keyboard.Initial input device:
OSK_DEVICE_PAD- PS3 controllerOSK_DEVICE_KB- USB keyboard
Returns 0 on success, nonzero on error.
oskSetInitialKeyLayout
Set the initial keyboard layout.Initial keyboard layout:
OSK_INITIAL_SYSTEM_PANEL- System default panelOSK_INITIAL_10KEY_PANEL- 10-key keypad panelOSK_INITIAL_FULLKEY_PANEL- Full keyboard panel
Returns 0 on success, nonzero on error.
oskSetLayoutMode
Set the layout mode for keyboard positioning.Layout mode flags (OR’ed combination):Horizontal Alignment:
OSK_LAYOUTMODE_HORIZONTAL_ALIGN_LEFT(0x00000800)OSK_LAYOUTMODE_HORIZONTAL_ALIGN_CENTER(0x00000400)OSK_LAYOUTMODE_HORIZONTAL_ALIGN_RIGHT(0x00000200)
OSK_LAYOUTMODE_VERTICAL_ALIGN_TOP(0x00004000)OSK_LAYOUTMODE_VERTICAL_ALIGN_CENTER(0x00002000)OSK_LAYOUTMODE_VERTICAL_ALIGN_BOTTOM(0x00001000)
Returns 0 on success, nonzero on error.
oskSetKeyLayoutOption
Set keyboard key layout options.Key layout flags:
OSK_10KEY_PANEL(1) - 10-key keypadOSK_FULLKEY_PANEL(2) - Full keyboard
Returns 0 on success, nonzero on error.
oskSetDeviceMask
Set allowed input devices.Device mask:
0- All devices allowedOSK_DEVICE_MASK_PAD(0xff) - Only controller allowed
Returns 0 on success, nonzero on error.
oskDisableDimmer
Disable the background dimmer filter.Returns 0 on success, nonzero on error.
oskSetSeparateWindowOption
Set options for separate window mode.Pointer to separate window options structure.
Returns 0 on success, nonzero on error.
oskAddSupportLanguage
Add a supported language to the keyboard.Language panel type (see Panel Types below).
Returns 0 on success, nonzero on error.
oskGetSize
Get the size of the keyboard panel.Pointer to store panel width in pixels.
Pointer to store panel height in pixels.
OSK type to query size for.
Returns 0 on success, nonzero on error.
Data Structures
oskParam
Keyboard parameters structure.OR’ed combination of allowed panel types.
Initial panel type to display.
Panel origin control point.
Prohibited input flags:
OSK_PROHIBIT_SPACE(0x00000001) - Prohibit spaceOSK_PROHIBIT_RETURN(0x00000002) - Prohibit return/enterOSK_PROHIBIT_INPUT_ANALOG(0x00000008) - Prohibit analog input
oskInputFieldInfo
Input field information.Buffer for message text (UTF-16).
Initial text to display (UTF-16).
Maximum number of characters allowed.
oskCallbackReturnParam
Return parameters from keyboard.Result status:
OSK_OK- Input successOSK_CANCELED- Input canceledOSK_ABORT- Input abortedOSK_NO_TEXT- No text entered
Number of characters entered.
Array of characters entered (UTF-16).
oskSeparateWindowOption
Separate window options.Continuous mode:
OSK_CONTINUOUS_MODE_NONE- No continuous modeOSK_CONTINUOUS_MODE_REMAIN_OPEN- Keep panel openOSK_CONTINUOUS_MODE_HIDE- Hide panel by defaultOSK_CONTINUOUS_MODE_SHOW- Show panel by default
Device mask (0 or
OSK_DEVICE_MASK_PAD).Input field width.
Input field transparency (0.0 - 1.0).