# GvrSettings Class Reference

# GvrSettings

Accesses and configures Daydream settings.

## Summary

| ### Public types ||
|---|---|
| `https://developers.google.com/vr/reference/unity/class/GvrSettings#classGvrSettings_1a7617cae1ca9bf5987d89957a3c47d7c4{ https://developers.google.com/vr/reference/unity/class/GvrSettings#classGvrSettings_1a7617cae1ca9bf5987d89957a3c47d7c4a902b0d55fddef6f8d651fe1035b7d4bd = -1, https://developers.google.com/vr/reference/unity/class/GvrSettings#classGvrSettings_1a7617cae1ca9bf5987d89957a3c47d7c4a92b09c7c48c520c3c55e497875da437c, https://developers.google.com/vr/reference/unity/class/GvrSettings#classGvrSettings_1a7617cae1ca9bf5987d89957a3c47d7c4a945d5e233cf7d6240f6b783b36a374ff }` | enumHandedness preference values. |
| `https://developers.google.com/vr/reference/unity/class/GvrSettings#classGvrSettings_1afedeb28afa253f4be96799f56b31ab87{ https://developers.google.com/vr/reference/unity/class/GvrSettings#classGvrSettings_1afedeb28afa253f4be96799f56b31ab87a902b0d55fddef6f8d651fe1035b7d4bd = -1, https://developers.google.com/vr/reference/unity/class/GvrSettings#classGvrSettings_1afedeb28afa253f4be96799f56b31ab87ade4657520f74a9de815899b7d026654e, https://developers.google.com/vr/reference/unity/class/GvrSettings#classGvrSettings_1afedeb28afa253f4be96799f56b31ab87a98213f5932cb96ff4fe7f85c449d06dd }` | enumViewer type. |

| ### Public attributes ||
|---|---|
| `https://developers.google.com/vr/reference/unity/class/GvrSettings#classGvrSettings_1a1ee97f4f8627dffa5771e31b06f2ea13 = "cardboard"` | `const string` Name of Cardboard GVR SDK, as returned by VRSettings.loadedDeviceName. |
| `https://developers.google.com/vr/reference/unity/class/GvrSettings#classGvrSettings_1a19b6c9c620ac914d36c7982ca117ed9a = "daydream"` | `const string` Name of Daydream GVR SDK, as returned by `VRSettings.loadedDeviceName`. |
| `https://developers.google.com/vr/reference/unity/class/GvrSettings#classGvrSettings_1ab17ee8ef963c3691647b6b8d87182359 = "None"` | `const string` Name of 'None' VR SDK, as returned by `VRSettings.loadedDeviceName`. |

| ### Properties ||
|---|---|
| `https://developers.google.com/vr/reference/unity/class/GvrSettings#classGvrSettings_1a1f7bdc1367c1952244497801816884e7` | `static https://developers.google.com/vr/reference/unity/class/GvrSettings#classGvrSettings_1a7617cae1ca9bf5987d89957a3c47d7c4` Gets the user's handedness preference value. |
| `https://developers.google.com/vr/reference/unity/class/GvrSettings#classGvrSettings_1ae698f9ce1a55ce892023968871d1425f` | `static bool` Sets a value indicating whether sustained performance mode is enabled. |
| `https://developers.google.com/vr/reference/unity/class/GvrSettings#classGvrSettings_1a1ace5d2aca4019e5526ba55e9d877b12` | `static https://developers.google.com/vr/reference/unity/class/GvrSettings#classGvrSettings_1afedeb28afa253f4be96799f56b31ab87` Gets the viewer platform type setting. |

| ### Public static functions ||
|---|---|
| `https://developers.google.com/vr/reference/unity/class/GvrSettings#classGvrSettings_1ae918c8d7811dba77da84ff86d3afa13f()` | `IntPtr` Wraps call to `VRDevice.GetNativePtr()`. |

## Public types

### UserPrefsHandedness

```c#
 UserPrefsHandedness
```
Handedness preference values.

| Properties ||
|---|---|
| `Error` | An error value indicating that something has gone wrong. Plugin-only value, does not exist in the NDK. |
| `Left` | A left-handed preference. |
| `Right` | A right-handed preference. |

### ViewerPlatformType

```c#
 ViewerPlatformType
```
Viewer type.

| Properties ||
|---|---|
| `Cardboard` | The Google Cardboard platform. |
| `Daydream` | The Google Daydream platform. |
| `Error` | An error value indicating that something has gone wrong. Plugin-only value, does not exist in the NDK. |

## Public attributes

### VR_SDK_CARDBOARD

```c#
const string VR_SDK_CARDBOARD = "cardboard"
```
Name of Cardboard GVR SDK, as returned by VRSettings.loadedDeviceName.

### VR_SDK_DAYDREAM

```c#
const string VR_SDK_DAYDREAM = "daydream"
```
Name of Daydream GVR SDK, as returned by `VRSettings.loadedDeviceName`.

### VR_SDK_NONE

```c#
const string VR_SDK_NONE = "None"
```
Name of 'None' VR SDK, as returned by `VRSettings.loadedDeviceName`.

## Properties

### Handedness

```c#
static UserPrefsHandedness Handedness
```
Gets the user's handedness preference value.

The user's handedness preference value.

### SustainedPerformanceMode

```c#
static bool SustainedPerformanceMode
```
Sets a value indicating whether sustained performance mode is enabled.

The developer is expected to remember whether sustained performance mode is set at runtime, via the checkbox in Player Settings.

This state may be recorded here in a future release.

The sustained performance mode setting.

### ViewerPlatform

```c#
static ViewerPlatformType ViewerPlatform
```
Gets the viewer platform type setting.

In the editor this can be set for devlopment testing.

The viewer platform type setting.

## Public static functions

### GetValidGvrNativePtrOrLogError

```c#
IntPtr GetValidGvrNativePtrOrLogError()
```
Wraps call to `VRDevice.GetNativePtr()`.

Logs error if a supported GVR SDK is not active or if the returned native pointer is `IntPtr.Zero`.

<br />

| Details ||
|---|---|
| **Returns** | An int pointer representing a GVR context. |