This site has been permanently archived. The content on this site was last updated in 2019.

All developers actively developing experiences for Google Cardboard should use the open source Cardboard SDKs for iOS, Android NDK, and Unity XR Plugin.
The Daydream View VR headset is no longer available for purchase as of October 15, 2019. As of November 2023, previously supported devices will no longer be able to download and install Google VR Serivces (Android application ID com.google.vr.vrcore) for new users.

GvrKeyboard

Handles keyboard state management such as hiding and displaying the keyboard, directly modifying text and stereoscopic rendering.

Summary

Inheritance

Inherits from: MonoBehaviour

Public attributes
`distance = 0`	`float` The distance to the keyboard.
`inputMode = GvrKeyboardInputMode.DEFAULT`	`GvrKeyboardInputMode` The input mode of the keyboard.
`keyboardDelegate = null`	`GvrKeyboardDelegateBase` Delegate to handle keyboard events and input.
`useRecommended = true`	`bool` Flag to use the recommended world matrix for the keyboard.

Properties
`EditorText`	`string` Gets or sets the text being affected by this keyboard.
`IsReady`	`bool` Gets a value indicating whether this keyboard is ready.
`IsValid`	`bool` Gets a value indicating whether this keyboard instance is valid.
`Mode`	`GvrKeyboardInputMode` Gets the current input mode of the keyboard.
`WorldMatrix`	`Matrix4x4` Gets the world matrix of the keyboard.

Public functions
`ClearText()`	`void` Resets keyboard text.
`EditTextCallback(string edit_text)`	`delegate void` Edit text keyboard delegate type.
`ErrorCallback(GvrKeyboardError err)`	`delegate void` Keyboard error delegate type.
`Hide()`	`void` Hides the keyboard.
`KeyboardCallback(IntPtr closure, GvrKeyboardEvent evt)`	`delegate void` Keyboard delegate type.
`OnPointerClick(BaseEventData data)`	`void` Handle a pointer click on the keyboard.
`Show()`	`void` Shows the keyboard.
`StandardCallback()`	`delegate void` Standard keyboard delegate type.

Public attributes

distance

float distance = 0

The distance to the keyboard.

inputMode

GvrKeyboardInputMode inputMode = GvrKeyboardInputMode.DEFAULT

The input mode of the keyboard.

keyboardDelegate

GvrKeyboardDelegateBase keyboardDelegate = null

Delegate to handle keyboard events and input.

useRecommended

bool useRecommended = true

Flag to use the recommended world matrix for the keyboard.

Properties

EditorText

string EditorText

Gets or sets the text being affected by this keyboard.

The text being affected by this keyboard.

IsReady

bool IsReady

Gets a value indicating whether this keyboard is ready.

Value true if this keyboard is ready, false otherwise.

IsValid

bool IsValid

Gets a value indicating whether this keyboard instance is valid.

Value true if this keyboard instance is valid, false otherwise.

Mode

GvrKeyboardInputMode Mode

Gets the current input mode of the keyboard.

The current input mode of the keyboard.

WorldMatrix

Matrix4x4 WorldMatrix

Gets the world matrix of the keyboard.

The world matrix of the keyboard.

Public functions

ClearText

void ClearText()

Resets keyboard text.

EditTextCallback

delegate void EditTextCallback(
  string edit_text
)

Edit text keyboard delegate type.

Details

Parameters

edit_text

The edited text which has been typed into the keyboard.

ErrorCallback

delegate void ErrorCallback(
  GvrKeyboardError err
)

Keyboard error delegate type.

Details

Parameters

err

The error which raised this callback.

Hide

void Hide()

Hides the keyboard.

KeyboardCallback

delegate void KeyboardCallback(
  IntPtr closure,
  GvrKeyboardEvent evt
)

Keyboard delegate type.

Details

Parameters

`closure`	A closure around the method to call.
`evt`	The event which prompted this callback.

OnPointerClick

void OnPointerClick(
  BaseEventData data
)

Handle a pointer click on the keyboard.

Details

Parameters

data

The event data associated with this callback.

Show

void Show()

Shows the keyboard.

StandardCallback

delegate void StandardCallback()

Standard keyboard delegate type.