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

ReadableMediaPanelRenderOptions Class

Modifiers: final
Rendering configuration specific to post-processing supported media panels. These are useful for panels that can have shaders and supports transparency.

Signature

data class ReadableMediaPanelRenderOptions(val mips: Int = 1, val stereoMode: StereoMode = StereoMode.None, val samplerConfig: SamplerConfig = PanelConfigOptions.DEFAULT_PANEL_SAMPLER, val renderMode: PanelRenderMode = PanelRenderMode.Layer(), val zIndex: Int = 0) : PanelConfigOptionsModifier

Constructors

ReadableMediaPanelRenderOptions ( mips , stereoMode , samplerConfig , renderMode , zIndex )
Signature
constructor(mips: Int = 1, stereoMode: StereoMode = StereoMode.None, samplerConfig: SamplerConfig = PanelConfigOptions.DEFAULT_PANEL_SAMPLER, renderMode: PanelRenderMode = PanelRenderMode.Layer(), zIndex: Int = 0)
Parameters
mips: Int
  Number of mip levels to use for panel texture. Mipmapping is the process of generating lower resolution versions of a texture to display on panels when they are far away.
stereoMode: StereoMode
  The StereoMode to use for the panel.
samplerConfig: SamplerConfig
  The SamplerConfig to set the panel texture/layer.
renderMode: PanelRenderMode
  Control how the panel will render in the scene. Use layers to make panels appear crisp and high resolution, or mesh for basic rendering without compositor layers.
zIndex: Int
  The zIndex to set the panel layer.

Properties

mips : Int
[Get]
Number of mip levels to use for panel texture. Mipmapping is the process of generating lower resolution versions of a texture to display on panels when they are far away.
Signature
val mips: Int = 1
renderMode : PanelRenderMode
[Get]
Control how the panel will render in the scene. Use layers to make panels appear crisp and high resolution, or mesh for basic rendering without compositor layers.
Signature
val renderMode: PanelRenderMode
samplerConfig : SamplerConfig
[Get]
The SamplerConfig to set the panel texture/layer.
Signature
val samplerConfig: SamplerConfig
stereoMode : StereoMode
[Get]
The StereoMode to use for the panel.
Signature
val stereoMode: StereoMode
zIndex : Int
[Get]
The zIndex to set the panel layer.
Signature
val zIndex: Int = 0

Functions

applyTo ( options )
Signature
open override fun applyTo(options: PanelConfigOptions)
Parameters
Did you find this page helpful?