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 prominently displayed, such as overlays or HUD elements.
To use the Overlay property, you need to create an instance of the RenderOptions class and set the Overlay property to true or false depending on your rendering needs. This property is particularly useful when you want to ensure that certain elements are always visible above others.
// Create a new instance of RenderOptions RenderOptions renderOptions = new RenderOptions(); // Set the Overlay property to true to render above everything else renderOptions.Overlay = true; // Apply these render options to a SceneObject SceneObject mySceneObject = new SceneObject(); renderOptions.Apply(mySceneObject);