Node.js のためのウィンドウ、グラフィックス、オーディオ、ネットワーク API。モジュールから探すか、API 名で検索できます。
時間、ベクトル、ストリーム。各モジュールを支える基盤。
同じ型の値を加算した新しいオブジェクトを返す。ベクトルは成分ごとに加算し、 Color チャンネルは 255 で飽和する。
left に right を直接加算して left を返す。読み取り専用定数は変更できない。
sf::Angle の float32 値。ネイティブ所有権は必要に応じて作成される。
一時停止可能な単調ストップウォッチ。ネイティブ SFML ハンドルは持たない。
度数から角度を作成し、float32 精度で格納する。
スカラーで除算した新しいオブジェクトを返す。2 つの Time または 2 つの Angle の除算では数値の比率を返す。
左の値をスカラーで直接除算して返す。除数がゼロなら RangeError をスローする。
同じ型のオペランドを値で比較する。浮動小数点数は厳密に比較し、 ベクトルは同じスカラー型でなければならない。
書き込んだバイトが実際の SFML ストリームに渡されるシングルトン Writable。
呼び出し元のバッファへ直接読み込む、シーク可能な非同期ファイル入力。
左の値が右の値より大きいか判定する。両者は同じ順序付け可能な型で なければならない。
左の値が右の値以上か判定する。両者は同じ順序付け可能な型でなければならない。
シーク可能な入力。各操作は同期または非同期で完了できる。
左の値が右の値より小さいか判定する。Time、Angle、VideoMode、 IpAddress に対応する。
左の値が右の値以下か判定する。両者は同じ順序付け可能な型でなければならない。
渡されたバイト列をコピーせずに保持する。
正確な符号付き 64 ビットのマイクロ秒数から時間長を作成する。 範囲外の場合は RangeError をスローする。
ミリ秒数から時間長を作成する。ゼロ方向に切り捨てた入力は符号付き 32 ビット整数の範囲内でなければならない。
マイクロ秒数の整数除算の剰余を時間長として返す。剰余の符号は left に従う。
時間長の剰余を left に書き戻し、left を返す。
スカラー倍、変換の合成、または点の変換による新しいオブジェクトを返す。 Color はチャンネルごとに乗算してから 255 で割る。
スケーリング、変換の合成、または色の変調を直接行い、左オペランドを返す。
元のスカラー型に変換した符号反転済みの新しいオブジェクトを返す。 Color は非対応で、ブールベクトルの値は変わらない。
同じ型のオペランドの値が等しくないかどうかを返す。
ラジアン値から角度を作成し、float32 精度で格納する。
データメンバーは再帰的に読み取り専用になります。 メソッドは引き続き独立した変更可能な値を返せます。
ベクトルのスカラー型。i/u は符号付き/符号なし整数、 f は浮動小数点数、末尾の数字はビット幅を表します。
float32 演算を使い、整数マイクロ秒に切り捨てて秒数から時間長を作成する。
プロセス全体の SFML 出力。Writable で転送、null で抑止、 undefined でリセットする。
SFML バインディングが報告する実行時エラー。
非同期待機。呼び出しスレッドは引き続きイベントループで利用できる。
undefined は I/O 失敗を示す。例外のスローや拒否された Promise の返却により、 読み込み操作の Promise も拒否される。
同じ型の値を減算した新しいオブジェクトを返す。Color チャンネルの下限は 0。
left から right を直接減算して left を返す。Color の各チャンネルの下限は 0。
システムのサスペンド時間も含める SFML の Android 時計。
符号付きマイクロ秒の時間長。ネイティブ API は bigint を値渡しで受け取る。
チェック周期ごとに 1 回呼ばれる。true で待機を続け、false で終了する。
タイムアウト設定。これを使う操作が待機とチェックを行う。
SFML の Unicode 規則で UTF-16 インデックス position の直前が書記素境界か 判定する。先頭と末尾は境界で、サロゲートペアの途中は境界ではない。 孤立したサロゲートコード単位は U+FFFD として扱う。
SFML の Unicode 規則で UTF-16 インデックス position の直前が文境界か 判定する。先頭と末尾は境界で、サロゲートペアの途中は境界ではない。 孤立したサロゲートコード単位は U+FFFD として扱う。
SFML の Unicode 規則で UTF-16 インデックス position の直前が単語境界か 判定する。先頭と末尾は境界で、サロゲートペアの途中は境界ではない。 孤立したサロゲートコード単位は U+FFFD として扱う。
sf::Vector2
sf::Vector2
sf::Vector2
sf::Vector2
sf::Vector3
3 つの float32 成分からなるベクトル。
3 つの符号付き 32 ビット整数成分からなるベクトル。
3 つの符号なし 32 ビット整数成分からなるベクトル。
実行時の SFML バージョン。ネイティブ格納領域を持つ単一の不変値として キャッシュされる。
現在読み込まれているネイティブ SFML ライブラリのバージョン。
ウィンドウ、入力、OpenGL コンテキスト。デスクトップとの接点。
OpenGL コンテキストを持つ OS ウィンドウ。Texture.update() で利用できる。
SFML のバリアント。kind がサブタイプを識別し、ペイロードフィールドは保たれる。
ビデオモード。ピクセル寸法とピクセルあたりのビット数。
システムクリップボードのテキストを返す。テキストがなければ空文字列を返す。
システムクリップボードのテキストを text に置き換える。
ネイティブ側が所有する OpenGL コンテキスト。 有効化は引き続きネイティブスレッド単位で行う。
OpenGL コンテキスト属性のビットフラグ。
SFML コンテキストへの要求。省略したメンバーには SFML の既定値を使う。
システムカーソルまたはカスタム RGBA ピクセルカーソル。
システムカーソルの形状。利用できる形状はプラットフォームに依存します。
SFML のバリアント。kind がサブタイプを識別し、ペイロードフィールドは保たれる。
kind フィールドで判別するイベントデータの共用体型。
イベントの種類ごとに任意で指定する同期ハンドラー。
対応するウィンドウイベントの種類名。
ウィンドウイベントの種類と付随データ。位置はすべてクライアント領域の ピクセル座標。
任意のウィンドウイベントデータを受け取るビジター関数。
指定した軸の位置を -100~100 の範囲で返す。
指定したジョイスティックのボタン数を返す。
指定したジョイスティックの名前、ベンダー識別子、製品識別子を返す。
ジョイスティックが指定した軸を持つかどうかを返す。
ジョイスティックデバイスの識別情報。
指定したジョイスティックのボタンが押されているか確認する。番号はゼロから始まる。
指定したジョイスティックが接続されているか返す。番号はゼロから始まる。
ジョイスティックの状態を手動で更新する。ウィンドウイベント処理でも更新される。
ジョイスティックの軸。
対応する軸の最大数
対応するボタンの最大数
対応するジョイスティックの最大数
現在のキーボード配列に基づき、論理キーコードを物理スキャンコードに変換する。
物理キーのユーザー向けの読みやすい名前を返す。
イベントキューに依存せず、論理キーのリアルタイムの押下状態を確認する。
現在のキーボード配列に基づき、物理スキャンコードを論理キーコードに変換する。
対応プラットフォームでスクリーンキーボードを表示または非表示にする。
システムのキーボード配列に依存する論理キー。
Key::Unknown を除くキーボードのキーの総数
キーボード配列に依存しない物理キー。
Scan::Unknown を除くスキャンコードの総数
マウスのピクセル位置を返す。ウィンドウを指定した場合はクライアント領域基準、 それ以外はデスクトップ基準。
マウスボタンのリアルタイムの押下状態を確認する。
マウスを移動する。ウィンドウを指定した場合はクライアント領域のピクセル座標、 それ以外はデスクトップのピクセル座標を使う。
マウスボタン。
マウスボタンの総数
マウスホイールの方向。
現在の OpenGL コンテキストの読み取り専用設定インターフェース。
3 軸の測定値を返す。加速度は m/s²、角速度は度/秒、磁場は µT、方向は度。
デバイスが指定したセンサーを提供するかどうかを返す。
センサーデータの収集を有効または無効にする。
センサーの種類の総数
センサーの種類。
ウィンドウの初期表示状態。
ビット単位の OR で組み合わせられるウィンドウスタイルのフラグ。
relativeTo のクライアント領域を基準としたタッチのピクセル位置を返す。 省略時はデスクトップ基準。
指定したタッチがまだ押されているかどうかを返す。
ビデオモード。ピクセル寸法とピクセルあたりのビット数。
Vulkan 関数のアドレスを取得し、見つからなければ undefined を返す。 アドレスは bigint で精度を保つ。呼び出しには関数シグネチャが一致する ネイティブバインディングが必要。
グラフィックスインスタンス作成に必要な拡張名のコピーを返す。 内容は SFML のプラットフォームバックエンドに依存する。
SFML バックエンドの Vulkan 対応を確認する。false なら計算機能のみ確認する。
OpenGL コンテキストを持つ OS ウィンドウ。Texture.update() で利用できる。
プラットフォームのウィンドウハンドルと Vulkan ポインターを損失なく表す。
ウィンドウ作成オプション。
テクスチャ、図形、テキスト、描画。2D シーンを構築。
Window のウィンドウ操作と RenderTarget の二次元描画を両方サポートするウィンドウ。
バックグラウンド画像デコードと順序付きピクセルアップロードに対応する GPU テクスチャ。
共通の Transformable API を備えた sf::Sprite。
Alpha を乗算したソース色を出力先に加算します。読み取り専用。
標準の Alpha ブレンド。読み取り専用。
各係数を乗算したソース色と出力先の色を合成する方法。
ブレンド式でソース色または出力先の色に乗算する係数。
ソースと出力先の成分ごとの最大値。読み取り専用。
ソースと出力先の成分ごとの最小値。読み取り専用。
sf::BlendMode。値は記録される各描画にコピーされます。
ソースと出力先を成分ごとに乗算します。読み取り専用。
色をブレンドせず、ソースで出力先を上書きします。読み取り専用。
Shape の外観と変換を備えた sf::CircleShape のジオメトリ。
円の初期ジオメトリパラメーター。
テキストシェーピング時のグリフクラスターのグループ化方法。
各 1 バイト、範囲 0~255 の四つのチャンネルを持つ RGBA 色。書き込みは Uint8Array の規則で変換し、必要に応じて Native とストレージを共有します。
sf::ConvexShape。頂点は輪郭に沿った順序で凸多角形を構成する必要があります。
テクスチャ座標の単位。
sf::Drawable。draw をオーバーライドして他の描画可能オブジェクトを同期的に組み合わせます。
sf::Rect
ネイティブ所有のフォントフェイス、入力ストレージ、保持されたグリフアトラス。
現在のフォントの識別情報と特性。
sf::Vector2
sf::Vector3
四つのブール成分を持つ GLSL bvec4。
四つの符号付き 32 ビット整数成分を持つ GLSL ivec4。
列優先の float32 成分を九つ持つ GLSL mat3。
列優先の float32 成分を十六個持つ GLSL mat4。
四つの float32 成分を持つ GLSL vec4。
sf::Glyph とその矩形メンバーは 44 バイトの割り当てを共有します。
グリフプリプロセッサーが変更できる単一グリフの外観。
グリフの外観を同期的に変更するコールバック。実行中は同じ Text のジオメトリを変更または照会してはいけません。
非同期のファイル操作とコーデック操作に対応するネイティブ所有の RGBA8 ピクセル。
sf::Rect
テキスト行の配置。
SFML 3 のプリミティブ型(四角形は非対応)。
同一フォントリソースへの読み取り専用インターフェース。フォントとグリフテクスチャの寿命を保持します。
コンパイル時の const ビュー。実行時ストレージは同じネイティブ Uint8Array です。
読み取り専用の描画状態。テクスチャとシェーダーはリソース参照を保持します。
同じシェーダープログラムへの読み取り専用インターフェース。
同一テクスチャリソースへのコンパイル時 const 参照。
Shape の外観と変換を備えた sf::RectangleShape のジオメトリ。
値メンバーはディープコピーされ、テクスチャとシェーダーの参照は同一性を保ちます。
描画状態の入力。設定オブジェクト、または単一の変換、ブレンド、ステンシル、テクスチャ、シェーダーリソース。
一部だけ指定できる描画状態パラメーター。
レンダーターゲットに共通の描画ディスパッチとコマンド記録。
sf::RenderTexture。clear/draw を記録し、display 呼び出し時に送信します。
オフスクリーンレンダーターゲットの深度、ステンシル、アンチエイリアス、OpenGL コンテキスト設定。
Window のウィンドウ操作と RenderTarget の二次元描画を両方サポートするウィンドウ。
ネイティブ所有のプログラム。ソースの読み込みとコンパイルは非同期に実行されます。
GLSL シェーダーステージ。
カスタム形状は update() を呼び出して凸な頂点輪郭を公開します。
シェーピング済みの単一グリフとその配置情報。
共通の Transformable API を備えた sf::Sprite。
マスク適用後の参照値とステンシルバッファー値を比較します。
sf::StencilMode。参照値とマスクは独立した値のコピーです。
ステンシルテストの初期設定。未指定フィールドは StencilMode の既定値を使います。
ステンシルテスト通過後のステンシルバッファー更新方法。
sf::StencilValue。符号付きから符号なしへの整数変換を含みます。
以前に記録された描画を保持しつつ、同じ型のリソースを交換します。
ネイティブ頂点ストレージとバッチ描画スナップショットを使う SFML シェーピング。
グリフの配置方向。
テキストの初期パラメーター。
横書きまたは縦書きの方向。
ビット演算で組み合わせ可能なテキストスタイルフラグ。
バックグラウンド画像デコードと順序付きピクセルアップロードに対応する GPU テクスチャ。
構築時から 64 バイトの列優先ストレージを使用する sf::Transform。
ネイティブ所有のステージング領域と JS による変換計算を備えた sf::Transformable。
位置、RGBA、テクスチャ座標を 20 バイトで共有する sf::Vertex。
割り当てごとに安定したビューで公開される、ネイティブの連続頂点。
Native 所有の GPU ストレージ。draw は頂点をアップロードせずにハンドルを記録します。
文字列により単一引数の Usage コンストラクターと PrimitiveType コンストラクターを区別します。
値として扱うカメラ。変更と投影計算は JS 側で行います。
再生、録音、空間オーディオ。リアルタイムに音を処理。
メモリ内の短い効果音を再生します。 SoundBuffer を保持してサンプルストレージを維持します。
ビューは取得元となったネイティブメモリ割り当てをそのまま保持します。
全サンプルを一度にメモリへ読み込まず、長い音声をブロック単位でデコード・再生します。
音声コールバックファクトリーに渡す実際の処理パラメーター。
モジュールのエクスポートはコンテキストと構造化クローンデータを 受け取るファクトリーです。
音声 Worker モジュールとブロックキューの設定。
ネイティブ音声ブロックキューの累積統計。
インターリーブ順に並ぶチャンネル位置の読み取り専用ビュー。
浮動小数点フィールドを通じて公開される ネイティブの sf::SoundSource::Cone。
空間音源またはリスナーの指向性コーンのパラメーター。
エフェクトプロセッサーが実際に消費・生成したフレーム数。
ネイティブ浮動小数点ブロックに対するバッファー付き DSP。 アンダーフロー時は無音を出力します。
Node Worker で実行する浮動小数点 PCM のエフェクトコールバック。
浮動小数点 PCM エフェクトプロセッサーの Worker と容量の設定。
呼び出し順に非同期で 16 ビットインターリーブ PCM を読み取る、 シーク可能な音声デコーダー。
リスナーの指向性コーンのパラメーターのコピーを返します。
リスナーの向きのコピーを返します。
全体音量の百分率を返します。
リスナーの 3D 位置のコピーを返します。
リスナーの上方向のコピーを返します。
リスナーの速度のコピーを返します。
指向性コーンのパラメーターをコピーし、ネイティブリスナーを更新します。
リスナーの前方方向を設定します。
全音源の全体音量を百分率で設定します。0 は無音、100 は元の音量です。
リスナーのワールド座標での位置を設定します。
リスナーの上方向を設定します。前方方向とともに空間内の向きを決めます。
ドップラー効果用のリスナー速度を設定します。単位は位置単位/秒です。
全サンプルを一度にメモリへ読み込まず、長い音声をブロック単位でデコード・再生します。
16 ビットインターリーブ PCM を音声ファイルに非同期でエンコードします。 形式はファイルの拡張子で決まります。
利用可能な再生デバイスの名前を返します。
システムの既定の再生デバイス名を返します。利用不可なら undefined。
現在の再生デバイス名を返します。利用不可なら undefined。
現在のデバイスのサンプルレートを Hz で返します。利用不可なら undefined。
現在のデバイスがシステムの既定デバイスに追従するかどうかを返します。
音声再生デバイスのライフサイクル通知。
再生デバイスの状態通知を受け取るコールバック。
指定名の再生デバイスに切り替え、成功したかどうかを返します。
システムの既定の再生デバイスに切り替え、成功したかどうかを返します。
音を出力しないヌルデバイスに切り替え、成功したかどうかを返します。
デバイス通知のコールバックを設定します。undefined または null で解除します。
16 ビットのインターリーブ PCM の読み取り専用型ビュー。 基になるネイティブストレージを保持します。
音声バッファーの読み取り専用インターフェース。 サンプルビューは対応するネイティブストレージを保持します。
メモリ内の短い効果音を再生します。 SoundBuffer を保持してサンプルストレージを維持します。
ビューは取得元となったネイティブメモリ割り当てをそのまま保持します。
キャプチャした PCM を SoundBuffer に保存する録音器。
インターリーブ PCM チャンネルに対応するスピーカー位置。
登録は現在の Node 環境に属します。
カスタム音声デコーダーのインターフェース。 読み書き位置は全チャンネルの合計サンプル数で表します。
登録可能なデコーダークラス。 引数なしのコンストラクターと形式判定メソッドが必要です。
スカラーフィールドが直接マッピングされた sf::SoundFileReader::Info。
カスタム音声デコーダーが返す形式情報。
16 ビットのインターリーブ PCM を受け取るカスタム音声エンコーダー。
登録可能なエンコーダークラス。引数なしのコンストラクターと ファイル名による形式判定メソッドが必要です。
デバイスの音声をキャプチャし、Node Worker で 16 ビットインターリーブ PCM を処理します。
Node Worker で実行する録音コールバック。
共有の制御・結果フィールド。エンジン操作はすべて SFML で実行されます。
音源の現在の再生状態。
バッファー付き SFML ストリーム。 指定モジュールが Node Worker 内で PCM を生成します。
Node Worker で実行する再生ストリームのコールバック。
samples は再利用可能なネイティブスロットを参照し、 コールバックの完了まで有効です。
カスタム PCM 再生ストリームの形式と Worker 設定。
正確なマイクロ秒数で保存される変更可能な音声の時間範囲。
音声の時間範囲の入力。
ソケット、パケット、通信プロトコル。ネットワークに接続。
生バイト、SFML Packet のフレーミング、TLS アップグレード対応の TCP ソケット。
リクエストごとに 1 接続を使う HTTP/HTTPS クライアント。 リダイレクトを自動追跡しません。
整数はネットワーク順、SFML の浮動小数点数はホスト順を使用します。
単一の UDP データグラムの受信結果。
OpenDNS で指定アドレスファミリーの外向き公開アドレスを照会し、 失敗時は undefined を返します。
メール交換サーバーのレコード。
メール交換レコードを照会します。既定のタイムアウトは 1 秒で、 照会失敗時は空配列を返します。
ネームサーバーレコードを照会します。既定はシステム DNS と 1 秒の タイムアウトで、照会失敗時は空配列を返します。
サービス検出レコード(例: _service._tcp.domain)を照会し、 失敗時は空配列を返します。
TXT レコードを照会します。各レコードは複数のテキスト断片を含み、 失敗時は空配列を返します。
IPv4/IPv6 アドレスを非同期に解決し、失敗時は undefined を返します。 servers が空ならシステムのリゾルバーを使い、timeout は適用しません。 DNS サーバーを指定した場合、既定のタイムアウトは 1 秒です。
サービス検出レコード。
リモートファイルシステムのエントリー型。
basic-ftp ベースの FTP クライアント。キューで操作を呼び出し順に実行します。
作業ディレクトリのパスを含む FTP レスポンス。
ディレクトリエントリー名を含む FTP レスポンス。
FTP 状態コードとサーバーメッセージ。
FTP サーバーの応答コードとクライアントのエラーコード。
リクエストごとに 1 接続を使う HTTP/HTTPS クライアント。 リダイレクトを自動追跡しません。
HTTP リクエストメソッド。
変更可能な HTTP/1 リクエスト。既定は GET /、HTTP/1.0、空の本文です。
HTTP レスポンスの状態、ヘッダーフィールド、本文。
HTTP レスポンス状態とクライアントエラー。値は SFML の定義を維持します。
IPv4 と IPv6 に対応する不変の IP アドレス値。
IP アドレスファミリー。
整数はネットワーク順、SFML の浮動小数点数はホスト順を使用します。
Packet.write/read が受け付ける符号化型名。
Packet の符号化型と対応する JS 値。複数バイト整数はネットワーク順です。
ビット単位で組み合わせ可能なソケットの準備状態。
今回の wait で取得した準備状態のビットフラグを受け取ります。
ssh2 ベースの非同期 SFTP クライアント。ファイル操作は呼び出し順に実行します。
リモートエントリーの属性。サーバーが提供しないフィールドは undefined です。
単一ファイルシステムエントリーの属性を含む結果。
ダウンロードチャンクを処理し、false を返すと早期終了します。 空チャンクはファイル終端を示します。
SSH サーバーのホスト公開鍵の種類。
ディレクトリエントリーの属性一覧を含む結果。
リモートパスを含む操作結果。
SFTP 操作の状態とメッセージ。
SFTP 操作の結果コード。
アプリケーションによるホスト公開鍵とアルゴリズムの検証に使う SSH ハンドシェイクの交渉結果。
進捗がない場合のタイムアウト設定。データ受信または RPC 完了で タイマーをリセットします。期間がゼロならタイムアウトなしです。
アップロードチャンクを埋めて size を設定します。 false を返しても現在のチャンクを送信してから終了します。
アップロードコールバックが受け取る書き込み可能なデータチャンク。
Node ネットワークトランスポートの共通基底クラス。 既定では非同期待機によるブロッキング動作を使います。
Node の TCP、UDP、またはリスナートランスポートオブジェクト。 OS の生のファイル記述子は受け付けません。
ソケット群の準備完了を非同期に待ち、直近の wait の結果を保持します。
生の TCP バイトの送信結果。
ソケット操作の結果。ブロッキングモードは Promise で待機し、 Node のイベントループをブロックしません。
生の TCP バイトの読み取り結果。
sf::Socket::Type に対応するソケットのトランスポートプロトコル。
TCP 接続を待ち受け、accept で TcpSocket に渡します。
生バイト、SFML Packet のフレーミング、TLS アップグレード対応の TCP ソケット。
TLS アップグレードの現在の状態。
FTP のファイル転送モード。
データグラム境界を保持する UDP ソケット。 Packet に TCP の長さヘッダーは付加しません。
一時停止可能な単調ストップウォッチ。ネイティブ SFML ハンドルは持たない。