API 参考
正在准备搜索索引…

sfml.js-rmlui · 概览

初始化、字体、事件传递与帧渲染。 RML 加载、元素属性与原生对象生命周期。 事件数据副本与 JavaScript 监听器签名。

运行时与上下文

初始化、字体、事件传递与帧渲染。

全部 API442
Animation

Rml::Animation 值;字段及 Tween 在原生边界按值复制。

animationEquals

原生 Animation 相等比较;取反对应 operator!=。

AnimationList

带标记的 Rml::AnimationList。

anyUnit

Rml::Any:检查单位集合中是否存在标志。

AttributeResult

由非空默认值的类型选择的原生模板结果。

AttributeValue

属性值,包含受生命周期保护的元素引用。

BaseXMLParser

支持同步或批量事件交付的原生 XML 解析器。

BaseXMLParserCallbacks

Rml::BaseXMLParser 虚方法的同步实现。

BlendMode

预乘透明度图层合成所用的 Rml::BlendMode。

Box

Native 持有的 Rml::Box 值,数值字段通过可写共享视图访问。

BoxArea

Rml::BoxArea,按从外侧到内容区域排序。

BoxDirection

用于跨区域尺寸查询的 Rml::BoxDirection。

BoxEdge

Rml::BoxEdge,顺序与原生边数组一致。

BoxShadow

Rml::BoxShadow 字段副本,长度不转换为像素。

BoxShadowList

带类型标签的 Rml::BoxShadowList 快照,保留原生顺序。

BuiltinFontEngine

初始化前可选择的内置原生字体引擎。

CallbackTexture

延迟同步生成纹理的唯一 Rml::CallbackTexture。

CallbackTextureFunction

同步 Rml::CallbackTextureFunction;成功时恰好提交一次纹理。

CallbackTextureInterface

仅在生成回调期间有效的 Rml::CallbackTextureInterface。

CallbackTextureSource

按管理器缓存唯一回调纹理的 CallbackTextureSource 等价接口。

ClassIdentifier

Rml::ClassId 的不透明相等性令牌,不暴露原生地址。

ClipMaskGeometry

Rml::ClipMaskGeometry 的独立副本,不借用元素指针。

clipMaskGeometryEquals

按原生指针相等语义比较 Rml::ClipMaskGeometry。

ClipMaskOperation

Rml::ClipMaskOperation,也用于裁剪查询快照。

ColorFormat

字形位图的原生颜色格式。

ColorStop

Rml::ColorStop 副本,保留未解析的位置单位。

ColorStopList

带类型标签的 Rml::ColorStopList 快照,保留原生顺序。

CompiledFilter

自动释放原生资源的自有 Rml::CompiledFilter。

CompiledShader

自有 Rml::CompiledShader,遵循编译滤镜的生命周期规则。

ComputedValues

关联存活元素的独立 Rml::ComputedValues 存储。

ComputedValuesView

元素计算样式的实时只读视图。

Context

绑定到单个 sfml.js 渲染窗口的 RmlUi 上下文。

ContextDimensions

上下文缓存物理尺寸的只读视图。

ContextInstanceCallback

通过另一原生实例器分配自有上下文。

ContextInstancer

受检查的 Rml::ContextInstancer,保留原生分配及释放所有权。

ContextReleaseCallback

在运行时安全边界观察已完成的原生销毁。

ContextReleaseSnapshot

原生上下文销毁前捕获的名称副本。

ConvolutionFilter

原生 Rml::ConvolutionFilter,提供可写共享 float32 核。

CornerSizes

Rml::CornerSizes:左上、右上、右下、左下。

createContext

创建命名的 RmlUi 上下文。

createRenderInterface

在初始化前或初始化后为窗口创建独立的 SFML 渲染接口。

createString

经校验的原生格式化路径提供托管 Rml::CreateString。

CustomFontFace

原生自定义字体及固定可写测量存储。

CustomFontMetrics

用于注册原生自定义字体的独立度量。

DataAddress

有序的原生根、成员和索引地址项,解析变量时复制。

DataAddressEntry

一个原生数据地址分量,名称和索引可独立修改。

DataBatchView

由原生模型调度器求值的显式数值 view 组。

DataBatchViewOptions

显式原生数据 view 组的配置。

DataBatchViewUpdate

计算一个紧凑脏区间,返回输出命令数。

DataBindingInitialize

真实 Rml::DataView 或 Rml::DataController 的初始化回调。

DataBindingRelease

原生数据绑定在安全外层调用边界发送的释放通知。

DataController

受检查的自有或 Core 借用 Rml::DataController。

DataControllerCallbacks

实际 Rml::DataController 的虚方法。

DataControllerInstanceCallback

为请求元素分配控制器;拒绝时返回 null。

