All Implemented Interfaces:
```
public final class PolyUI

                    
```
PolyUI is a declarative UI framework developed for, and by Polyfrost.
It is designed to be lightweight, fast, extensible and easy to use, while still being very powerful. Make sure to check out the examples for more information.
PolyUI is split into two parts, being PolyUI and its logic, and it's accompanying Renderer implementation. This allows us to have PolyUI in many places, including inside Minecraft! It is declarative, meaning that you don't have to worry about the logic of the UI, just the layout and the components.
PolyUI has the policy of 'render what you need ONLY WHEN you need it'. Most of the time, PolyUI will be drawing frame buffers to the screen instead of drawing directly to the screen, as long as they are suitably complex for it to be worth it; or not drawing at all! This allows us to have a very fast rendering pipeline, and allows us to have a lot of components on screen at once, without a performance hit.
Rendering can be requested by components, and if so, it will be rendered during the next frame. This should only be requested if it is necessary, for example to do an animation or something.
During a render cycle, PolyUI will systematically go through every layout, and render it to its framebuffer or to the screen. Each layout will then render its components and child layouts, and so on. Rendering happens in three steps:
- preRender: This will do pre-rendering logic, such as setting up transformations, updating animations, and more.
- render: This is where the actual rendering happens.
- postRender: This will do post-rendering logic, such as cleaning up transformations.
Check out some components to see how this works.
Components are the interactive parts of the UI, such as buttons, text fields, etc.
Interactions are driven by events, which thanks to Kotlin's inlining are a zero-overhead way of distributing events, such as mouse clicks, or key presses.
PolyUI also supports a variety of animations and transitions, which can be used to make your UI more dynamic, along with dynamically adding and removing components.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`public final static Boolean`	`isOnMac`
`public final static FontFamily`	`defaultFonts`
`public final static Font`	`monospaceFont`
`public final static PolyImage`	`defaultImage`
`public final static Byte`	`INPUT_NONE`
`public final static Byte`	`INPUT_HOVERED`
`public final static Byte`	`INPUT_PRESSED`
`public final static Byte`	`DANGER`
`public final static Byte`	`WARNING`
`public final static Byte`	`SUCCESS`
`private final Settings`	`settings`
`private Colors`	`colors`
`private FontFamily`	`fonts`
`private Font`	`monospaceFont`
`private Window`	`window`
`private final Boolean`	`canPauseRendering`
`private final Boolean`	`canUseFramebuffers`
`private final Float`	`pixelRatio`
`private String`	`clipboard`
`private final Drawable`	`master`
`private final InputManager`	`inputManager`
`private final KeyBinder`	`keyBinder`
`private final Translator`	`translator`
`private final Clock`	`clock`
`private LayoutController`	`layoutController`
`private final Boolean`	`drew`
`private final Float`	`mouseX`
`private final Float`	`mouseY`
`private final Boolean`	`mouseDown`
`private Cursor`	`cursor`
`private final Vec2`	`size`
`private final Vec2`	`iSize`
`private final Long`	`delta`
`private final Debugger`	`debugger`
`private final Renderer`	`renderer`

Constructor Summary

