# RenderViewpoint

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

*** ** * ** ***


```
public final class RenderViewpoint
```

<br />

*** ** * ** ***

Viewpoint used for rendering.

This class provides access to the `https://developer.android.com/reference/androidx/xr/arcore/RenderViewpoint.State` of a specific render viewpoint, including its `https://developer.android.com/reference/androidx/xr/arcore/RenderViewpoint.State#pose()`, `https://developer.android.com/reference/androidx/xr/arcore/RenderViewpoint.State#localPose()`, and `https://developer.android.com/reference/androidx/xr/arcore/RenderViewpoint.State#fieldOfView()`.

## Summary

| ### Nested types |
|---|
| `public final class https://developer.android.com/reference/androidx/xr/arcore/RenderViewpoint.State` Class that contains the current state of the render viewpoint. |

| ### Public methods |
|---|---|
| `boolean` | `https://developer.android.com/reference/androidx/xr/arcore/RenderViewpoint#equals(kotlin.Any)(https://developer.android.com/reference/java/lang/Object.html other)` |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-state-flow/index.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/arcore/RenderViewpoint.State>` | `https://developer.android.com/reference/androidx/xr/arcore/RenderViewpoint#getState()()` the current `https://developer.android.com/reference/androidx/xr/arcore/RenderViewpoint.State` of the render viewpoint |
| `int` | `https://developer.android.com/reference/androidx/xr/arcore/RenderViewpoint#hashCode()()` |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/arcore/RenderViewpoint` | `https://developer.android.com/reference/androidx/xr/arcore/RenderViewpoint#left(androidx.xr.runtime.Session)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/runtime/Session session)` Returns the RenderViewpoint associated with the left display. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/arcore/RenderViewpoint` | `https://developer.android.com/reference/androidx/xr/arcore/RenderViewpoint#mono(androidx.xr.runtime.Session)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/runtime/Session session)` Returns the RenderViewpoint associated with the single device display. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/arcore/RenderViewpoint` | `https://developer.android.com/reference/androidx/xr/arcore/RenderViewpoint#right(androidx.xr.runtime.Session)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/runtime/Session session)` Returns the RenderViewpoint associated with the right display. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/xr/arcore/RenderViewpoint#toString()()` Returns a string representation of `https://developer.android.com/reference/androidx/xr/arcore/RenderViewpoint` for debugging. |

## Public methods

### equals

```
public boolean equals(Object other)
```

### getState

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-arcore#1.0.0)

```
public final @NonNull StateFlow<@NonNull RenderViewpoint.State> getState()
```

the current `https://developer.android.com/reference/androidx/xr/arcore/RenderViewpoint.State` of the render viewpoint

### hashCode

```
public int hashCode()
```

### left

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-arcore#1.0.0)

```
public static final @NonNull RenderViewpoint left(@NonNull Session session)
```

Returns the RenderViewpoint associated with the left display.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/runtime/Session session` | the currently active `https://developer.android.com/reference/androidx/xr/runtime/Session` |

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-state-exception/index.html` | if the device does not support `https://developer.android.com/reference/androidx/xr/runtime/RenderingMode#STEREO()` |

### mono

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-arcore#1.0.0)

```
public static final @NonNull RenderViewpoint mono(@NonNull Session session)
```

Returns the RenderViewpoint associated with the single device display.

When the device supports `https://developer.android.com/reference/androidx/xr/runtime/RenderingMode#MONO()`, this will return the render viewpoint for that display. When the device uses `https://developer.android.com/reference/androidx/xr/runtime/RenderingMode#STEREO()`, this will return the render viewpoint for the center of the two displays.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/runtime/Session session` | the currently active `https://developer.android.com/reference/androidx/xr/runtime/Session` |

### right

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-arcore#1.0.0)

```
public static final @NonNull RenderViewpoint right(@NonNull Session session)
```

Returns the RenderViewpoint associated with the right display.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/runtime/Session session` | the currently active `https://developer.android.com/reference/androidx/xr/runtime/Session` |

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-state-exception/index.html` | if the device does not support `https://developer.android.com/reference/androidx/xr/runtime/RenderingMode#STEREO()` |

### toString

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

Returns a string representation of `https://developer.android.com/reference/androidx/xr/arcore/RenderViewpoint` for debugging.

Note: Not intended for production use.