DataControllerInstancer

原生 RML 控制器的真实 Rml::DataControllerInstancer。

DataCustomDefinition

基于保活 JS 数据的真实原生 VariableDefinition 回调。省略项使用原生默认值。

DataDefinition

受检原生 VariableDefinition,包含未注册变量的租约。

DataEnumKind

受检原生枚举存储支持的整数宽度。

DataEventFunc

Rml::DataEventFunc 接收模型句柄、实时事件和表达式参数。

DataEventMemberFunc

原生成员事件的等价形式,注册前绑定宿主接收者。

DataGetFunc

返回自有 Variant 的 Rml::DataGetFunc 对应接口。

DataGetResult

VariableDefinition::Get 的显式结果,包含成功返回的 null。

DataMemberGetter

从当前受检父路径读取成员。标量返回自有值;引用、数组和结构返回同注册表变量或 null。

DataMemberSetter

原生宽度和枚举转换通过后设置标量成员;自定义标量成员直接交换自有 Variant。

DataModelConstructor

使用原生自有绑定的 Rml::DataModelConstructor。

DataModelHandle

经校验的 Rml::DataModelHandle,使用原生脏变量调度。

DataModelOptions

对应 Rml::Context::CreateDataModel 的选项。

DataNumericView

原生数值数组存储的共享视图。

DataPointerTraits

Rml::PointerTraits 的受检原生租约对应接口。C++ 原始、独占和共享指针在 JS 中使用受管理的可空引用;原生保有存储,解引用不会向 JS 暴露地址。

DataScalarDefinition

对应 ScalarFuncDefinition 的标量类型回调。保活每份绑定数据;getter 返回自有 Variant。

DataScalarKind

原生标量类型,包含每一种有符号和无符号整数宽度。

DataScalarValue

由原生 RmlUi 数据定义存储的内置标量值。

DataSchema

使用真实 Rml::FamilyId 注册的原生定义。

DataSetFunc

赋值的 Rml::DataSetFunc 对应接口。

DataStorageRecord

原生记录中具名成员的初始值。

DataStorageValue

原生存储初始值,记录和数组可以递归嵌套。

DataStructHandle

对应 Rml::DataStructHandle 的运行时结构体注册接口。

DataTransformFunc

Rml::DataTransformFunc 按顺序接收原生表达式参数。

DataTransformResult

Rml::TransformFuncRegister::Call 的输出,保留其成功标记。

DataTypeGetFunc

原生带 Variant 输出参数的类型 getter 的宿主等价形式。

DataTypeRegister

独立持有或从一个上下文借用的 Rml::DataTypeRegister。

DataTypeSetFunc

原生类型 void setter 的宿主等价形式。

DataVariable

指向 Rml::DataVariable 的受检路径,每次调用重新解析原生存储。

DataVariableType

原生 Rml::DataVariableType 分类。

DataVariantValue

数据回调接受的自有原生 Variant 值,包含 null。

DataView

真实原生 Rml::DataView 的自有或 Core 借用句柄。

DataViewCallbacks

原生 Rml::DataView 的虚方法。

DataViewInstanceCallback

为请求元素分配视图;拒绝时返回 null。

DataViewInstancer

RML 解析器及 Factory 使用的真实 Rml::DataViewInstancer。

Debugger

原生 RmlUi Debugger 工具,支持分别指定宿主与被调试上下文。

DecomposedMatrix4

Rml::Transforms::DecomposedMatrix4 的副本。

Decorator

实例器返回的共享 Rml::Decorator。

DecoratorCallbacks

使用宿主元素数据的同步 Rml::Decorator 虚函数。

DecoratorData

自有 Rml::DecoratorDataHandle,检查装饰器与元素身份。

DecoratorDeclaration

可写的 Rml::DecoratorDeclaration 记录,赋给列表时复制。

DecoratorInstancer

具有属性和同步 JS 实例化回调的 Rml::DecoratorInstancer。

DecoratorInstancerCallback

Rml::DecoratorInstancer::InstanceDecorator 的同步实现。

DecoratorInstancerInterface

样式表与渲染管理器对应的 Rml::DecoratorInstancerInterface。

DecoratorList

检查运行代的 Rml::DecoratorsPtr,保留共享资源身份。

DefaultActionPhase

监听器完成后执行 Rml::Element::ProcessDefaultAction 的阶段。

DirtyVariables

原生脏根变量名称集合。

DispatchEventOptions

Rml::Element::DispatchEvent 的显式传播选项。

DocumentHeader

用于文档解析及资源合并的原生 Rml::DocumentHeader。

DocumentHeaderInit

文档头输入,省略项使用空字符串、空列表及原生资源默认值。

DocumentHeaderResource

