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

Node.js のためのウィンドウ、グラフィックス、オーディオ、ネットワーク API。モジュールから探すか、API 名で検索できます。

System

時間、ベクトル、ストリーム。各モジュールを支える基盤。

すべての API52
add

同じ型の値を加算した新しいオブジェクトを返す。ベクトルは成分ごとに加算し、 Color チャンネルは 255 で飽和する。

addAssign

left に right を直接加算して left を返す。読み取り専用定数は変更できない。

Angle

sf::Angle の float32 値。ネイティブ所有権は必要に応じて作成される。

Clock

一時停止可能な単調ストップウォッチ。ネイティブ SFML ハンドルは持たない。

degrees

度数から角度を作成し、float32 精度で格納する。

divide

スカラーで除算した新しいオブジェクトを返す。2 つの Time または 2 つの Angle の除算では数値の比率を返す。

divideAssign

左の値をスカラーで直接除算して返す。除数がゼロなら RangeError をスローする。

equal

同じ型のオペランドを値で比較する。浮動小数点数は厳密に比較し、 ベクトルは同じスカラー型でなければならない。

err

書き込んだバイトが実際の SFML ストリームに渡されるシングルトン Writable。

FileInputStream

呼び出し元のバッファへ直接読み込む、シーク可能な非同期ファイル入力。

greater

左の値が右の値より大きいか判定する。両者は同じ順序付け可能な型で なければならない。

greaterEqual

左の値が右の値以上か判定する。両者は同じ順序付け可能な型でなければならない。

InputStream

シーク可能な入力。各操作は同期または非同期で完了できる。

less

左の値が右の値より小さいか判定する。Time、Angle、VideoMode、 IpAddress に対応する。

lessEqual

左の値が右の値以下か判定する。両者は同じ順序付け可能な型でなければならない。

MemoryInputStream

渡されたバイト列をコピーせずに保持する。

microseconds

正確な符号付き 64 ビットのマイクロ秒数から時間長を作成する。 範囲外の場合は RangeError をスローする。

milliseconds

ミリ秒数から時間長を作成する。ゼロ方向に切り捨てた入力は符号付き 32 ビット整数の範囲内でなければならない。

modulo

マイクロ秒数の整数除算の剰余を時間長として返す。剰余の符号は left に従う。

moduloAssign

時間長の剰余を left に書き戻し、left を返す。

multiply

スカラー倍、変換の合成、または点の変換による新しいオブジェクトを返す。 Color はチャンネルごとに乗算してから 255 で割る。

multiplyAssign

スケーリング、変換の合成、または色の変調を直接行い、左オペランドを返す。

negate

元のスカラー型に変換した符号反転済みの新しいオブジェクトを返す。 Color は非対応で、ブールベクトルの値は変わらない。

notEqual

同じ型のオペランドの値が等しくないかどうかを返す。

radians

ラジアン値から角度を作成し、float32 精度で格納する。

ReadonlyValue

データメンバーは再帰的に読み取り専用になります。 メソッドは引き続き独立した変更可能な値を返せます。

ScalarType

ベクトルのスカラー型。i/u は符号付き/符号なし整数、 f は浮動小数点数、末尾の数字はビット幅を表します。

seconds

float32 演算を使い、整数マイクロ秒に切り捨てて秒数から時間長を作成する。

setErrorOutput

プロセス全体の SFML 出力。Writable で転送、null で抑止、 undefined でリセットする。

SFMLError

SFML バインディングが報告する実行時エラー。

sleep

非同期待機。呼び出しスレッドは引き続きイベントループで利用できる。

StreamResult

undefined は I/O 失敗を示す。例外のスローや拒否された Promise の返却により、 読み込み操作の Promise も拒否される。

subtract

同じ型の値を減算した新しいオブジェクトを返す。Color チャンネルの下限は 0。

subtractAssign

left から right を直接減算して left を返す。Color の各チャンネルの下限は 0。

SuspendAwareClock

システムのサスペンド時間も含める SFML の Android 時計。

Time

符号付きマイクロ秒の時間長。ネイティブ API は bigint を値渡しで受け取る。

