Text.SizeRender

static Vec2 SizeRender(Vec2 sizeLayout, TextStyle style, Single& yOffset)

This modifies a text layout size to include the tallest and lowest possible values for the glyphs in this font. This is for when you need to be careful about avoiding clipping that would happen if you only used the layout size.

   
Vec2 sizeLayout A size previously calculated using Text.SizeLayout.
TextStyle style The same style as used for calculating the sizeLayout.
Single& yOffset Since the render size will ascend from the initial position, this will be the offset from the initial position upwards. You should add it to your Y position.
RETURNS: Vec2 The sizeLayout modified to account for the size of the most extreme glyphs.

Examples

Text Sizes

When you need to work with placing text, Text.SizeLayout and Text.SizeRender are the keys to the kingdom! SizeLayout will give you the size of your text as far as layout is generally concerned, while SizeRender will take your layout size and provide the total bounds that you need to watch out for! Some fonts can have absolutely unreasonable ascenders and descenders for some of their glyphs. Extreme cases can be a bit rare, so in general you’ll only need to work with the layout size. Just watch out when you need to clip your text!

Text sizes You can see here with Segoe UI, the ascender area for rendering looks ridiculous.

In this screenshot, the black area represents the layout size, while the gray area represents the render size. “lÔTy” is a decent set of characters to illustrate a pretty normal range of height variation.

string text  = "lÔTy";
TextStyle style = TextStyle.Default;

Text.Add(text, Matrix.Identity, style, TextAlign.Center);

// Calculate the text sizes! Layout size is used for placing text, but
// render size indicates the total area where text could end up,
// accounting for _extreme_ ascenders and descenders.
Vec2 layoutSz = Text.SizeLayout(text,     style);
Vec2 renderSz = Text.SizeRender(layoutSz, style, out float renderYOff);

// Draw the layout size behind the text in black
Mesh.Quad.Draw(Material.Unlit,
	Matrix.TS(V.XYZ(0, 0, 0.0001f), (-layoutSz).XY1),
	Color.Black);

// Draw the render size behind the text in gray, note that we're
// dividing the y offset by 2 because we're drawing from the _center_
// of a quad rather than something like the top left.
Mesh.Quad.Draw(Material.Unlit,
	Matrix.TS(V.XYZ(0, renderYOff/2.0f, 0.0002f), (-renderSz).XY1),
	new Color(0.2f,0.2f,0.2f));



Found an issue with these docs, or have some additional questions? Create an Issue on Github!