sfml.js 1.0.0-rc.1 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (334) hide show
  1. package/README.ja.md +177 -0
  2. package/README.ko.md +177 -0
  3. package/README.md +119 -14
  4. package/README.zh-CN.md +177 -0
  5. package/assets/branding/sfml-js-symbol-pentagon.svg +24 -0
  6. package/assets/branding/sfml-js-wordmark-dark.svg +20 -0
  7. package/assets/branding/sfml-js-wordmark.svg +19 -0
  8. package/assets/breakout.png +0 -0
  9. package/dist/audio/effect-processor.d.ts +53 -8
  10. package/dist/audio/effect-processor.js +35 -5
  11. package/dist/audio/input-sound-file.d.ts +101 -15
  12. package/dist/audio/input-sound-file.js +101 -15
  13. package/dist/audio/listener.d.ts +74 -12
  14. package/dist/audio/listener.js +74 -12
  15. package/dist/audio/music.d.ts +172 -22
  16. package/dist/audio/music.js +185 -24
  17. package/dist/audio/output-sound-file.d.ts +36 -4
  18. package/dist/audio/output-sound-file.js +36 -4
  19. package/dist/audio/playback-device.d.ts +103 -17
  20. package/dist/audio/playback-device.js +97 -16
  21. package/dist/audio/sound-buffer-recorder.d.ts +89 -9
  22. package/dist/audio/sound-buffer-recorder.js +89 -9
  23. package/dist/audio/sound-buffer.d.ts +121 -16
  24. package/dist/audio/sound-buffer.js +98 -13
  25. package/dist/audio/sound-file-factory.d.ts +84 -11
  26. package/dist/audio/sound-file-factory.js +84 -11
  27. package/dist/audio/sound-file-reader.d.ts +155 -24
  28. package/dist/audio/sound-file-reader.js +84 -13
  29. package/dist/audio/sound-file-writer.d.ts +49 -7
  30. package/dist/audio/sound-file-writer.js +13 -2
  31. package/dist/audio/sound-recorder.d.ts +143 -19
  32. package/dist/audio/sound-recorder.js +142 -18
  33. package/dist/audio/sound-source.d.ts +273 -45
  34. package/dist/audio/sound-source.js +273 -45
  35. package/dist/audio/sound-stream.d.ts +57 -9
  36. package/dist/audio/sound-stream.js +43 -7
  37. package/dist/audio/sound.d.ts +32 -5
  38. package/dist/audio/sound.js +32 -5
  39. package/dist/audio/value.d.ts +291 -48
  40. package/dist/audio/value.js +235 -39
  41. package/dist/audio/worker.d.ts +256 -38
  42. package/dist/graphics/blend-mode.d.ts +199 -33
  43. package/dist/graphics/blend-mode.js +163 -27
  44. package/dist/graphics/boolean-vector.d.ts +102 -16
  45. package/dist/graphics/boolean-vector.js +102 -16
  46. package/dist/graphics/circle-shape.d.ts +68 -11
  47. package/dist/graphics/circle-shape.js +37 -6
  48. package/dist/graphics/color.d.ts +227 -42
  49. package/dist/graphics/color.js +177 -32
  50. package/dist/graphics/convex-shape.d.ts +45 -7
  51. package/dist/graphics/convex-shape.js +31 -5
  52. package/dist/graphics/drawable.d.ts +15 -2
  53. package/dist/graphics/drawable.js +6 -1
  54. package/dist/graphics/font.d.ts +153 -24
  55. package/dist/graphics/font.js +116 -18
  56. package/dist/graphics/glsl-matrix.d.ts +44 -7
  57. package/dist/graphics/glsl-matrix.js +44 -7
  58. package/dist/graphics/glsl.d.ts +129 -21
  59. package/dist/graphics/glsl.js +123 -20
  60. package/dist/graphics/glyph.d.ts +106 -17
  61. package/dist/graphics/glyph.js +76 -12
  62. package/dist/graphics/image.d.ts +159 -24
  63. package/dist/graphics/image.js +122 -18
  64. package/dist/graphics/primitive-type.d.ts +42 -7
  65. package/dist/graphics/primitive-type.js +42 -7
  66. package/dist/graphics/rect.d.ts +162 -26
  67. package/dist/graphics/rect.js +101 -16
  68. package/dist/graphics/rectangle-shape.d.ts +44 -7
  69. package/dist/graphics/rectangle-shape.js +31 -5
  70. package/dist/graphics/render-states.d.ts +153 -25
  71. package/dist/graphics/render-states.js +49 -8
  72. package/dist/graphics/render-target.d.ts +145 -22
  73. package/dist/graphics/render-target.js +110 -17
  74. package/dist/graphics/render-texture.d.ts +100 -16
  75. package/dist/graphics/render-texture.js +80 -13
  76. package/dist/graphics/render-window.d.ts +106 -17
  77. package/dist/graphics/render-window.js +57 -9
  78. package/dist/graphics/shader.d.ts +153 -24
  79. package/dist/graphics/shader.js +126 -20
  80. package/dist/graphics/shape.d.ts +133 -21
  81. package/dist/graphics/shape.js +115 -18
  82. package/dist/graphics/sprite.d.ts +71 -11
  83. package/dist/graphics/sprite.js +57 -9
  84. package/dist/graphics/stencil-mode.d.ts +193 -32
  85. package/dist/graphics/stencil-mode.js +121 -20
  86. package/dist/graphics/swap.d.ts +13 -2
  87. package/dist/graphics/text.d.ts +624 -103
  88. package/dist/graphics/text.js +443 -73
  89. package/dist/graphics/texture.d.ts +209 -32
  90. package/dist/graphics/texture.js +137 -21
  91. package/dist/graphics/transform.d.ts +93 -14
  92. package/dist/graphics/transform.js +93 -14
  93. package/dist/graphics/transformable.d.ts +13 -2
  94. package/dist/graphics/transformable.js +13 -2
  95. package/dist/graphics/vertex-array.d.ts +83 -14
  96. package/dist/graphics/vertex-array.js +70 -12
  97. package/dist/graphics/vertex-buffer.d.ts +162 -26
  98. package/dist/graphics/vertex-buffer.js +106 -17
  99. package/dist/graphics/vertex.d.ts +83 -14
  100. package/dist/graphics/vertex.js +43 -7
  101. package/dist/graphics/view.d.ts +140 -22
  102. package/dist/graphics/view.js +103 -16
  103. package/dist/internal/glsl-value.d.ts +30 -5
  104. package/dist/internal/glsl-value.js +30 -5
  105. package/dist/internal/scalar.d.ts +9 -1
  106. package/dist/internal/transformable.d.ts +84 -13
  107. package/dist/internal/value-storage.d.ts +8 -1
  108. package/dist/network/common.d.ts +6 -1
  109. package/dist/network/common.js +6 -1
  110. package/dist/network/dns.d.ts +103 -14
  111. package/dist/network/dns.js +55 -6
  112. package/dist/network/ftp.d.ts +217 -33
  113. package/dist/network/ftp.js +217 -33
  114. package/dist/network/gen/constants.d.ts +750 -124
  115. package/dist/network/gen/constants.js +750 -124
  116. package/dist/network/http.d.ts +365 -57
  117. package/dist/network/http.js +365 -57
  118. package/dist/network/ip-address.d.ts +179 -26
  119. package/dist/network/ip-address.js +164 -24
  120. package/dist/network/packet.d.ts +200 -29
  121. package/dist/network/packet.js +101 -13
  122. package/dist/network/sftp.d.ts +525 -84
  123. package/dist/network/sftp.js +322 -53
  124. package/dist/network/socket-selector.d.ts +109 -15
  125. package/dist/network/socket-selector.js +103 -14
  126. package/dist/network/socket.d.ts +245 -33
  127. package/dist/network/socket.js +205 -28
  128. package/dist/network/tcp-listener.d.ts +91 -13
  129. package/dist/network/tcp-listener.js +85 -12
  130. package/dist/network/tcp-socket.d.ts +232 -33
  131. package/dist/network/tcp-socket.js +153 -22
  132. package/dist/network/tls-material.d.ts +18 -2
  133. package/dist/network/tls-material.js +18 -2
  134. package/dist/network/udp-socket.d.ts +137 -19
  135. package/dist/network/udp-socket.js +101 -13
  136. package/dist/system/angle.d.ts +60 -10
  137. package/dist/system/angle.js +60 -10
  138. package/dist/system/clock.d.ts +51 -8
  139. package/dist/system/clock.js +51 -8
  140. package/dist/system/err.d.ts +14 -2
  141. package/dist/system/err.js +14 -2
  142. package/dist/system/error.d.ts +12 -2
  143. package/dist/system/error.js +12 -2
  144. package/dist/system/file-input-stream.d.ts +54 -7
  145. package/dist/system/file-input-stream.js +54 -7
  146. package/dist/system/input-stream.d.ts +97 -13
  147. package/dist/system/input-stream.js +60 -8
  148. package/dist/system/operators.d.ts +146 -19
  149. package/dist/system/operators.js +118 -15
  150. package/dist/system/sleep.d.ts +6 -1
  151. package/dist/system/sleep.js +6 -1
  152. package/dist/system/suspend-aware-clock.d.ts +18 -3
  153. package/dist/system/suspend-aware-clock.js +18 -3
  154. package/dist/system/time.d.ts +81 -12
  155. package/dist/system/time.js +63 -9
  156. package/dist/system/timeout-with-predicate.d.ts +48 -7
  157. package/dist/system/timeout-with-predicate.js +20 -3
  158. package/dist/system/unicode.d.ts +42 -6
  159. package/dist/system/unicode.js +42 -6
  160. package/dist/system/vector2.d.ts +240 -36
  161. package/dist/system/vector2.js +105 -16
  162. package/dist/system/vector3.d.ts +197 -31
  163. package/dist/system/vector3.js +104 -16
  164. package/dist/system/version.d.ts +43 -7
  165. package/dist/system/version.js +7 -1
  166. package/dist/window/clipboard.d.ts +12 -2
  167. package/dist/window/clipboard.js +12 -2
  168. package/dist/window/context-settings.d.ts +78 -13
  169. package/dist/window/context-settings.js +30 -5
  170. package/dist/window/context.d.ts +70 -10
  171. package/dist/window/context.js +52 -7
  172. package/dist/window/cursor.d.ts +44 -6
  173. package/dist/window/cursor.js +28 -4
  174. package/dist/window/event.d.ts +423 -70
  175. package/dist/window/event.js +36 -6
  176. package/dist/window/gen/constants.d.ts +1890 -314
  177. package/dist/window/gen/constants.js +1890 -314
  178. package/dist/window/joystick.d.ts +67 -11
  179. package/dist/window/joystick.js +43 -7
  180. package/dist/window/keyboard.d.ts +42 -6
  181. package/dist/window/keyboard.js +26 -4
  182. package/dist/window/mouse.d.ts +24 -3
  183. package/dist/window/mouse.js +24 -3
  184. package/dist/window/sensor.d.ts +20 -3
  185. package/dist/window/sensor.js +20 -3
  186. package/dist/window/touch.d.ts +19 -4
  187. package/dist/window/touch.js +19 -4
  188. package/dist/window/video-mode.d.ts +61 -10
  189. package/dist/window/video-mode.js +36 -6
  190. package/dist/window/vulkan.d.ts +26 -3
  191. package/dist/window/vulkan.js +26 -3
  192. package/dist/window/window.d.ts +296 -44
  193. package/dist/window/window.js +241 -34
  194. package/docs/README.ja.md +30 -0
  195. package/docs/README.ko.md +30 -0
  196. package/docs/README.md +30 -0
  197. package/docs/README.zh-CN.md +30 -0
  198. package/docs/api.ja.md +84 -0
  199. package/docs/api.ko.md +84 -0
  200. package/docs/api.md +48 -1080
  201. package/docs/api.zh-CN.md +81 -0
  202. package/docs/audio.ja.md +249 -0
  203. package/docs/audio.ko.md +251 -0
  204. package/docs/audio.md +132 -92
  205. package/docs/audio.zh-CN.md +252 -0
  206. package/docs/concepts.ja.md +130 -0
  207. package/docs/concepts.ko.md +130 -0
  208. package/docs/concepts.md +131 -0
  209. package/docs/concepts.zh-CN.md +131 -0
  210. package/docs/development.ja.md +144 -0
  211. package/docs/development.ko.md +144 -0
  212. package/docs/development.md +112 -43
  213. package/docs/development.zh-CN.md +146 -0
  214. package/docs/getting-started.ja.md +154 -0
  215. package/docs/getting-started.ko.md +154 -0
  216. package/docs/getting-started.md +156 -0
  217. package/docs/getting-started.zh-CN.md +156 -0
  218. package/docs/graphics.ja.md +256 -0
  219. package/docs/graphics.ko.md +254 -0
  220. package/docs/graphics.md +255 -0
  221. package/docs/graphics.zh-CN.md +257 -0
  222. package/docs/network.ja.md +214 -0
  223. package/docs/network.ko.md +216 -0
  224. package/docs/network.md +133 -84
  225. package/docs/network.zh-CN.md +218 -0
  226. package/docs/system.ja.md +169 -0
  227. package/docs/system.ko.md +171 -0
  228. package/docs/system.md +173 -0
  229. package/docs/system.zh-CN.md +173 -0
  230. package/docs/window.ja.md +138 -0
  231. package/docs/window.ko.md +140 -0
  232. package/docs/window.md +141 -0
  233. package/docs/window.zh-CN.md +141 -0
  234. package/native/shared-handle.h +41 -3
  235. package/package.json +17 -6
  236. package/src/audio/effect-processor.ts +53 -8
  237. package/src/audio/input-sound-file.ts +101 -15
  238. package/src/audio/listener.ts +74 -12
  239. package/src/audio/music.ts +191 -25
  240. package/src/audio/output-sound-file.ts +36 -4
  241. package/src/audio/playback-device.ts +103 -17
  242. package/src/audio/sound-buffer-recorder.ts +89 -9
  243. package/src/audio/sound-buffer.ts +121 -16
  244. package/src/audio/sound-file-factory.ts +84 -11
  245. package/src/audio/sound-file-reader.ts +155 -24
  246. package/src/audio/sound-file-writer.ts +49 -7
  247. package/src/audio/sound-recorder.ts +155 -20
  248. package/src/audio/sound-source.ts +273 -45
  249. package/src/audio/sound-stream.ts +57 -9
  250. package/src/audio/sound.ts +32 -5
  251. package/src/audio/value.ts +291 -48
  252. package/src/audio/worker.ts +256 -38
  253. package/src/graphics/blend-mode.ts +199 -33
  254. package/src/graphics/boolean-vector.ts +102 -16
  255. package/src/graphics/circle-shape.ts +68 -11
  256. package/src/graphics/color.ts +227 -42
  257. package/src/graphics/convex-shape.ts +45 -7
  258. package/src/graphics/drawable.ts +15 -2
  259. package/src/graphics/font.ts +153 -24
  260. package/src/graphics/glsl-matrix.ts +44 -7
  261. package/src/graphics/glsl.ts +129 -21
  262. package/src/graphics/glyph.ts +106 -17
  263. package/src/graphics/image.ts +159 -24
  264. package/src/graphics/primitive-type.ts +42 -7
  265. package/src/graphics/rect.ts +162 -26
  266. package/src/graphics/rectangle-shape.ts +44 -7
  267. package/src/graphics/render-states.ts +153 -25
  268. package/src/graphics/render-target.ts +145 -22
  269. package/src/graphics/render-texture.ts +100 -16
  270. package/src/graphics/render-window.ts +113 -18
  271. package/src/graphics/shader.ts +153 -24
  272. package/src/graphics/shape.ts +133 -21
  273. package/src/graphics/sprite.ts +71 -11
  274. package/src/graphics/stencil-mode.ts +193 -32
  275. package/src/graphics/swap.ts +13 -2
  276. package/src/graphics/text.ts +624 -103
  277. package/src/graphics/texture.ts +209 -32
  278. package/src/graphics/transform.ts +93 -14
  279. package/src/graphics/transformable.ts +13 -2
  280. package/src/graphics/vertex-array.ts +83 -14
  281. package/src/graphics/vertex-buffer.ts +162 -26
  282. package/src/graphics/vertex.ts +83 -14
  283. package/src/graphics/view.ts +140 -22
  284. package/src/internal/glsl-value.ts +30 -5
  285. package/src/internal/scalar.ts +9 -1
  286. package/src/internal/transformable.ts +84 -13
  287. package/src/internal/value-storage.ts +8 -1
  288. package/src/network/common.ts +6 -1
  289. package/src/network/dns.ts +103 -14
  290. package/src/network/ftp.ts +217 -33
  291. package/src/network/gen/constants.ts +750 -124
  292. package/src/network/http.ts +365 -57
  293. package/src/network/ip-address.ts +179 -26
  294. package/src/network/packet.ts +200 -29
  295. package/src/network/sftp.ts +525 -84
  296. package/src/network/socket-selector.ts +109 -15
  297. package/src/network/socket.ts +245 -33
  298. package/src/network/tcp-listener.ts +91 -13
  299. package/src/network/tcp-socket.ts +232 -33
  300. package/src/network/tls-material.ts +18 -2
  301. package/src/network/udp-socket.ts +137 -19
  302. package/src/system/angle.ts +60 -10
  303. package/src/system/clock.ts +51 -8
  304. package/src/system/err.ts +14 -2
  305. package/src/system/error.ts +12 -2
  306. package/src/system/file-input-stream.ts +54 -7
  307. package/src/system/input-stream.ts +97 -13
  308. package/src/system/operators.ts +146 -19
  309. package/src/system/sleep.ts +6 -1
  310. package/src/system/suspend-aware-clock.ts +18 -3
  311. package/src/system/time.ts +81 -12
  312. package/src/system/timeout-with-predicate.ts +48 -7
  313. package/src/system/unicode.ts +42 -6
  314. package/src/system/vector2.ts +240 -36
  315. package/src/system/vector3.ts +197 -31
  316. package/src/system/version.ts +43 -7
  317. package/src/window/clipboard.ts +12 -2
  318. package/src/window/context-settings.ts +78 -13
  319. package/src/window/context.ts +70 -10
  320. package/src/window/cursor.ts +44 -6
  321. package/src/window/event.ts +423 -70
  322. package/src/window/gen/constants.ts +1890 -314
  323. package/src/window/joystick.ts +67 -11
  324. package/src/window/keyboard.ts +42 -6
  325. package/src/window/mouse.ts +24 -3
  326. package/src/window/sensor.ts +20 -3
  327. package/src/window/touch.ts +19 -4
  328. package/src/window/video-mode.ts +61 -10
  329. package/src/window/vulkan.ts +26 -3
  330. package/src/window/window.ts +314 -46
  331. package/tools/constant-docs.cjs +109 -0
  332. package/tools/constant-docs.json +1318 -0
  333. package/tools/generate-network-constants.cjs +21 -9
  334. package/tools/generate-window-constants.cjs +26 -12