TimeoutPredicate

チェック周期ごとに 1 回呼ばれる。true で待機を続け、false で終了する。

TimeoutWithPredicate

タイムアウト設定。これを使う操作が待機とチェックを行う。

Unicode
isGraphemeBoundary

SFML の Unicode 規則で UTF-16 インデックス position の直前が書記素境界か 判定する。先頭と末尾は境界で、サロゲートペアの途中は境界ではない。 孤立したサロゲートコード単位は U+FFFD として扱う。

isSentenceBoundary

SFML の Unicode 規則で UTF-16 インデックス position の直前が文境界か 判定する。先頭と末尾は境界で、サロゲートペアの途中は境界ではない。 孤立したサロゲートコード単位は U+FFFD として扱う。

isWordBoundary

SFML の Unicode 規則で UTF-16 インデックス position の直前が単語境界か 判定する。先頭と末尾は境界で、サロゲートペアの途中は境界ではない。 孤立したサロゲートコード単位は U+FFFD として扱う。

Vector2

sf::Vector2。ネイティブハンドルは既存の格納領域へ遅延バインドされる。

Vector2f

sf::Vector2。浮動小数点型の 2 次元ベクトル。

Vector2i

sf::Vector2。整数型の 2 次元ベクトル。

Vector2u

sf::Vector2。符号なし整数型の 2 次元ベクトル。

Vector3

sf::Vector3。そのスカラー型の 3 つの連続した値として格納される。

Vector3f

3 つの float32 成分からなるベクトル。

Vector3i

3 つの符号付き 32 ビット整数成分からなるベクトル。

Vector3u

3 つの符号なし 32 ビット整数成分からなるベクトル。

version

実行時の SFML バージョン。ネイティブ格納領域を持つ単一の不変値として キャッシュされる。

Version

現在読み込まれているネイティブ SFML ライブラリのバージョン。

Window

ウィンドウ、入力、OpenGL コンテキスト。デスクトップとの接点。

すべての API64
Clipboard
getString

システムクリップボードのテキストを返す。テキストがなければ空文字列を返す。

setString

システムクリップボードのテキストを text に置き換える。

Context

ネイティブ側が所有する OpenGL コンテキスト。 有効化は引き続きネイティブスレッド単位で行う。

ContextAttribute

OpenGL コンテキスト属性のビットフラグ。

ContextSettings

SFML コンテキストへの要求。省略したメンバーには SFML の既定値を使う。

Cursor

システムカーソルまたはカスタム RGBA ピクセルカーソル。

CursorType

システムカーソルの形状。利用できる形状はプラットフォームに依存します。

Event

SFML のバリアント。kind がサブタイプを識別し、ペイロードフィールドは保たれる。

EventData

kind フィールドで判別するイベントデータの共用体型。

EventHandlers

イベントの種類ごとに任意で指定する同期ハンドラー。

EventKind

対応するウィンドウイベントの種類名。

EventPayloads

ウィンドウイベントの種類と付随データ。位置はすべてクライアント領域の ピクセル座標。

EventVisitor

任意のウィンドウイベントデータを受け取るビジター関数。

Joystick
getAxisPosition

指定した軸の位置を -100~100 の範囲で返す。

getButtonCount

指定したジョイスティックのボタン数を返す。

getIdentification

指定したジョイスティックの名前、ベンダー識別子、製品識別子を返す。

hasAxis

ジョイスティックが指定した軸を持つかどうかを返す。

Identification

ジョイスティックデバイスの識別情報。

isButtonPressed

指定したジョイスティックのボタンが押されているか確認する。番号はゼロから始まる。

isConnected

指定したジョイスティックが接続されているか返す。番号はゼロから始まる。

update

ジョイスティックの状態を手動で更新する。ウィンドウイベント処理でも更新される。

JoystickAxis

ジョイスティックの軸。

JoystickAxisCount

対応する軸の最大数

JoystickButtonCount

対応するボタンの最大数

JoystickCount

対応するジョイスティックの最大数

Keyboard
delocalize

