Class LightDirectionalGizmo

Namespace

Stride.CommunityToolkit.Rendering.Gizmos

Assembly

Stride.CommunityToolkit.dll

Represents a directional light gizmo used to visually represent light direction in a 3D scene.

public class LightDirectionalGizmo

Inheritance

object

LightDirectionalGizmo

Constructors

LightDirectionalGizmo(GraphicsDevice, Color?)

Initializes a new instance of the LightDirectionalGizmo class with the specified graphics device and optional color.

public LightDirectionalGizmo(GraphicsDevice graphicsDevice, Color? color = null)

Parameters

graphicsDevice GraphicsDevice

The graphics device used to render the gizmo.

color Color?

An optional color to apply to the gizmo. If null, white is used.

Exceptions

ArgumentNullException

Thrown if the graphicsDevice is null.

Methods

Create(Entity)

Creates the directional light gizmo and attaches it to the specified root entity.

public Entity Create(Entity root)

Parameters

root Entity

The root entity to which the light gizmo is attached.

Returns

Entity

The root entity with the light gizmo added.