All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Modules Pages
Loading...
Searching...
No Matches
VideoBackground Class Reference

Provides access to VideoBackground rendering specific features. More...

Public Member Functions

void SetVideoBackgroundMaterial (Material mat)
 Set a custom video background material.
 
void StartVideoBackgroundRendering ()
 Start video background rendering (enable)
 
void StopVideoBackgroundRendering ()
 Stop video background rendering (enable)
 

Properties

Texture VideoBackgroundTexture [get]
 The texture the video background is rendered into.
 

Events

Action OnVideoBackgroundChanged
 Gets called when the video background has been updated and is ready to use. After this call, it's safe to access the VideoBackgroundTexture.
 

Detailed Description

Provides access to VideoBackground rendering specific features.

Member Function Documentation

◆ SetVideoBackgroundMaterial()

void SetVideoBackgroundMaterial ( Material mat)
inline

Set a custom video background material.

Parameters
mat
Exceptions
NotImplementedException

◆ StartVideoBackgroundRendering()

void StartVideoBackgroundRendering ( )
inline

Start video background rendering (enable)

◆ StopVideoBackgroundRendering()

void StopVideoBackgroundRendering ( )
inline

Stop video background rendering (enable)

Property Documentation

◆ VideoBackgroundTexture

Texture VideoBackgroundTexture
get

The texture the video background is rendered into.

Event Documentation

◆ OnVideoBackgroundChanged

Action OnVideoBackgroundChanged

Gets called when the video background has been updated and is ready to use. After this call, it's safe to access the VideoBackgroundTexture.