現在のキーボード配列に基づき、論理キーコードを物理スキャンコードに変換する。

getDescription

物理キーのユーザー向けの読みやすい名前を返す。

isKeyPressed

イベントキューに依存せず、論理キーのリアルタイムの押下状態を確認する。

localize

現在のキーボード配列に基づき、物理スキャンコードを論理キーコードに変換する。

setVirtualKeyboardVisible

対応プラットフォームでスクリーンキーボードを表示または非表示にする。

KeyboardKey

システムのキーボード配列に依存する論理キー。

KeyboardKeyCount

Key::Unknown を除くキーボードのキーの総数

KeyboardScancode

キーボード配列に依存しない物理キー。

KeyboardScancodeCount

Scan::Unknown を除くスキャンコードの総数

Mouse
getPosition

マウスのピクセル位置を返す。ウィンドウを指定した場合はクライアント領域基準、 それ以外はデスクトップ基準。

isButtonPressed

マウスボタンのリアルタイムの押下状態を確認する。

setPosition

マウスを移動する。ウィンドウを指定した場合はクライアント領域のピクセル座標、 それ以外はデスクトップのピクセル座標を使う。

MouseButton

マウスボタン。

MouseButtonCount

マウスボタンの総数

MouseWheel

マウスホイールの方向。

ReadonlyContext

現在の OpenGL コンテキストの読み取り専用設定インターフェース。

Sensor
getValue

3 軸の測定値を返す。加速度は m/s²、角速度は度/秒、磁場は µT、方向は度。

isAvailable

デバイスが指定したセンサーを提供するかどうかを返す。

setEnabled

センサーデータの収集を有効または無効にする。

SensorCount

センサーの種類の総数

SensorType

センサーの種類。

State

ウィンドウの初期表示状態。

Style

ビット単位の OR で組み合わせられるウィンドウスタイルのフラグ。

Touch
getPosition

relativeTo のクライアント領域を基準としたタッチのピクセル位置を返す。 省略時はデスクトップ基準。

isDown

指定したタッチがまだ押されているかどうかを返す。

VideoMode

ビデオモード。ピクセル寸法とピクセルあたりのビット数。

Vulkan
getFunction

Vulkan 関数のアドレスを取得し、見つからなければ undefined を返す。 アドレスは bigint で精度を保つ。呼び出しには関数シグネチャが一致する ネイティブバインディングが必要。

getGraphicsRequiredInstanceExtensions

グラフィックスインスタンス作成に必要な拡張名のコピーを返す。 内容は SFML のプラットフォームバックエンドに依存する。

isAvailable

SFML バックエンドの Vulkan 対応を確認する。false なら計算機能のみ確認する。

Window

OpenGL コンテキストを持つ OS ウィンドウ。Texture.update() で利用できる。

WindowHandle

プラットフォームのウィンドウハンドルと Vulkan ポインターを損失なく表す。

WindowOptions

ウィンドウ作成オプション。

Graphics

テクスチャ、図形、テキスト、描画。2D シーンを構築。

すべての API71
BlendAdd

Alpha を乗算したソース色を出力先に加算します。読み取り専用。

BlendAlpha

標準の Alpha ブレンド。読み取り専用。

BlendEquation

各係数を乗算したソース色と出力先の色を合成する方法。

BlendFactor

ブレンド式でソース色または出力先の色に乗算する係数。

BlendMax

ソースと出力先の成分ごとの最大値。読み取り専用。

BlendMin

ソースと出力先の成分ごとの最小値。読み取り専用。

BlendMode

sf::BlendMode。値は記録される各描画にコピーされます。

BlendMultiply

ソースと出力先を成分ごとに乗算します。読み取り専用。

BlendNone

色をブレンドせず、ソースで出力先を上書きします。読み取り専用。

CircleShape

Shape の外観と変換を備えた sf::CircleShape のジオメトリ。

CircleShapeOptions

円の初期ジオメトリパラメーター。

ClusterGrouping

テキストシェーピング時のグリフクラスターのグループ化方法。

Color

