API reference
Preparing search index…

sfml.js-rmlui · Overview

Initialization, fonts, events and frame rendering. RML loading, element properties and native lifetimes. Copied event payloads and JavaScript listener signatures.

Runtime and contexts

Initialization, fonts, events and frame rendering.

All APIs442
Animation

Rml::Animation value; fields and Tween are copied at each native boundary.

animationEquals

Native Animation equality; negation represents operator!=.

AnimationList

Tagged Rml::AnimationList.

anyUnit

Rml::Any: check whether a unit set contains any flag.

AttributeResult

Native template result selected by a non-null default value's type.

AttributeValue

Attribute values, including lifetime-guarded element references.

BaseXMLParser

Native XML tokenizer with synchronous or batched event delivery.

BaseXMLParserCallbacks

Synchronous Rml::BaseXMLParser virtual implementations.

BlendMode

Rml::BlendMode for premultiplied layer composition.

Box

Native-owned Rml::Box value with writable shared numerical fields.

BoxArea

Rml::BoxArea, ordered from the outside towards the content.

BoxDirection

Rml::BoxDirection for size-across queries.

BoxEdge

Rml::BoxEdge, in native edge-array order.

BoxShadow

Copied Rml::BoxShadow fields; lengths are not resolved to pixels.

BoxShadowList

Tagged Rml::BoxShadowList snapshot, preserving native order.

BuiltinFontEngine

Built-in native font engines selectable before initialization.

CallbackTexture

Unique Rml::CallbackTexture with lazy synchronous texture generation.

CallbackTextureFunction

Synchronous Rml::CallbackTextureFunction; submit exactly once on success.

CallbackTextureInterface

Rml::CallbackTextureInterface valid only during its generation callback.

CallbackTextureSource

CallbackTextureSource equivalent with a unique callback texture per manager.

ClassIdentifier

Opaque equality token for Rml::ClassId, without exposing native addresses.

ClipMaskGeometry

Owned copy of Rml::ClipMaskGeometry; no borrowed element pointers.

clipMaskGeometryEquals

Compare Rml::ClipMaskGeometry with native pointer equality semantics.

ClipMaskOperation

Rml::ClipMaskOperation, also used by clipping query snapshots.

ColorFormat

The channel format of a glyph bitmap: alpha coverage or RGBA colour.

ColorStop

Copied Rml::ColorStop, with the unresolved position unit.

ColorStopList

Tagged Rml::ColorStopList snapshot, preserving native order.

CompiledFilter

Owned Rml::CompiledFilter with automatic native release.

CompiledShader

Owned Rml::CompiledShader; shares the compiled filter lifetime rules.

ComputedValues

Owned Rml::ComputedValues storage associated with a live element.

ComputedValuesView

Read-only live view of an element’s computed style.

Context

RmlUi context bound to one sfml.js render window.

ContextDimensions

Read-only view of the context's cached physical dimensions.

ContextInstanceCallback

Allocate an owned context through another native instancer.

ContextInstancer

Checked Rml::ContextInstancer with native allocation and release ownership.

ContextReleaseCallback

Observe completed native destruction at a safe runtime boundary.

ContextReleaseSnapshot

Copied name captured before native context destruction.

ConvolutionFilter

Native Rml::ConvolutionFilter with a writable shared float32 kernel.

CornerSizes

Rml::CornerSizes: top-left, top-right, bottom-right, bottom-left.

createContext

Create a named RmlUi context.

createRenderInterface

Create an independent SFML renderer before or after initialisation.

createString

Managed Rml::CreateString using the checked native formatting path.

CustomFontFace

Native custom face and fixed writable measurement storage.

CustomFontMetrics

Independent metrics used to register a Native custom face.

DataAddress

Ordered native root/member/index entries, copied when resolving a variable.

DataAddressEntry

One native data address component, with independently mutable name and index.

DataBatchView

Explicit numeric view group evaluated by the native model scheduler.

DataBatchViewOptions

Configuration for explicit native data-view groups.

DataBatchViewUpdate

Compute one compact dirty interval and return its output command count.

DataBindingInitialize

Initialization of a real Rml::DataView or Rml::DataController.

DataBindingRelease

Native data-binding release notification at a safe outer call boundary.

DataController

Checked owning or Core-borrowed Rml::DataController.

DataControllerCallbacks

Virtual operations of an actual Rml::DataController.

DataControllerInstanceCallback

Allocate a controller for the requesting element or decline with null.

