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 a 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.
-
Layouts are the containers for components, such as a grid layout, or a flex layout, etc. They are responsible for positioning and sizing the components.
-
Properties are the shared states or tokens for the components. They describe default values, and can be overridden by the components.
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.
- find some components here.
- find some layouts here.
- find a simple example here.
- find a rendering implementation here.