各 1 バイト、範囲 0~255 の四つのチャンネルを持つ RGBA 色。書き込みは Uint8Array の規則で変換し、必要に応じて Native とストレージを共有します。

ConvexShape

sf::ConvexShape。頂点は輪郭に沿った順序で凸多角形を構成する必要があります。

CoordinateType

テクスチャ座標の単位。

Drawable

sf::Drawable。draw をオーバーライドして他の描画可能オブジェクトを同期的に組み合わせます。

FloatRect

sf::Rect。メンバービューとネイティブの 16 バイトを共有します。

Font

ネイティブ所有のフォントフェイス、入力ストレージ、保持されたグリフアトラス。

FontInfo

現在のフォントの識別情報と特性。

Glsl
Bvec2

sf::Vector2。各成分は正規化された 0/1 の 1 バイトを占めます。

Bvec3

sf::Vector3。数値型 Vector3 と同じネイティブファミリーを共有します。

Bvec4

四つのブール成分を持つ GLSL bvec4。

Ivec4

四つの符号付き 32 ビット整数成分を持つ GLSL ivec4。

Mat3

列優先の float32 成分を九つ持つ GLSL mat3。

Mat4

列優先の float32 成分を十六個持つ GLSL mat4。

Vec4

四つの float32 成分を持つ GLSL vec4。

Glyph

sf::Glyph とその矩形メンバーは 44 バイトの割り当てを共有します。

GlyphAppearance

グリフプリプロセッサーが変更できる単一グリフの外観。

GlyphPreProcessor

グリフの外観を同期的に変更するコールバック。実行中は同じ Text のジオメトリを変更または照会してはいけません。

Image

非同期のファイル操作とコーデック操作に対応するネイティブ所有の RGBA8 ピクセル。

IntRect

sf::Rect。getCenter() では整数除算を使用します。

LineAlignment

テキスト行の配置。

PrimitiveType

SFML 3 のプリミティブ型(四角形は非対応)。

ReadonlyFont

同一フォントリソースへの読み取り専用インターフェース。フォントとグリフテクスチャの寿命を保持します。

ReadonlyPixels

コンパイル時の const ビュー。実行時ストレージは同じネイティブ Uint8Array です。

ReadonlyRenderStates

読み取り専用の描画状態。テクスチャとシェーダーはリソース参照を保持します。

ReadonlyShader

同じシェーダープログラムへの読み取り専用インターフェース。

ReadonlyTexture

同一テクスチャリソースへのコンパイル時 const 参照。

RectangleShape

Shape の外観と変換を備えた sf::RectangleShape のジオメトリ。

RenderStates

値メンバーはディープコピーされ、テクスチャとシェーダーの参照は同一性を保ちます。

RenderStatesInput

描画状態の入力。設定オブジェクト、または単一の変換、ブレンド、ステンシル、テクスチャ、シェーダーリソース。

RenderStatesOptions

一部だけ指定できる描画状態パラメーター。

RenderTarget

レンダーターゲットに共通の描画ディスパッチとコマンド記録。

RenderTexture

sf::RenderTexture。clear/draw を記録し、display 呼び出し時に送信します。

RenderTextureSettings

オフスクリーンレンダーターゲットの深度、ステンシル、アンチエイリアス、OpenGL コンテキスト設定。

RenderWindow

Window のウィンドウ操作と RenderTarget の二次元描画を両方サポートするウィンドウ。

Shader

ネイティブ所有のプログラム。ソースの読み込みとコンパイルは非同期に実行されます。

ShaderType

GLSL シェーダーステージ。

Shape

カスタム形状は update() を呼び出して凸な頂点輪郭を公開します。

ShapedGlyph

シェーピング済みの単一グリフとその配置情報。

Sprite

共通の Transformable API を備えた sf::Sprite。

StencilComparison

マスク適用後の参照値とステンシルバッファー値を比較します。

StencilMode

sf::StencilMode。参照値とマスクは独立した値のコピーです。

StencilModeOptions

ステンシルテストの初期設定。未指定フィールドは StencilMode の既定値を使います。

StencilUpdateOperation

ステンシルテスト通過後のステンシルバッファー更新方法。

