PanelClippingConfig

class PanelClippingConfig

Defines the clipping configuration for all panels within the Scene.

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

Summary

Public constructors
PanelClippingConfig(isDepthTestEnabled: Boolean)

Public functions
PanelClippingConfig
copy(isDepthTestEnabled: Boolean)

Returns a copy of this configuration with the specified values updated.
open operator Boolean
equals(other: Any?)
open Int
open String

Public properties
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.

Public constructors

PanelClippingConfig

Added in 1.0.0-alpha05
PanelClippingConfig(isDepthTestEnabled: Boolean = true)

Public functions

copy

Added in 1.0.0-alpha05
fun copy(isDepthTestEnabled: Boolean = this.isDepthTestEnabled): PanelClippingConfig

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

Parameters
isDepthTestEnabled: Boolean = this.isDepthTestEnabled

The new depth test enabled state.
Returns
PanelClippingConfig

A new 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-alpha05
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.