November 6, 2019 update:
  • There's a new open source Cardboard SDK for iOS and Android NDK that offers a streamlined API, improved device compatibility, and built-in viewer profile QR code scanning. A corresponding Unity package (SDK) is planned for a future release. We recommend that all developers actively building for Google Cardboard migrate (iOS, Android NDK) to the new Cardboard SDK.
October 15, 2019 update:
  • The Daydream View VR headset is no longer available for purchase. However, you can continue to use the existing Google VR SDK to update and distribute your apps to the Google Play Store, and make them available to users in the Daydream app.

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
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.