Rml::DocumentHeader::Resource 的独立快照。

DocumentHeaderResourceInit

省略字段使用上游默认值的资源输入。

DocumentHeaderSnapshot

原生文档头存储的完整独立副本。

EdgeSizes

Rml::EdgeSizes:上、右、下、左。

EffectProperty

效果实例器局部规范中的属性副本。

ElementBackgroundBorder

元素持有的带检查 Rml::ElementBackgroundBorder。

ElementClippingRegion

原生裁剪的两类输出;没有矩形区域时仍可能存在蒙版。

ElementCommandBuffer

Native 持有的数值命令平面,配合预注册元素槽位表。

ElementCommandOpcode

ElementCommandBuffer.submit 按顺序消费的数值操作。

ElementCommandStatus

每条数值查询命令的结果状态。

ElementDefinition

样式表选择器匹配产生的不可变 Rml::ElementDefinition。

ElementForm

原生 Rml::ElementForm 包装器。

ElementFormControl

原生 Rml::ElementFormControl 基类包装器,通过文档获取。

ElementFormControlInput

Rml::ElementFormControlInput,保留原生输入类型行为。

ElementFormControlSelect

原生 Rml::ElementFormControlSelect 包装器。

ElementFormControlTextArea

原生 Rml::ElementFormControlTextArea 包装器。

ElementInstanceCallback

通过另一有类型的实例器分配游离原生元素。

ElementInstancer

Rml::ElementInstancer 的受检原生分配和释放定制。

ElementLottie

原生 Rml::ElementLottie,播放使用原生系统时钟。

ElementProgress

带类型检查的 Rml::ElementProgress 包装器。

ElementRectangle

窗口坐标中的独立矩形快照。

ElementReleaseCallback

在原生安全边界观察销毁前的独立快照。

ElementReleaseSnapshot

原生元素销毁前捕获的自有属性快照。

ElementScroll

独立持有的 Rml::ElementScroll 或 Element::GetElementScroll 的检查视图。

ElementStyle

带检查的元素自有 Rml::ElementStyle,保留原生层叠与脏状态。

ElementSVG

原生 Rml::ElementSVG,支持内联 XML 或 src 文件属性。

ElementTabSet

带类型检查的 Rml::ElementTabSet 包装器。

ElementText

带类型检查的 Rml::ElementText 包装器,提供原生文本排版操作。

ElementTransformBuffer

一次进入原生即可读取多个元素的可复用变换快照。

ElementUtilities

带有效性检查的静态 Rml::ElementUtilities 操作。

EventDispatcher

元素持有的带检查 Rml::EventDispatcher。

EventId

Rml::EventId 常量;自定义编号由 registerEventType 返回。

EventInstanceCallback

将事件分配委派给另一 EventInstancer。

EventInstancer

具有受检查分配及释放的原生 Rml::EventInstancer。

EventListener

支持多个派发器挂载的原生 Rml::EventListener。

EventListenerAttachment

原生监听器挂载时复制的元素标识。

EventListenerHook

在原生活动调用返回后观察挂载或解绑。

EventListenerInstanceCallback

按确切的原生内联属性值分配监听器。

EventListenerInstancer

真实 RML on* 属性的 Rml::EventListenerInstancer 适配器。

EventPhase

Rml::EventPhase 的阶段值。

EventReleaseCallback

原生事件的活动调用栈返回后观察其销毁。

EventReleaseSnapshot

原生释放前复制的事件标识。

Factory

受检查的 Rml::Factory 实例化、解析和缓存操作。

FileCallbacks

同步文件接口方法;省略的方法使用 Native 字节存储。

FileHandle

单个打开文件的原生 token。

FileInterface

原生持有的 Rml::FileInterface,支持文件根目录或自定义回调。

Filter

具有原生或同步 JavaScript 虚函数的自有 Rml::Filter。

FilterCallbacks

Rml::Filter 虚函数的同步实现。

FilterDeclaration

可写的 Rml::FilterDeclaration 记录,赋给列表时复制。

FilterHandleList

保留编译资源所有权的 Rml::FilterHandleList 适配器。

FilterInstancer

具有局部属性和同步 JS 工厂的 Rml::FilterInstancer。

FilterInstancerCallback

Rml::FilterInstancer::InstanceFilter 的同步实现。

FilterList

检查运行代的 Rml::FiltersPtr,保留共享资源身份。

FilterOperation

原生 alpha 卷积的 Rml::FilterOperation。

FilterOverflow

Rml::Rectanglef 墨迹溢出区域的角点表示。

FocusFlag

Document.show 使用的 Rml::FocusFlag。

FontAdvanceTable

可选的独立码点宽度表,测量完全在 Native 中执行。

FontEffect

Rml::FontEffect,提供可写元数据及原生虚函数字形操作。

