io.github.cottonmc.cotton.gui.client

Class ScreenDrawing

java.lang.Object

io.github.cottonmc.cotton.gui.client.ScreenDrawing

public class ScreenDrawing
extends java.lang.Object

ScreenDrawing contains utility methods for drawing contents on a screen.

Method Summary

Modifier and Type	Method and Description
static int	colorAtOpacity(int opaque, float opacity)
static void	coloredRect(net.minecraft.client.util.math.MatrixStack matrices, int left, int top, int width, int height, int color) Draws an untextured rectangle of the specified RGB color.
static void	drawBeveledPanel(net.minecraft.client.util.math.MatrixStack matrices, int x, int y) Draws a default-sized recessed itemslot panel
static void	drawBeveledPanel(net.minecraft.client.util.math.MatrixStack matrices, int x, int y, int width, int height) Draws a default-color recessed itemslot panel of variable size
static void	drawBeveledPanel(net.minecraft.client.util.math.MatrixStack matrices, int x, int y, int width, int height, int topleft, int panel, int bottomright) Draws a generalized-case beveled panel.
static void	drawGuiPanel(net.minecraft.client.util.math.MatrixStack matrices, int x, int y, int width, int height) Draws a beveled, round rectangle that is substantially similar to default Minecraft UI panels.
static void	drawGuiPanel(net.minecraft.client.util.math.MatrixStack matrices, int x, int y, int width, int height, int panelColor) Draws a beveled, round, and colored rectangle that is substantially similar to default Minecraft UI panels.
static void	drawGuiPanel(net.minecraft.client.util.math.MatrixStack matrices, int x, int y, int width, int height, int shadow, int panel, int hilight, int outline) Draws a beveled, round rectangle with custom edge colors that is substantially similar to default Minecraft UI panels.
static void	drawString(net.minecraft.client.util.math.MatrixStack matrices, net.minecraft.text.OrderedText text, HorizontalAlignment align, int x, int y, int width, int color) Draws a text component with a custom alignment.
static void	drawString(net.minecraft.client.util.math.MatrixStack matrices, net.minecraft.text.OrderedText text, int x, int y, int color) Draws a left-aligned text component.
static void	drawString(net.minecraft.client.util.math.MatrixStack matrices, java.lang.String s, HorizontalAlignment align, int x, int y, int width, int color) Draws a string with a custom alignment.
static void	drawString(net.minecraft.client.util.math.MatrixStack matrices, java.lang.String s, int x, int y, int color) Draws a left-aligned string.
static void	drawStringWithShadow(net.minecraft.client.util.math.MatrixStack matrices, net.minecraft.text.OrderedText text, HorizontalAlignment align, int x, int y, int width, int color) Draws a shadowed text component.
static void	drawStringWithShadow(net.minecraft.client.util.math.MatrixStack matrices, java.lang.String s, HorizontalAlignment align, int x, int y, int width, int color) Draws a shadowed string.
static void	drawTextHover(net.minecraft.client.util.math.MatrixStack matrices, @Nullable net.minecraft.text.Style textStyle, int x, int y) Draws the text hover effects for a text style.
static int	multiplyColor(int color, float amount)
static void	texturedGuiRect(net.minecraft.client.util.math.MatrixStack matrices, int left, int top, int width, int height, net.minecraft.util.Identifier texture, int color) Draws a textured rectangle with UV values based on the width and height.
static void	texturedGuiRect(net.minecraft.client.util.math.MatrixStack matrices, int x, int y, int width, int height, net.minecraft.util.Identifier texture, int textureX, int textureY, int color) Draws a textured rectangle with UV values based on the width and height.
static void	texturedRect(net.minecraft.client.util.math.MatrixStack matrices, int x, int y, int width, int height, net.minecraft.util.Identifier texture, float u1, float v1, float u2, float v2, int color) Draws a textured rectangle.
static void	texturedRect(net.minecraft.client.util.math.MatrixStack matrices, int x, int y, int width, int height, net.minecraft.util.Identifier texture, float u1, float v1, float u2, float v2, int color, float opacity) Draws a textured rectangle.
static void	texturedRect(net.minecraft.client.util.math.MatrixStack matrices, int x, int y, int width, int height, net.minecraft.util.Identifier texture, int color) Draws a textured rectangle.
static void	texturedRect(net.minecraft.client.util.math.MatrixStack matrices, int x, int y, int width, int height, net.minecraft.util.Identifier texture, int color, float opacity) Draws a textured rectangle.
static void	texturedRect(net.minecraft.client.util.math.MatrixStack matrices, int x, int y, int width, int height, Texture texture, int color) Draws a textured rectangle.
static void	texturedRect(net.minecraft.client.util.math.MatrixStack matrices, int x, int y, int width, int height, Texture texture, int color, float opacity) Draws a textured rectangle.