Constructors
Constructor	Description
`PolyUI(Component components, Renderer renderer, Settings settings, InputManager inputManager, Translator translator, PolyColor backgroundColor, Align masterAlignment, Colors colors, Float width, Float height)`
`PolyUI(Component components, Renderer renderer, Settings settings, InputManager inputManager, Translator translator, PolyColor backgroundColor, Align masterAlignment, Float width, Float height)`
`PolyUI(Component components, Renderer renderer, Settings settings, InputManager inputManager, Translator translator, PolyColor backgroundColor, Float width, Float height)`
`PolyUI(Component components, Renderer renderer, Settings settings, InputManager inputManager, Translator translator, Float width, Float height)`
`PolyUI(Component components, Renderer renderer, Settings settings, InputManager inputManager, Float width, Float height)`
`PolyUI(Component components, Renderer renderer, Settings settings, Float width, Float height)`
`PolyUI(Component components, Renderer renderer, Float width, Float height)`
`PolyUI(Component components, Renderer renderer, Settings settings, InputManager inputManager, Translator translator, PolyColor backgroundColor, Align masterAlignment, Colors colors, Vec2 size)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Settings`	`getSettings()`
`final Colors`	`getColors()`	Colors attached to this PolyUI instance.
`final Unit`	`setColors(Colors colors)`	Colors attached to this PolyUI instance.
`final FontFamily`	`getFonts()`	Fonts attached to this PolyUI instance.
`final Unit`	`setFonts(FontFamily fonts)`	Fonts attached to this PolyUI instance.
`final Font`	`getMonospaceFont()`	Monospace font attached to this PolyUI instance.
`final Unit`	`setMonospaceFont(Font monospaceFont)`	Monospace font attached to this PolyUI instance.
`final Window`	`getWindow()`	The window this polyUI was opened with.
`final Unit`	`setWindow(Window window)`
`final Boolean`	`getCanPauseRendering()`
`final Boolean`	`getCanUseFramebuffers()`
`final Float`	`getPixelRatio()`
`final String`	`getClipboard()`
`final Unit`	`setClipboard(String clipboard)`
`final Drawable`	`getMaster()`	This is the root layout of the UI.
`final InputManager`	`getInputManager()`
`final KeyBinder`	`getKeyBinder()`
`final Translator`	`getTranslator()`
`final Clock`	`getClock()`
`final LayoutController`	`getLayoutController()`
`final Unit`	`setLayoutController(LayoutController layoutController)`
`final Boolean`	`getDrew()`	weather this PolyUI instance drew on this frame.
`final Float`	`getMouseX()`
`final Float`	`getMouseY()`
`final Boolean`	`getMouseDown()`
`final Cursor`	`getCursor()`	The cursor currently being displayed.
`final Unit`	`setCursor(Cursor cursor)`
`final Vec2`	`getSize()`
`final Vec2`	`getInitialSize()`
`final Long`	`getDelta()`	the time since the last frame, in nanoseconds.
`final Debugger`	`getDebugger()`	the debugger attached to this PolyUI instance.
`final Renderer`	`getRenderer()`
`final Unit`	`resize(Float newWidth, Float newHeight, Boolean force)`	Resize this PolyUI instance.
`final Long`	`render()`	Perform a render cycle.
`final Clock.Executor`	`every(Long nanos, Integer repeats, Function0<Unit> func)`	add a function that is called every nanos nanoseconds.
`final Unit`	`addExecutor(Clock.Executor executor)`
`final Boolean`	`removeExecutor(Clock.Executor executor)`	Remove a clock-based executor from this PolyUI instance.
`final Unit`	`focus(Inputtable focusable)`	Sets the focus to the specified focusable element.
`final Unit`	`unfocus()`
`final String`	`getKeyName(Integer key)`	Return the key name for the given key code, or "Unknown" if the key is not mapped / no window is present.
`final Long`	`timed(String msg, Function0<Unit> block)`	Time the block and return how long it took, as well as logging with the msg if debug is active.
`String`	`toString()`
`final Unit`	`cleanup()`	cleanup the polyUI instance.
`final static Long`	`timed(Boolean log, String msg, Function0<Unit> block)`	Time the block and return how long it took, as well as logging with the msg if log is `true`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PolyUI
```
PolyUI(Component components, Renderer renderer, Settings settings, InputManager inputManager, Translator translator, PolyColor backgroundColor, Align masterAlignment, Colors colors, Float width, Float height)
```
  - PolyUI
```
PolyUI(Component components, Renderer renderer, Settings settings, InputManager inputManager, Translator translator, PolyColor backgroundColor, Align masterAlignment, Float width, Float height)
```
  - PolyUI