FontEffectCallbacks

Rml::FontEffect 原生虚函数的同步回调。

FontEffectInstancer

使用局部属性及 JS 回调的原生字体效果工厂。

FontEffectInstancerCallback

Rml::FontEffectInstancer::InstanceFontEffect 的同步实现。

FontEffectLayer

字体效果的绘制层级。

FontEffectList

检查运行代的 Rml::FontEffectsPtr,包含 const 字体效果。

FontEffectsCallback

不透明字体特效数据准备回调。

FontEffectsHandle

绑定字体、引擎和字体代次的不透明 Rml::FontEffectsHandle。

FontEffectSnapshot

原生 FontEffect 包装器公开的元数据字段。

FontEngineCallbacks

构造时捕获的同步 Rml::FontEngineInterface 虚函数。

FontEngineCapability

上游引擎语义,与当前选中状态无关。

FontEngineInterface

原生 Rml::FontEngineInterface,提供共享值及可选宿主虚函数。

FontEngineKind

选定的内置引擎或显式同步自定义回调。

FontFaceCallback

选择本 provider 字体令牌的回调。

FontFaceHandle

当前原生字体引擎提供的不透明 Rml::FontFaceHandle。

FontFaceId

字体声明规则中描述项的标识。

FontGenerateCallback

生成自有几何快照的回调。

FontGlyph

原生持有的 Rml::FontGlyph,提供指标映射和保活位图存储。

FontGlyphMap

Rml::FontGlyphMap,以 Unicode 码点为键、自有字形为值。

FontGlyphMetrics

Rml::FontEffect::GetGlyphMetrics 的输出。

FontLifecycleCallback

同步字体生命周期回调。

FontLoadCallback

文件元数据加载回调。

FontLoadMemoryCallback

使用内存快照加载字体的回调。

FontLoadNamedCallback

指定名称的字体文件加载回调。

FontMeasureBuffer

用于字体测量的可复用原生 UTF-8、边界索引和宽度存储。

FontMeasureCallback

不逐文本创建 JS 字符串的单次紧凑回调。

FontMetrics

原生持有的 Rml::FontMetrics 快照,提供共享字段访问。

FontMetricsCallback

字体度量刷新回调。

FontShapingParameters

上游文本排版参数快照。

FontStyle

显式注册字体时使用的 Rml::Style::FontStyle 值。

FontVersionCallback

字体几何版本回调。

FontWeight

Rml::Style::FontWeight 命名值;也接受 1 到 1000 的任意整数字重。

FontWidthCallback

兼容的逐文本测量回调。

FontWidthsCallback

兼容的批量文本测量回调。

formatString

用实际原生 Rml::FormatString 格式化有类型的参数。

FormattedString

Rml::FormatString 的托管结果,保留原生字节长度。

GeneratedString

Rml::FontEngineInterface::GenerateString 的结果。

GeneratedTextLine

Rml::ElementText::GenerateLine 的输出快照。

Geometry

持有不可变原生网格快照的唯一 Rml::Geometry。

GeometryReleaseMode

原生几何资源释放模式。

getCapabilities

读取编译模块、字体语义及运行时可用性。

getContext

按名称或从零开始的索引调用 Rml::GetContext。

getFileInterface

返回所选原生文件接口。

getFontEngineInterface

读取已安装的字体引擎,保持公开包装对象身份。

getNumContexts

获取运行时注册表中活跃上下文的数量。

getRenderInterface

将实际 Rml::GetRenderInterface 指针返回为受检引用。

getSystemInterface

在初始化前后读取 Rml::GetSystemInterface。

getTextInputHandler

返回当前原生全局输入处理器。

getTextureSourceList

复制 Rml::GetTextureSourceList 返回的所有渲染管理器纹理源列表。

initialise

使用 SFML 支撑的系统接口与渲染接口初始化 RmlUi。

InitialiseOptions

进程级 RmlUi 运行时选项。

KeyframeBlock

独立的 Rml::KeyframeBlock。

KeyFramePropertyResolver

原生可复用的可选简写缓存、变量依赖和输出存储。

Keyframes

独立的 Rml::Keyframes 快照。

KeyIdentifier

RmlUi 按键标识;自定义按键占用 177 至 250。

KeyModifier

RmlUi 修饰键标志;使用按位或组合。

LayerHandle

属于一个管理器和一次图层生命周期的不透明 Rml::LayerHandle。

loadFontFace

将经过检查的重载转发给原生字体引擎。

Log

通过原生 Rml::Log 与所选系统接口输出应用日志。

LogType

原生 Rml::Log::Type 值。

LuaFunction

捕获的原生 Lua 函数或编译块,保活其所属 VM。

LuaScalar

