# PanelClippingConfig

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/PanelClippingConfig.kt+class:androidx.xr.scenecore.PanelClippingConfig) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

*** ** * ** ***


```
class PanelClippingConfig
```

<br />

*** ** * ** ***

Defines the clipping configuration for all panels within the `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene`.

This setting cannot be applied to an individual panel within the Scene, it must apply to all panels.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/PanelClippingConfig#PanelClippingConfig(kotlin.Boolean)(isDepthTestEnabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)` |

| ### Public functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/PanelClippingConfig` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/PanelClippingConfig#copy(kotlin.Boolean)(isDepthTestEnabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)` Returns a copy of this configuration with the specified values updated. |
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/PanelClippingConfig#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/PanelClippingConfig#hashCode()()` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/PanelClippingConfig#toString()()` |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/PanelClippingConfig#isDepthTestEnabled()` When `true`, enables depth testing for all panels in the Scene, allowing them to be drawn in an intuitive, distance-based way with respect to other objects in the scene, including other panels and the environment. |

## Public constructors

### PanelClippingConfig

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

```
PanelClippingConfig(isDepthTestEnabled: Boolean = true)
```

## Public functions

### copy

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

```
fun copy(isDepthTestEnabled: Boolean = this.isDepthTestEnabled): PanelClippingConfig
```

Returns a copy of this configuration with the specified values updated.

| Parameters |
|---|---|
| `isDepthTestEnabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = this.isDepthTestEnabled` | The new depth test enabled state. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/PanelClippingConfig` | A new `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/PanelClippingConfig` instance with the updated values. |

### equals

```
open operator fun equals(other: Any?): Boolean
```

### hashCode

```
open fun hashCode(): Int
```

### toString

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

## Public properties

### isDepthTestEnabled

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

```
val isDepthTestEnabled: Boolean
```

When `true`, enables depth testing for all panels in the Scene, allowing them to be drawn in an intuitive, distance-based way with respect to other objects in the scene, including other panels and the environment. When `false`, all panels are rendered on top of any other non-depth-tested 3D content that were drawn **before** them, regardless of their actual distance (i.e., depth) from the camera. The `false` setting can be used to ensure panels are drawn on top of the virtual environment, i.e., they do not clip into the environment.