Methods inherited from class java.lang.Object

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

Method Detail

texturedRect

public static void texturedRect(net.minecraft.client.util.math.MatrixStack matrices,
                                int x,
                                int y,
                                int width,
                                int height,
                                net.minecraft.util.Identifier texture,
                                int color)

Draws a textured rectangle.

Parameters:

matrices - the rendering matrix stack

x - the x coordinate of the box on-screen

y - the y coordinate of the box on-screen

width - the width of the box on-screen

height - the height of the box on-screen

texture - the Identifier for the texture

color - a color to tint the texture. This can be transparent! Use 0xFF_FFFFFF if you don't want a color tint

texturedRect

public static void texturedRect(net.minecraft.client.util.math.MatrixStack matrices,
                                int x,
                                int y,
                                int width,
                                int height,
                                net.minecraft.util.Identifier texture,
                                int color,
                                float opacity)

Draws a textured rectangle.

Parameters:

matrices - the rendering matrix stack

x - the x coordinate of the box on-screen

y - the y coordinate of the box on-screen

width - the width of the box on-screen

height - the height of the box on-screen

texture - the Identifier for the texture

color - a color to tint the texture. This can be transparent! Use 0xFF_FFFFFF if you don't want a color tint

opacity - opacity of the drawn texture. (0f is fully opaque and 1f is fully visible)

Since:

2.0.0

texturedRect

public static void texturedRect(net.minecraft.client.util.math.MatrixStack matrices,
                                int x,
                                int y,
                                int width,
                                int height,
                                net.minecraft.util.Identifier texture,
                                float u1,
                                float v1,
                                float u2,
                                float v2,
                                int color)

Draws a textured rectangle.

Parameters:

matrices - the rendering matrix stack

x - the x coordinate of the box on-screen

y - the y coordinate of the box on-screen

width - the width of the box on-screen

height - the height of the box on-screen

texture - the Identifier for the texture

u1 - the left edge of the texture

v1 - the top edge of the texture

u2 - the right edge of the texture

v2 - the bottom edge of the texture

color - a color to tint the texture. This can be transparent! Use 0xFF_FFFFFF if you don't want a color tint

texturedRect

public static void texturedRect(net.minecraft.client.util.math.MatrixStack matrices,
                                int x,
                                int y,
                                int width,
                                int height,
                                Texture texture,
                                int color)

Draws a textured rectangle.

Parameters:

matrices - the rendering matrix stack

x - the x coordinate of the box on-screen

y - the y coordinate of the box on-screen

width - the width of the box on-screen

height - the height of the box on-screen

texture - the texture

color - a color to tint the texture. This can be transparent! Use 0xFF_FFFFFF if you don't want a color tint

Since:

3.0.0

texturedRect

public static void texturedRect(net.minecraft.client.util.math.MatrixStack matrices,
                                int x,
                                int y,
                                int width,
                                int height,
                                Texture texture,
                                int color,
                                float opacity)

Draws a textured rectangle.

Parameters:

matrices - the rendering matrix stack

x - the x coordinate of the box on-screen

y - the y coordinate of the box on-screen

width - the width of the box on-screen

height - the height of the box on-screen

texture - the texture

color - a color to tint the texture. This can be transparent! Use 0xFF_FFFFFF if you don't want a color tint

opacity - opacity of the drawn texture. (0f is fully opaque and 1f is fully visible)

Since:

3.0.0

texturedRect

