Package io.github.cottonmc.cotton.gui.client

Class Scissors

java.lang.Object

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

@Deprecated(forRemoval=true)
@Environment(CLIENT)
public final class Scissors
extends Object

Deprecated, for removal: This API element is subject to removal in a future version.

Use scissor methods in DrawContext instead.

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	Description
static final class	Scissors.Frame	Deprecated, for removal: This API element is subject to removal in a future version. A single scissor frame in the stack.

Method Summary

Modifier and Type	Method	Description
static void	pop()	Deprecated, for removal: This API element is subject to removal in a future version. Pops the topmost scissor frame and refreshes the scissored area.
static Scissors.Frame	push(DrawContext context, int x, int y, int width, int height)	Deprecated, for removal: This API element is subject to removal in a future version. 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 Details

push

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

Deprecated, for removal: This API element is subject to removal in a future version.

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

Parameters:

context - the associated draw context

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()

Deprecated, for removal: This API element is subject to removal in a future version.

Pops the topmost scissor frame and refreshes the scissored area.

Throws:

IllegalStateException - if there are no scissor frames on the stack