DataControllerInstancer

Real Rml::DataControllerInstancer for native RML controllers.

DataCustomDefinition

Real native VariableDefinition callbacks over a retained JS payload. Omitted callbacks use native defaults: false, zero, null, or an empty list.

DataDefinition

Checked native VariableDefinition, including unregistered variable leases.

DataEnumKind

Integer widths supported by checked native enum storage.

DataEventFunc

Rml::DataEventFunc receives a model, live event and expression arguments.

DataEventMemberFunc

Native member event equivalent; bind the host receiver before registration.

DataGetFunc

Rml::DataGetFunc equivalent returning an owned Variant.

DataGetResult

Explicit result of VariableDefinition::Get, including successful null values.

DataMemberGetter

Read a member from its current checked parent path. Scalar schemas return an owned value; reference, array and struct schemas return a same-register variable or null.

DataMemberSetter

Assign a scalar member after native width and enum conversion. Custom scalar members exchange owned Variants directly.

DataModelConstructor

Rml::DataModelConstructor with native-owned bindings.

DataModelHandle

Checked Rml::DataModelHandle with native dirty-variable scheduling.

DataModelOptions

Options matching Rml::Context::CreateDataModel.

DataNumericView

Shared views of native numeric array storage.

DataPointerTraits

Runtime counterpart of Rml::PointerTraits for checked native data leases. Raw, unique and shared C++ pointers use managed nullable references in JS. Native retains storage; dereferencing never exposes an address to JS.

DataScalarDefinition

Registered scalar type callbacks, corresponding to ScalarFuncDefinition. Each bound payload is retained; getters return owned Variants.

DataScalarKind

Native scalar types, including every signed and unsigned integer width.

DataScalarValue

Built-in scalar values stored by native RmlUi data definitions.

DataSchema

Registered native definition with a real Rml::FamilyId.

DataSetFunc

Rml::DataSetFunc equivalent assigning one value.

DataStorageRecord

Named initial members of a native record.

DataStorageValue

Initial native storage values; records and arrays may nest recursively.

DataStructHandle

Runtime struct registration corresponding to Rml::DataStructHandle.

DataTransformFunc

Rml::DataTransformFunc receives native expression arguments in order.

DataTransformResult

Output of Rml::TransformFuncRegister::Call, preserving its success flag.

DataTypeGetFunc

Host equivalent of a native typed getter with a Variant output parameter.

DataTypeRegister

Rml::DataTypeRegister, owned independently or borrowed from one context.

DataTypeSetFunc

Host equivalent of a native typed void setter.

DataVariable

Checked path into an Rml::DataVariable; resolves native storage on each call.

DataVariableType

Native Rml::DataVariableType categories.

DataVariantValue

Owned native Variant values accepted by data callbacks, including null.

DataView

Owning or Core-borrowed handle to a real native Rml::DataView.

DataViewCallbacks

Virtual operations of a native Rml::DataView.

DataViewInstanceCallback

Allocate a view for the requesting element or decline with null.

DataViewInstancer

Real Rml::DataViewInstancer used by the RML parser and Factory.

Debugger

Native RmlUi Debugger tools hosted in one context and inspecting another.

DecomposedMatrix4

Copied Rml::Transforms::DecomposedMatrix4.

Decorator

Shared Rml::Decorator returned by an instancer.

DecoratorCallbacks

Synchronous Rml::Decorator virtual functions with host-owned element data.

DecoratorData

Owned Rml::DecoratorDataHandle with checked decorator and element identity.

DecoratorDeclaration

Writable Rml::DecoratorDeclaration record, copied when assigned to a list.

DecoratorInstancer

Rml::DecoratorInstancer with properties and synchronous JS instancing.

DecoratorInstancerCallback

Synchronous Rml::DecoratorInstancer::InstanceDecorator implementation.

DecoratorInstancerInterface

Rml::DecoratorInstancerInterface for a stylesheet and render manager.

DecoratorList

Generation-owned Rml::DecoratorsPtr, preserving shared resource identity.

DefaultActionPhase

Phases that run Rml::Element::ProcessDefaultAction after listeners finish.

DirtyVariables

Native collection of dirty root variable names.

DispatchEventOptions

Explicit Rml::Element::DispatchEvent propagation options.

DocumentHeader

Native-owned Rml::DocumentHeader for document parsing and resource merging.

DocumentHeaderInit

Header input with empty strings/lists and native resource defaults.

DocumentHeaderResource