public static void texturedRect(net.minecraft.client.util.math.MatrixStack matrices,
                                int x,
                                int y,
                                int width,
                                int height,
                                net.minecraft.util.Identifier texture,
                                float u1,
                                float v1,
                                float u2,
                                float v2,
                                int color,
                                float opacity)

Draws a textured rectangle.

Parameters:

matrices - the rendering matrix stack

x - the x coordinate of the box on-screen

y - the y coordinate of the box on-screen

width - the width of the box on-screen

height - the height of the box on-screen

texture - the Identifier for the texture

u1 - the left edge of the texture

v1 - the top edge of the texture

u2 - the right edge of the texture

v2 - the bottom edge of the texture

color - a color to tint the texture. This can be transparent! Use 0xFF_FFFFFF if you don't want a color tint

opacity - opacity of the drawn texture. (0f is fully opaque and 1f is fully visible)

Since:

2.0.0

texturedGuiRect

public static void texturedGuiRect(net.minecraft.client.util.math.MatrixStack matrices,
                                   int x,
                                   int y,
                                   int width,
                                   int height,
                                   net.minecraft.util.Identifier texture,
                                   int textureX,
                                   int textureY,
                                   int color)

Draws a textured rectangle with UV values based on the width and height.

If the texture is 256x256, this draws the texture at one pixel per texel.

Parameters:

matrices - the rendering matrix stack

x - the x coordinate of the box on-screen

y - the y coordinate of the box on-screen

width - the width of the box on-screen

height - the height of the box on-screen

texture - the Identifier for the texture

textureX - the x offset into the texture

textureY - the y offset into the texture

color - a color to tint the texture. This can be transparent! Use 0xFF_FFFFFF if you don't want a color tint

texturedGuiRect

public static void texturedGuiRect(net.minecraft.client.util.math.MatrixStack matrices,
                                   int left,
                                   int top,
                                   int width,
                                   int height,
                                   net.minecraft.util.Identifier texture,
                                   int color)

Draws a textured rectangle with UV values based on the width and height.

If the texture is 256x256, this draws the texture at one pixel per texel.

Parameters:

matrices - the rendering matrix stack

left - the x coordinate of the box on-screen

top - the y coordinate of the box on-screen

width - the width of the box on-screen

height - the height of the box on-screen

texture - the Identifier for the texture

color - a color to tint the texture. This can be transparent! Use 0xFF_FFFFFF if you don't want a color tint

coloredRect

public static void coloredRect(net.minecraft.client.util.math.MatrixStack matrices,
                               int left,
                               int top,
                               int width,
                               int height,
                               int color)

Draws an untextured rectangle of the specified RGB color.

drawGuiPanel

public static void drawGuiPanel(net.minecraft.client.util.math.MatrixStack matrices,
                                int x,
                                int y,
                                int width,
                                int height)

Draws a beveled, round rectangle that is substantially similar to default Minecraft UI panels.

Parameters:

matrices - the rendering matrix stack

x - the X position of the panel

y - the Y position of the panel

width - the width of the panel

height - the height of the panel

drawGuiPanel

public static void drawGuiPanel(net.minecraft.client.util.math.MatrixStack matrices,
                                int x,
                                int y,
                                int width,
                                int height,
                                int panelColor)

Draws a beveled, round, and colored rectangle that is substantially similar to default Minecraft UI panels.

Parameters:

matrices - the rendering matrix stack

x - the X position of the panel

y - the Y position of the panel

width - the width of the panel

height - the height of the panel

panelColor - the panel ARGB color

drawGuiPanel

public static void drawGuiPanel(net.minecraft.client.util.math.MatrixStack matrices,
                                int x,
                                int y,
                                int width,
                                int height,
                                int shadow,
                                int panel,
                                int hilight,
                                int outline)

Draws a beveled, round rectangle with custom edge colors that is substantially similar to default Minecraft UI panels.

Parameters:

matrices - the rendering matrix stack

x - the X position of the panel

y - the Y position of the panel

width - the width of the panel

height - the height of the panel

shadow - the bottom/right shadow ARGB color

panel - the center ARGB color

hilight - the top/left hilight ARGB color

outline - the outline ARGB color

