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

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

通过 createContext 获取已注册实例,或通过 Factory.instanceContext 获取独立自有实例。原生上下文持有已挂接文档; Context.remove 或 shutdown 后不可继续使用相关包装器。

继承关系

层级 (查看层级一览)

源码与继承
成员目录62

构造函数

访问器

方法

构造函数

  • 构造独立自有的原生 Rml::Context。

    参数

    name
    string

    原生名称,与 Core 注册表独立。

    manager

    上下文保活的活跃原生渲染管理器。

    handler

    显式借用文本输入处理器,或 null。

    返回值

    保留原生零尺寸及密度 1,不进入 Core 注册表或触发插件创建通知。 管理器保活至 remove 或回收。显式 null 处理器保持 null,不选择全局处理器。 可在 ContextInstancer 回调内使用。

    源码与继承

访问器

  • get densityIndependentPixelRatio(): number

    每个 RCSS dp 对应的物理像素数。

    返回值

    number

    当前屏幕密度。

    对应 Rml::Context::GetDensityIndependentPixelRatio()。 自动模式在创建、更新和缩放时从窗口刷新。手动值持续到传入 null 恢复自动模式。

    源码与继承
  • get dimensions(): ContextDimensions

    通过原生共享内存读取上下文缓存尺寸。

    返回值

    缓存宽高视图,单位为物理像素。

    同一视图会反映 setDimensions() 和已转发的尺寸变化事件。 访问器没有设置器,必须通过 Context.setDimensions 修改布局。 上下文销毁后,保留视图归零。

    源码与继承
  • get isMouseInteracting(): boolean

    Rml::Context::IsMouseInteracting 的当前交互提示,与不透明度无关。

    返回值

    boolean

    是否存在悬停、激活元素或自动滚动。

    源码与继承
  • get name(): string

    Rml::Context::GetName,校验当前运行时代次。

    返回值

    string

    上下文名称。

    源码与继承