Owned snapshot of Rml::DocumentHeader::Resource.

DocumentHeaderResourceInit

Resource input with upstream defaults for omitted fields.

DocumentHeaderSnapshot

Complete independent copy of native document-header storage.

EdgeSizes

Rml::EdgeSizes: top, right, bottom, left.

EffectProperty

A copied property in an effect instancer's local specification.

ElementBackgroundBorder

Checked element-owned Rml::ElementBackgroundBorder.

ElementClippingRegion

Both native clipping outputs; a mask can exist without a scissor region.

ElementCommandBuffer

Native-owned numeric command planes with a registered element slot table.

ElementCommandOpcode

Ordered numeric operations consumed by ElementCommandBuffer.submit.

ElementCommandStatus

Per-command numeric query result.

ElementDefinition

Immutable Rml::ElementDefinition from stylesheet selector matching.

ElementForm

Native Rml::ElementForm wrapper.

ElementFormControl

Native Rml::ElementFormControl base wrapper; obtain it from a document.

ElementFormControlInput

Rml::ElementFormControlInput, including native input-type behavior.

ElementFormControlSelect

Native Rml::ElementFormControlSelect wrapper.

ElementFormControlTextArea

Native Rml::ElementFormControlTextArea wrapper.

ElementInstanceCallback

Allocate a detached native element through another typed instancer.

ElementInstancer

Checked native allocation/release customization for Rml::ElementInstancer.

ElementLottie

Native Rml::ElementLottie; playback uses the native system clock.

ElementProgress

Checked wrapper for Rml::ElementProgress.

ElementRectangle

Owned rectangle snapshot in window coordinates.

ElementReleaseCallback

Observe an independent pre-destruction snapshot at a safe native boundary.

ElementReleaseSnapshot

Owned attribute snapshot captured before native element destruction.

ElementScroll

Owned Rml::ElementScroll or checked view of Element::GetElementScroll.

ElementStyle

Checked element-owned Rml::ElementStyle with native cascade and dirty state.

ElementSVG

Native Rml::ElementSVG with inline XML or a file-backed src attribute.

ElementTabSet

Checked wrapper for Rml::ElementTabSet.

ElementText

Checked Rml::ElementText wrapper with native text layout operations.

ElementTransformBuffer

Reusable native transform snapshots for many elements in one native entry.

ElementUtilities

Checked static Rml::ElementUtilities operations.

EventDispatcher

Checked Rml::EventDispatcher owned by its native element.

EventId

Rml::EventId constants. Custom ids are returned by registerEventType.

EventInstanceCallback

Delegate event allocation to another EventInstancer.

EventInstancer

Native Rml::EventInstancer with checked allocation and release.

EventListener

Native Rml::EventListener supporting multiple dispatcher attachments.

EventListenerAttachment

Element identity copied when a native listener attaches.

EventListenerHook

Observe a native attachment or detachment after its active frame returns.

EventListenerInstanceCallback

Allocate a listener for an exact native inline attribute value.

EventListenerInstancer

Rml::EventListenerInstancer adapter for real RML on* attributes.

EventPhase

Rml::EventPhase values.

EventReleaseCallback

Observe native event destruction after its active stack returns.

EventReleaseSnapshot

Event identity copied before native release.

Factory

Checked Rml::Factory instancing, parsing and cache operations.

FileCallbacks

Synchronous file provider methods; omitted methods use Native byte storage.

FileHandle

Native token for one open file.

FileInterface

Native-owned Rml::FileInterface with a filesystem root or custom callbacks.

Filter

Owned Rml::Filter with native or synchronous JavaScript virtual methods.

FilterCallbacks

Synchronous implementations of Rml::Filter virtual functions.

FilterDeclaration

Writable Rml::FilterDeclaration record, copied when assigned to a list.

FilterHandleList

Rml::FilterHandleList adapter retaining its compiled resources.

FilterInstancer

Rml::FilterInstancer with local properties and a synchronous JS factory.

FilterInstancerCallback

Synchronous Rml::FilterInstancer::InstanceFilter implementation.

FilterList

Generation-owned Rml::FiltersPtr, preserving shared resource identity.

FilterOperation

Rml::FilterOperation for native alpha convolution.

FilterOverflow

Corner representation of the Rml::Rectanglef ink overflow.

FocusFlag

Rml::FocusFlag for Document.show.

FontAdvanceTable

Optional independent codepoint advances for entirely Native measurement.

FontEffect

