Class EntityDebugSceneRendererOptions

Namespace

Stride.CommunityToolkit.Rendering.Compositing

Assembly

Stride.CommunityToolkit.dll

Options for rendering debug information for entities in the scene.

public class EntityDebugSceneRendererOptions

Inheritance

object

EntityDebugSceneRendererOptions

Constructors

EntityDebugSceneRendererOptions()

Initializes a new instance of EntityDebugSceneRendererOptions with default settings.

public EntityDebugSceneRendererOptions()

EntityDebugSceneRendererOptions(int, Color)

Initializes a new instance of EntityDebugSceneRendererOptions with specified font size and color.

public EntityDebugSceneRendererOptions(int fontSize, Color fontColor)

Parameters

fontSize int

The size of the debug font text.

fontColor Color

The color of the debug font text.

Properties

BackgroundColor

Gets or sets the color of the background behind the text.

public Color4? BackgroundColor { get; set; }

Property Value

Color4?

EnableBackground

Gets or sets a value indicating whether to display a background behind the text.

public bool EnableBackground { get; set; }

Property Value

bool

FontColor

Gets or sets the font color for the debug text. Default is black.

public Color FontColor { get; set; }

Property Value

Color

FontSize

Gets or sets the font size for the debug text. Default is 12.

public int FontSize { get; set; }

Property Value

int

Offset

Gets or sets the offset for positioning the debug text relative to the entity. Default offset is (0, -25).

public Vector2 Offset { get; set; }

Property Value

Vector2

Padding

Gets or sets the padding around the text.

public float Padding { get; set; }

Property Value

float

ShowEntityName

Gets or sets a value indicating whether to show the entity's name. Default is true.

public bool ShowEntityName { get; set; }

Property Value

bool

ShowEntityPosition

Gets or sets a value indicating whether to show the entity's position.

public bool ShowEntityPosition { get; set; }

Property Value

bool

Methods

CreateDefault()

Provides default settings for rendering entity debug information.

public static EntityDebugSceneRendererOptions CreateDefault()

Returns

EntityDebugSceneRendererOptions

A new instance of EntityDebugSceneRendererOptions with default values.