Class TextBevel

Namespace

Stride.CommunityToolkit.Rendering.Text

Assembly

Stride.CommunityToolkit.dll

A rounded edge between the caps and the walls of 3D text: a quarter-ellipse fillet, the same on the front and the back.

public sealed record TextBevel : IEquatable<TextBevel>

Inheritance

object

TextBevel

Implements

IEquatable<TextBevel>

Remarks

A bevel wider than a glyph's thinnest stem would fold the cap over itself; TextMesh halves Size for that glyph until it fits, up to six times, before giving up on it. In world units, like Depth.

Constructors

TextBevel(float, float, int)

Creates a bevel.

public TextBevel(float size, float thickness, int segments = 3)

Parameters

size float

How far the bevel reaches in from the outline across the cap, in world units.

thickness float

How far the bevel reaches along the depth, from the cap towards the middle, in world units; capped at half the depth.

segments int

How many steps the rounding takes; 1 is a chamfer, 3 reads as round, 6 is smooth up close.

Exceptions

ArgumentOutOfRangeException

The size or the thickness is not a positive finite number, or there are no segments.

Properties

Segments

How many steps the rounding takes.

public int Segments { get; }

Property Value

int

Size

How far the bevel reaches in from the outline across the cap, in world units.

public float Size { get; }

Property Value

float

Thickness

How far the bevel reaches along the depth, from the cap towards the middle, in world units.

public float Thickness { get; }

Property Value

float