Node 与 Lua 之间复制的值,Lua 整数返回 bigint。

LuaScriptHost

原生持有的 Lua 5.4 宿主,各文档共享 Lua 全局值。

LuaScriptHostOptions

单个原生 Lua 状态的受信任来源策略。

makeAnimation

按原生默认值及 float32 字段构造 Rml::Animation。

makeLiteralIntVariable

创建 Core 的不可变有符号 32 位整数变量。 常量不持有可变存储,在运行时关闭后仍有效。

makeTransformPrimitive

调用上游接受 NumericValue 数组的原语构造函数。

makeTransition

按原生默认值及 float32 字段构造 Rml::Transition。

makeTransitionList

构造 Rml::TransitionList,默认 none=true、all=false、条目为空。

MediaQueryId

依上下文判断的媒体查询条件标识。

MemberGetFunc

原生 Variant 输出成员 getter,通过绑定宿主接收者用于 bindFunc。

MemberGetterFunc

通过绑定宿主方法表示的原生值或引用成员 getter。

MemberSetFunc

原生 Variant 输入成员 setter,通过绑定宿主接收者用于 bindFunc。

MemberSetterFunc

通过绑定宿主方法表示的原生值成员 setter。

Mesh

原生持有的 Rml::Mesh,提供共享顶点和索引分配。

MeshUtilities

Rml::MeshUtilities,提供 Native 几何生成及批量提交。

ModalFlag

Document.show 使用的 Rml::ModalFlag。

ModuleCapability

编译支持及当前所属运行时中的可用状态。

NamedDecorator

独立的 Rml::NamedDecorator 元数据。

NodeScriptHost

原生持有、每文档独立的 JavaScript 宿主,使用 Node vm.Script。

NodeScriptHostOptions

受信任 JavaScript 文档执行的显式策略。

NumericValue

Native 持有的 Rml::NumericValue,数值和单位字段通过共享视图映射。

NumericValueSnapshot

Rml::NumericValue 字段副本,不包含共享缓冲区或运行时引用。

PackedFontMeasurement

Native 持有并复用的紧凑测量工作区。

ParameterMap

Rml::ParameterMap,将自有字符串键映射到 32 位有符号整数。

Plugin

Native 持有的 Rml::Plugin 适配器。

PluginCallbacks

同步 Rml::Plugin 通知。

PluginContextCallback

Rml::Plugin 上下文创建或销毁通知。

PluginDataModelCallback

Rml::Plugin 数据模型创建或销毁前通知。

PluginDocumentCallback

Rml::Plugin 文档加载或卸载通知。

PluginDocumentOpenCallback

Rml::Plugin::OnDocumentOpen 请求通知。

PluginElementCallback

Rml::Plugin 元素创建或销毁通知。

PluginEventClasses

Rml::Plugin::EventClasses 订阅位,每次注册时固定。

PluginEventClassesCallback

Rml::Plugin::GetEventClasses 回调契约。

PluginLifecycleCallback

Rml::Plugin 运行时生命周期通知。

PositionAnchor

Rml::ElementUtilities 的定位锚点。

PositionedBox

Rml::Element::GetBox(index, offset) 的盒副本及输出偏移。

PreloadFont

通过 Rml::LoadFontFace 以显式字体族注册的文件字体。

preloadResources

通过 Native 工作线程和所选文件源准备资源,再由所属线程上传纹理并注册字体。

PreloadResources

加载并显示文档前准备的资源。

PremultipliedColour

Rml::ColourbPremultiplied 字节值,RGB 已乘以 alpha。

ProjectedPoint

Rml::Element::Project 的返回值与输入输出坐标快照。

Property

Native 持有的 Rml::Property 副本,仅在创建时的 RmlUi 运行代内有效。

PropertyDefinition

检查运行代的 Rml::PropertyDefinition。

PropertyDictionary

原生持有的 Rml::PropertyDictionary,返回独立属性快照。

PropertyId

内置和自定义 RCSS 属性的标识。

PropertyParser

原生属性解析器,可以使用内置实现或 JS 回调。

PropertyParserCallback

Rml::PropertyParser::ParseValue 的同步回调。

PropertyShorthandItem

引用属性定义的简写组成项。

PropertySource

Rml::PropertySource 的副本。

PropertySpecification

持有 Rml::PropertySpecification,使用局部属性和简写编号。

PropertyValueResult

Rml::PropertyDefinition::GetValue 的两个输出。

RecursiveShorthandItem

引用另一简写的组成项。

registerEventType

使用 Rml::RegisterEventType 注册原生事件定义。

registerPlugin

注册 Rml::Plugin 并保活其 Native 适配器。

RelativeTarget

解析属性相对单位时使用的 Rml::RelativeTarget。

releaseCompiledGeometry