@@ -0,0 +1,177 @@
1
+ <p align="center">
2
+ <img src="./assets/branding/sfml-js-symbol-pentagon.svg" width="80" height="80" align="middle" alt="" />
3
+ <picture>
4
+ <source media="(prefers-color-scheme: dark)" srcset="./assets/branding/sfml-js-wordmark-dark.svg" />
5
+ <img src="./assets/branding/sfml-js-wordmark.svg" width="246" height="68" align="middle" alt="sfml.js" />
6
+ </picture>
7
+ </p>
8
+
9
+ <p align="center">
10
+ 基于 <a href="https://www.sfml-dev.org/documentation/3.1.0/">SFML 3.1.0</a>,为 Node.js 提供原生窗口、二维图形与音频。
11
+ </p>
12
+
13
+ <p align="center">
14
+ <a href="https://www.npmjs.org/package/sfml.js">
15
+ <img src="https://img.shields.io/npm/v/sfml.js.svg?style=for-the-badge&colorA=FF7800&colorB=CC5600&label=NPM" alt="npm version" />
16
+ </a>
17
+ <a href="https://www.npmjs.org/package/sfml.js">
18
+ <img src="https://img.shields.io/npm/dm/sfml.js.svg?style=for-the-badge&colorA=5DDB61&colorB=4BC74F&label=DOWNLOADS" alt="npm downloads" />
19
+ </a>
20
+ <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
21
+ <a href="#contributors-"><img src="https://img.shields.io/badge/3-ALL%20CONTRIBUTORS?style=for-the-badge&colorA=FF69b4&colorB=cc47a4&label=ALL%20CONTRIBUTORS" alt="3 contributors" /></a>
22
+ <!-- ALL-CONTRIBUTORS-BADGE:END -->
23
+ <a href="https://github.com/XadillaX/node-sfml">
24
+ <img src="https://img.shields.io/github/stars/XadillaX/node-sfml.svg?style=for-the-badge&colorA=FBBD30&colorB=F2AA08&label=STAR" alt="GitHub stars" />
25
+ </a>
26
+ </p>
27
+
28
+ [English](README.md) · **简体中文** · [日本語](README.ja.md) · [한국어](README.ko.md)
29
+
30
+ 使用 JavaScript 或 TypeScript 构建桌面多媒体应用:绘制精灵、形状和文字,处理窗口事件,播放与录制音频,并通过 SFML 风格的网络 API 交换数据。
31
+
32
+ [官网](https://sfml.js.org/zh/) · [快速开始](docs/getting-started.zh-CN.md) · [指南](docs/README.zh-CN.md) · [类型参考](https://sfml.js.org/zh/reference/) · [示例](examples/README.zh-CN.md)
33
+
34
+ ## 功能
35
+
36
+ | 模块 | 能力 |
37
+ | --- | --- |
38
+ | System | 类型化向量、角度、时间、时钟、Unicode 边界和可寻址输入流 |
39
+ | Window | 原生窗口、类型化事件、键盘、鼠标、摇杆、剪贴板和 OpenGL 上下文 |
40
+ | Graphics | 精灵、形状、Unicode 文字、相机、着色器、顶点缓冲和离屏渲染 |
41
+ | Audio | 音效、流式音乐、录音、空间音频和 Worker 处理 |
42
+ | Network | 基于 Node.js 传输的 TCP、UDP、Packet、DNS、TLS、HTTP、FTP 和 SFTP |
43
+
44
+ 软件包包含 TypeScript 类型声明。数值和资源视图使用类型化数组;绘制记录状态快照并批量提交命令。所有权、异步加载与绘制行为见 [核心概念](docs/concepts.zh-CN.md)。
45
+
46
+ ## 安装
47
+
48
+ ```bash
49
+ npm install sfml.js
50
+ ```
51
+
52
+ 安装时编译原生扩展并下载匹配的 SFML 库。请先准备 **Python 和 C++20 工具链**:
53
+
54
+ | 平台 | 下载目标 | 构建工具 |
55
+ | --- | --- | --- |
56
+ | macOS 13+ | x64、arm64 | Xcode Command Line Tools |
57
+ | Linux | x64 | GCC 或 Clang、make、X11、OpenGL 和音频开发库 |
58
+ | Windows | x64、ia32 | Visual Studio 2022 C++ Build Tools |
59
+
60
+ 软件包声明的 Node.js 范围为 `^18.19.0 || >=20.5.0`;CI 配置覆盖 Linux、macOS 和 Windows 上的 Node.js 20、22。支持下载不代表每种架构与设备都经过测试。各平台命令见 [安装说明](docs/getting-started.zh-CN.md#requirements)。
61
+
62
+ ## 第一个窗口
63
+
64
+ 保存为 `hello.cjs`,执行 `node hello.cjs`:
65
+
66
+ ```javascript
67
+ const sf = require('sfml.js');
68
+
69
+ const window = new sf.RenderWindow(
70
+ new sf.VideoMode(new sf.Vector2u(800, 600)),
71
+ 'Hello, sfml.js',
72
+ );
73
+ const circle = new sf.CircleShape({ radius: 80 });
74
+ circle.setPosition(new sf.Vector2f(320, 220));
75
+ circle.setFillColor(new sf.Color(76, 190, 110));
76
+ window.setFramerateLimit(60);
77
+
78
+ function frame() {
79
+ window.handleEvents({
80
+ Closed: () => window.close(),
81
+ KeyPressed: event => {
82
+ if (event.code === sf.Keyboard.Key.Escape) window.close();
83
+ },
84
+ });
85
+ if (!window.isOpen()) return;
86
+
87
+ window.clear(new sf.Color(24, 28, 32));
88
+ window.draw(circle);
89
+ window.display();
90
+ setImmediate(frame);
91
+ }
92
+
93
+ frame();
94
+ ```
95
+
96
+ 示例创建原生桌面窗口,需要在图形会话中运行。`setImmediate()` 让 Node.js 在帧间处理 I/O;`display()` 是同步操作,可能等待帧率限制或垂直同步。
97
+
98
+ TypeScript 使用具名导入,例如 `import { RenderWindow, Vector2u } from 'sfml.js'`。文件加载使用 Promise:
99
+
100
+ ```javascript
101
+ async function loadSprite(filename) {
102
+ const texture = new sf.Texture();
103
+ if (!await texture.loadFromFile(filename)) {
104
+ throw new Error(`Cannot load texture: ${filename}`);
105
+ }
106
+ return new sf.Sprite(texture);
107
+ }
108
+ ```
109
+
110
+ ## 文档
111
+
112
+ README 和指南提供英文、简体中文、日文与韩文版本,默认语言为英文。
113
+
114
+ | 入口 | 内容 |
115
+ | --- | --- |
116
+ | [快速开始](docs/getting-started.zh-CN.md) | 安装、导入和第一个窗口 |
117
+ | [核心概念](docs/concepts.zh-CN.md) | 值、资源生命周期、Promise 和绘制快照 |
118
+ | [API 指南](docs/api.zh-CN.md) | System、Window、Graphics、Audio 和 Network 导航 |
119
+ | [示例](examples/README.zh-CN.md) | 可运行程序及操作说明 |
120
+ | [开发指南](docs/development.zh-CN.md) | 构建、测试与贡献 |
121
+
122
+ [TypeDoc](https://sfml.js.org/zh/reference/) 提供自动生成的方法签名与源码注释。[SFML 官方 C++ 文档](https://www.sfml-dev.org/documentation/3.1.0/) 解释上游 API;本项目指南说明 JavaScript 的适配行为。
123
+
124
+ ## 运行示例
125
+
126
+ ![在 sfml.js 原生窗口中运行的打砖块游戏](assets/breakout.png)
127
+
128
+ 画面采集自 [breakout.cjs](examples/breakout.cjs)。游戏用 JavaScript 处理图形、键盘输入与游戏循环。方向键左/右或 A/D 移动挡板,Space 发球,Esc 退出。
129
+
130
+ ```bash
131
+ git clone https://github.com/XadillaX/node-sfml.git
132
+ cd node-sfml
133
+ npm ci
134
+ node examples/breakout.cjs
135
+ node examples/all-types.cjs --frames=120
136
+ node examples/network.cjs
137
+ ```
138
+
139
+ [功能示例](examples/features/README.zh-CN.md) · [官方示例](examples/official/README.zh-CN.md) · [游戏与应用](examples/projects/README.zh-CN.md)
140
+
141
+ [node-sfml-demos](https://github.com/XadillaX/node-sfml-demos) 包含使用 sfml.js 实现的 Bomberman、Breakout、Tetris、Doodle Jump 和 Arkanoid。安装与启动命令见 [游戏项目](examples/projects/README.zh-CN.md#node-sfml-demos)。
142
+
143
+ [16-sfml.js-games-ported](https://github.com/XadillaX/16-sfml.js-games-ported) 将 [jsyqrt/games](https://github.com/jsyqrt/games) 中原本使用 C++ 和 SFML 编写的全部 16 个游戏迁移为 ClojureScript + sfml.js。游戏清单与 nbb 启动命令见 [16 个游戏](examples/projects/README.zh-CN.md#16-games)。
144
+
145
+ [play-nes](examples/projects/README.zh-CN.md#play-nes) — 基于 sfml.js 和 JSNES 的桌面 NES 模拟器。
146
+
147
+ ## 参与贡献
148
+
149
+ 请按 [开发指南](docs/development.zh-CN.md) 准备环境。欢迎提交修复、文档与示例的 PR。反馈问题时,请提供可运行的复现程序,以及 Node.js 版本、操作系统和架构。
150
+
151
+ <a id="contributors-"></a>
152
+ <a id="maintenance-XadillaX"></a>
153
+
154
+ ## 贡献者 ✨
155
+
156
+ 感谢以下贡献者([表情含义](https://allcontributors.org/docs/en/emoji-key)):
157
+
158
+ <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
159
+ <!-- prettier-ignore-start -->
160
+ <!-- markdownlint-disable -->
161
+ <table>
162
+ <tr>
163
+ <td align="center"><a href="https://xcoder.in/"><img src="https://avatars.githubusercontent.com/u/2842176?v=4&amp;s=100" width="100px;" alt="Khaidi Chu"/><br /><sub><b>Khaidi Chu</b></sub></a><br /><a href="#maintenance-XadillaX" title="Maintenance">🚧</a> <a href="https://github.com/XadillaX/node-sfml/commits?author=XadillaX" title="Code">💻</a></td>
164
+ <td align="center"><a href="https://pokemonworkshop.com/forum"><img src="https://avatars.githubusercontent.com/u/7335788?v=4&amp;s=100" width="100px;" alt="NuriYuri"/><br /><sub><b>NuriYuri</b></sub></a><br /><a href="https://github.com/XadillaX/node-sfml/commits?author=NuriYuri" title="Code">💻</a></td>
165
+ <td align="center"><a href="https://godot.id"><img src="https://avatars.githubusercontent.com/u/40712686?v=4&amp;s=100" width="100px;" alt="Hanz"/><br /><sub><b>Hanz</b></sub></a><br /><a href="https://github.com/XadillaX/node-sfml/commits?author=HanzCEO" title="Code">💻</a></td>
166
+ </tr>
167
+ </table>
168
+
169
+ <!-- markdownlint-restore -->
170
+ <!-- prettier-ignore-end -->
171
+ <!-- ALL-CONTRIBUTORS-LIST:END -->
172
+
173
+ 本项目遵循 [all-contributors](https://github.com/all-contributors/all-contributors) 规范,欢迎各种形式的贡献。
174
+
175
+ ## 许可证
176
+
177
+ [MIT](LICENSE)。
@@ -0,0 +1,24 @@
1
+ <?xml version='1.0' encoding='utf-8'?>
2
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="-22 .5 480 480" role="img" aria-labelledby="title description" width="480" height="480">
3
+ <title id="title">SFML.js</title>
4
+ <desc id="description">Square SFML.js symbol with a six-sided core and pentagonal outer pieces.</desc>
5
+ <defs>
6
+ <linearGradient id="node-green" gradientUnits="userSpaceOnUse" x1="268.98" y1="60.68" x2="140.4" y2="293.2">
7
+ <stop stop-color="#85de18" />
8
+ <stop offset="1" stop-color="#73d519" />
9
+ </linearGradient>
10
+ <linearGradient id="left-wing-green" gradientUnits="userSpaceOnUse" x1="234.66" y1="409.29" x2="20.12" y2="368.62">
11
+ <stop stop-color="#1a9f32" />
12
+ <stop offset="1" stop-color="#16982a" />
13
+ </linearGradient>
14
+ <linearGradient id="right-wing-green" gradientUnits="userSpaceOnUse" x1="396.95" y1="385.28" x2="215.38" y2="389.89">
15
+ <stop stop-color="#87e31d" />
16
+ <stop offset="1" stop-color="#60c71e" />
17
+ </linearGradient>
18
+ </defs>
19
+ <g id="symbol">
20
+ <path id="node" fill="url(#node-green)" d="M 219.5 30.5 L 212.5 31.5 L 168.5 56.5 L 134.5 78.5 L 117.5 86.5 L 112.5 92.5 L 112.5 214.5 L 120.5 221.5 L 172.5 250.5 L 189.5 262.5 L 216.5 339.5 L 238.5 264.5 L 318.5 215.5 L 317.5 87.5 Z" />
21
+ <path id="left-wing" fill="url(#left-wing-green)" d="M68 206 L154 297 L217 410.5 L218 450.5 L88 450.5 L8 252Z" />
22
+ <path id="right-wing" fill="url(#right-wing-green)" d="M369 206 L275 297 L217 410.5 L218 450.5 L348 450.5 L428 252Z" />
23
+ </g>
24
+ </svg>
@@ -0,0 +1,20 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <svg xmlns="http://www.w3.org/2000/svg" width="492" height="136" viewBox="-8 0 492 136" role="img" aria-labelledby="title description">
3
+ <title id="title">SFML.js</title>
4
+ <desc id="description">Custom SFML.js lettering with angled terminals, a V-shaped M and a six-sided separator.</desc>
5
+ <style>.wordmark-primary{fill:#f5f8f1}.wordmark-accent{fill:#a5d936}</style>
6
+ <g id="wordmark">
7
+ <g class="wordmark-primary" fill="#15392f">
8
+ <path d="M12 12H66V20L58 28H22L18 31V47L22 50H52L66 60V97L52 108H0V100L8 92H44L48 89V73L44 68H14L0 58V23Z"/>
9
+ <path d="M94 12H144V28H100V50H137V68H100V108H82V21Z"/>
10
+ <path d="M160 108V12H178L202 46L226 12H244V108H226V44L202 76L178 44V108Z"/>
11
+ <path d="M260 12H278V90H322V98L310 108H260Z"/>
12
+ </g>
13
+ <g class="wordmark-accent" fill="#347c35">
14
+ <path d="M343 92L351 96V104L343 108L335 104V96Z"/>
15
+ <path d="M382 42H400V110L384 124H360V106H374L382 98Z"/>
16
+ <path d="M382 12H400V30H382Z"/>
17
+ <path d="M430 42H476V57H437L433 60V65L437 68H462L476 78V97L462 108H418V93H454L458 90V85L454 82H432L418 72V53Z"/>
18
+ </g>
19
+ </g>
20
+ </svg>
@@ -0,0 +1,19 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <svg xmlns="http://www.w3.org/2000/svg" width="492" height="136" viewBox="-8 0 492 136" role="img" aria-labelledby="title description">
3
+ <title id="title">SFML.js</title>
4
+ <desc id="description">Custom SFML.js lettering with angled terminals, a V-shaped M and a six-sided separator.</desc>
5
+ <g id="wordmark">
6
+ <g class="wordmark-primary" fill="#15392f">
7
+ <path d="M12 12H66V20L58 28H22L18 31V47L22 50H52L66 60V97L52 108H0V100L8 92H44L48 89V73L44 68H14L0 58V23Z"/>
8
+ <path d="M94 12H144V28H100V50H137V68H100V108H82V21Z"/>
9
+ <path d="M160 108V12H178L202 46L226 12H244V108H226V44L202 76L178 44V108Z"/>
10
+ <path d="M260 12H278V90H322V98L310 108H260Z"/>
11
+ </g>
12
+ <g class="wordmark-accent" fill="#347c35">
13
+ <path d="M343 92L351 96V104L343 108L335 104V96Z"/>
14
+ <path d="M382 42H400V110L384 124H360V106H374L382 98Z"/>
15
+ <path d="M382 12H400V30H382Z"/>
16
+ <path d="M430 42H476V57H437L433 60V65L437 68H462L476 78V97L462 108H418V93H454L458 90V85L454 82H432L418 72V53Z"/>
17
+ </g>
18
+ </g>
19
+ </svg>
Binary file
@@ -1,22 +1,67 @@
1
1
  import { audioHandle, type AudioHandle } from '../internal/audio-native';
2
2
  import type { AudioWorkerOptions, AudioWorkerStats } from './worker';
3
- /** 浮点 PCM 效果处理器的 Worker 和容量配置。 */
3
+ /**
4
+ * Worker and capacity configuration for a floating-point PCM effect processor.
5
+ * @zh 浮点 PCM 效果处理器的 Worker 和容量配置。
6
+ * @ja 浮動小数点 PCM エフェクトプロセッサーの Worker と容量の設定。
7
+ * @ko 부동 소수점 PCM 효과 처리기의 Worker 및 용량 설정입니다.
8
+ */
4
9
  export interface EffectProcessorOptions extends AudioWorkerOptions {
5
- /** Maximum engine output channels; input is already spatialized. */
10
+ /**
11
+ * Maximum engine output channels; input is already spatialized.
12
+ * @zh 引擎输出声道数上限;输入已完成空间音效处理。
13
+ * @ja エンジンの最大出力チャンネル数。入力は空間音響処理済みです。
14
+ * @ko 엔진의 최대 출력 채널 수이며, 입력은 이미 공간 음향 처리가 되어 있습니다.
15
+ */
6
16
  maxChannelCount?: number;
7
17
  }
8
- /** Buffered DSP on native float blocks. Underflow produces silence. */
18
+ /**
19
+ * Buffered DSP on native float blocks. Underflow produces silence.
20
+ * @zh 对原生浮点块进行缓冲式 DSP 处理,欠载时输出静音。
21
+ * @ja ネイティブ浮動小数点ブロックに対するバッファー付き DSP。
22
+ * アンダーフロー時は無音を出力します。
23
+ * @ko 네이티브 부동 소수점 블록을 버퍼링하여 DSP 처리합니다.
24
+ * 언더플로 시 무음을 출력합니다.
25
+ */
9
26
  export declare class EffectProcessor {
10
27
  readonly [audioHandle]: AudioHandle<'worker'>;
11
- /** Worker 效果工厂初始化结果。 */
28
+ /**
29
+ * Initialization result of the Worker effect factory.
30
+ * @zh Worker 效果工厂初始化结果。
31
+ * @ja Worker エフェクトファクトリーの初期化結果。
32
+ * @ko Worker 효과 팩토리의 초기화 결과입니다.
33
+ */
12
34
  readonly ready: Promise<boolean>;
13
35
  private readonly session;
14
- /** 创建 Worker 效果处理器,默认每块 1024 帧、8 块队列和最多 8 个声道。 */
36
+ /**
37
+ * Create a Worker effect processor, defaulting to 1024 frames per block,
38
+ * an 8-block queue, and at most 8 channels.
39
+ * @zh 创建 Worker 效果处理器,默认每块 1024 帧、8 块队列和最多 8 个声道。
40
+ * @ja Worker エフェクトプロセッサーを作成します。既定値はブロックあたり
41
+ * 1024 フレーム、8 ブロックのキュー、最大 8 チャンネルです。
42
+ * @ko Worker 효과 처리기를 생성합니다. 기본값은 블록당 1024프레임,
43
+ * 8블록 큐, 최대 8채널입니다.
44
+ */
15
45
  constructor(options: EffectProcessorOptions);
16
- /** 返回分块处理和队列欠载、溢出统计。 */
46
+ /**
47
+ * Return block processing and queue underrun/overrun statistics.
48
+ * @zh 返回分块处理和队列欠载、溢出统计。
49
+ * @ja ブロック処理とキューのアンダーラン・オーバーランの統計を返します。
50
+ * @ko 블록 처리 및 큐 언더런과 오버런 통계를 반환합니다.
51
+ */
17
52
  getWorkerStats(): AudioWorkerStats;
18
- /** 返回 Worker 错误;没有错误时为 undefined。 */
53
+ /**
54
+ * Return the Worker error, or undefined if there is none.
55
+ * @zh 返回 Worker 错误;没有错误时为 undefined。
56
+ * @ja Worker のエラーを返します。エラーがなければ undefined。
57
+ * @ko Worker 오류를 반환합니다. 오류가 없으면 undefined입니다.
58
+ */
19
59
  getWorkerError(): Error | undefined;
20
- /** 异步关闭效果 Worker 会话。 */
60
+ /**
61
+ * Asynchronously close the effect Worker session.
62
+ * @zh 异步关闭效果 Worker 会话。
63
+ * @ja エフェクト Worker セッションを非同期で閉じます。
64
+ * @ko 효과 Worker 세션을 비동기로 닫습니다.
65
+ */
21
66
  close(): Promise<void>;
22
67
  }
@@ -5,9 +5,24 @@ const audio_native_1 = require("../internal/audio-native");
5
5
  const audio_worker_session_1 = require("../internal/audio-worker-session");
6
6
  const value_1 = require("./value");
7
7
  const playback_device_1 = require("./playback-device");
8
- /** Buffered DSP on native float blocks. Underflow produces silence. */
8
+ /**
9
+ * Buffered DSP on native float blocks. Underflow produces silence.
10
+ * @zh 对原生浮点块进行缓冲式 DSP 处理,欠载时输出静音。
11
+ * @ja ネイティブ浮動小数点ブロックに対するバッファー付き DSP。
12
+ * アンダーフロー時は無音を出力します。
13
+ * @ko 네이티브 부동 소수점 블록을 버퍼링하여 DSP 처리합니다.
14
+ * 언더플로 시 무음을 출력합니다.
15
+ */
9
16
  class EffectProcessor {
10
- /** 创建 Worker 效果处理器,默认每块 1024 帧、8 块队列和最多 8 个声道。 */
17
+ /**
18
+ * Create a Worker effect processor, defaulting to 1024 frames per block,
19
+ * an 8-block queue, and at most 8 channels.
20
+ * @zh 创建 Worker 效果处理器,默认每块 1024 帧、8 块队列和最多 8 个声道。
21
+ * @ja Worker エフェクトプロセッサーを作成します。既定値はブロックあたり
22
+ * 1024 フレーム、8 ブロックのキュー、最大 8 チャンネルです。
23
+ * @ko Worker 효과 처리기를 생성합니다. 기본값은 블록당 1024프레임,
24
+ * 8블록 큐, 최대 8채널입니다.
25
+ */
11
26
  constructor(options) {
12
27
  const frames = (0, value_1.unsigned)(options.blockFrames ?? 1024);
13
28
  const channels = (0, value_1.unsigned)(options.maxChannelCount ?? 8);
@@ -18,11 +33,26 @@ class EffectProcessor {
18
33
  blockFrames: frames });
19
34
  this.ready = this.session.ready;
20
35
  }
21
- /** 返回分块处理和队列欠载、溢出统计。 */
36
+ /**
37
+ * Return block processing and queue underrun/overrun statistics.
38
+ * @zh 返回分块处理和队列欠载、溢出统计。
39
+ * @ja ブロック処理とキューのアンダーラン・オーバーランの統計を返します。
40
+ * @ko 블록 처리 및 큐 언더런과 오버런 통계를 반환합니다.
41
+ */
22
42
  getWorkerStats() { return this.session.getStats(); }
23
- /** 返回 Worker 错误;没有错误时为 undefined。 */
43
+ /**
44
+ * Return the Worker error, or undefined if there is none.
45
+ * @zh 返回 Worker 错误;没有错误时为 undefined。
46
+ * @ja Worker のエラーを返します。エラーがなければ undefined。
47
+ * @ko Worker 오류를 반환합니다. 오류가 없으면 undefined입니다.
48
+ */
24
49
  getWorkerError() { return this.session.error; }
25
- /** 异步关闭效果 Worker 会话。 */
50
+ /**
51
+ * Asynchronously close the effect Worker session.
52
+ * @zh 异步关闭效果 Worker 会话。
53
+ * @ja エフェクト Worker セッションを非同期で閉じます。
54
+ * @ko 효과 Worker 세션을 비동기로 닫습니다.
55
+ */
26
56
  close() { return this.session.close(); }
27
57
  }
28
58
  exports.EffectProcessor = EffectProcessor;
@@ -4,7 +4,14 @@ import type { InputStream } from '../system/input-stream';
4
4
  import type { ReadonlyValue as R } from '../internal/value-storage';
5
5
  import { type ChannelMap } from './value';
6
6
  export declare const cancelAudioInput: unique symbol;
7
- /** 可寻址音频解码器,按调用顺序异步读取交错 16 位 PCM。 */
7
+ /**
8
+ * Seekable audio decoder reading interleaved 16-bit PCM asynchronously in
9
+ * invocation order.
10
+ * @zh 可寻址音频解码器,按调用顺序异步读取交错 16 位 PCM。
11
+ * @ja 呼び出し順に非同期で 16 ビットインターリーブ PCM を読み取る、
12
+ * シーク可能な音声デコーダー。
13
+ * @ko 호출 순서대로 16비트 인터리브 PCM을 비동기로 읽는 탐색 가능한 오디오 디코더입니다.
14
+ */
8
15
  export declare class InputSoundFile {
9
16
  readonly [audioHandle]: AudioHandle<'input'>;
10
17
  private readonly queue;
@@ -15,35 +22,114 @@ export declare class InputSoundFile {
15
22
  private stream?;
16
23
  private custom?;
17
24
  private customMetadata?;
18
- /** 创建未打开数据源的解码器。 */
25
+ /**
26
+ * Create a decoder with no open data source.
27
+ * @zh 创建未打开数据源的解码器。
28
+ * @ja データソースを開いていないデコーダーを作成します。
29
+ * @ko 데이터 소스가 열리지 않은 디코더를 생성합니다.
30
+ */
19
31
  constructor();
20
- /** 异步打开音频文件并读取格式信息,返回是否成功。 */
32
+ /**
33
+ * Asynchronously open an audio file and read its format information,
34
+ * returning whether it succeeded.
35
+ * @zh 异步打开音频文件并读取格式信息,返回是否成功。
36
+ * @ja 音声ファイルを非同期で開いて形式情報を読み取り、成功したかどうかを返します。
37
+ * @ko 오디오 파일을 비동기로 열고 형식 정보를 읽어 성공 여부를 반환합니다.
38
+ */
21
39
  openFromFile(filename: string): Promise<boolean>;
22
- /** 异步打开编码音频字节,返回是否成功。 */
40
+ /**
41
+ * Asynchronously open encoded audio bytes, returning whether it succeeded.
42
+ * @zh 异步打开编码音频字节,返回是否成功。
43
+ * @ja エンコード済み音声バイトを非同期で開き、成功したかどうかを返します。
44
+ * @ko 인코딩된 오디오 바이트를 비동기로 열고 성공 여부를 반환합니다.
45
+ */
23
46
  openFromMemory(data: Uint8Array): Promise<boolean>;
24
- /** 异步打开可寻址流,读取期间保留数据源引用。 */
47
+ /**
48
+ * Asynchronously open a seekable stream, retaining the data source reference
49
+ * during reading.
50
+ * @zh 异步打开可寻址流,读取期间保留数据源引用。
51
+ * @ja シーク可能なストリームを非同期で開き、読み取り中はデータソース参照を保持します。
52
+ * @ko 탐색 가능한 스트림을 비동기로 열고 읽는 동안 데이터 소스 참조를 유지합니다.
53
+ */
25
54
  openFromStream(stream: InputStream): Promise<boolean>;
26
- /** 返回所有声道合计的样本总数。 */
55
+ /**
56
+ * Return the total sample count across all channels.
57
+ * @zh 返回所有声道合计的样本总数。
58
+ * @ja 全チャンネルのサンプル総数を返します。
59
+ * @ko 모든 채널의 샘플 총수를 반환합니다.
60
+ */
27
61
  getSampleCount(): bigint;
28
- /** 返回当前样本偏移,包含所有交错声道。 */
62
+ /**
63
+ * Return the current sample offset, including all interleaved channels.
64
+ * @zh 返回当前样本偏移,包含所有交错声道。
65
+ * @ja 全インターリーブチャンネルを含む現在のサンプルオフセットを返します。
66
+ * @ko 모든 인터리브 채널을 포함하는 현재 샘플 오프셋을 반환합니다.
67
+ */
29
68
  getSampleOffset(): bigint;
30
- /** 返回音频总时长。 */
69
+ /**
70
+ * Return the total audio duration.
71
+ * @zh 返回音频总时长。
72
+ * @ja 音声全体の長さを返します。
73
+ * @ko 오디오의 전체 길이를 반환합니다.
74
+ */
31
75
  getDuration(): Time;
32
- /** 返回当前解码位置对应的时间。 */
76
+ /**
77
+ * Return the time corresponding to the current decoding position.
78
+ * @zh 返回当前解码位置对应的时间。
79
+ * @ja 現在のデコード位置に対応する時刻を返します。
80
+ * @ko 현재 디코딩 위치에 해당하는 시간을 반환합니다.
81
+ */
33
82
  getTimeOffset(): Time;
34
- /** 返回每声道采样率,单位为 Hz。 */
83
+ /**
84
+ * Return the sample rate per channel, in Hz.
85
+ * @zh 返回每声道采样率,单位为 Hz。
86
+ * @ja チャンネルごとのサンプルレートを Hz で返します。
87
+ * @ko 채널별 샘플 레이트를 Hz 단위로 반환합니다.
88
+ */
35
89
  getSampleRate(): number;
36
- /** 返回声道数。 */
90
+ /**
91
+ * Return the number of channels.
92
+ * @zh 返回声道数。
93
+ * @ja チャンネル数を返します。
94
+ * @ko 채널 수를 반환합니다.
95
+ */
37
96
  getChannelCount(): number;
38
- /** 返回交错声道的位置映射。 */
97
+ /**
98
+ * Return the position mapping of interleaved channels.
99
+ * @zh 返回交错声道的位置映射。
100
+ * @ja インターリーブチャンネルの位置マッピングを返します。
101
+ * @ko 인터리브 채널의 위치 매핑을 반환합니다.
102
+ */
39
103
  getChannelMap(): ChannelMap;
40
104
  /** @internal */
41
105
  [cancelAudioInput](): void;
42
- /** 异步解码到 data,返回实际写入的样本数;末尾返回 0n,完成前勿修改缓冲区。 */
106
+ /**
107
+ * Asynchronously decode into data, returning the actual number of samples
108
+ * written; return 0n at the end. Do not modify the buffer before completion.
109
+ * @zh 异步解码到 data,返回实际写入的样本数;末尾返回 0n,完成前勿修改缓冲区。
110
+ * @ja data に非同期でデコードし、実際に書き込んだサンプル数を返します。
111
+ * 末尾では 0n を返します。完了前にバッファーを変更しないでください。
112
+ * @ko data에 비동기로 디코딩하여 실제 기록한 샘플 수를 반환합니다.
113
+ * 끝에서는 0n을 반환하며, 완료 전에 버퍼를 수정하면 안 됩니다.
114
+ */
43
115
  read(data: Int16Array): Promise<bigint>;
44
- /** 异步跳转到样本偏移(bigint,包含所有声道)或时间偏移(Time)。 */
116
+ /**
117
+ * Asynchronously seek to a sample offset (bigint, including all channels)
118
+ * or a time offset (Time).
119
+ * @zh 异步跳转到样本偏移(bigint,包含所有声道)或时间偏移(Time)。
120
+ * @ja サンプルオフセット(bigint、全チャンネルを含む)または
121
+ * 時間オフセット(Time)に非同期でシークします。
122
+ * @ko 샘플 오프셋(bigint, 모든 채널 포함) 또는 시간 오프셋(Time)으로
123
+ * 비동기 이동합니다.
124
+ */
45
125
  seek(offset: bigint | R<Time>): Promise<void>;
46
- /** 等待此前操作并异步关闭解码器、释放其持有的数据源。 */
126
+ /**
127
+ * Wait for prior operations, then asynchronously close the decoder and
128
+ * release its retained data source.
129
+ * @zh 等待此前操作并异步关闭解码器、释放其持有的数据源。
130
+ * @ja 先行する操作を待ち、非同期でデコーダーを閉じて保持するデータソースを解放します。
131
+ * @ko 이전 작업을 기다린 뒤 디코더를 비동기로 닫고 보유한 데이터 소스를 해제합니다.
132
+ */
47
133
  close(): Promise<void>;
48
134
  private map;
49
135
  private runStream;