StencilValue

sf::StencilValue。符号付きから符号なしへの整数変換を含みます。

swap

以前に記録された描画を保持しつつ、同じ型のリソースを交換します。

Text

ネイティブ頂点ストレージとバッチ描画スナップショットを使う SFML シェーピング。

TextDirection

グリフの配置方向。

TextOptions

テキストの初期パラメーター。

TextOrientation

横書きまたは縦書きの方向。

TextStyle

ビット演算で組み合わせ可能なテキストスタイルフラグ。

Texture

バックグラウンド画像デコードと順序付きピクセルアップロードに対応する GPU テクスチャ。

Transform

構築時から 64 バイトの列優先ストレージを使用する sf::Transform。

Transformable

ネイティブ所有のステージング領域と JS による変換計算を備えた sf::Transformable。

Vertex

位置、RGBA、テクスチャ座標を 20 バイトで共有する sf::Vertex。

VertexArray

割り当てごとに安定したビューで公開される、ネイティブの連続頂点。

VertexBuffer

Native 所有の GPU ストレージ。draw は頂点をアップロードせずにハンドルを記録します。

VertexBufferUsage

文字列により単一引数の Usage コンストラクターと PrimitiveType コンストラクターを区別します。

View

値として扱うカメラ。変更と投影計算は JS 側で行います。

Audio

再生、録音、空間オーディオ。リアルタイムに音を処理。

すべての API62
AudioWorkerContext

音声コールバックファクトリーに渡す実際の処理パラメーター。

AudioWorkerModule

モジュールのエクスポートはコンテキストと構造化クローンデータを 受け取るファクトリーです。

AudioWorkerOptions

音声 Worker モジュールとブロックキューの設定。

AudioWorkerStats

ネイティブ音声ブロックキューの累積統計。

ChannelMap

インターリーブ順に並ぶチャンネル位置の読み取り専用ビュー。

Cone

浮動小数点フィールドを通じて公開される ネイティブの sf::SoundSource::Cone。

ConeInput

空間音源またはリスナーの指向性コーンのパラメーター。

EffectFrames

エフェクトプロセッサーが実際に消費・生成したフレーム数。

EffectProcessor

ネイティブ浮動小数点ブロックに対するバッファー付き DSP。 アンダーフロー時は無音を出力します。

EffectProcessorCallbacks

Node Worker で実行する浮動小数点 PCM のエフェクトコールバック。

EffectProcessorOptions

浮動小数点 PCM エフェクトプロセッサーの Worker と容量の設定。

InputSoundFile

呼び出し順に非同期で 16 ビットインターリーブ PCM を読み取る、 シーク可能な音声デコーダー。

Listener
getCone

リスナーの指向性コーンのパラメーターのコピーを返します。

getDirection

リスナーの向きのコピーを返します。

getGlobalVolume

全体音量の百分率を返します。

getPosition

リスナーの 3D 位置のコピーを返します。

getUpVector

リスナーの上方向のコピーを返します。

getVelocity

リスナーの速度のコピーを返します。

setCone

指向性コーンのパラメーターをコピーし、ネイティブリスナーを更新します。

setDirection

リスナーの前方方向を設定します。

setGlobalVolume

全音源の全体音量を百分率で設定します。0 は無音、100 は元の音量です。

setPosition

リスナーのワールド座標での位置を設定します。

setUpVector

リスナーの上方向を設定します。前方方向とともに空間内の向きを決めます。

setVelocity

ドップラー効果用のリスナー速度を設定します。単位は位置単位/秒です。

Music

全サンプルを一度にメモリへ読み込まず、長い音声をブロック単位でデコード・再生します。

OutputSoundFile

16 ビットインターリーブ PCM を音声ファイルに非同期でエンコードします。 形式はファイルの拡張子で決まります。

PlaybackDevice
getAvailableDevices

利用可能な再生デバイスの名前を返します。

getDefaultDevice

システムの既定の再生デバイス名を返します。利用不可なら undefined。

getDevice

現在の再生デバイス名を返します。利用不可なら undefined。

getDeviceSampleRate

現在のデバイスのサンプルレートを Hz で返します。利用不可なら undefined。

isDefaultDevice

現在のデバイスがシステムの既定デバイスに追従するかどうかを返します。

Notification

音声再生デバイスのライフサイクル通知。

NotificationCallback

再生デバイスの状態通知を受け取るコールバック。

setDevice

指定名の再生デバイスに切り替え、成功したかどうかを返します。

setDeviceToDefault

システムの既定の再生デバイスに切り替え、成功したかどうかを返します。

setDeviceToNull

音を出力しないヌルデバイスに切り替え、成功したかどうかを返します。

setNotificationCallback

デバイス通知のコールバックを設定します。undefined または null で解除します。

ReadonlySamples

16 ビットのインターリーブ PCM の読み取り専用型ビュー。 基になるネイティブストレージを保持します。

ReadonlySoundBuffer

音声バッファーの読み取り専用インターフェース。 サンプルビューは対応するネイティブストレージを保持します。

Sound

メモリ内の短い効果音を再生します。 SoundBuffer を保持してサンプルストレージを維持します。

SoundBuffer

ビューは取得元となったネイティブメモリ割り当てをそのまま保持します。

SoundBufferRecorder

キャプチャした PCM を SoundBuffer に保存する録音器。

SoundChannel

インターリーブ PCM チャンネルに対応するスピーカー位置。

SoundFileFactory

登録は現在の Node 環境に属します。

SoundFileReader

カスタム音声デコーダーのインターフェース。 読み書き位置は全チャンネルの合計サンプル数で表します。

SoundFileReaderConstructor

登録可能なデコーダークラス。 引数なしのコンストラクターと形式判定メソッドが必要です。

SoundFileReaderInfo

スカラーフィールドが直接マッピングされた sf::SoundFileReader::Info。

SoundFileReaderInfoInput

カスタム音声デコーダーが返す形式情報。

SoundFileWriter

16 ビットのインターリーブ PCM を受け取るカスタム音声エンコーダー。

SoundFileWriterConstructor

登録可能なエンコーダークラス。引数なしのコンストラクターと ファイル名による形式判定メソッドが必要です。

SoundRecorder

デバイスの音声をキャプチャし、Node Worker で 16 ビットインターリーブ PCM を処理します。

SoundRecorderCallbacks

Node Worker で実行する録音コールバック。

SoundSource

共有の制御・結果フィールド。エンジン操作はすべて SFML で実行されます。

SoundStatus

音源の現在の再生状態。

SoundStream

バッファー付き SFML ストリーム。 指定モジュールが Node Worker 内で PCM を生成します。

SoundStreamCallbacks

Node Worker で実行する再生ストリームのコールバック。

SoundStreamChunk

samples は再利用可能なネイティブスロットを参照し、 コールバックの完了まで有効です。

SoundStreamOptions

カスタム PCM 再生ストリームの形式と Worker 設定。

TimeSpan

正確なマイクロ秒数で保存される変更可能な音声の時間範囲。

TimeSpanInput

音声の時間範囲の入力。

Network

ソケット、パケット、通信プロトコル。ネットワークに接続。

すべての API53
DatagramResult

単一の UDP データグラムの受信結果。

Dns
getPublicAddress

OpenDNS で指定アドレスファミリーの外向き公開アドレスを照会し、 失敗時は undefined を返します。

MxRecord

メール交換サーバーのレコード。

queryMx

メール交換レコードを照会します。既定のタイムアウトは 1 秒で、 照会失敗時は空配列を返します。

queryNs

ネームサーバーレコードを照会します。既定はシステム DNS と 1 秒の タイムアウトで、照会失敗時は空配列を返します。

querySrv

サービス検出レコード(例: _service._tcp.domain)を照会し、 失敗時は空配列を返します。

queryTxt

TXT レコードを照会します。各レコードは複数のテキスト断片を含み、 失敗時は空配列を返します。

resolve

IPv4/IPv6 アドレスを非同期に解決し、失敗時は undefined を返します。 servers が空ならシステムのリゾルバーを使い、timeout は適用しません。 DNS サーバーを指定した場合、既定のタイムアウトは 1 秒です。

