API reference

CylinderLayerConfig Class

Extends LayerConfig

DeprecatedUse PanelConfigOptions.panelShapeType instead

Layer config for a single-sided, cylindrical surface

Signature

class CylinderLayerConfig(
    var radius: Float,
    var alphaBlend: LayerAlphaBlend? = null,
    var colorScaleBias: LayerColorScaleBias? = null,
    var zIndex: Int = 0,
) : LayerConfig

Constructors

CylinderLayerConfig ( radius , alphaBlend , colorScaleBias , zIndex )

Signature

constructor(
    radius: Float,
    alphaBlend: LayerAlphaBlend? = null,
    colorScaleBias: LayerColorScaleBias? = null,
    zIndex: Int = 0,
)

Parameters

radius: Float

alphaBlend: LayerAlphaBlend?

colorScaleBias: LayerColorScaleBias?

zIndex: Int

Returns

CylinderLayerConfig

Properties

alphaBlend : LayerAlphaBlend? [Get][Set]	Configuration for alpha blending, or null to use default blending Signature var alphaBlend: LayerAlphaBlend?
colorScaleBias : LayerColorScaleBias? [Get][Set]	Color adjustment settings, or null to use default colors Signature var colorScaleBias: LayerColorScaleBias?
filters : Int [Get][Set]	Signature var filters: Int
radius : Float [Get][Set]	Signature var radius: Float
secure : Boolean [Get][Set]	Whether the layer should be rendered securely to enable DRM. Signature var secure: Boolean
zIndex : Int [Get][Set]	Integer value controlling the rendering order (higher values render on top). Layers of the same z-index are rendered based on the distance of entity origin from head pose. Signature var zIndex: Int

Methods

getAspectRatio ( config )	Signature fun getAspectRatio(config: PanelShapeConfig): Float Parameters `config: PanelShapeConfig` Returns `Float`
getCentralAngle ( config )	Signature fun getCentralAngle(config: PanelShapeConfig) = minOf(config.width / radius, Math.PI.toFloat()) Parameters `config: PanelShapeConfig`