Struct FontRenderingOptions

Namespace

Icy.Rendering.Fonts

Assembly

IcyUI.dll

Represents the options for rendering text with a custom font.

public readonly record struct FontRenderingOptions : IEquatable<FontRenderingOptions>

Implements

IEquatable<FontRenderingOptions>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

PropertyReferencesExtensions.ContainsProperty(object, IPropertyReference)

Constructors

FontRenderingOptions(Vector2, Vector2?, float, Vector2, float, float, Color, float, ICustomFontEffect?)

Represents the options for rendering text with a custom font.

public FontRenderingOptions(Vector2 Position, Vector2? Scale, float Rotation, Vector2 Origin, float CharacterSpacing, float LineSpacing, Color Color, float Depth, ICustomFontEffect? Effect)

Parameters

Position Vector2

The position of the text in the rendering space.

Scale Vector2?

The scale factor for the text. If null, the default scale will be used.

Rotation float

The rotation angle of the text in degrees.

Origin Vector2

The origin point for the text rotation.

CharacterSpacing float

The spacing between characters in the text.

LineSpacing float

The spacing between lines of text.

Color Color

The color of the text.

Depth float

The depth value for rendering, used for layering in 3D space.

Effect ICustomFontEffect

An optional custom font effect to apply to the text.

Properties

CharacterSpacing

The spacing between characters in the text.

public float CharacterSpacing { get; init; }

Property Value

float

Color

The color of the text.

public Color Color { get; init; }

Property Value

Color

Depth

The depth value for rendering, used for layering in 3D space.

public float Depth { get; init; }

Property Value

float

Effect

An optional custom font effect to apply to the text.

public ICustomFontEffect? Effect { get; init; }

Property Value

ICustomFontEffect

LineSpacing

The spacing between lines of text.

public float LineSpacing { get; init; }

Property Value

float

Origin

The origin point for the text rotation.

public Vector2 Origin { get; init; }

Property Value

Vector2

Position

The position of the text in the rendering space.

public Vector2 Position { get; init; }

Property Value

Vector2

Rotation

The rotation angle of the text in degrees.

public float Rotation { get; init; }

Property Value

float

Scale

The scale factor for the text. If null, the default scale will be used.

public Vector2? Scale { get; init; }

Property Value

Vector2?