```
PolyUI(Component components, Renderer renderer, Settings settings, InputManager inputManager, Translator translator, PolyColor backgroundColor, Float width, Float height)
```
  - PolyUI
```
PolyUI(Component components, Renderer renderer, Settings settings, InputManager inputManager, Translator translator, Float width, Float height)
```
  - PolyUI
```
PolyUI(Component components, Renderer renderer, Settings settings, InputManager inputManager, Float width, Float height)
```
  - PolyUI
```
PolyUI(Component components, Renderer renderer, Settings settings, Float width, Float height)
```
  - PolyUI
```
PolyUI(Component components, Renderer renderer, Float width, Float height)
```
  - PolyUI
```
PolyUI(Component components, Renderer renderer, Settings settings, InputManager inputManager, Translator translator, PolyColor backgroundColor, Align masterAlignment, Colors colors, Vec2 size)
```
- Method Detail
  - getSettings
```
 final Settings getSettings()
```
  - getColors
```
 final Colors getColors()
```
    Colors attached to this PolyUI instance. This contains all the colors needed for the UI.
    Note that changing this value can be an expensive operation while the UI is running, as it has to update all the components.
    
    Since:
    
    0.17.0
  - setColors
```
 final Unit setColors(Colors colors)
```
    Colors attached to this PolyUI instance. This contains all the colors needed for the UI.
    Note that changing this value can be an expensive operation while the UI is running, as it has to update all the components.
    
    Since:
    
    0.17.0
  - getFonts
```
 final FontFamily getFonts()
```
    Fonts attached to this PolyUI instance. This contains all the fonts needed for the UI.
    Note that changing this value can be an expensive operation while the UI is running, as it has to update all the components.
    
    Since:
    
    0.22.0
  - setFonts
```
 final Unit setFonts(FontFamily fonts)
```
    Fonts attached to this PolyUI instance. This contains all the fonts needed for the UI.
    Note that changing this value can be an expensive operation while the UI is running, as it has to update all the components.
    
    Since:
    
    0.22.0
  - getMonospaceFont
```
 final Font getMonospaceFont()
```
    Monospace font attached to this PolyUI instance. This is used for debugging and other purposes.
  - setMonospaceFont
```
 final Unit setMonospaceFont(Font monospaceFont)
```
    Monospace font attached to this PolyUI instance. This is used for debugging and other purposes.
  - getWindow
```
 final Window getWindow()
```
    The window this polyUI was opened with.
    Since v1.1.3, a window is not required to be set. If it is not set, the clipboard, cursor and render hooks will not work.
    
    Since:
    
    0.18.3
  - setWindow
```
 final Unit setWindow(Window window)
```
  - getCanPauseRendering
```
 final Boolean getCanPauseRendering()
```
  - getCanUseFramebuffers
```
 final Boolean getCanUseFramebuffers()
```
  - getPixelRatio
```
 final Float getPixelRatio()
```
  - getClipboard
```
 final String getClipboard()
```
  - setClipboard
```
 final Unit setClipboard(String clipboard)
```
  - getMaster
```
 final Drawable getMaster()
```
    This is the root layout of the UI. It is the parent of all other layouts.
  - getInputManager
```
 final InputManager getInputManager()
```
  - getKeyBinder
```
 final KeyBinder getKeyBinder()
```
  - getTranslator
```
 final Translator getTranslator()
```
  - getClock
```
 final Clock getClock()
```
  - getLayoutController
```
 final LayoutController getLayoutController()
```
  - setLayoutController
```
 final Unit setLayoutController(LayoutController layoutController)
```
  - getDrew
```
 final Boolean getDrew()
```
    weather this PolyUI instance drew on this frame.
    You can use this value to implement a 'render pausing' function, if you are using a dual-buffered rendering implementation (like OpenGL/GLFW) by enabling this flag:
    if (polyUI.drew) glfwSwapBuffers(handle)
    This is very handy as it will drastically reduce required system resources. If you are looking for more efficiency optimizations, see the settings for max fps and framebuffer settings.
  - getMouseX