Rml::FontEffect with writable metadata and native virtual glyph operations.

FontEffectCallbacks

Synchronous native Rml::FontEffect virtual overrides.

FontEffectInstancer

Native font effect factory with local properties and a JS callback.

FontEffectInstancerCallback

Synchronous Rml::FontEffectInstancer::InstanceFontEffect implementation.

FontEffectLayer

Choose whether a font effect is rendered behind or in front of the text.

FontEffectList

Generation-owned Rml::FontEffectsPtr containing const font effects.

FontEffectsCallback

Opaque font effect preparation hook.

FontEffectsHandle

Opaque Rml::FontEffectsHandle bound to its face, engine and font generation.

FontEffectSnapshot

Metadata fields exposed by a native FontEffect wrapper.

FontEngineCallbacks

Synchronous Rml::FontEngineInterface virtuals, captured at construction.

FontEngineCapability

Upstream engine semantics, independent of current selection.

FontEngineInterface

Native Rml::FontEngineInterface with shared values and host virtuals.

FontEngineKind

Selected built-in engine or explicit synchronous custom callbacks.

FontFaceCallback

Provider-owned face selection hook.

FontFaceHandle

Opaque Rml::FontFaceHandle from the active native font engine.

FontFaceId

Identifiers for descriptors in a font-face rule.

FontGenerateCallback

Owned geometry generation hook.

FontGlyph

Native-owned Rml::FontGlyph with mapped metrics and retained bitmap storage.

FontGlyphMap

Rml::FontGlyphMap represented by Unicode code point keys and owned glyphs.

FontGlyphMetrics

Output of Rml::FontEffect::GetGlyphMetrics.

FontLifecycleCallback

Synchronous provider lifecycle hook.

FontLoadCallback

File metadata loading hook.

FontLoadMemoryCallback

Snapshot-based memory loading hook.

FontLoadNamedCallback

Explicitly named file loading hook.

FontMeasureBuffer

Reusable native UTF-8, offset and width storage for font measurement.

FontMeasureCallback

One packed callback without per-string JS conversion.

FontMetrics

Native-owned Rml::FontMetrics snapshot with shared field access.

FontMetricsCallback

Font metrics refresh hook.

FontShapingParameters

Snapshot of the upstream text-shaping arguments.

FontStyle

Rml::Style::FontStyle values for explicit font registration.

FontVersionCallback

Font geometry version hook.

FontWeight

Named Rml::Style::FontWeight values; any integer from 1 to 1000 is valid.

FontWidthCallback

Compatibility single-string measurement hook.

FontWidthsCallback

Compatibility bulk text measurement hook.

formatString

Format typed arguments through the real native Rml::FormatString.

FormattedString

Managed result of Rml::FormatString, with its native byte length.

GeneratedString

Rml::FontEngineInterface::GenerateString result.

GeneratedTextLine

Copied outputs from Rml::ElementText::GenerateLine.

Geometry

Unique Rml::Geometry owning an immutable native mesh snapshot.

GeometryReleaseMode

Choose whether releasing geometry preserves or clears its owned mesh.

getCapabilities

Read compiled modules, font semantics and runtime availability.

getContext

Look up Rml::GetContext by name or zero-based index.

getFileInterface

Return the selected Native file interface.

getFontEngineInterface

Rml::GetFontEngineInterface, with canonical public wrapper identity.

getNumContexts

Get the number of active contexts in the runtime registry.

getRenderInterface

Read the actual Rml::GetRenderInterface pointer as a checked reference.

getSystemInterface

Read Rml::GetSystemInterface before or after initialization.

getTextInputHandler

Return the selected native global input handler.

getTextureSourceList

Copy Rml::GetTextureSourceList across all render managers.

initialise

Initialise RmlUi with SFML-backed system and render interfaces.

InitialiseOptions

Options for the process-wide RmlUi runtime.

KeyframeBlock

Independent Rml::KeyframeBlock.

KeyFramePropertyResolver

Native reusable optional shorthand cache, dependencies and output storage.

Keyframes

Independent Rml::Keyframes snapshot.

KeyIdentifier

RmlUi key identifiers; custom keys occupy 177 through 250.

KeyModifier

RmlUi modifier flags; combine flags with bitwise OR.

LayerHandle

Opaque Rml::LayerHandle belonging to one manager and one layer lifetime.

loadFontFace

Forward the checked overload to the native font engine.

Log

Application logging through Rml::Log and the selected system interface.