使用 Rml::ReleaseCompiledGeometry 释放句柄,保留网格供重新编译。

releaseFontResources

释放字体纹理和字形缓存,并重建活动字体。

releaseRenderManagers

使用 Rml::ReleaseRenderManagers 释放未使用的渲染管理器。

releaseTexture

使用 Rml::ReleaseTexture 释放指定源的纹理。

releaseTextures

使用 Rml::ReleaseTextures 释放已加载和生成的纹理句柄。

removeContext

使用 Rml::RemoveContext 移除命名上下文,并使其所有别名失效。

RenderBox

独立的 Rml::RenderBox,包含可写原生数值视图。

RenderInterface

由运行时持有的不透明 Rml::RenderInterface 引用。

RenderManager

带有效性检查的 Rml::RenderManager 资源工厂。

RenderParameters

传入 Rml::RenderManager 的自有标量、向量和颜色参数。

RenderState

Rml::RenderState 的自有快照。

ResourcePreloadOptions

单批预加载的取消信号及渲染接口选择。

RmlEvent

RmlUi 事件快照,原生传播控制仅在当前回调期间有效。

RmlUiCapabilities

此二进制及其所属进程级运行时的快照。

ScriptHandler

同步的命名文档事件处理器。

ScriptInterface

带检查的 Rml::ScriptInterface 对象的类型基类。

ScrollAlignment

原生 Rml::ScrollAlignment。

ScrollBehavior

上下文和元素滚动使用的原生 Rml::ScrollBehavior。

ScrollFlag

Document.show 使用的 Rml::ScrollFlag。

ScrollIntoViewOptions

原生 Rml::Element::ScrollIntoView 的选项。

ScrollOrientation

选择水平或垂直滚动条。

ScrollParentage

原生 Rml::ScrollParentage。

SeekOrigin

原生定位基准。

setFileInterface

在 RmlUi 初始化前选择原生文件接口。

setFontEngineInterface

初始化前选择字体引擎;null 恢复自动选择 FreeType。

setRenderInterface

在初始化前调用 Rml::SetRenderInterface 选定渲染接口。

setSystemInterface

初始化前安装 Rml::SetSystemInterface。

setTextInputHandler

调用 Rml::SetTextInputHandler;已有上下文保留原处理器。

ShorthandDefinition

Rml::ShorthandDefinition 的快照,包含受检查的属性引用。

ShorthandId

RCSS 简写属性组的标识。

ShorthandItemOptions

从 Rml::ShorthandItem 复制的标志。

ShorthandType

Rml::ShorthandType 控制声明如何填充各组成属性。

shutdown

关闭 RmlUi 并释放其接口。

Sprite

Rml::Sprite 元数据,在原生精灵插入可能使其失效前复制。

SpriteDefinitionList

Rml::SpriteDefinitionList,有序的精灵名称与像素矩形二元组。

SpriteMap

Rml::SpriteMap,以精灵名称为键。

SpriteRectangle

原生 Rml::Rectanglef 精灵区域的像素角点。

Spritesheet

Rml::Spritesheet 元数据副本,包含独立持有的纹理源。

SpritesheetList

自有 Rml::SpritesheetList,保留原生覆盖与合并行为。

Stream

使用原生内存、文件或同步 JS 存储的受检查 Rml::Stream。

StreamCallbacks

Rml::Stream 虚方法的同步实现。

StreamFile

使用已安装 RmlUi 文件接口的只读 Rml::StreamFile。

StreamMemory

由原生持有字节的 Rml::StreamMemory。

StreamMode

Rml::Stream 模式位。

StringInput

UTF-8 文本或保活的不可变原生字节视图。

StringIteratorU8

托管 Rml::StringIteratorU8,每个字节视图复用一次原生索引。

StringUtilities

原生 Rml::StringUtilities,位置以 UTF-8 字节和码点计。

StringView

Rml::StringView,每个切片均保活不可变原生存储。

Style

原生计算样式的类型、值与解析函数。

AlignContent

计算后的弹性行对齐。

AlignItems

计算后的弹性项默认对齐。

AlignSelf

计算后的单个弹性项对齐。

BoxSizing

计算后的尺寸计算盒。

Clear

计算后的浮动避让。

Clip

原生 Rml::Style::Clip,保留有符号字节编码语义。

ClipType

计算后的祖先裁剪控制。

CommonValues

常用布局和边框属性的独立存储。

Direction

计算后的文本阅读方向。

Display

计算后的布局盒生成方式。

Drag

计算后的拖动交互。

FlexDirection

计算后的弹性主轴方向。

FlexWrap

计算后的弹性换行方式。

Float

计算后的浮动方向。

Focus

计算后的焦点接收能力。

FontKerning

