common/io.github.notenoughupdates.moulconfig.gui/GuiImmediateContext

GuiImmediateContext

data class GuiImmediateContext(val renderContext: RenderContext, val renderOffsetX: Int, val renderOffsetY: Int, val width: Int, val height: Int, val mouseX: Int, val mouseY: Int, val absoluteMouseX: Int, val absoluteMouseY: Int, val mouseXHF: Float, val mouseYHF: Float)(source)

A context containing the constraints of a gui elements, as well as the state of the user interface, relative to that gui element.

Constructors

GuiImmediateContext

constructor(renderContext: RenderContext, renderOffsetX: Int, renderOffsetY: Int, width: Int, height: Int, mouseX: Int, mouseY: Int, absoluteMouseX: Int, absoluteMouseY: Int, mouseXHF: Float, mouseYHF: Float)

Properties

absoluteMouseX

val absoluteMouseX: Int

The position of the mouse, relative to the root element.

absoluteMouseY

val absoluteMouseY: Int

The position of the mouse, relative to the root element.

height

val height: Int

The available height for that gui element to render in.

isHovered

val isHovered: Boolean

mouseX

val mouseX: Int

The position of the mouse, relative to this gui element.

mouseXHF

val mouseXHF: Float

The position of the mouse, relative to this gui element in as high of a resolution as possible.

mouseY

val mouseY: Int

The position of the mouse, relative to this gui element.

mouseYHF

val mouseYHF: Float

The position of the mouse, relative to this gui element in as high of a resolution as possible.

renderContext

val renderContext: RenderContext

renderOffsetX

val renderOffsetX: Int

The current absolute offset for this gui context. This should not need to be accessed, unless you are contacting some API that does not access GlStateManager.

renderOffsetY

val renderOffsetY: Int

The current absolute offset for this gui context. This should not need to be accessed, unless you are contacting some API that does not access GlStateManager.

width

val width: Int

The available width for that gui element to render in.

Functions

limitSize

fun limitSize(maxWidth: Int, maxHeight: Int): GuiImmediateContext

Construct a new context, which has not been translated, but possible smaller if the arguments demand so.

scaled

fun scaled(scale: Float): GuiImmediateContext

translated

fun translated(xOffset: Int, yOffset: Int, width: Int, height: Int): GuiImmediateContext

Construct a new context representing that is located within this context.

translatedNonRendering

fun translatedNonRendering(xOffset: Int, yOffset: Int, width: Int, height: Int): GuiImmediateContext

Construct a new context representing that is located within this context. Does not translate the rendering offset.

withBleed

fun withBleed(xBleed: Int, yBleed: Int): GuiImmediateContext

Construct a new context that bleeds out over the boundaries of the existing context. This is usually used for more fuzzy click detection.