bool Overlay { get; set; }

book_4_sparkGenerated
code_blocksInput

Description

The Overlay property of the RenderOptions class determines whether the rendering should occur above all other elements in the scene. When set to true, the associated scene object will be rendered on top of everything else, ensuring it is always visible regardless of other scene elements.

Usage

To use the Overlay property, you can set it on an instance of RenderOptions associated with a SceneObject. This is particularly useful for elements that need to be prominently displayed, such as HUD elements or important notifications.

Example

// Create a new RenderOptions instance
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);