LogType

Native Rml::Log::Type values.

LuaFunction

Captured native Lua function or compiled chunk, retaining its exact VM.

LuaScalar

Values copied between Node and Lua; Lua integers return as bigint.

LuaScriptHost

Native-owned Lua 5.4 host; its documents intentionally share Lua globals.

LuaScriptHostOptions

Explicit trusted-source policy for one native Lua state.

makeAnimation

Construct Rml::Animation with native defaults and float32 fields.

makeLiteralIntVariable

Create Core's immutable signed 32-bit integer variable. It owns no mutable storage and remains valid across runtime shutdown.

makeTransformPrimitive

Invoke an upstream NumericValue-array primitive constructor.

makeTransition

Construct Rml::Transition with native defaults and float32 fields.

makeTransitionList

Construct Rml::TransitionList; none=true, all=false, entries=[] by default.

MediaQueryId

Identifiers for context-dependent media conditions.

MemberGetFunc

Native Variant-output member getter; bind the host receiver for bindFunc.

MemberGetterFunc

Native value or reference member getter represented by a bound host method.

MemberSetFunc

Native Variant-input member setter; bind the host receiver for bindFunc.

MemberSetterFunc

Native value member setter represented by a bound host method.

Mesh

Native-owned Rml::Mesh with shared vertex and index allocations.

MeshUtilities

Rml::MeshUtilities with Native geometry generation and batch submission.

ModalFlag

Rml::ModalFlag for Document.show.

ModuleCapability

Compiled support and availability in the current owning runtime.

NamedDecorator

Independent Rml::NamedDecorator metadata.

NodeScriptHost

Native-owned, per-document JavaScript host using Node's vm.Script.

NodeScriptHostOptions

Explicit policy for trusted JavaScript document execution.

NumericValue

Native-owned Rml::NumericValue with mapped number and unit fields.

NumericValueSnapshot

Copied Rml::NumericValue fields; no shared buffer or runtime owner.

PackedFontMeasurement

Native-owned reusable packed measurement workspace.

ParameterMap

Rml::ParameterMap, mapping own string keys to signed 32-bit integers.

Plugin

Native-owned adapter for Rml::Plugin.

PluginCallbacks

Synchronous Rml::Plugin notifications.

PluginContextCallback

Rml::Plugin context creation or destruction notification.

PluginDataModelCallback

Rml::Plugin data model creation or pre-destruction notification.

PluginDocumentCallback

Rml::Plugin document load or unload notification.

PluginDocumentOpenCallback

Rml::Plugin::OnDocumentOpen request notification.

PluginElementCallback

Rml::Plugin element creation or destruction notification.

PluginEventClasses

Rml::Plugin::EventClasses subscription bits, captured on each registration.

PluginEventClassesCallback

Rml::Plugin::GetEventClasses contract.

PluginLifecycleCallback

Rml::Plugin runtime lifecycle notification.

PositionAnchor

Choose the reference edge or centre used to position an element.

PositionedBox

Copied box and output offset from Rml::Element::GetBox(index, offset).

PreloadFont

A file font registered under an explicit family through Rml::LoadFontFace.

preloadResources

Prepare resources with Native workers and the selected file provider, then commit texture uploads and font registration on the owning runtime thread.

PreloadResources

Resources to prepare before loading and showing a document.

PremultipliedColour

Rml::ColourbPremultiplied bytes, already multiplied by alpha.

ProjectedPoint

Copied return value and in/out point from Rml::Element::Project.

Property

Native-owned Rml::Property copy, valid for its RmlUi runtime generation.

PropertyDefinition

Generation-checked Rml::PropertyDefinition.

PropertyDictionary

Native-owned Rml::PropertyDictionary with independent property snapshots.

PropertyId

Identifiers for built-in and custom RCSS properties.

PropertyParser

Native property parser, either built in or implemented by a JS callback.

PropertyParserCallback

Rml::PropertyParser::ParseValue callback, returning synchronously.

PropertyShorthandItem

A shorthand component referencing a property definition.

PropertySource

Copied Rml::PropertySource.

PropertySpecification

Own an Rml::PropertySpecification with local property and shorthand ids.

PropertyValueResult

Both outputs from Rml::PropertyDefinition::GetValue.

RecursiveShorthandItem

A shorthand component referencing another shorthand.

registerEventType

Register a native event specification with Rml::RegisterEventType.

registerPlugin

Register Rml::Plugin and retain its Native adapter.

