sfml.js ドキュメント

このドキュメントは、現在のリポジトリの SFML 3.1.0 バインディングに対応しています。初めて使う場合は「クイックスタート」から読み、個々のメソッドのシグネチャを調べる場合は TypeDoc を参照してください。

はじめに

ドキュメント	内容
クイックスタート	依存関係のインストール、インポート方法の選択、最初のウィンドウの作成
基本概念	値とリソースのコピー、読み込みの完了時点、draw が反映されるタイミング
API ナビゲーション	5 つのモジュールが提供する機能
サンプル一覧	リポジトリ内の完全なデモの実行

モジュール別ガイド

モジュール	内容
System	ベクトル、角度、時間、入力ストリーム、Unicode、エラー処理
Window	ウィンドウのライフサイクル、イベント、リアルタイム入力、OpenGL、Vulkan
Graphics	画像、テクスチャ、スプライト、図形、テキスト、ビュー、描画
Audio	再生、ストリーミングでのデータ供給、エフェクト、録音、エンコードとデコード
Network	Packet、TCP／UDP、DNS、TLS、HTTP、FTP、SFTP

開発への参加

開発ガイドでは、ビルド、テスト、ソースコードの構成、現在のドキュメント公開手順を説明しています。

メソッドのシグネチャとエクスポート一覧は src/index.ts とそのソースコメントを基準とします。上流の概念は SFML 3.1.0 C++ リファレンスを参照してください。JavaScript への適応、特に Node.js の非同期処理、メモリ、ネットワークの挙動は、sfml.js のガイドと TypeDoc を基準とします。