API reference
API reference
Select your platform
No SDKs available
No versions available

UIPanelSettings Class

Implements PanelSettings
 Modifiers: final
Configuration for interactive UI panels, combining shape, display, rendering, style, and input options into a single PanelSettings implementation. The primary panel type for Compose-based user interfaces. Defaults to a quad-shaped panel with screen-fraction display sizing, layer rendering, transparent theme, and standard click button input.

Signature

class UIPanelSettings(val shape: UIPanelShapeOptions = QuadShapeOptions(), val display: UIPanelDisplayOptions = ScreenFractionDisplayOptions(), val rendering: UIPanelRenderOptions = UIPanelRenderOptions(), val style: PanelStyleOptions = PanelStyleOptions(), val input: PanelInputOptions = PanelInputOptions()) : PanelSettings

Constructors

UIPanelSettings ( shape , display , rendering , style , input )
Signature 
constructor(shape: UIPanelShapeOptions = QuadShapeOptions(), display: UIPanelDisplayOptions = ScreenFractionDisplayOptions(), rendering: UIPanelRenderOptions = UIPanelRenderOptions(), style: PanelStyleOptions = PanelStyleOptions(), input: PanelInputOptions = PanelInputOptions())
Parameters
shape: UIPanelShapeOptions
display: UIPanelDisplayOptions
rendering: UIPanelRenderOptions
style: PanelStyleOptions
input: PanelInputOptions
Returns
UIPanelSettings

Properties

display : UIPanelDisplayOptions
[Get]
Signature 
val display: UIPanelDisplayOptions
input : PanelInputOptions
[Get]
Signature 
val input: PanelInputOptions
rendering : UIPanelRenderOptions
[Get]
Signature 
val rendering: UIPanelRenderOptions
shape : UIPanelShapeOptions
[Get]
Signature 
val shape: UIPanelShapeOptions
style : PanelStyleOptions
[Get]
Signature 
val style: PanelStyleOptions

Methods

toPanelConfigOptions ()
Converts these high-level panel settings into a low-level PanelConfigOptions object consumed by the panel rendering system. Applies rendering, shape, display, style, and input modifiers in the correct order.
Signature 
open override fun toPanelConfigOptions(): PanelConfigOptions
Returns
PanelConfigOptions  A fully configured PanelConfigOptions ready for the panel rendering system.
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta