Skip to content

RmlUi ガイド ​

RmlUi

sfml.js-rmlui で SFML ウィンドウ内に文書ベースの UI を構築します。RML が要素ツリーを、RCSS が外観を定義し、JavaScript がアプリケーション状態とイベント処理を管理します。現在のソースは RmlUi 6.3 と SFML 3.1 を対象としています。

JavaScript と SFML ウィンドウの基礎が前提です。RmlUi 6.3 は HTML/CSS に似ていますが、ブラウザーを組み込んでいません。ネイティブデータモデルはスカラーとコールバック、再帰レコードと配列、独自変数、共有数値領域と部分更新を扱います。以下のガイドはランタイム、文書ツリー、スタイル、描画、入力、フォント、スクリプト、リソース所有権を説明し、API リファレンスは TypeScript の契約を示します。

RmlUi とは ​

RmlUi は、HTML/CSS に似た文書構文を使う C++ UI ライブラリです。RML を一度読み込むと永続的な要素ツリーを作り、RCSS で装飾し、アプリケーション状態の変化に応じて個々の要素を更新します。RmlUi がレイアウトとジオメトリの生成を行い、本パッケージが SFML で描画します。

ゲームメニュー、HUD、インベントリ、レイアウトと外観を別の素材ファイルで管理する UI に適しています。RML、RCSS、Node.js のイベント処理が連携し、ブラウザー DOM や Web の JavaScript 環境は使いません。毎フレームのウィジェット呼び出しで構築するツールには ImGui ガイドを参照してください。

公式ドキュメント · 公式リポジトリ

学習順序 ​

章内容
クイックスタートカウンターを実行し、初期化、フォント、フレーム順序を理解
RML と RCSS の基礎マークアップ、セレクター、レイアウト、クリック処理、公式構文リファレンス
文書とイベントRML の読み込み、要素編集、リスナー登録、ネイティブオブジェクトの解放
ネイティブ Debugger別ホストで要素、ログ、データモデルを検査
SVG と LottieNative ベクター要素、デコレーター、フレームとソース
ジオメトリと畳み込みメッシュの一括生成と共有アルファ領域のフィルター
描画と RetinaSFML との合成、高密度表示、エフェクトの対応範囲
共有領域とバッチ処理数値コマンド、まとめた JS 計算、リソースの準備
API ガイド型、既定値、戻り値、有効期間の契約

ガイドとソースから生成する API リファレンスは、英語、簡体字中国語、日本語、韓国語で保守しています。

サンプルを実行 ​

monorepo のルートで実行します。

sh
node tools/bootstrap.cjs
node packages/sfml.js-rmlui/examples/demo.cjs
node packages/sfml.js-rmlui/examples/official.cjs variables

サンプル一覧に画面、操作方法、ソースリンクがあります。カウンターの Increment は動作しますが、variables のミッションボタンはホバースタイルのみです。

所有権の境界 ​

プロセス全体のランタイムは 1 つの RenderWindow に接続し、初期化した Node.js 環境とスレッドに属します。コンテキスト、文書、フォント、描画リソースを管理します。ラッパーはネイティブの有効性を共有します。JS 参照は所有権付き未接続ツリーを保持し、接続済み要素の寿命は親が管理します。破棄時にリスナーを自動解放し、無効なラッパーの使用は例外になります。SFML ウィンドウを閉じる前に RmlUi を終了してください。遅延破棄と Worker の制約はネイティブの有効期間を参照してください。

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