Construct an independently owned native Rml::Context.
nameNative name, independent of the Core registry.
managerLive native render manager retained by the context.
handlerExplicit borrowed text-input handler, or null.
Read the context's cached dimensions through shared native memory.
Cached width and height view in physical pixels.
The same view reflects setDimensions() and forwarded resize events. Accessors have no setters. Use Context.setDimensions to change layout. A retained view becomes zero when its context is destroyed.
Current Rml::Context::IsMouseInteracting hint, independent of opacity.
Whether an element is hovered, active, or autoscrolling.
Rml::Context::GetName, validated against this runtime generation.
Context name.
Renderer used by this context's native render manager.
Canonical renderer reference for scoped resource operations.
Enable or disable a named RCSS media theme (Rml::Context::ActivateTheme).
nameTheme name used in @media (theme: name).
activateTrue enables the theme; false disables it.
Attach to the context root, as Rml::Context::AddEventListener does.
typeEvent name or registered native EventId.
listenerSynchronous callback.
captureCapture phase; defaults to false.
Create a native Rml::Context::CreateDataModel.
nameModel name used by RML data-model attributes.
optionsNative creation options.
Constructor, or null for duplicate names.
Create an empty document through Rml::Context::CreateDocument.
instancerNameRegistered document instancer; defaults to "body".
Context-owned document, or null if the factory fails.
Read the actual native Context class identifier.
Native token; Context inherits ScriptInterface's identity.
Find Rml::Context::GetDataModel.
nameModel name.
Canonical constructor, or null when absent.
Snapshot Rml::Context::GetDataModels.
Name-to-constructor snapshot.
Find a document through either Rml::Context::GetDocument overload.
idOrIndexDocument id or zero-based int32 index in stack order.
First match, or null for missing ids and out-of-range indices.
Get the root tag used to create subsequent documents.
Base tag for subsequent documents.
Hit-test current layout through Rml::Context::GetElementAtPoint.
pointPhysical pixels; float-rounded coordinates must fit int32.
ignoreElementIgnore this subtree; default null.
elementNative search root, or null for the context root.
Deepest hit, or null. Arguments must belong to this context.
Get the element that currently holds input focus.
Focused element, which may be the context root, or null.
Get the element under the pointer after the latest input or update.
Hovered element from the latest input/update, or null.
Get the number of seconds until the next scheduled context update.
Seconds until update; Infinity means no pending native deadline.
Count loaded documents through Rml::Context::GetNumDocuments.
Count excluding documents queued for destruction.
Get the render manager shared by contexts using this render interface.
Manager shared by contexts using the same render interface.
Return Rml::Context::GetRootElement with canonical element identity.
Context root, valid until context destruction.
Read the registered native Context script object.
Same registered host object, or null when unregistered.
Read the exact borrowed Rml::Context::GetTextInputHandler.
Canonical checked handler, or null when absent.
Check actual native ScriptInterface inheritance.
identifierModule-owned class token.
Whether the native Context implements that class.
Query a named theme (Rml::Context::IsThemeActive).
nameTheme name.
Whether the theme is active.
Parse an RML string into a document.
rmlRML markup.
sourceUrlOptionalOptional source URL for relative resource resolution.
Parsed, initially hidden document; call show() to display it.
Forward an sfml.js window event to the RmlUi context.
eventsfml.js event object or event data.
Propagation or interaction result; true for ignored events.
Key, text and wheel events return propagation; mouse/touch input returns whether no element is interacting. Coordinates use physical pixels. Key modifiers come from the event snapshot; pointer modifiers use live keyboard state. Touch events forward a one-entry TouchList. SFML system keys map to LMETA/RMETA on macOS and LWIN/RWIN elsewhere. TextEntered normalizes CR to LF and skips other control characters. Resize events update dimensions and density automatically.
Send Rml::Context::ProcessKeyDown, including custom keys (177–250).
keyRmlUi key identifier, not an SFML key code.
modifiersBitwise OR of KeyModifier flags; defaults to 0.
Whether the event remains propagating.
Send Rml::Context::ProcessKeyUp.
keyRmlUi KeyIdentifier or custom key (177–250).
modifiersKeyModifier flags; defaults to 0.
Whether the event remains propagating.
Send Rml::Context::ProcessMouseButtonDown at the last mouse position.
buttonNonnegative button index: left 0, right 1, middle 2.
modifiersKeyModifier flags; defaults to 0.
True when the mouse is not interacting with an element.
Send Rml::Context::ProcessMouseButtonUp at the last mouse position.
buttonNonnegative button index: left 0, right 1, middle 2.
modifiersKeyModifier flags; defaults to 0.
True when the mouse is not interacting with an element.
Clear hover with Rml::Context::ProcessMouseLeave until the next mouse move.
True when the mouse is not interacting with an element.
Send Rml::Context::ProcessMouseMove in physical window pixels.
xSigned 32-bit horizontal coordinate.
ySigned 32-bit vertical coordinate.
modifiersKeyModifier flags; defaults to 0.
True when the mouse is not interacting with an element.
Send Rml::Context::ProcessMouseWheel.
deltaWheel vector, positive right/down. A number uses the deprecated vertical overload.
modifiersKeyModifier flags; defaults to 0.
Whether the event remains propagating.
Send Unicode text through Rml::Context::ProcessTextInput.
textString or Unicode scalar; isolated surrogates are rejected.
Whether the event remains propagating.
Call Rml::Context::ProcessTextInput(char) with one byte.
byteInteger from 0 to 255.
Whether the event remains propagating; high bytes return false.
ASCII bytes 0–127 preserve control characters. Bytes 128–255 produce no event, matching the native char overload. Use processTextInput for Unicode scalars or strings.
Cancel touches with Rml::Context::ProcessTouchCancel.
touchesOrdered touch list.
AND of results; unknown touches return false, empty lists true.
Release every touch with Rml::Context::ProcessTouchEnd.
touchesOrdered touch list.
modifiersKeyModifier flags; defaults to 0.
AND of results; unknown touches and empty lists return true.
Move every touch with Rml::Context::ProcessTouchMove.
touchesOrdered touch list.
modifiersKeyModifier flags; defaults to 0.
AND of results; unknown touches and empty lists return true.
Start every touch with Rml::Context::ProcessTouchStart.
touchesTouch list, processed in order after full validation.
modifiersKeyModifier flags; defaults to 0.
AND of upstream interaction results; true for an empty list.
Move a document to the front through Rml::Context::PullDocumentToFront.
documentDocument belonging to this context.
Move a document to the back through Rml::Context::PushDocumentToBack.
documentDocument belonging to this context.
Remove the context from RmlUi.
Whether the native context was removed.
Calls Rml::RemoveContext for registered contexts, or releases independent native ownership. Owned removal never removes a same-name registration. Listeners release automatically. Later operations throw, including repeated remove(). Dimensions become zero; a same-name context never revives old wrappers.
Remove Rml::Context::RemoveDataModel and invalidate all its leases.
nameModel name.
Native removal result.
Remove the matching context-root registration.
typeEvent name or registered native EventId.
listenerPreviously registered callback.
captureOriginal capture flag; defaults to false.
Compile and submit geometry for this frame.
The native render result, currently always true.
Request RmlUi's next update after a nonnegative delay in seconds.
delaySeconds, including zero and Infinity.
Set the default scroll behavior and speed for this context.
behaviorDefault behavior; Auto selects Smooth.
speedFactorPositive finite float; defaults to 1.
Set Rml::Context::SetDensityIndependentPixelRatio or restore auto mode.
ratioPositive finite ratio; null resumes window synchronization.
Update the context dimensions, usually on window resize.
widthPhysical pixel width for Rml::Context::SetDimensions.
heightHeight in physical pixels.
Set Rml::Context::SetDocumentsBaseTag for subsequent documents.
tagBase tag; initially "body".
Select a document script host for subsequent loads, or disable scripting.
hostCaptured host, or null to use normal RmlUi documents.
Register a script object with the Context's existing ownership.
objectHost object, or null to clear its association.
Restore previous document focus through Rml::Context::UnfocusDocument.
documentDocument to remove from this context's focus history.
Queue all documents through Rml::Context::UnloadAllDocuments.
Queue destruction through Rml::Context::UnloadDocument.
documentDocument belonging to this context.
StaticgetRead Context's inherited native ScriptInterface class identifier.
Opaque token available before initialisation.
RmlUi context bound to one sfml.js render window.
Remarks
Obtain registered instances through createContext, or independently owned instances through Factory.instanceContext. The native context owns attached documents. Stop using wrappers after remove or shutdown.