计算后的字体字偶距。

FontStyle

计算后的字体倾斜样式。

FontWeight

计算后的字重。

InheritedValues

继承的文本、颜色和输入属性的独立存储。

JustifyContent

计算后的弹性主轴对齐。

LengthPercentage

像素长度或相对基准尺寸的百分比。

LengthPercentageAuto

像素长度、百分比或自动尺寸。

LengthPercentageAutoType

像素长度、百分比或自动尺寸。

LengthPercentageType

像素长度或相对基准尺寸的百分比。

LineHeight

计算后的像素行高及其继承数值或长度。

LineHeightInheritType

计算后的像素行高及其继承数值或长度。

计算后的方向键导航。

NumberAuto

数值或自动关键字,用于堆叠顺序。

NumberAutoType

数值或自动关键字,用于堆叠顺序。

OriginX

计算后的水平变换原点。

OriginY

计算后的垂直变换原点。

Overflow

计算后的溢出处理。

OverscrollBehavior

计算后的滚动链传递。

PointerEvents

计算后的指针命中检测。

Position

计算后的定位方式。

RareValues

较少使用的布局、变换和效果属性的独立存储。

resolveValue

两种计算长度类型的 Rml::ResolveValue。

resolveValueOr

两种计算长度类型的 Rml::ResolveValueOr。

TabIndex

计算后的键盘顺序焦点。

TextAlign

计算后的文本水平对齐。

TextDecoration

计算后的文本装饰线。

TextOverflow

计算后的文本溢出标记。

TextTransform

计算后的文本大小写转换。

VerticalAlign

行内垂直对齐关键字或像素偏移。

VerticalAlignType

行内垂直对齐关键字或像素偏移。

Visibility

计算后的可见性。

WhiteSpace

计算后的空白与换行处理。

WordBreak

计算后的单词断行。

StyleDisplay

原生 Rml::Style::Display。

StyleFloat

原生 Rml::Style::Float。

StylePosition

原生 Rml::Style::Position。

StyleSheet

Rml::StyleSheet:受检查的编译视图或自有合并结果。

StyleSheetContainer

自有或只读共享的 Rml::StyleSheetContainer。

StyleSheetSpecification

Rml::StyleSheetSpecification,即运行时的全局 RCSS 注册表。

SystemCallbacks

可选的同步系统虚方法实现。

SystemClipboardCallback

原生剪贴板读取回调。

SystemInterface

原生持有的 SFML 系统接口,支持可选宿主虚方法。

SystemJoinPathCallback

原生资源路径回调。

SystemLogCallback

原生日志决策回调。

SystemTranslateCallback

原生翻译回调。

TextInputBounds

文本区域投影后的屏幕像素边界。

TextInputCallbacks

原生文本输入生命周期的可选显式宿主回调。

TextInputContext

存活 input 或 textarea 控件的受检原生 Rml::TextInputContext。

TextInputEvents

原生生命周期批次。类型为 0 激活、1 失活、2 销毁。

TextInputHandler

支持批量生命周期通知的原生 Rml::TextInputHandler。

TextInputRange

Unicode 码点范围,结束位置不包含在内。

TextLine

Rml::ElementText::Line 的副本。

TextSelection

原生文本选区快照,索引单位为 Unicode 码点,不是 UTF-16。

TextShapingContext

持有 Rml::TextShapingContext 的语言字符串及共享数值字段。

Texture

保活原生渲染管理器的 Rml::Texture 视图。

TexturedMesh

Rml::TexturedMesh,由原生网格存储和纹理视图组成。

TexturedMeshList

有序的 Rml::TexturedMeshList,以类型化原生资源记录表示。

TextureHandle

用于 SetTextureHandle 的自有 SFML 纹理令牌。

TextureSource

原生 Rml::TextureSource,按管理器延迟缓存纹理。

Touch

Rml::TouchList 中的触点,用于上下文直接触摸输入。

Transform

Native 持有的 Rml::Transform,原语访问使用副本。

TransformArrayPrimitiveType

使用有序分量数组的原语类型。

TransformFuncRegister

使用同一类型注册表的所有模型共享的原生变换函数。

TransformPrimitive

全部 22 种原语的字段副本,使用可区分联合类型。

TransformPrimitiveRecord

数组原语快照,保留原生类型标识和分量数量。

TransformPrimitiveType

与 Rml::TransformPrimitive::Type 一致的类型标识。

TransformPrimitiveValues

根据原语类型选择与原生数量一致的分量元组。

TransformSnapshot

自有 TransformPtr 快照;primitives 为 null 时保留原生空指针。

TransformState

Rml::TransformState,独立持有或元素的只读视图。

Transition

属性过渡设置:目标属性、时长、延迟和缓动。

transitionEquals

