li.cil.tis3d.api

Interface FontRendererAPI

All Known Implementing Classes:

FontRendererAPIImpl

@Environment(value=CLIENT)
public interface FontRendererAPI

API entry point for access to the tiny font renderer used on execution modules, for example.

Keep in mind that the list of printable characters is very small for this font renderer, due to the small number of characters in the font sheet.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FontRendererAPI.Font Font type; small font is found on eg.

Method Summary

Modifier and Type	Method and Description
net.minecraft.client.render.VertexConsumer	chooseVertexConsumer(FontRendererAPI.Font font, net.minecraft.client.render.VertexConsumerProvider vcp) Query an appropriate VertexConsumer for a given font type.
void	drawString(FontRendererAPI.Font font, net.minecraft.client.util.math.MatrixStack.Entry matrices, net.minecraft.client.render.VertexConsumer vc, int light, int overlay, int color, java.lang.CharSequence string, int maxChars) Render up to the specified amount of characters of the specified string.
void	drawString(java.lang.String string) Render the specified string.
void	drawString(java.lang.String string, int maxChars) Render up to the specified amount of characters of the specified string.
int	getCharHeight() Get the height of the characters drawn with the font renderer, in pixels.
int	getCharWidth() Get the width of the characters drawn with the font renderer, in pixels.

Method Detail

drawString

void drawString(java.lang.String string)

Render the specified string.

Parameters:

string - the string to render.

drawString

void drawString(java.lang.String string,
                int maxChars)

Render up to the specified amount of characters of the specified string.

This is intended as a convenience method for clamped-width rendering, avoiding additional string operations such as substring.

Parameters:

string - the string to render.

maxChars - the maximum number of characters to render.

drawString

void drawString(FontRendererAPI.Font font,
                net.minecraft.client.util.math.MatrixStack.Entry matrices,
                net.minecraft.client.render.VertexConsumer vc,
                int light,
                int overlay,
                int color,
                java.lang.CharSequence string,
                int maxChars)

Render up to the specified amount of characters of the specified string.

Parameters:

font - the font type.

matrices - the current transformation.

vc - the VertexConsumer queried via chooseVertexConsumer.

light - the light value, usually RenderUtil.maxLight.

overlay - the overlay value, passed from vanilla.

color - the text color, in 0xAARRGGBB.

string - the string to render.

maxChars - the maximum number of characters to render.

chooseVertexConsumer

net.minecraft.client.render.VertexConsumer chooseVertexConsumer(FontRendererAPI.Font font,
                                                                net.minecraft.client.render.VertexConsumerProvider vcp)

Query an appropriate VertexConsumer for a given font type.

Parameters:

font - the font type.

vcp - the VertexConsumerProvider for this frame.

Returns:

the VertexConsumer instance to use with further text render calls.

getCharWidth

int getCharWidth()

Get the width of the characters drawn with the font renderer, in pixels.

Returns:

the width of the drawn characters.

getCharHeight

int getCharHeight()

Get the height of the characters drawn with the font renderer, in pixels.

Returns:

the height of the drawn characters.