# 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)

*** ** * ** ***


```
public final 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 fields |
|---|---|
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity.StereoMode` | `https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity.StereoMode#MONO()` Each eye will see the entire surface (no separation) |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity.StereoMode` | `https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity.StereoMode#MULTIVIEW_LEFT_PRIMARY()` Multiview video, primary, auxiliary views will map to left, right eyes |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity.StereoMode` | `https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity.StereoMode#MULTIVIEW_RIGHT_PRIMARY()` Multiview video, primary, auxiliary views will map to right, left eyes |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity.StereoMode` | `https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity.StereoMode#SIDE_BY_SIDE()` The left, right halves of the surface will map to left, right eyes |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity.StereoMode` | `https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity.StereoMode#TOP_BOTTOM()` The top, bottom halves of the surface will map to left, right eyes |

| ### Public methods |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity.StereoMode#toString()()` |

## Public fields

### MONO

```
public static final @NonNull SurfaceEntity.StereoMode MONO
```

Each eye will see the entire surface (no separation)

### MULTIVIEW_LEFT_PRIMARY

```
public static final @NonNull SurfaceEntity.StereoMode MULTIVIEW_LEFT_PRIMARY
```

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

### MULTIVIEW_RIGHT_PRIMARY

```
public static final @NonNull SurfaceEntity.StereoMode MULTIVIEW_RIGHT_PRIMARY
```

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

### SIDE_BY_SIDE

```
public static final @NonNull SurfaceEntity.StereoMode SIDE_BY_SIDE
```

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

### TOP_BOTTOM

```
public static final @NonNull SurfaceEntity.StereoMode TOP_BOTTOM
```

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

## Public methods

### toString

```
public @NonNull String toString()
```