方法

  • 启用或禁用命名 RCSS 媒体主题,对应 Rml::Context::ActivateTheme。

    参数

    name
    string

    @media (theme: name) 中使用的主题名称。

    activate
    boolean

    为 true 时启用,为 false 时禁用。

    返回值

    void
    源码与继承
  • 与 Rml::Context::AddEventListener 一样,在上下文根元素上注册。

    参数

    type
    string | number

    事件名称或已注册的原生 EventId。

    listener

    同步回调。

    capture
    boolean = false

    捕获阶段标志,默认为 false。

    返回值

    void
    源码与继承
  • 通过 Rml::Context::CreateDocument 创建空文档。

    参数

    instancerName
    string = 'body'

    注册的文档实例工厂名称,默认 "body"。

    返回值

    null | Document

    由上下文持有的文档,工厂失败时返回 null。

    源码与继承
  • 开关 RmlUi 鼠标光标。

    参数

    enable
    boolean

    为 true 时由 RmlUi 控制系统光标。

    返回值

    void

    启用后在下一次鼠标更新时刷新光标。禁用后停止修改光标,不会隐藏系统光标。

    源码与继承
  • 通过 Rml::Context::GetDocument 的两个重载查找文档。

    参数

    idOrIndex
    string | number

    文档 id 或按栈顺序从零开始的 int32 索引。

    返回值

    null | Document

    首个匹配文档;id 不存在或索引越界时返回 null。

    源码与继承
  • 获取创建后续文档所用的根标签。

    返回值

    string

    后续文档使用的根标签。

    源码与继承
  • 通过 Rml::Context::GetElementAtPoint 对当前布局执行命中测试。

    参数

    point

    物理像素坐标,转为 float 后必须在 int32 范围内。

    ignoreElement
    null | Element = null

    忽略此子树,默认 null。

    element
    null | Element = null

    原生搜索根节点,null 表示上下文根节点。

    返回值

    null | Element

    最深命中元素或 null;元素参数必须属于本上下文。

    RmlUi 在 render() 时刷新变换矩阵。变换命中测试使用最近渲染的矩阵, 原生裁剪使用逆变换后的坐标与祖先裁剪矩形比较。

    源码与继承
  • 获取当前拥有输入焦点的元素。

    返回值

    null | Element

    焦点元素,可能是上下文根元素;无焦点时返回 null。

    源码与继承
  • 获取最近输入或更新后指针下的元素。

    返回值

    null | Element

    最近输入或更新得到的悬停元素,不存在时返回 null。

    源码与继承
  • 获取距下次计划上下文更新的秒数。

    返回值

    number

    距下次更新的秒数;Infinity 表示无原生更新期限。

    源码与继承
  • 通过 Rml::Context::GetNumDocuments 统计已加载文档。

    返回值

    number

    文档数量,不包含待销毁文档。

    源码与继承
  • 返回 Rml::Context::GetRootElement,并保留唯一元素身份。

    返回值

    上下文根元素,在上下文销毁前有效。

    源码与继承
  • 查询命名主题状态,对应 Rml::Context::IsThemeActive。

    参数

    name
    string

    主题名称。

    返回值

    boolean

    主题是否已启用。

    源码与继承
  • 加载外部 .rml 文档,或从原生流的当前游标解析。

    参数

    documentPath
    string | Stream

    文件接口路径或带来源 URL 的流。

    返回值

    已加载但尚未显示的文档,调用 show() 显示。

    加载失败时抛出 Error。

    源码与继承
  • 将 RML 字符串解析为文档。

    参数

    rml
    string

    RML 标记。

    sourceUrl可选
    string

    可选来源 URL,用于解析相对资源。

    返回值

    解析后尚未显示的文档,调用 show() 显示。

    省略时使用 "[document from memory]",空字符串保持为空。 RmlUi 在解析 head 元素时记录 sourceURL,相对资源基于此 URL 解析。 非字符串参数和内嵌空字节被拒绝。

    解析失败时抛出 Error。

    源码与继承
  • 将 sfml.js 窗口事件转交给 RmlUi 上下文。

    参数

    event
    Event<(keyof EventPayloads)> | EventData

    sfml.js 事件对象或事件数据。

    返回值

    boolean

    上游传播或交互结果;忽略的事件返回 true。

    键盘、文本和滚轮返回传播状态;鼠标、触摸返回是否未与元素交互。 坐标使用物理像素。键盘修饰键来自事件快照,指针修饰键来自实时键盘状态。 触摸事件转为单条 TouchList。系统键在 macOS 映射为 LMETA/RMETA, 其他平台为 LWIN/RWIN。TextEntered 将 CR 转为 LF 并跳过其他控制字符。 尺寸变化事件自动更新尺寸与密度。

    源码与继承
  • 调用 Rml::Context::ProcessKeyDown,传入 KeyIdentifier 或自定义键(177–250)。

    参数

    key
    number

    RmlUi 按键标识,与 SFML 键码不同。

    modifiers
    number = 0

    KeyModifier 标志按位或,默认 0。

    返回值

    boolean

    事件是否仍在传播。

    源码与继承
  • 调用 Rml::Context::ProcessKeyUp。

    参数

    key
    number

    RmlUi KeyIdentifier 或自定义键(177–250)。

    modifiers
    number = 0

    KeyModifier 标志,默认 0。

    返回值

    boolean

    事件是否仍在传播。

    源码与继承
  • 在上次鼠标位置调用 Rml::Context::ProcessMouseButtonDown。

    参数

    button
    number

    非负按键索引:左键 0、右键 1、中键 2。

    modifiers
    number = 0

    KeyModifier 标志,默认 0。

    返回值

    boolean

    鼠标未与元素交互时返回 true。

    源码与继承
  • 在上次鼠标位置调用 Rml::Context::ProcessMouseButtonUp。

    参数

    button
    number

    非负按键索引:左键 0、右键 1、中键 2。

    modifiers
    number = 0

    KeyModifier 标志,默认 0。

    返回值

    boolean

    鼠标未与元素交互时返回 true。

    源码与继承
  • 调用 Rml::Context::ProcessMouseLeave 清除悬停,直至下次鼠标移动。

    返回值

    boolean

    鼠标未与元素交互时返回 true。

    源码与继承
  • 按窗口物理像素调用 Rml::Context::ProcessMouseMove。

    参数

    x
    number

    32 位有符号横坐标。

    y
    number

    32 位有符号纵坐标。

    modifiers
    number = 0

    KeyModifier 标志,默认 0。

    返回值

    boolean

    鼠标未与元素交互时返回 true。

    源码与继承
  • 调用 Rml::Context::ProcessMouseWheel。

    参数

    delta

    滚轮向量:正值向右、向下。数值对应已弃用的垂直滚轮重载。

    modifiers
    number = 0

    KeyModifier 标志,默认 0。

    返回值

    boolean

    事件是否仍在传播。

    源码与继承
  • 通过 Rml::Context::ProcessTextInput 输入 Unicode 文本。

    参数

    text
    string | number

    字符串或 Unicode 标量数值;拒绝孤立代理项。

    返回值

    boolean

    事件是否仍在传播。

    字符串产生一个 textinput 事件;ASCII 和 Unicode 数值使用字符重载。 直接输入保留控制字符。

    源码与继承
  • 用单个字节调用 Rml::Context::ProcessTextInput(char)。

    参数

    byte
    number

    0 到 255 的整数。

    返回值

    boolean

    事件是否仍在传播;高位字节返回 false。

    ASCII 字节 0–127 保留控制字符;128–255 不产生事件,与原生 char 重载一致。Unicode 标量或字符串使用 processTextInput。

    源码与继承
  • 通过 Rml::Context::ProcessTouchCancel 取消触点。

    参数

    touches
    readonly Touch[]

    有序触点列表。

    返回值

    boolean

    各结果的逻辑与;未知触点返回 false,空列表返回 true。

    RmlUi 6.3 模拟不带修饰键的左键释放,可能触发点击。

    源码与继承
  • 通过 Rml::Context::ProcessTouchEnd 释放所有触点。

    参数

    touches
    readonly Touch[]

    有序触点列表。

    modifiers
    number = 0

    KeyModifier 标志,默认 0。

    返回值

    boolean

    各结果的逻辑与;未知触点和空列表返回 true。

    源码与继承
  • 通过 Rml::Context::ProcessTouchMove 移动所有触点。

    参数

    touches
    readonly Touch[]

    有序触点列表。

    modifiers
    number = 0

    KeyModifier 标志,默认 0。

    返回值

    boolean

    各结果的逻辑与;未知触点和空列表返回 true。

    源码与继承
  • 通过 Rml::Context::ProcessTouchStart 开始列表中的所有触点。

    参数

    touches
    readonly Touch[]

    完整校验后按顺序处理的触点列表。

    modifiers
    number = 0

    KeyModifier 标志,默认 0。

    返回值

    boolean

    上游交互结果的逻辑与;空列表返回 true。

    源码与继承
  • 通过 Rml::Context::PullDocumentToFront 将文档移至栈顶。

    参数

    document

    属于本上下文的文档。

    返回值

    void
    源码与继承
  • 通过 Rml::Context::PushDocumentToBack 将文档移至栈底。

    参数

    document

    属于本上下文的文档。

    返回值

    void
    源码与继承
  • 从 RmlUi 移除该上下文。

    返回值

    boolean

    是否移除了原生上下文。

    已注册上下文调用 Rml::RemoveContext,自有上下文释放独立原生所有权, 不移除同名注册。自动释放监听器。后续包装器操作(含重复 remove) 会抛出异常。保留的尺寸视图归零,同名新上下文不会恢复旧包装器。

    源码与继承
  • 执行 Rml::Context::RemoveDataModel 并失效该模型的全部租约。

    参数

    name
    string

    模型名称。

    返回值

    boolean

    原生移除结果。

    源码与继承
  • 移除匹配的上下文根元素监听器。

    参数

    type
    string | number

    事件名称或已注册的原生 EventId。

    listener

    已注册的回调。

    capture
    boolean = false

    原捕获阶段标志,默认为 false。

    返回值

    void
    源码与继承
  • 编译并提交本帧几何。

    返回值

    boolean

    原生渲染结果,当前始终为 true。

    RmlUi 6.3 的 Rml::Context::Render 即使没有几何也返回 true。 调用前先 flush 已录制的 sfml.js 绘制,随后通过 display() 显示。 渲染器会修改窗口视图及裁剪区域。每帧录制场景绘制前, 用 window.setView(sceneView) 重新设置场景视图。

    源码与继承
  • 请求 RmlUi 在非负秒数后更新。

    参数

    delay
    number

    秒数,允许零和 Infinity。

    返回值

    void

    对应 Rml::Context::RequestNextUpdate,只缩短延迟。 update() 先重置延迟,再由原生元素请求后续更新时间。

    源码与继承
  • 设置此上下文的默认滚动行为和速度。

    参数

    behavior

    默认滚动行为,Auto 采用 Smooth。

    speedFactor
    number = 1

    正有限 float,默认为 1。

    返回值

    void
    源码与继承
  • 设置 Rml::Context::SetDensityIndependentPixelRatio,或恢复自动模式。

    参数

    ratio
    null | number

    正有限比率;null 恢复窗口同步。

    返回值

    void
    源码与继承
  • 更新上下文尺寸,通常在窗口缩放时调用。

    参数

    width
    number

    传给 Rml::Context::SetDimensions 的物理像素宽度。

    height
    number

    物理像素高度。

    返回值

    void
    源码与继承
  • 通过 Rml::Context::SetDocumentsBaseTag 设置后续文档的根标签。

    参数

    tag
    string

    根标签,初始值为 "body"。

    返回值

    void
    源码与继承
  • 为后续加载选择文档脚本宿主,或禁用脚本。

    参数

    host

    捕获的宿主,null 使用常规 RmlUi 文档。

    返回值

    void

    已有文档保留自己的宿主,全局 body/监听器注册保持完整。 禁止在活跃原生回调内切换宿主。

    源码与继承
  • 按 Context 原有所有权注册脚本对象。

    参数

    object
    null | object

    宿主对象,或传 null 清除关联。

    返回值

    void

    已注册上下文由原生保活对象,独立自有上下文使用 JS 所有者边, 上下文与对象形成的环可回收。

    源码与继承
  • 通过 Rml::Context::UnfocusDocument 恢复前一个文档的焦点。

    参数

    document

    从本上下文焦点历史移除的文档。

    返回值

    void
    源码与继承
  • 通过 Rml::Context::UnloadAllDocuments 将所有文档加入销毁队列。

    返回值

    void
    源码与继承
  • 通过 Rml::Context::UnloadDocument 排队销毁文档。

    参数

    document

    属于本上下文的文档。

    返回值

    void

    同步派发 unload 后从查询列表移除,在 update 时销毁。重复卸载待销毁文档无操作。

    源码与继承
  • 执行本帧的布局与事件分发。

    返回值

    boolean

    原生更新结果,当前始终为 true。

    RmlUi 6.3 的 Rml::Context::Update 始终返回 true,不表示活动状态。 每帧在 render() 前调用,即使没有输入。

    源码与继承

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