API reference

StereoCanvasPanelSettings Class

Implements PanelSettings

Settings for a panel that renders custom stereo canvas content directly to a panel surface.

This API paints two versions of the content per frame (one per eye), so draw work is doubled compared to a regular Android canvas. Treat it as a stereo rendering surface, not a general 2D canvas.

The rendering modifier is intentionally open-ended, so apps can combine this content source with existing panel render options while this API evolves.

Signature

data class StereoCanvasPanelSettings(
    val shape: MediaPanelShapeOptions = QuadShapeOptions(),
    val perEyeWidthPx: Int,
    val perEyeHeightPx: Int,
    val layout: StereoCanvasLayout = StereoCanvasLayout.Mono,
    val rendering: PanelConfigOptionsModifier = MediaPanelRenderOptions(),
    val enableTransparent: Boolean? = null,
    val style: PanelStyleOptions = PanelStyleOptions(),
    val input: PanelInputOptions = PanelInputOptions(),
) : PanelSettings

Constructors

StereoCanvasPanelSettings ( shape , perEyeWidthPx , perEyeHeightPx , layout , rendering , enableTransparent , style , input )

Signature

constructor(
    shape: MediaPanelShapeOptions = QuadShapeOptions(),
    perEyeWidthPx: Int,
    perEyeHeightPx: Int,
    layout: StereoCanvasLayout = StereoCanvasLayout.Mono,
    rendering: PanelConfigOptionsModifier = MediaPanelRenderOptions(),
    enableTransparent: Boolean? = null,
    style: PanelStyleOptions = PanelStyleOptions(),
    input: PanelInputOptions = PanelInputOptions(),
)

Parameters

shape: MediaPanelShapeOptions

perEyeWidthPx: Int

perEyeHeightPx: Int

layout: StereoCanvasLayout

rendering: PanelConfigOptionsModifier

enableTransparent: Boolean?

style: PanelStyleOptions

input: PanelInputOptions

Returns

StereoCanvasPanelSettings

Properties

enableTransparent : Boolean? [Get]	Signature val enableTransparent: Boolean? = null
input : PanelInputOptions [Get]	Signature val input: PanelInputOptions
layout : StereoCanvasLayout [Get]	Signature val layout: StereoCanvasLayout
perEyeHeightPx : Int [Get]	Signature val perEyeHeightPx: Int
perEyeWidthPx : Int [Get]	Signature val perEyeWidthPx: Int
rendering : PanelConfigOptionsModifier [Get]	Signature val rendering: PanelConfigOptionsModifier
shape : MediaPanelShapeOptions [Get]	Signature val shape: MediaPanelShapeOptions
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.