Module technology.sola.engine

Package technology.sola.engine.graphics.gui.util

Class TextRenderUtils

java.lang.Object

technology.sola.engine.graphics.gui.util.TextRenderUtils

@NullMarked
public class TextRenderUtils
extends Object

TextRenderUtils contains methods useful for rendering text for a GUI.

Method Summary

Modifier and Type	Method	Description
static TextRenderDetails	calculateRenderDetails(Font font, String text, GuiElementBounds contentBounds)	Calculates TextRenderDetails for the text based on the content bounds available on current Font.
static void	renderLines(Renderer renderer, TextRenderDetails textRenderDetails, TextStyles.TextAlignment textAlignment, GuiElementBounds contentBounds, Color textColor)	Handles rendering lines of GUI text to a Renderer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

calculateRenderDetails

public static TextRenderDetails calculateRenderDetails(Font font,
 String text,
 GuiElementBounds contentBounds)

Calculates TextRenderDetails for the text based on the content bounds available on current Font.

Parameters:

font - the font to render with

text - the text to render

contentBounds - the bounds to render the text within

Returns:

the details needed to render the text

renderLines

public static void renderLines(Renderer renderer,
 TextRenderDetails textRenderDetails,
 TextStyles.TextAlignment textAlignment,
 GuiElementBounds contentBounds,
 Color textColor)

Handles rendering lines of GUI text to a Renderer.

Parameters:

renderer - the Renderer instance

textRenderDetails - the TextRenderDetails

textAlignment - the TextStyles.TextAlignment for rendering

contentBounds - the GuiElement's content GuiElementBounds

textColor - the Color of the lines of text