core/com.pico.spatial.core.ecs.resource/VideoMaterial

VideoMaterial

class VideoMaterial : Material

A material specialized for rendering spatial videos.

This material supports immersive spatial video experiences by providing essential tools to achieve a variety of visual effects. Additionally, a ShaderGraphMaterial can be attached to apply rendering effects directly to the texture used by VideoMaterial during rendering.

Notes:

When a ShaderGraphMaterial is attached, it should be detached once it is no longer needed by the current VideoMaterial. Any previously attached ShaderGraphMaterial will be automatically released unless it has been marked as a global resource via the `.toGlobal()' method as shown in the following example:

val bundle = AssetBundle.load("asset://your_shaderGraphMaterial_name.bundle")
val shaderMat = ShaderGraphMaterial.loadFromAssetBundle(bundle, "relative_path_in_AssetBundle")
shaderMat.toGlobal()
videoMaterial.attachShaderGraphMaterial(shaderMat)

Detaching a ShaderGraphMaterial will release it if it is not marked as a global resource. To make a material global, call .toGlobal() like shown in the example above.

See also

ShaderGraphMaterial

Constructors

@ExperimentalSpatialApi

constructor(blendingMode: BlendingMode, videoDimensionMode: VideoDimensionMode, cullingMode: MaterialCullingMode, defaultColor: Color4 = Color4.BLACK, onHardwareBufferRelease: HardwareBufferReleaseCallback? = null)

Creates a VideoMaterial with the specified BlendingMode, VideoDimensionMode, and MaterialCullingMode.

constructor(blendingMode: BlendingMode, videoDimensionMode: VideoDimensionMode, cullingMode: MaterialCullingMode, defaultColor: Color4 = Color4.BLACK)

Creates a VideoMaterial with the specified BlendingMode, VideoDimensionMode, and MaterialCullingMode.

Functions

attachShaderGraphMaterial

fun attachShaderGraphMaterial(shaderGraphMaterial: ShaderGraphMaterial): Boolean

Attaches a valid ShaderGraphMaterial to the VideoMaterial.

bindSurfaceRenderTexture

fun bindSurfaceRenderTexture(surfaceRenderTexture: SurfaceRenderTexture)

Bind a SurfaceRenderTexture instance with current video material.

detachShaderGraphMaterial

fun detachShaderGraphMaterial()

Detaches the previously attached ShaderGraphMaterial from the VideoMaterial.

getBindSurfaceRenderTexture

fun getBindSurfaceRenderTexture(): SurfaceRenderTexture?

Gets the bind SurfaceRenderTexture of the VideoMaterial.

fun getCullingMode(): MaterialCullingMode

Gets the MaterialCullingMode of the VideoMaterial.

fun getDepthTest(): Boolean

Gets the state of depth testing for the VideoMaterial.

fun getDepthWrite(): Boolean

Gets the state of depth writing for the VideoMaterial.

getDimensionMode

fun getDimensionMode(): VideoDimensionMode

Gets the VideoDimensionMode of the VideoMaterial.

getShaderGraphMaterial

fun getShaderGraphMaterial(): ShaderGraphMaterial?

Gets the attached ShaderGraphMaterial of the VideoMaterial.

fun setCullingMode(cullingMode: MaterialCullingMode)

Sets the MaterialCullingMode of the VideoMaterial.

fun setDepthTest(depthTest: Boolean)

Enables or disables depth testing for the VideoMaterial.

fun setDepthWrite(depthWrite: Boolean)

Enables or disables depth writing for the VideoMaterial.

setDimensionMode

fun setDimensionMode(videoDimensionMode: VideoDimensionMode)

Sets the VideoDimensionMode of the VideoMaterial.

setHardwareBuffer

@RequiresApi(value = 28)

@ExperimentalSpatialApi

fun setHardwareBuffer(hwBuffer: HardwareBuffer): Boolean

Sets the image HardwareBuffer of the VideoMaterial in the following modes: VideoDimensionMode.MONO, VideoDimensionMode.SIDE_BY_SIDE, and VideoDimensionMode.TOP_AND_DOWN.

@RequiresApi(value = 28)

@ExperimentalSpatialApi

fun setHardwareBuffer(leftEyeBuffer: HardwareBuffer, rightEyeBuffer: HardwareBuffer): Boolean

Sets the image of the VideoMaterial in VideoDimensionMode.MULTIPLE_VIEW mode.

@ExperimentalSpatialApi

fun setTexture(texture: TextureResource)

Sets the TextureResource of the VideoMaterial in the following modes: VideoDimensionMode.MONO, VideoDimensionMode.SIDE_BY_SIDE, and VideoDimensionMode.TOP_AND_DOWN.

@ExperimentalSpatialApi

fun setTexture(textureLeft: TextureResource, textureRight: TextureResource)

Sets the TextureResource of the VideoMaterial in VideoDimensionMode.MULTIPLE_VIEW.

unbindSurfaceRenderTexture

fun unbindSurfaceRenderTexture()

Unbind surface render texture with current video material.