RelativeTarget

Rml::RelativeTarget used when resolving relative property units.

releaseCompiledGeometry

Release handles with Rml::ReleaseCompiledGeometry, retaining the meshes.

releaseFontResources

Release font textures/glyph caches and rebuild active fonts.

releaseRenderManagers

Release unused managers with Rml::ReleaseRenderManagers.

releaseTexture

Release a named texture with Rml::ReleaseTexture.

releaseTextures

Release loaded/generated texture handles with Rml::ReleaseTextures.

removeContext

Remove a named context with Rml::RemoveContext and invalidate its aliases.

RenderBox

Independent Rml::RenderBox with writable native numerical views.

RenderInterface

Opaque runtime-owned Rml::RenderInterface reference.

RenderManager

Checked Rml::RenderManager resource factory.

RenderParameters

Owned scalar/vector/colour parameters passed to Rml::RenderManager.

RenderState

Owned snapshot of Rml::RenderState.

ResourcePreloadOptions

Cancellation and renderer selection for one preload batch.

RmlEvent

RmlUi event snapshot with callback-scoped native propagation controls.

RmlUiCapabilities

Snapshot of this binary and its owning process-wide runtime.

ScriptHandler

Synchronous named document event handler.

ScriptInterface

Typed base for checked Rml::ScriptInterface objects.

ScrollAlignment

Native Rml::ScrollAlignment.

ScrollBehavior

Native Rml::ScrollBehavior for context and element scrolling.

ScrollFlag

Rml::ScrollFlag for Document.show.

ScrollIntoViewOptions

Options for native Rml::Element::ScrollIntoView.

ScrollOrientation

Choose the horizontal or vertical scrollbar.

ScrollParentage

Native Rml::ScrollParentage.

SeekOrigin

Native seek origins.

setFileInterface

Select a Native file provider before RmlUi initialization.

setFontEngineInterface

Rml::SetFontEngineInterface before initialization; null restores automatic FreeType selection.

setRenderInterface

Select Rml::SetRenderInterface before initialisation.

setSystemInterface

Install Rml::SetSystemInterface before initialization.

setTextInputHandler

Call Rml::SetTextInputHandler; existing contexts keep their selected handler.

ShorthandDefinition

Snapshot of Rml::ShorthandDefinition with checked property references.

ShorthandId

Identifiers for RCSS shorthand property groups.

ShorthandItemOptions

Flags copied from an Rml::ShorthandItem.

ShorthandType

Rml::ShorthandType controls how a declaration fills its component properties.

shutdown

Shut down RmlUi and release its interfaces.

Sprite

Rml::Sprite metadata copied before insertion can invalidate native pointers.

SpriteDefinitionList

Rml::SpriteDefinitionList, ordered sprite name and pixel rectangle pairs.

SpriteMap

Rml::SpriteMap with sprite names as keys.

SpriteRectangle

Pixel corners of a native Rml::Rectanglef sprite region.

Spritesheet

Copied Rml::Spritesheet metadata with an independently owned texture source.

SpritesheetList

Owned Rml::SpritesheetList preserving native overwrite and merge behavior.

Stream

Checked Rml::Stream with native memory, file or synchronous JS storage.

StreamCallbacks

Synchronous implementations of Rml::Stream virtual methods.

StreamFile

Read-only Rml::StreamFile using the installed RmlUi file interface.

StreamMemory

Rml::StreamMemory backed by native-owned bytes.

StreamMode

Rml::Stream mode bits.

StringInput

UTF-8 text or a retained immutable native byte view.

StringIteratorU8

Managed Rml::StringIteratorU8 with one cached native index per byte view.

StringUtilities

Native Rml::StringUtilities with UTF-8 byte and codepoint positions.

StringView

Rml::StringView with immutable native backing retained by every slice.

Style

Native computed style types, values and resolution functions.

AlignContent

The computed flex line alignment.

AlignItems

The computed default flex item alignment.

AlignSelf

The computed individual flex item alignment.

BoxSizing

The computed size calculation box.

Clear

The computed float clearance.

Clip

Native Rml::Style::Clip with its encoded signed-byte semantics.

ClipType

The computed ancestor clipping control.

CommonValues

Owned storage for common layout and border properties.

Direction

The computed text reading direction.

Display

The computed layout box generation.

Drag

The computed drag interaction.

FlexDirection

The computed flex main axis direction.

FlexWrap

The computed flex line wrapping.

Float

The computed float placement.

Focus

The computed focus eligibility.

FontKerning

The computed font kerning.

FontStyle

The computed font slant.

FontWeight

The computed font weight.

InheritedValues

Owned storage for inherited text, colour and input properties.

JustifyContent

The computed flex main axis alignment.

LengthPercentage

A length in pixels or a percentage of a reference size.

LengthPercentageAuto

A length in pixels, a percentage, or automatic sizing.

LengthPercentageAutoType

A length in pixels, a percentage, or automatic sizing.

LengthPercentageType

A length in pixels or a percentage of a reference size.

LineHeight

Computed line height in pixels together with its inherited number or length.

LineHeightInheritType

Computed line height in pixels together with its inherited number or length.

The computed directional keyboard navigation.

NumberAuto

A numeric value or the automatic keyword, used for stacking order.

NumberAutoType

A numeric value or the automatic keyword, used for stacking order.

OriginX

The computed horizontal transform origin.

OriginY

The computed vertical transform origin.

Overflow

The computed overflow handling.

OverscrollBehavior

The computed scroll chaining.

PointerEvents

The computed pointer hit testing.

Position

The computed positioning scheme.

RareValues

Owned storage for less common layout, transform and effect properties.

resolveValue

Rml::ResolveValue for either computed length type.

resolveValueOr

Rml::ResolveValueOr for either computed length type.

TabIndex

The computed sequential keyboard focus.

TextAlign

The computed text horizontal alignment.

TextDecoration

The computed text decoration line.

TextOverflow

The computed text overflow marker.

TextTransform

The computed text case conversion.

VerticalAlign

An inline vertical alignment keyword or pixel offset.

VerticalAlignType

An inline vertical alignment keyword or pixel offset.

Visibility

The computed visibility.

WhiteSpace

The computed whitespace and wrapping.

WordBreak

The computed word breaking.

StyleDisplay

Native Rml::Style::Display.

StyleFloat

Native Rml::Style::Float.

StylePosition

Native Rml::Style::Position.

StyleSheet

Rml::StyleSheet: a checked compiled view or an owned combination.

StyleSheetContainer

Owned or read-only shared Rml::StyleSheetContainer.

StyleSheetSpecification

Rml::StyleSheetSpecification, the runtime's global RCSS registry.

SystemCallbacks

Optional synchronous system virtual implementations.

SystemClipboardCallback

Native clipboard read callback.

SystemInterface

Native-owned SFML system interface with optional host virtuals.

SystemJoinPathCallback

Native resource path callback.

SystemLogCallback

Native log decision callback.

SystemTranslateCallback

Native translation callback.

TextInputBounds

Projected text-area bounds in screen pixels.

TextInputCallbacks

Optional explicit host callbacks for native text-input lifecycle events.

TextInputContext

Checked native Rml::TextInputContext for a live input or textarea widget.

TextInputEvents

Native lifecycle batch. Kinds are 0 activate, 1 deactivate, 2 destroy.

TextInputHandler

Native Rml::TextInputHandler with batched lifecycle notifications.

TextInputRange

Character range in Unicode code points, with an exclusive end.

TextLine

Copy of Rml::ElementText::Line.

TextSelection

Copied native text selection, in Unicode code points rather than UTF-16.

TextShapingContext

Owned Rml::TextShapingContext language and shared numerical fields.

Texture

Rml::Texture view retaining its native render manager.

TexturedMesh

Rml::TexturedMesh aggregate of native mesh storage and a texture view.

TexturedMeshList

Ordered Rml::TexturedMeshList represented by typed native-resource records.

TextureHandle

Owned SFML texture token for Rml::CallbackTextureInterface::SetTextureHandle.

TextureSource

Native Rml::TextureSource with per-manager lazy texture caching.

Touch

A point in a Rml::TouchList, used by direct context touch input.

Transform

Native-owned Rml::Transform with copied primitive access.

TransformArrayPrimitiveType

Primitive types with ordered component arrays.

TransformFuncRegister

Native transform functions shared by every model using one type register.

TransformPrimitive

All 22 native primitives as a discriminated union of copied fields.

TransformPrimitiveRecord

Array primitive snapshot preserving its native discriminator and arity.

TransformPrimitiveType

Exact Rml::TransformPrimitive::Type discriminators.

TransformPrimitiveValues

Exact native component tuple selected by the primitive type.

TransformSnapshot

Owned TransformPtr snapshot; null primitives preserve a null native pointer.

TransformState

