Samples

RmlUi Sample Applications

This directory contains a collection of sample applications that demonstrate the use of RmlUi in small, easy to understand applications.

Directory Overview

assets

This directory contains the assets shared by all the sample applications.

basic

This directory contains basic applications that demonstrate initialisation, usage, shutdown and installation of custom interfaces.

• animation Animations and transitions.
• benchmark A benchmark to measure performance.
• bitmap_font Using a custom font engine. Available even without FreeType, i.e. RMLUI_FONT_ENGINE="none".
• custom_log Setting up custom logging.
• data_binding Setting up and using data bindings.
• demo Demonstrates a variety of features in RmlUi and includes a sandbox for playing with RML/RCSS.
• drag Dragging elements between containers.
• effects Advanced rendering effects, including filters, gradients and box shadows. Only enabled with supported backends.
• harfbuzz Advanced text shaping. Only enabled when HarfBuzz is enabled.
• ime A showcase of Input Method Editor (IME) with fallback fonts to support different writing systems. Available only when using a Windows backend.
• load_document Loading your first document.
• lottie Playing Lottie animations, only enabled with the Lottie plugin.
• svg Render SVG images, only enabled with the SVG plugin.
• transform Demonstration of transforms.
• tree_view Using data bindings to create a file browser.

invaders

A full implementation of the 1970s classic Space Invaders using the RmlUi interface.

lua_invaders

Lua version of the invaders sample. Only installed with the Lua plugin.

shell

The shell provides some common functionality that are specific to the included samples and tests, such as loading fonts and handling global keyboard shortcuts.

Note that, the code for rendering, opening and closing windows, and providing inputs, is instead located in the backends, however some extensions to these backends are found in the shell.

tutorial

Tutorial code that should be used in conjunction with the tutorials in the RmlUi documentation.