Description
The Overlay
property of the RenderOptions
class is a boolean value that determines whether the rendering should occur above all other elements. When set to true
, the rendering is prioritized to be on top of everything else in the scene, making it useful for elements that need to be visible at all times, such as HUDs or overlays.
Usage
To use the Overlay
property, you can set it on an instance of the RenderOptions
class. This property is typically used when configuring rendering settings for a SceneObject
to ensure that certain elements are rendered above others.
Example
// Example of setting the Overlay property
RenderOptions renderOptions = new RenderOptions();
renderOptions.Overlay = true;
// Apply these render options to a SceneObject
SceneObject mySceneObject = new SceneObject();
renderOptions.Apply(mySceneObject);