drawBeveledPanel

public static void drawBeveledPanel(net.minecraft.client.util.math.MatrixStack matrices,
                                    int x,
                                    int y)

Draws a default-sized recessed itemslot panel

drawBeveledPanel

public static void drawBeveledPanel(net.minecraft.client.util.math.MatrixStack matrices,
                                    int x,
                                    int y,
                                    int width,
                                    int height)

Draws a default-color recessed itemslot panel of variable size

drawBeveledPanel

public static void drawBeveledPanel(net.minecraft.client.util.math.MatrixStack matrices,
                                    int x,
                                    int y,
                                    int width,
                                    int height,
                                    int topleft,
                                    int panel,
                                    int bottomright)

Draws a generalized-case beveled panel. Can be inset or outset depending on arguments.

Parameters:

matrices - the rendering matrix stack

x - x coordinate of the topleft corner

y - y coordinate of the topleft corner

width - width of the panel

height - height of the panel

topleft - color of the top/left bevel

panel - color of the panel area

bottomright - color of the bottom/right bevel

drawString

public static void drawString(net.minecraft.client.util.math.MatrixStack matrices,
                              java.lang.String s,
                              HorizontalAlignment align,
                              int x,
                              int y,
                              int width,
                              int color)

Draws a string with a custom alignment.

Parameters:

matrices - the rendering matrix stack

s - the string

align - the alignment of the string

x - the X position

y - the Y position

width - the width of the string, used for aligning

color - the text color

drawString

public static void drawString(net.minecraft.client.util.math.MatrixStack matrices,
                              net.minecraft.text.OrderedText text,
                              HorizontalAlignment align,
                              int x,
                              int y,
                              int width,
                              int color)

Draws a text component with a custom alignment.

Parameters:

matrices - the rendering matrix stack

text - the text

align - the alignment of the string

x - the X position

y - the Y position

width - the width of the string, used for aligning

color - the text color

Since:

1.9.0

drawStringWithShadow

public static void drawStringWithShadow(net.minecraft.client.util.math.MatrixStack matrices,
                                        java.lang.String s,
                                        HorizontalAlignment align,
                                        int x,
                                        int y,
                                        int width,
                                        int color)

Draws a shadowed string.

Parameters:

matrices - the rendering matrix stack

s - the string

align - the alignment of the string

x - the X position

y - the Y position

width - the width of the string, used for aligning

color - the text color

drawStringWithShadow

public static void drawStringWithShadow(net.minecraft.client.util.math.MatrixStack matrices,
                                        net.minecraft.text.OrderedText text,
                                        HorizontalAlignment align,
                                        int x,
                                        int y,
                                        int width,
                                        int color)

Draws a shadowed text component.

Parameters:

matrices - the rendering matrix stack

text - the text component

align - the alignment of the string

x - the X position

y - the Y position

width - the width of the string, used for aligning

color - the text color

drawString

public static void drawString(net.minecraft.client.util.math.MatrixStack matrices,
                              java.lang.String s,
                              int x,
                              int y,
                              int color)

Draws a left-aligned string.

Parameters:

matrices - the rendering matrix stack

s - the string

x - the X position

y - the Y position

color - the text color

drawString

public static void drawString(net.minecraft.client.util.math.MatrixStack matrices,
                              net.minecraft.text.OrderedText text,
                              int x,
                              int y,
                              int color)

Draws a left-aligned text component.

Parameters:

matrices - the rendering matrix stack

text - the text component

x - the X position

y - the Y position

color - the text color

drawTextHover

public static void drawTextHover(net.minecraft.client.util.math.MatrixStack matrices,
                                 @Nullable
                                 @Nullable net.minecraft.text.Style textStyle,
                                 int x,
                                 int y)

Draws the text hover effects for a text style.

This method should only be called from a widget in a screen. For example, there will be nothing drawn in HUDs.

Parameters:

matrices - the rendering matrix stack

textStyle - the text style

x - the X position

y - the Y position

Since:

4.0.0

colorAtOpacity

public static int colorAtOpacity(int opaque,
                                 float opacity)

multiplyColor

public static int multiplyColor(int color,
                                float amount)