原生 Transition 相等比较;取反对应 operator!=。

TransitionList

带标记的 Rml::TransitionList;none/all 与条目分别保留。

transitionListEquals

原生 TransitionList 相等比较;取反对应 operator!=。

TranslationResult

原生 TranslateString 输出及替换次数。

Tween

原生 Rml::Tween;加入动画时复制到关键帧。

TweenCallback

同步回调;输入为原生 float32,输出必须是有限 float32。

TweenDirection

选择在补间起点、终点或两端应用缓动。

TweenOutType

原生 (Type, Type) 重载的第二个类型,避免与数字方向歧义。

TweenType

Rml::Tween::Type 缓动类型。

Unit

Rml::Unit 标志;使用 JavaScript 的 | 和 & 合并及求交集。

Units

Rml::Units:Unit 标志集合。

unregisterPlugin

注销 Rml::Plugin,返回是否移除了注册。

URL

原生 Rml::URL 资源解析器,无需初始化运行时。

Variant

Native 持有的 Rml::Variant,类型元数据通过共享内存读取。

VariantConversion

原生 GetInto 结果,转换失败后也保留目标值的原生修改。

VariantType

精确对应上游字符编码的 Rml::Variant::Type。

version

原生库报告的 RmlUi 版本号。

Vertex

原生 Rml::Vertex 分配的类型化视图。

VertexColour

Rml::ColourbPremultiplied 通道,各为 0 至 255 的整数。

VoidMemberFunc

缺省成员回调,对应原生 VoidMemberFunc。

XMLAttributes

Rml::XMLAttributes 的独立副本;解析器产生的属性是字符串。

XMLDataEvent

一个原生文本、CDATA 或捕获标记事件。

XMLDataType

原生解析器使用的 Rml::XMLDataType 值。

XMLEndEvent

批量解析结果中的一个原生闭标签事件。

XMLNodeHandler

受检查的原生 XML 节点处理器,可独立拥有或从注册表借用。

XMLNodeHandlerCallbacks

Rml::XMLNodeHandler 全部虚方法的同步实现。

XMLParseEvent

按原生顺序排列的 XML 事件快照。

XMLParseFrame

Rml::XMLParser::ParseFrame 的独立快照,包含受检查的引用。

XMLParser

保留根元素所有权的原生 Rml::XMLParser。

XMLSourcePosition

原生 XML 解析记录的源位置。

XMLStartEvent

批量解析结果中的一个原生开标签事件。

文档与元素

RML 加载、元素属性与原生对象生命周期。

全部 API3
Document

已加载的 RmlUi 文档包装器。

Element

带有效性检查的 RmlUi 原生元素包装器。

IntrinsicDimensions

Rml::Element::GetIntrinsicDimensions 的输出快照。

事件数据

事件数据副本与 JavaScript 监听器签名。

全部 API19
RmlEventListener

JavaScript 事件监听器。

VariantByteColour

Rml::Colourb 快照,通道为 0 到 255 的整数。

VariantCharacter

原生 Rml::Character 枚举,存储类型为 INT64,转换结果为 uint32。

VariantColour

带类型标记的 Rml::Colourb 或 Rml::Colourf,保留原生颜色类型。

VariantConversionDefault

原生转换默认值,包含没有对应 Variant 存储类型的目标。

VariantDefault

用于选择原生 Variant 转换模板的非空自有值。

VariantInteger64

显式选择有符号或无符号 64 位 Variant 存储或转换类型。

VariantIntegerVector

整数向量模板目标,Rml::Variant 不能直接存储此类型。

VariantNumber

显式选择数值 Variant 存储或转换类型。

VariantOpaqueObject

具有已验证原生不透明指针来源的宿主原对象; 隐藏原生身份与对象公开字段相互独立。

VariantOpaquePointer

自有不透明宿主对象,选择原生 void* 存储与转换。

VariantReadValue

原生 Variant 输出,包含不透明指针引用的原对象。 具备原生来源的不透明输出可以直接写回;任意宿主对象首次存储需要 voidptr 样本。

VariantResult

默认值选择的结果类型,原始值的字面量类型会扩宽。

VariantScriptObject

Native ScriptInterface 拥有者登记的 JS 原对象身份。 副本保留受保护指针;扩展负责原生生命周期。

VariantScriptPointer

受保护的原生 ScriptInterface 指针存储和 GetInto 目标。

VariantValue

支持的 Rml::Variant 值。原生 64 位整数精确转换为 BigInt; Element、Context 和 Event 保留对象身份,任意指针被拒绝。

VariantVector2

Rml::Vector2f 值,分量按原生 float 精度存储。

VariantVector3

Rml::Vector3f 三分量值。

VariantVector4

Rml::Vector4f 四分量值。

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