```
 final Float getMouseX()
```
  - getMouseY
```
 final Float getMouseY()
```
  - getMouseDown
```
 final Boolean getMouseDown()
```
  - getCursor
```
 final Cursor getCursor()
```
    The cursor currently being displayed.
    
    Since:
    
    0.18.4
  - setCursor
```
 final Unit setCursor(Cursor cursor)
```
  - getSize
```
 final Vec2 getSize()
```
  - getInitialSize
```
 final Vec2 getInitialSize()
```
  - getDelta
```
 final Long getDelta()
```
    the time since the last frame, in nanoseconds. It is used internally a lot for animations, etc.
  - getDebugger
```
 final Debugger getDebugger()
```
    the debugger attached to this PolyUI instance.
    
    Since:
    
    1.1.7
  - getRenderer
```
 final Renderer getRenderer()
```
  - resize
```
 final Unit resize(Float newWidth, Float newHeight, Boolean force)
```
    Resize this PolyUI instance.
  - render
```
 final Long render()
```
    Perform a render cycle.
    
    Returns:
    
    (revised 1.1.7) the maximum amount of time that can be waited, as long as no events are dispatched, that can be waited before render needs to be called again.
  - every
```
 final Clock.Executor every(Long nanos, Integer repeats, Function0<Unit> func)
```
    add a function that is called every nanos nanoseconds.
    Note that the requested time is not guaranteed to be accurate, especially on small values (less than 5ms). It will be executed at the end of the next frame. The executor will overshoot much more often that it will undershoot.
    From testing, a requested time of 1 second is about 99.3% accurate. (+7ms, -0.01ms)
  - addExecutor
```
 final Unit addExecutor(Clock.Executor executor)
```
  - removeExecutor
```
 final Boolean removeExecutor(Clock.Executor executor)
```
    Remove a clock-based executor from this PolyUI instance.
    
    Returns:
    
    true if the executor was successfully removed.
    
    Since:
    
    1.0.5
  - focus
```
 final Unit focus(Inputtable focusable)
```
    Sets the focus to the specified focusable element.
    
    Parameters:
    
    focusable - the element to set focus on
    
    Returns:
    
    true if focus was successfully set, false if the provided focusable is already focused
  - unfocus
```
 final Unit unfocus()
```
  - getKeyName
```
 final String getKeyName(Integer key)
```
    Return the key name for the given key code, or "Unknown" if the key is not mapped / no window is present.
  - timed
```
 final Long timed(String msg, Function0<Unit> block)
```
    Time the block and return how long it took, as well as logging with the msg if debug is active.
    
    Since:
    
    0.18.5
  - toString
```
 String toString()
```
  - cleanup
```
 final Unit cleanup()
```
    cleanup the polyUI instance. This will delete all resources, and render this instance unusable.
  - timed
```
 final static Long timed(Boolean log, String msg, Function0<Unit> block)
```
    Time the block and return how long it took, as well as logging with the msg if log is true.
    
    Since:
    
    1.1.61

Class PolyUI

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PolyUI

PolyUI

PolyUI

PolyUI

PolyUI

PolyUI

PolyUI

PolyUI

Method Detail

getSettings

getColors

setColors

getFonts

setFonts

getMonospaceFont

setMonospaceFont

getWindow

setWindow

getCanPauseRendering

getCanUseFramebuffers

getPixelRatio

getClipboard

setClipboard

getMaster

getInputManager

getKeyBinder

getTranslator

getClock

getLayoutController

setLayoutController

getDrew

getMouseX

getMouseY

getMouseDown

getCursor

setCursor

getSize

getInitialSize

getDelta

getDebugger

getRenderer

resize

render

every

addExecutor

removeExecutor

focus

unfocus

getKeyName

timed

toString

cleanup

timed