Rml::TransformState, independently owned or a read-only element view.

Transition

Property transition settings: target property, duration, delay and easing.

transitionEquals

Native Transition equality; negation represents operator!=.

TransitionList

Tagged Rml::TransitionList, preserving none/all independently of entries.

transitionListEquals

Native TransitionList equality; negation represents operator!=.

TranslationResult

Native TranslateString output and number of substitutions.

Tween

Native Rml::Tween, copied into animation keys.

TweenCallback

Synchronous callback, with native float32 input and finite float32 output.

TweenDirection

Select whether easing applies at the start, end, or both ends of a tween.

TweenOutType

Unambiguous second type for the native (Type, Type) overload.

TweenType

Rml::Tween::Type easing families.

Unit

Rml::Unit flags. Combine and intersect sets with JavaScript | and &.

Units

Rml::Units: a set of Unit flags.

unregisterPlugin

Unregister Rml::Plugin, returning whether a registration was removed.

URL

Native Rml::URL resource parser, independent of runtime initialisation.

Variant

Native-owned Rml::Variant with shared type metadata.

VariantConversion

Native GetInto result, including destination changes on conversion failure.

VariantType

Exact Rml::Variant::Type values, matching the upstream character codes.

version

RmlUi version reported by the native library.

Vertex

Typed view of a native Rml::Vertex allocation.

VertexColour

Rml::ColourbPremultiplied channels, each an integer from 0 through 255.

VoidMemberFunc

Absent member callback, corresponding to native VoidMemberFunc.

XMLAttributes

Owned copy of Rml::XMLAttributes; parser-produced attributes contain strings.

XMLDataEvent

One native text, CDATA, or captured-markup event.

XMLDataType

Rml::XMLDataType values used by the native parser.

XMLEndEvent

One native end-tag event in a batched parse result.

XMLNodeHandler

Checked native XML node handler, owned or borrowed from the registry.

XMLNodeHandlerCallbacks

Synchronous implementations of all Rml::XMLNodeHandler virtuals.

XMLParseEvent

Ordered native XML event snapshot.

XMLParseFrame

Owned snapshot of Rml::XMLParser::ParseFrame with checked references.

XMLParser

Native Rml::XMLParser with retained root ownership.

XMLSourcePosition

Source positions recorded by native XML parsing.

XMLStartEvent

One native start-tag event in a batched parse result.

Documents and elements

RML loading, element properties and native lifetimes.

All APIs3
Document

Loaded RmlUi document wrapper.

Element

Checked wrapper around an RmlUi-owned element.

IntrinsicDimensions

Copied outputs of Rml::Element::GetIntrinsicDimensions.

Event data

Copied event payloads and JavaScript listener signatures.

All APIs19
RmlEventListener

JavaScript event listener.

VariantByteColour

Rml::Colourb snapshot with integer channels from 0 through 255.

VariantCharacter

Native Rml::Character enum. Storage uses INT64; conversion returns uint32.

VariantColour

Tagged Rml::Colourb or Rml::Colourf, preserving the native colour type.

VariantConversionDefault

Native conversion default, including destinations without Variant storage.

VariantDefault

Owned non-null value selecting a native Variant conversion template.

VariantInteger64

Explicit signed or unsigned 64-bit Variant storage or conversion selector.

VariantIntegerVector

Integer vector template destination. Rml::Variant cannot store this type.

VariantNumber

Explicit numeric Variant storage or conversion selector.

VariantOpaqueObject

Original host object with checked native opaque-pointer provenance. Its hidden native identity is independent of the object's public fields.

VariantOpaquePointer

Owned opaque host object selecting native void* storage and conversion.

VariantReadValue

Native Variant output, including the original object of an opaque pointer. Native provenance allows an opaque output to be stored again. Arbitrary host objects first require a voidptr selector.

VariantResult

Result type selected by a default value, widening primitive literals.

VariantScriptObject

Original JS identity registered by a Native ScriptInterface owner. Copies retain its guarded pointer; the extension controls native lifetime.

VariantScriptPointer

Guarded native ScriptInterface pointer storage and GetInto destination.

VariantValue

Supported Rml::Variant values. Native 64-bit integers retain exact BigInt values; native script owners retain identity. Arbitrary pointers are rejected.

VariantVector2

Two-component Rml::Vector2f value; components round to native float.

VariantVector3

Three-component Rml::Vector3f value.

VariantVector4

Four-component Rml::Vector4f value.

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0