API リファレンス
検索インデックスを準備中…

1 つの sfml.js 描画ウィンドウに紐付く RmlUi コンテキスト。

登録済みは createContext、独立した所有インスタンスは Factory.instanceContext で取得します。追加した文書をコンテキストが所有し、 Context.remove または shutdown 後は関連ラッパーを使用できません。

継承関係

階層 (概要を見る)

ソースと継承
メンバー一覧62

コンストラクター

アクセッサー

メソッド

コンストラクター

  • 独立して所有するネイティブ Rml::Context を構築します。

    引数

    name
    string

    Core 登録と独立したネイティブ名。

    manager

    コンテキストが保持する有効なネイティブ描画管理器。

    handler

    明示的に借用する文字入力ハンドラー、または null。

    戻り値

    寸法ゼロと密度 1 を保持し、Core 登録やプラグイン通知を行いません。 remove または回収まで管理器を保持します。明示的な null は全体設定を選びません。 ContextInstancer コールバック内でも使用できます。

    ソースと継承

アクセッサー

  • get densityIndependentPixelRatio(): number

    RCSS の 1 dp に対応する物理ピクセル数。

    戻り値

    number

    現在の表示密度。

    Rml::Context::GetDensityIndependentPixelRatio() に対応します。 自動モードでは作成・更新・リサイズ時に同期します。手動値は null で解除します。

    ソースと継承
  • get dimensions(): ContextDimensions

    共有ネイティブメモリからキャッシュされた寸法を読み取ります。

    戻り値

    物理ピクセル単位の幅と高さのキャッシュビュー。

    同じビューに setDimensions() と転送されたリサイズイベントが反映されます。 レイアウトの変更には Context.setDimensions を使ってください。 セッターはありません。コンテキスト破棄後に保持したビューは 0 になります。

    ソースと継承
  • get isMouseInteracting(): boolean

    不透明度に依存しない Rml::Context::IsMouseInteracting の現在のヒント。

    戻り値

    boolean

    要素がホバー、アクティブ、または自動スクロール状態かどうか。

    ソースと継承
  • get name(): string

    ランタイム世代を検証して Rml::Context::GetName を取得します。

    戻り値

    string

    コンテキスト名。

    ソースと継承
  • get renderInterface(): RenderInterface

    このコンテキストのネイティブ描画管理器が使用する描画インターフェース。

    戻り値

    リソース操作の対象を指定する一意の描画インターフェース参照。

    ソースと継承

メソッド

  • Rml::Context::ActivateTheme で名前付き RCSS メディアテーマを切り替えます。

    引数

    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、またはスタック順の 0 始まりの 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。 要素引数はこのコンテキストに属する必要があります。

    変換行列は 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

    ファイル API のパスか、参照元 URL を持つストリーム。

    戻り値

    読み込み済みの非表示文書。show() で表示します。

    読み込み失敗時は Error。

    ソースと継承
  • RML 文字列を文書として解析します。

    引数

    rml
    string

    RML マークアップ。

    sourceUrlオプション
    string

    相対リソースの解決に使う任意のソース URL。

    戻り値

    解析済みの非表示文書。show() で表示します。

    省略時は "[document from memory]"、空文字列は空のままです。 RmlUi は head の解析時に sourceURL を記録し、相対リソースを解決します。 文字列以外の値とヌル文字は拒否します。

    解析失敗時は Error。

    ソースと継承
  • sfml.js のウィンドウイベントを RmlUi に転送します。

    引数

    event
    Event<(keyof EventPayloads)> | EventData

    sfml.js のイベントオブジェクトまたはイベントデータ。

    戻り値

    boolean

    上流の伝播または操作の結果。無視するイベントでは true。

    キー・テキスト・ホイールは伝播状態、マウス・タッチは要素と操作していないかを返します。 座標は物理ピクセルです。キー修飾はイベントのスナップショット、ポインター修飾は現在の状態です。 タッチは 1 要素の TouchList に変換します。システムキーは macOS で LMETA/RMETA、 他で LWIN/RWIN です。TextEntered は CR を LF に変換し、他の制御文字を除外します。 リサイズで寸法と密度も更新します。

    ソースと継承
  • KeyIdentifier またはカスタムキー(177–250)で Rml::Context::ProcessKeyDown を呼びます。

    引数

    key
    number

    SFML キーコードとは異なる RmlUi キー識別子。

    modifiers
    number = 0

    KeyModifier フラグのビット OR。既定値は 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

    イベントが引き続き伝播するかどうか。

    文字列は 1 回の textinput イベントになり、数値は文字のオーバーロードを使います。 直接入力では制御文字を保持します。

    ソースと継承
  • 1 バイトで 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

    結果の論理 AND。不明なタッチは false、空一覧は true。

    RmlUi 6.3 は修飾キーなしの左ボタン解放を模擬し、クリックが発生する場合があります。

    ソースと継承
  • Rml::Context::ProcessTouchEnd ですべてのタッチを解放します。

    引数

    touches
    readonly Touch[]

    順序付きタッチ一覧。

    modifiers
    number = 0

    KeyModifier フラグ。既定値は 0。

    戻り値

    boolean

    結果の論理 AND。不明なタッチと空一覧は true。

    ソースと継承
  • Rml::Context::ProcessTouchMove ですべてのタッチを移動します。

    引数

    touches
    readonly Touch[]

    順序付きタッチ一覧。

    modifiers
    number = 0

    KeyModifier フラグ。既定値は 0。

    戻り値

    boolean

    結果の論理 AND。不明なタッチと空一覧は true。

    ソースと継承
  • Rml::Context::ProcessTouchStart ですべてのタッチを開始します。

    引数

    touches
    readonly Touch[]

    全体を検証してから順番に処理するタッチ一覧。

    modifiers
    number = 0

    KeyModifier フラグ。既定値は 0。

    戻り値

    boolean

    上流の操作結果の論理 AND。空一覧では true。

    ソースと継承
  • Rml::Context::PullDocumentToFront で文書を最前面に移動します。

    引数

    document

    このコンテキストに属する文書。

    戻り値

    void
    ソースと継承
  • Rml::Context::PushDocumentToBack で文書を最背面に移動します。

    引数

    document

    このコンテキストに属する文書。

    戻り値

    void
    ソースと継承
  • 元のインスタンサー経由で独立所有 Context を解放します。

    戻り値

    void

    登録済みは release を拒否します。remove() で登録を削除してください。

    ソースと継承
  • RmlUi からこのコンテキストを削除します。

    戻り値

    boolean

    ネイティブコンテキストを削除したかどうか。

    登録済みは Rml::RemoveContext、独立所有はネイティブ所有権を解放します。 同名登録は削除せず、リスナーを自動解放します。remove の再呼び出しを 含む以後の操作は例外を投げます。寸法は 0 になり、同名の再作成でも復活しません。

    ソースと継承
  • 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 を返します。 呼び出し前に sfml.js の描画キューを flush し、後で display() してください。 ウィンドウのビューとクリップ領域が変更されます。毎フレーム、シーン描画の 記録前に window.setView(sceneView) でビューを再設定してください。

    ソースと継承
  • 非負の秒数後に RmlUi の更新を要求します。

    引数

    delay
    number

    秒数。0 と 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 所有者経由で 保持するため、Context とオブジェクトの循環は回収できます。

    ソースと継承
  • 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