SrvRecord

サービス検出レコード。

FileType

リモートファイルシステムのエントリー型。

Ftp

basic-ftp ベースの FTP クライアント。キューで操作を呼び出し順に実行します。

FtpDirectoryResponse

作業ディレクトリのパスを含む FTP レスポンス。

FtpListingResponse

ディレクトリエントリー名を含む FTP レスポンス。

FtpResponse

FTP 状態コードとサーバーメッセージ。

FtpStatus

FTP サーバーの応答コードとクライアントのエラーコード。

Http

リクエストごとに 1 接続を使う HTTP/HTTPS クライアント。 リダイレクトを自動追跡しません。

HttpMethod

HTTP リクエストメソッド。

HttpRequest

変更可能な HTTP/1 リクエスト。既定は GET /、HTTP/1.0、空の本文です。

HttpResponse

HTTP レスポンスの状態、ヘッダーフィールド、本文。

HttpStatus

HTTP レスポンス状態とクライアントエラー。値は SFML の定義を維持します。

IpAddress

IPv4 と IPv6 に対応する不変の IP アドレス値。

IpAddressType

IP アドレスファミリー。

Packet

整数はネットワーク順、SFML の浮動小数点数はホスト順を使用します。

PacketType

Packet.write/read が受け付ける符号化型名。

PacketValues

Packet の符号化型と対応する JS 値。複数バイト整数はネットワーク順です。

ReadinessType

ビット単位で組み合わせ可能なソケットの準備状態。

ReadyCallback

今回の wait で取得した準備状態のビットフラグを受け取ります。

Sftp

ssh2 ベースの非同期 SFTP クライアント。ファイル操作は呼び出し順に実行します。

SftpAttributes

リモートエントリーの属性。サーバーが提供しないフィールドは undefined です。

SftpAttributesResult

単一ファイルシステムエントリーの属性を含む結果。

SftpDownloadCallback

ダウンロードチャンクを処理し、false を返すと早期終了します。 空チャンクはファイル終端を示します。

SftpHostKeyType

SSH サーバーのホスト公開鍵の種類。

SftpListingResult

ディレクトリエントリーの属性一覧を含む結果。

SftpPathResult

リモートパスを含む操作結果。

SftpResult

SFTP 操作の状態とメッセージ。

SftpResultValue

SFTP 操作の結果コード。

SftpSessionInfo

アプリケーションによるホスト公開鍵とアルゴリズムの検証に使う SSH ハンドシェイクの交渉結果。

SftpTimeout

進捗がない場合のタイムアウト設定。データ受信または RPC 完了で タイマーをリセットします。期間がゼロならタイムアウトなしです。

SftpUploadCallback

アップロードチャンクを埋めて size を設定します。 false を返しても現在のチャンクを送信してから終了します。

SftpUploadChunk

アップロードコールバックが受け取る書き込み可能なデータチャンク。

Socket

Node ネットワークトランスポートの共通基底クラス。 既定では非同期待機によるブロッキング動作を使います。

SocketHandle

Node の TCP、UDP、またはリスナートランスポートオブジェクト。 OS の生のファイル記述子は受け付けません。

SocketSelector

ソケット群の準備完了を非同期に待ち、直近の wait の結果を保持します。

SocketSendResult

生の TCP バイトの送信結果。

SocketStatus

ソケット操作の結果。ブロッキングモードは Promise で待機し、 Node のイベントループをブロックしません。

SocketTransfer

生の TCP バイトの読み取り結果。

SocketType

sf::Socket::Type に対応するソケットのトランスポートプロトコル。

TcpListener

TCP 接続を待ち受け、accept で TcpSocket に渡します。

TcpSocket

生バイト、SFML Packet のフレーミング、TLS アップグレード対応の TCP ソケット。

TlsStatus

TLS アップグレードの現在の状態。

TransferMode

FTP のファイル転送モード。

UdpSocket

データグラム境界を保持する UDP ソケット。 Packet に TCP の長さヘッダーは付加しません。

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