polyui/org.polyfrost.polyui.renderer/Window

Window

abstract class Window(var width: Int, var height: Int, var pixelRatio: Float = 1.0f)

Window

This class represents the physical window that PolyUI will render to. As a window implementation, you must:

implement these methods
call PolyUI.resize when the window is resized
call PolyUI.render every frame, inside a rendering loop started with open. It may be blocking or non-blocking.
callbacks for InputManager.mousePressed
callbacks for InputManager.mouseReleased
callbacks for InputManager.mouseMoved
callbacks for InputManager.mouseScrolled
callbacks for InputManager.keyDown
callbacks for InputManager.keyUp
callbacks for InputManager.keyTyped
callbacks for InputManager.filesDropped

Constructors

Window

constructor(width: Int, height: Int, pixelRatio: Float = 1.0f)

Properties

height

open var height: Int

pixelRatio

open var pixelRatio: Float

width

open var width: Int

Functions

breakPause

abstract fun breakPause()

This function may be called by the PolyUI instance when it has something that it wants to do immediately.

abstract fun close()

destroy the window.

getClipboard

abstract fun getClipboard(): String?

Get the clipboard string. This is used for the org.polyfrost.polyui.component.impl.TextInput class.

getKeyName

abstract fun getKeyName(key: Int): String

Return the name of a key that is not mapped by PolyUI.

open

abstract fun open(polyUI: PolyUI): Window

open the window with the specified PolyUI instance, and then start the rendering loop. It may be blocking or non-blocking. Every frame, call the PolyUI.render function to render the UI.

postRender

open fun postRender(renderer: Renderer)

this function hooks into the rendering loop. it is ran after a render cycle.

preRender

open fun preRender(renderer: Renderer)

this function hooks into the rendering loop. it is ran before a render cycle.

setClipboard

abstract fun setClipboard(text: String?)

Set the clipboard string. This is used for the org.polyfrost.polyui.component.impl.TextInput class.

setCursor

abstract fun setCursor(cursor: Cursor)

Set the cursor design.

supportsRenderPausing

abstract fun supportsRenderPausing(): Boolean

Return true if your window supports "render pausing", an optimization technique which will not render any frames if not necessary.