io.github.cottonmc.cotton.gui.client

Class Scissors

java.lang.Object

io.github.cottonmc.cotton.gui.client.Scissors

@Environment(value=CLIENT)
public final class Scissors
extends java.lang.Object

Contains a stack for GL scissors for restricting the drawn area of a widget.

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Scissors.Frame A single scissor frame in the stack.

Method Summary

Modifier and Type	Method and Description
static void	pop() Pops the topmost scissor frame and refreshes the scissored area.
static Scissors.Frame	push(int x, int y, int width, int height) Pushes a new scissor frame onto the stack and refreshes the scissored area.

Methods inherited from class java.lang.Object

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

Method Detail

push

public static Scissors.Frame push(int x,
                                  int y,
                                  int width,
                                  int height)

Pushes a new scissor frame onto the stack and refreshes the scissored area.

Parameters:

x - the frame's X coordinate

y - the frame's Y coordinate

width - the frame's width in pixels

height - the frame's height in pixels

Returns:

the pushed frame

pop

public static void pop()

Pops the topmost scissor frame and refreshes the scissored area.

Throws:

java.lang.IllegalStateException - if there are no scissor frames on the stack