# SurfaceEntity.StereoMode

Artifact: [androidx.xr.scenecore:scenecore](https://developer.android.com/jetpack/androidx/releases/xr-scenecore) [View Source](https://cs.android.com/search?q=file:androidx/xr/scenecore/SurfaceEntity.kt+class:androidx.xr.scenecore.SurfaceEntity.StereoMode) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

*** ** * ** ***


```
class SurfaceEntity.StereoMode
```

<br />

*** ** * ** ***

Specifies how the surface content will be routed for stereo viewing. Applications must render into the surface in accordance with what they provided here in order for the compositor to correctly produce a stereoscopic view to the user.

Values here match values from [androidx.media3.common.C.StereoMode](https://developer.android.com/reference/androidx/media3/common/C.StereoMode).

## Summary

| ### Public companion properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SurfaceEntity.StereoMode` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SurfaceEntity.StereoMode#MONO()` Each eye will see the entire surface (no separation) |
| `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SurfaceEntity.StereoMode` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SurfaceEntity.StereoMode#MULTIVIEW_LEFT_PRIMARY()` Multiview video, primary, auxiliary views will map to left, right eyes |
| `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SurfaceEntity.StereoMode` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SurfaceEntity.StereoMode#MULTIVIEW_RIGHT_PRIMARY()` Multiview video, primary, auxiliary views will map to right, left eyes |
| `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SurfaceEntity.StereoMode` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SurfaceEntity.StereoMode#SIDE_BY_SIDE()` The left, right halves of the surface will map to left, right eyes |
| `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SurfaceEntity.StereoMode` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SurfaceEntity.StereoMode#TOP_BOTTOM()` The top, bottom halves of the surface will map to left, right eyes |

| ### Public functions |
|---|---|
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SurfaceEntity.StereoMode#toString()()` |

## Public companion properties

### MONO

```
val MONO: SurfaceEntity.StereoMode
```

Each eye will see the entire surface (no separation)

### MULTIVIEW_LEFT_PRIMARY

```
val MULTIVIEW_LEFT_PRIMARY: SurfaceEntity.StereoMode
```

Multiview video, primary, auxiliary views will map to left, right eyes

### MULTIVIEW_RIGHT_PRIMARY

```
val MULTIVIEW_RIGHT_PRIMARY: SurfaceEntity.StereoMode
```

Multiview video, primary, auxiliary views will map to right, left eyes

### SIDE_BY_SIDE

```
val SIDE_BY_SIDE: SurfaceEntity.StereoMode
```

The left, right halves of the surface will map to left, right eyes

### TOP_BOTTOM

```
val TOP_BOTTOM: SurfaceEntity.StereoMode
```

The top, bottom halves of the surface will map to left, right eyes

## Public functions

### toString

```
open fun toString(): String
```