用于 Node.js 的窗口、图形、音频与网络接口。按模块浏览,或直接搜索 API 名称。
时间、向量与数据流,为各模块提供基础能力。
返回同类型值相加的新对象;向量逐分量相加,Color 通道饱和到 255。
将 right 原地加到 left 并返回 left;不可修改只读常量。
sf::Angle 的 float32 值,按需创建原生所有权。
可暂停的单调秒表,不持有原生 SFML 句柄。
从度数创建角度,按 float32 精度存储。
返回除以标量的新对象;两个 Time 或两个 Angle 相除返回数值比率。
将左值原地除以标量并返回左值;除数为零时抛出 RangeError。
按值比较同类型操作数;浮点数精确比较,向量要求相同标量类型。
单例 Writable,其字节写入实际的 SFML 流。
可寻址的异步文件输入,直接读取到调用者的缓冲区。
判断左值是否大于右值;两者须具有相同可排序类型。
判断左值是否大于等于右值;两者须具有相同可排序类型。
可寻址的输入。每项操作均可同步或异步完成。
判断左值是否小于右值;支持 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。
每个检查周期调用一次;返回 true 继续等待,false 结束等待。
超时配置;使用此配置的操作负责等待和检查。
判断 UTF-16 索引 position 前是否为字素边界,使用 SFML 的 Unicode 规则。 起点和末尾均为边界;代理对中间不是边界,孤立代理码元按 U+FFFD 处理。
判断 UTF-16 索引 position 前是否为句子边界,使用 SFML 的 Unicode 规则。 起点和末尾均为边界;代理对中间不是边界,孤立代理码元按 U+FFFD 处理。
判断 UTF-16 索引 position 前是否为单词边界,使用 SFML 的 Unicode 规则。 起点和末尾均为边界;代理对中间不是边界,孤立代理码元按 U+FFFD 处理。
sf::Vector2
sf::Vector2
sf::Vector2
sf::Vector2
sf::Vector3
三个 float32 分量组成的向量。
三个有符号 32 位整数分量组成的向量。
三个无符号 32 位整数分量组成的向量。
运行时 SFML 版本,缓存为单个由原生存储支持的不可变值。
当前加载的 SFML 原生库版本。
窗口、输入与 OpenGL 上下文,连接应用与桌面环境。
带 OpenGL 上下文的操作系统窗口,可用于 Texture.update()。
SFML 的变体:kind 标识子类型,载荷字段保持完整。
视频模式:像素尺寸和每像素位数。
返回系统剪贴板文本;没有文本时返回空字符串。
用 text 替换系统剪贴板文本。
由原生端拥有的 OpenGL 上下文;激活状态仍按原生线程区分。
OpenGL 上下文属性位标志。
SFML 上下文请求;省略的成员使用 SFML 默认值。
系统光标或自定义 RGBA 像素光标。
系统光标形状,具体支持情况取决于平台。
SFML 的变体:kind 标识子类型,载荷字段保持完整。
带 kind 判别字段的事件数据联合类型。
按事件种类选择性提供的同步处理函数。
支持的窗口事件种类名称。
窗口事件种类及其附带数据;位置均为客户区像素坐标。
接收任意窗口事件数据的访问函数。
返回指定轴的位置,范围 -100~100。
返回指定手柄的按钮数量。
返回指定手柄的名称、厂商及产品标识。
返回手柄是否提供指定轴。
手柄设备识别信息。
查询指定手柄按钮的按下状态,编号从零开始。
返回指定手柄是否连接,编号从零开始。
手动刷新手柄状态;窗口事件处理也会执行刷新。
游戏手柄坐标轴。
支持的坐标轴数量上限
支持的按钮数量上限
支持的游戏手柄数量上限
按当前键盘布局将逻辑键码转换为物理扫描码。
返回物理按键的用户可读名称。
查询逻辑按键的实时按下状态,不依赖事件队列。
按当前键盘布局将物理扫描码转换为逻辑键码。
在支持的平台显示或隐藏屏幕键盘。
随系统键盘布局变化的逻辑按键。
键盘按键总数,不含 Key::Unknown
与键盘布局无关的物理按键。
扫描码总数,不含 Scan::Unknown
返回鼠标像素位置;提供窗口时相对于客户区,否则相对于桌面。
查询鼠标按钮的实时按下状态。
移动鼠标;提供窗口时使用客户区像素坐标,否则使用桌面像素坐标。
鼠标按钮。
鼠标按钮总数
鼠标滚轮方向。
当前 OpenGL 上下文的只读配置接口。
返回三轴测量值:加速度为 m/s²、角速度为度/秒、磁场为 µT、方向为度。
返回设备是否提供指定传感器。
启用或停用传感器的数据采集。
传感器类型总数
传感器类型。
窗口初始显示状态。
窗口样式位标志,可按位或组合。
返回触点像素位置;relativeTo 指定窗口客户区,否则相对于桌面。
返回指定触点是否仍按下。
视频模式:像素尺寸和每像素位数。
查询 Vulkan 函数地址,找不到时返回 undefined。 地址以 bigint 保留精度;调用它需要匹配函数签名的原生绑定。
返回创建图形实例所需的扩展名称副本;内容取决于 SFML 平台后端。
查询 SFML 后端是否支持 Vulkan;false 可仅检查计算能力。
带 OpenGL 上下文的操作系统窗口,可用于 Texture.update()。
无损表示平台窗口句柄和 Vulkan 指针。
窗口创建参数。
纹理、形状、文字与渲染,构建二维场景。
同时支持 Window 窗口操作和 RenderTarget 二维绘制的窗口。
支持后台图像解码和有序像素上传的 GPU 纹理。
具有共享 Transformable API 的 sf::Sprite。
源颜色按 Alpha 缩放后与目标相加,只读。
标准 Alpha 透明混合,只读。
源与目标颜色乘以各自因子后的组合方式。
混合方程中乘到源颜色或目标颜色上的因子。
逐分量取源与目标的较大值,只读。
逐分量取源与目标的较小值,只读。
sf::BlendMode。值会复制到每次录制的绘制中。
源与目标逐分量相乘,只读。
源直接覆盖目标,不做颜色混合,只读。
具有 Shape 外观和变换的 sf::CircleShape 几何。
圆形的初始几何参数。
文本整形时的字形簇分组方式。
RGBA 颜色,四个通道各占一个字节,取值为 0~255。 写入通道按 Uint8Array 规则转换;按需与 Native 共用同一块存储。
sf::ConvexShape;顶点必须按轮廓绕序组成凸多边形。
纹理坐标的单位。
sf::Drawable:重写 draw 以同步组合其他可绘制对象。
sf::Rect
由原生层拥有的字体、输入存储和保留的字形图集。
当前字体的标识和字体特性。
sf::Vector2
sf::Vector3
GLSL bvec4,四个布尔分量。
GLSL ivec4,四个有符号 32 位整数分量。
GLSL mat3,九个列主序 float32 分量。
GLSL mat4,十六个列主序 float32 分量。
GLSL vec4,四个 float32 分量。
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 纹理。
sf::Transform,从构造起使用其 64 字节列主序存储。
具有原生层拥有的暂存区和 JS 变换计算的 sf::Transformable。
sf::Vertex,在 20 字节中共享位置、RGBA 和纹理坐标。
通过每次分配期间稳定的视图公开的原生连续顶点。
Native 拥有的 GPU 存储;draw 录制句柄而不上传顶点。
使用字符串区分单参数的 Usage 和 PrimitiveType 构造函数。
值语义相机;修改和投影计算在 JS 侧完成。
播放、录音与空间音频,实时处理声音。
播放内存中的短音效,持有 SoundBuffer 以保留样本存储。
视图保留获取时对应的原生内存分配。
按块解码和播放长音频,无需一次将全部样本加载到内存。
传给音频回调工厂的实际处理参数。
模块导出是接收上下文和结构化克隆数据的工厂函数。
音频 Worker 模块和分块队列配置。
原生音频分块队列的累计统计。
按交错顺序排列的声道位置只读视图。
一个原生 sf::SoundSource::Cone,通过其浮点字段暴露。
空间声源或监听者的方向锥参数。
效果处理器实际消费和生成的帧数。
对原生浮点块进行缓冲式 DSP 处理,欠载时输出静音。
在 Node Worker 中执行的浮点 PCM 效果回调。
浮点 PCM 效果处理器的 Worker 和容量配置。
可寻址音频解码器,按调用顺序异步读取交错 16 位 PCM。
返回监听者方向锥参数副本。
返回监听者的朝向副本。
返回总音量百分比。
返回监听者的三维位置副本。
返回监听者上方方向的副本。
返回监听者的速度副本。
复制方向锥参数并更新原生监听者。
设置监听者的正前方方向。
设置所有声源的总音量百分比,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 套接字。
一次请求使用一条连接的 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 服务端响应码和客户端错误码。
一次请求使用一条连接的 HTTP/HTTPS 客户端,不自动跟随重定向。
HTTP 请求方法。
可修改的 HTTP/1 请求,默认 GET /、HTTP/1.0 和空请求体。
HTTP 响应状态、头字段和正文。
HTTP 响应状态及客户端错误;数值保持 SFML 定义。
不可变 IP 地址值,支持 IPv4 和 IPv6。
IP 地址族。
整数使用网络字节序;SFML 浮点数使用主机字节序。
Packet.write/read 接受的编码类型名称。
Packet 编码类型及对应 JS 值;多字节整数采用网络字节序。
套接字就绪条件,可按位组合。
接收本次 wait 得到的就绪位标志。
基于 ssh2 的异步 SFTP 客户端,文件操作按调用顺序执行。
远端条目属性;服务端未提供的字段为 undefined。
带单个文件系统条目属性的结果。
消费下载块,返回 false 提前结束;空块表示文件末尾。
SSH 服务端主机公钥类型。
带目录条目属性列表的结果。
带远端路径的操作结果。
SFTP 操作状态和消息。
SFTP 操作结果码。
SSH 握手协商结果,供应用核验主机公钥和算法。
无进展超时配置;收到数据或 RPC 完成时重置计时,零时长不设超时。
填充上传块并设置 size;返回 false 时仍发送当前块,然后结束。
上传回调接收的可填充数据块。
Node 网络传输的公共基类;默认使用异步等待的阻塞语义。
Node TCP、UDP 或监听传输对象,不接受操作系统裸文件描述符。
异步等待一组套接字就绪,并保存最近一次 wait 的结果。
原始 TCP 字节发送结果。
套接字操作结果;阻塞模式通过 Promise 等待,不阻塞 Node 事件循环。
原始 TCP 字节读取结果。
套接字使用的传输协议,对应 sf::Socket::Type。
监听 TCP 连接并通过 accept 将连接交给 TcpSocket。
支持原始字节、SFML Packet 分帧和 TLS 升级的 TCP 套接字。
TLS 升级的当前状态。
FTP 文件传输模式。
保留数据报边界的 UDP 套接字,Packet 不附加 TCP 长度头。
可暂停的单调秒表,不持有原生 SFML 句柄。