sfml.js 0.0.1 → 1.0.0-rc.2

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 (741) hide show
  1. package/LICENSE +1 -1
  2. package/README.ja.md +173 -0
  3. package/README.ko.md +173 -0
  4. package/README.md +129 -20
  5. package/README.zh-CN.md +173 -0
  6. package/assets/branding/sfml-js-symbol-pentagon.svg +24 -0
  7. package/assets/branding/sfml-js-wordmark-dark.svg +20 -0
  8. package/assets/branding/sfml-js-wordmark.svg +19 -0
  9. package/assets/breakout.png +0 -0
  10. package/binding.gyp +95 -183
  11. package/dist/audio/effect-processor.d.ts +67 -0
  12. package/dist/audio/effect-processor.js +58 -0
  13. package/dist/audio/input-sound-file.d.ts +138 -0
  14. package/dist/audio/input-sound-file.js +253 -0
  15. package/dist/audio/listener.d.ts +90 -0
  16. package/dist/audio/listener.js +148 -0
  17. package/dist/audio/music.d.ts +210 -0
  18. package/dist/audio/music.js +353 -0
  19. package/dist/audio/output-sound-file.d.ts +47 -0
  20. package/dist/audio/output-sound-file.js +102 -0
  21. package/dist/audio/playback-device.d.ts +121 -0
  22. package/dist/audio/playback-device.js +152 -0
  23. package/dist/audio/sound-buffer-recorder.d.ts +114 -0
  24. package/dist/audio/sound-buffer-recorder.js +142 -0
  25. package/dist/audio/sound-buffer.d.ts +150 -0
  26. package/dist/audio/sound-buffer.js +237 -0
  27. package/dist/audio/sound-file-factory.d.ts +100 -0
  28. package/dist/audio/sound-file-factory.js +225 -0
  29. package/dist/audio/sound-file-reader.d.ts +191 -0
  30. package/dist/audio/sound-file-reader.js +132 -0
  31. package/dist/audio/sound-file-writer.d.ts +59 -0
  32. package/dist/audio/sound-file-writer.js +20 -0
  33. package/dist/audio/sound-recorder.d.ts +184 -0
  34. package/dist/audio/sound-recorder.js +286 -0
  35. package/dist/audio/sound-source.d.ts +336 -0
  36. package/dist/audio/sound-source.js +389 -0
  37. package/dist/audio/sound-stream.d.ts +76 -0
  38. package/dist/audio/sound-stream.js +83 -0
  39. package/dist/audio/sound.d.ts +41 -0
  40. package/dist/audio/sound.js +66 -0
  41. package/dist/audio/value.d.ts +359 -0
  42. package/dist/audio/value.js +353 -0
  43. package/dist/audio/worker.d.ts +306 -0
  44. package/dist/audio/worker.js +2 -0
  45. package/dist/graphics/blend-mode.d.ts +248 -0
  46. package/dist/graphics/blend-mode.js +234 -0
  47. package/dist/graphics/boolean-vector.d.ts +134 -0
  48. package/dist/graphics/boolean-vector.js +202 -0
  49. package/dist/graphics/circle-shape.d.ts +84 -0
  50. package/dist/graphics/circle-shape.js +72 -0
  51. package/dist/graphics/color.d.ts +278 -0
  52. package/dist/graphics/color.js +291 -0
  53. package/dist/graphics/convex-shape.d.ts +56 -0
  54. package/dist/graphics/convex-shape.js +59 -0
  55. package/dist/graphics/drawable.d.ts +22 -0
  56. package/dist/graphics/drawable.js +20 -0
  57. package/dist/graphics/font.d.ts +199 -0
  58. package/dist/graphics/font.js +319 -0
  59. package/dist/graphics/glsl-matrix.d.ts +62 -0
  60. package/dist/graphics/glsl-matrix.js +106 -0
  61. package/dist/graphics/glsl.d.ts +165 -0
  62. package/dist/graphics/glsl.js +215 -0
  63. package/dist/graphics/glyph.d.ts +133 -0
  64. package/dist/graphics/glyph.js +138 -0
  65. package/dist/graphics/image.d.ts +192 -0
  66. package/dist/graphics/image.js +285 -0
  67. package/dist/graphics/primitive-type.d.ts +51 -0
  68. package/dist/graphics/primitive-type.js +60 -0
  69. package/dist/graphics/rect.d.ts +203 -0
  70. package/dist/graphics/rect.js +249 -0
  71. package/dist/graphics/rectangle-shape.d.ts +55 -0
  72. package/dist/graphics/rectangle-shape.js +60 -0
  73. package/dist/graphics/render-states.d.ts +188 -0
  74. package/dist/graphics/render-states.js +115 -0
  75. package/dist/graphics/render-target.d.ts +222 -0
  76. package/dist/graphics/render-target.js +434 -0
  77. package/dist/graphics/render-texture.d.ts +130 -0
  78. package/dist/graphics/render-texture.js +187 -0
  79. package/dist/graphics/render-window.d.ts +138 -0
  80. package/dist/graphics/render-window.js +154 -0
  81. package/dist/graphics/shader.d.ts +192 -0
  82. package/dist/graphics/shader.js +321 -0
  83. package/dist/graphics/shape.d.ts +189 -0
  84. package/dist/graphics/shape.js +277 -0
  85. package/dist/graphics/sprite.d.ts +104 -0
  86. package/dist/graphics/sprite.js +164 -0
  87. package/dist/graphics/stencil-mode.d.ts +230 -0
  88. package/dist/graphics/stencil-mode.js +173 -0
  89. package/dist/graphics/swap.d.ts +17 -0
  90. package/dist/graphics/swap.js +16 -0
  91. package/dist/graphics/text.d.ts +759 -0
  92. package/dist/graphics/text.js +724 -0
  93. package/dist/graphics/texture.d.ts +255 -0
  94. package/dist/graphics/texture.js +390 -0
  95. package/dist/graphics/transform.d.ts +129 -0
  96. package/dist/graphics/transform.js +274 -0
  97. package/dist/graphics/transformable.d.ts +24 -0
  98. package/dist/graphics/transformable.js +38 -0
  99. package/dist/graphics/vertex-array.d.ts +123 -0
  100. package/dist/graphics/vertex-array.js +234 -0
  101. package/dist/graphics/vertex-buffer.d.ts +205 -0
  102. package/dist/graphics/vertex-buffer.js +256 -0
  103. package/dist/graphics/vertex.d.ts +111 -0
  104. package/dist/graphics/vertex.js +134 -0
  105. package/dist/graphics/view.d.ts +172 -0
  106. package/dist/graphics/view.js +296 -0
  107. package/dist/index.d.ts +116 -0
  108. package/dist/index.js +251 -0
  109. package/dist/internal/audio-codec-registry.d.ts +13 -0
  110. package/dist/internal/audio-codec-registry.js +64 -0
  111. package/dist/internal/audio-input-stream.d.ts +13 -0
  112. package/dist/internal/audio-input-stream.js +44 -0
  113. package/dist/internal/audio-music-pump.d.ts +63 -0
  114. package/dist/internal/audio-music-pump.js +193 -0
  115. package/dist/internal/audio-native.d.ts +145 -0
  116. package/dist/internal/audio-native.js +24 -0
  117. package/dist/internal/audio-recorder-session.d.ts +77 -0
  118. package/dist/internal/audio-recorder-session.js +182 -0
  119. package/dist/internal/audio-worker-session.d.ts +18 -0
  120. package/dist/internal/audio-worker-session.js +82 -0
  121. package/dist/internal/audio-worker.d.ts +1 -0
  122. package/dist/internal/audio-worker.js +134 -0
  123. package/dist/internal/glsl-value.d.ts +51 -0
  124. package/dist/internal/glsl-value.js +69 -0
  125. package/dist/internal/graphics-state.d.ts +45 -0
  126. package/dist/internal/graphics-state.js +123 -0
  127. package/dist/internal/input-stream.d.ts +4 -0
  128. package/dist/internal/input-stream.js +25 -0
  129. package/dist/internal/lazy-value.d.ts +17 -0
  130. package/dist/internal/lazy-value.js +43 -0
  131. package/dist/internal/native.d.ts +317 -0
  132. package/dist/internal/native.js +8 -0
  133. package/dist/internal/numeric-properties.d.ts +2 -0
  134. package/dist/internal/numeric-properties.js +39 -0
  135. package/dist/internal/render-states.d.ts +4 -0
  136. package/dist/internal/render-states.js +44 -0
  137. package/dist/internal/scalar.d.ts +52 -0
  138. package/dist/internal/scalar.js +95 -0
  139. package/dist/internal/shaped-glyph.d.ts +32 -0
  140. package/dist/internal/shaped-glyph.js +51 -0
  141. package/dist/internal/struct-view.d.ts +11 -0
  142. package/dist/internal/struct-view.js +39 -0
  143. package/dist/internal/text-indices.d.ts +7 -0
  144. package/dist/internal/text-indices.js +22 -0
  145. package/dist/internal/transformable.d.ts +124 -0
  146. package/dist/internal/transformable.js +121 -0
  147. package/dist/internal/value-storage.d.ts +33 -0
  148. package/dist/internal/value-storage.js +21 -0
  149. package/dist/network/common.d.ts +23 -0
  150. package/dist/network/common.js +78 -0
  151. package/dist/network/dns.d.ts +124 -0
  152. package/dist/network/dns.js +142 -0
  153. package/dist/network/ftp.d.ts +265 -0
  154. package/dist/network/ftp.js +417 -0
  155. package/dist/network/gen/constants.d.ts +878 -0
  156. package/dist/network/gen/constants.js +886 -0
  157. package/dist/network/http.d.ts +458 -0
  158. package/dist/network/http.js +732 -0
  159. package/dist/network/ip-address.d.ts +210 -0
  160. package/dist/network/ip-address.js +301 -0
  161. package/dist/network/packet.d.ts +249 -0
  162. package/dist/network/packet.js +326 -0
  163. package/dist/network/sftp.d.ts +661 -0
  164. package/dist/network/sftp.js +826 -0
  165. package/dist/network/socket-selector.d.ts +132 -0
  166. package/dist/network/socket-selector.js +214 -0
  167. package/dist/network/socket.d.ts +301 -0
  168. package/dist/network/socket.js +402 -0
  169. package/dist/network/tcp-listener.d.ts +114 -0
  170. package/dist/network/tcp-listener.js +199 -0
  171. package/dist/network/tcp-socket.d.ts +307 -0
  172. package/dist/network/tcp-socket.js +493 -0
  173. package/dist/network/tls-material.d.ts +22 -0
  174. package/dist/network/tls-material.js +52 -0
  175. package/dist/network/udp-socket.d.ts +178 -0
  176. package/dist/network/udp-socket.js +285 -0
  177. package/dist/system/angle.d.ts +77 -0
  178. package/dist/system/angle.js +122 -0
  179. package/dist/system/clock.d.ts +65 -0
  180. package/dist/system/clock.js +99 -0
  181. package/dist/system/err.d.ts +18 -0
  182. package/dist/system/err.js +61 -0
  183. package/dist/system/error.d.ts +15 -0
  184. package/dist/system/error.js +22 -0
  185. package/dist/system/file-input-stream.d.ts +68 -0
  186. package/dist/system/file-input-stream.js +148 -0
  187. package/dist/system/input-stream.d.ts +114 -0
  188. package/dist/system/input-stream.js +106 -0
  189. package/dist/system/operators.d.ts +291 -0
  190. package/dist/system/operators.js +505 -0
  191. package/dist/system/sleep.d.ts +9 -0
  192. package/dist/system/sleep.js +28 -0
  193. package/dist/system/suspend-aware-clock.d.ts +22 -0
  194. package/dist/system/suspend-aware-clock.js +29 -0
  195. package/dist/system/time.d.ts +100 -0
  196. package/dist/system/time.js +188 -0
  197. package/dist/system/timeout-with-predicate.d.ts +60 -0
  198. package/dist/system/timeout-with-predicate.js +52 -0
  199. package/dist/system/unicode.d.ts +54 -0
  200. package/dist/system/unicode.js +67 -0
  201. package/dist/system/vector2.d.ts +302 -0
  202. package/dist/system/vector2.js +314 -0
  203. package/dist/system/vector3.d.ts +249 -0
  204. package/dist/system/vector3.js +266 -0
  205. package/dist/system/version.d.ts +51 -0
  206. package/dist/system/version.js +24 -0
  207. package/dist/window/clipboard.d.ts +14 -0
  208. package/dist/window/clipboard.js +26 -0
  209. package/dist/window/context-settings.d.ts +94 -0
  210. package/dist/window/context-settings.js +84 -0
  211. package/dist/window/context.d.ts +87 -0
  212. package/dist/window/context.js +122 -0
  213. package/dist/window/cursor.d.ts +58 -0
  214. package/dist/window/cursor.js +80 -0
  215. package/dist/window/event.d.ts +529 -0
  216. package/dist/window/event.js +87 -0
  217. package/dist/window/gen/constants.d.ts +2213 -0
  218. package/dist/window/gen/constants.js +2227 -0
  219. package/dist/window/joystick.d.ts +81 -0
  220. package/dist/window/joystick.js +80 -0
  221. package/dist/window/keyboard.d.ts +50 -0
  222. package/dist/window/keyboard.js +59 -0
  223. package/dist/window/mouse.d.ts +31 -0
  224. package/dist/window/mouse.js +57 -0
  225. package/dist/window/sensor.d.ts +26 -0
  226. package/dist/window/sensor.js +40 -0
  227. package/dist/window/touch.d.ts +27 -0
  228. package/dist/window/touch.js +44 -0
  229. package/dist/window/video-mode.d.ts +77 -0
  230. package/dist/window/video-mode.js +99 -0
  231. package/dist/window/vulkan.d.ts +32 -0
  232. package/dist/window/vulkan.js +45 -0
  233. package/dist/window/window.d.ts +355 -0
  234. package/dist/window/window.js +434 -0
  235. package/docs/README.ja.md +30 -0
  236. package/docs/README.ko.md +30 -0
  237. package/docs/README.md +30 -0
  238. package/docs/README.zh-CN.md +30 -0
  239. package/docs/api.ja.md +84 -0
  240. package/docs/api.ko.md +84 -0
  241. package/docs/api.md +81 -0
  242. package/docs/api.zh-CN.md +81 -0
  243. package/docs/audio.ja.md +249 -0
  244. package/docs/audio.ko.md +251 -0
  245. package/docs/audio.md +252 -0
  246. package/docs/audio.zh-CN.md +252 -0
  247. package/docs/concepts.ja.md +130 -0
  248. package/docs/concepts.ko.md +130 -0
  249. package/docs/concepts.md +131 -0
  250. package/docs/concepts.zh-CN.md +131 -0
  251. package/docs/development.ja.md +148 -0
  252. package/docs/development.ko.md +148 -0
  253. package/docs/development.md +150 -0
  254. package/docs/development.zh-CN.md +150 -0
  255. package/docs/getting-started.ja.md +154 -0
  256. package/docs/getting-started.ko.md +154 -0
  257. package/docs/getting-started.md +156 -0
  258. package/docs/getting-started.zh-CN.md +156 -0
  259. package/docs/graphics.ja.md +256 -0
  260. package/docs/graphics.ko.md +254 -0
  261. package/docs/graphics.md +255 -0
  262. package/docs/graphics.zh-CN.md +257 -0
  263. package/docs/network.ja.md +214 -0
  264. package/docs/network.ko.md +216 -0
  265. package/docs/network.md +218 -0
  266. package/docs/network.zh-CN.md +218 -0
  267. package/docs/system.ja.md +169 -0
  268. package/docs/system.ko.md +171 -0
  269. package/docs/system.md +173 -0
  270. package/docs/system.zh-CN.md +173 -0
  271. package/docs/window.ja.md +138 -0
  272. package/docs/window.ko.md +140 -0
  273. package/docs/window.md +141 -0
  274. package/docs/window.zh-CN.md +141 -0
  275. package/native/addon.cc +129 -0
  276. package/native/audio-binding.cc +543 -0
  277. package/native/audio-codec-binding.cc +246 -0
  278. package/native/audio-device-binding.cc +160 -0
  279. package/native/audio-file-binding.cc +192 -0
  280. package/native/audio-recorder-binding.cc +237 -0
  281. package/native/audio-recorder.h +39 -0
  282. package/native/audio-state.h +220 -0
  283. package/native/audio-stream-binding.cc +284 -0
  284. package/native/audio-stream.h +28 -0
  285. package/native/audio-worker-binding.cc +447 -0
  286. package/native/audio-worker.h +121 -0
  287. package/native/batch-drawable.cc +189 -0
  288. package/native/batch-drawable.h +57 -0
  289. package/native/context-binding.cc +180 -0
  290. package/native/context-settings.h +74 -0
  291. package/native/deferred-delete.cc +49 -0
  292. package/native/deferred-delete.h +84 -0
  293. package/native/error-stream-binding.cc +270 -0
  294. package/native/exception-boundary.h +97 -0
  295. package/native/font-binding.cc +210 -0
  296. package/native/font-state.h +27 -0
  297. package/native/graphics-binding.cc +338 -0
  298. package/native/graphics-state.h +253 -0
  299. package/native/image-binding.cc +258 -0
  300. package/native/image-state.h +93 -0
  301. package/native/input-binding.cc +246 -0
  302. package/native/numeric-fields.h +96 -0
  303. package/native/render-window-binding.cc +103 -0
  304. package/native/render-window-state.h +22 -0
  305. package/native/shader-binding.cc +292 -0
  306. package/native/shape-binding.cc +283 -0
  307. package/native/shape-state.h +68 -0
  308. package/native/shaped-glyph-storage.h +45 -0
  309. package/native/shared-handle.h +69 -0
  310. package/native/stream-binding.cc +286 -0
  311. package/native/system-binding.cc +91 -0
  312. package/native/text-binding.cc +205 -0
  313. package/native/text-state.h +101 -0
  314. package/native/texture-binding.cc +330 -0
  315. package/native/texture-resource.h +52 -0
  316. package/native/time-value.h +28 -0
  317. package/native/transformable-binding.cc +23 -0
  318. package/native/transformable-state.h +44 -0
  319. package/native/value-binding.h +200 -0
  320. package/native/value-layout.h +116 -0
  321. package/native/values-binding.cc +27 -0
  322. package/native/vertex-binding.cc +50 -0
  323. package/native/vertex-buffer-binding.cc +232 -0
  324. package/native/vertex-storage.h +20 -0
  325. package/native/view-data.h +24 -0
  326. package/native/window-binding.cc +388 -0
  327. package/native/window-event.h +92 -0
  328. package/native/window-owner.h +81 -0
  329. package/package.json +87 -35
  330. package/src/audio/effect-processor.ts +86 -0
  331. package/src/audio/input-sound-file.ts +259 -0
  332. package/src/audio/listener.ts +136 -0
  333. package/src/audio/music.ts +357 -0
  334. package/src/audio/output-sound-file.ts +96 -0
  335. package/src/audio/playback-device.ts +145 -0
  336. package/src/audio/sound-buffer-recorder.ts +141 -0
  337. package/src/audio/sound-buffer.ts +275 -0
  338. package/src/audio/sound-file-factory.ts +235 -0
  339. package/src/audio/sound-file-reader.ts +224 -0
  340. package/src/audio/sound-file-writer.ts +61 -0
  341. package/src/audio/sound-recorder.ts +315 -0
  342. package/src/audio/sound-source.ts +396 -0
  343. package/src/audio/sound-stream.ts +108 -0
  344. package/src/audio/sound.ts +63 -0
  345. package/src/audio/value.ts +408 -0
  346. package/src/audio/worker.ts +308 -0
  347. package/src/graphics/blend-mode.ts +291 -0
  348. package/src/graphics/boolean-vector.ts +225 -0
  349. package/src/graphics/circle-shape.ts +113 -0
  350. package/src/graphics/color.ts +374 -0
  351. package/src/graphics/convex-shape.ts +76 -0
  352. package/src/graphics/drawable.ts +32 -0
  353. package/src/graphics/font.ts +377 -0
  354. package/src/graphics/glsl-matrix.ts +110 -0
  355. package/src/graphics/glsl.ts +229 -0
  356. package/src/graphics/glyph.ts +186 -0
  357. package/src/graphics/image.ts +366 -0
  358. package/src/graphics/primitive-type.ts +56 -0
  359. package/src/graphics/rect.ts +350 -0
  360. package/src/graphics/rectangle-shape.ts +76 -0
  361. package/src/graphics/render-states.ts +238 -0
  362. package/src/graphics/render-target.ts +554 -0
  363. package/src/graphics/render-texture.ts +234 -0
  364. package/src/graphics/render-window.ts +250 -0
  365. package/src/graphics/shader.ts +353 -0
  366. package/src/graphics/shape.ts +343 -0
  367. package/src/graphics/sprite.ts +203 -0
  368. package/src/graphics/stencil-mode.ts +258 -0
  369. package/src/graphics/swap.ts +28 -0
  370. package/src/graphics/text.ts +944 -0
  371. package/src/graphics/texture.ts +529 -0
  372. package/src/graphics/transform.ts +321 -0
  373. package/src/graphics/transformable.ts +37 -0
  374. package/src/graphics/vertex-array.ts +270 -0
  375. package/src/graphics/vertex-buffer.ts +345 -0
  376. package/src/graphics/vertex.ts +211 -0
  377. package/src/graphics/view.ts +355 -0
  378. package/src/index.ts +147 -0
  379. package/src/internal/audio-codec-registry.ts +68 -0
  380. package/src/internal/audio-input-stream.ts +42 -0
  381. package/src/internal/audio-music-pump.ts +199 -0
  382. package/src/internal/audio-native.ts +176 -0
  383. package/src/internal/audio-recorder-session.ts +234 -0
  384. package/src/internal/audio-worker-session.ts +89 -0
  385. package/src/internal/audio-worker.ts +146 -0
  386. package/src/internal/glsl-value.ts +79 -0
  387. package/src/internal/graphics-state.ts +131 -0
  388. package/src/internal/input-stream.ts +30 -0
  389. package/src/internal/lazy-value.ts +62 -0
  390. package/src/internal/native.ts +581 -0
  391. package/src/internal/numeric-properties.ts +37 -0
  392. package/src/internal/render-states.ts +42 -0
  393. package/src/internal/scalar.ts +117 -0
  394. package/src/internal/shaped-glyph.ts +68 -0
  395. package/src/internal/struct-view.ts +49 -0
  396. package/src/internal/text-indices.ts +19 -0
  397. package/src/internal/transformable.ts +260 -0
  398. package/src/internal/value-storage.ts +40 -0
  399. package/src/network/common.ts +58 -0
  400. package/src/network/dns.ts +191 -0
  401. package/src/network/ftp.ts +386 -0
  402. package/src/network/gen/constants.ts +879 -0
  403. package/src/network/http.ts +680 -0
  404. package/src/network/ip-address.ts +311 -0
  405. package/src/network/packet.ts +388 -0
  406. package/src/network/sftp.ts +1015 -0
  407. package/src/network/socket-selector.ts +206 -0
  408. package/src/network/socket.ts +415 -0
  409. package/src/network/tcp-listener.ts +193 -0
  410. package/src/network/tcp-socket.ts +569 -0
  411. package/src/network/tls-material.ts +46 -0
  412. package/src/network/udp-socket.ts +294 -0
  413. package/src/system/angle.ts +132 -0
  414. package/src/system/clock.ts +104 -0
  415. package/src/system/err.ts +58 -0
  416. package/src/system/error.ts +18 -0
  417. package/src/system/file-input-stream.ts +147 -0
  418. package/src/system/input-stream.ts +150 -0
  419. package/src/system/operators.ts +681 -0
  420. package/src/system/sleep.ts +25 -0
  421. package/src/system/suspend-aware-clock.ts +27 -0
  422. package/src/system/time.ts +218 -0
  423. package/src/system/timeout-with-predicate.ts +94 -0
  424. package/src/system/unicode.ts +64 -0
  425. package/src/system/vector2.ts +549 -0
  426. package/src/system/vector3.ts +433 -0
  427. package/src/system/version.ts +66 -0
  428. package/src/window/clipboard.ts +22 -0
  429. package/src/window/context-settings.ts +143 -0
  430. package/src/window/context.ts +152 -0
  431. package/src/window/cursor.ts +116 -0
  432. package/src/window/event.ts +580 -0
  433. package/src/window/gen/constants.ts +2231 -0
  434. package/src/window/joystick.ts +108 -0
  435. package/src/window/keyboard.ts +78 -0
  436. package/src/window/mouse.ts +58 -0
  437. package/src/window/sensor.ts +37 -0
  438. package/src/window/touch.ts +42 -0
  439. package/src/window/video-mode.ts +136 -0
  440. package/src/window/vulkan.ts +42 -0
  441. package/src/window/window.ts +579 -0
  442. package/test/native/audio-probes.cc +181 -0
  443. package/test/native/deferred-delete-probes.cc +62 -0
  444. package/test/native/drawable-probes.cc +168 -0
  445. package/test/native/exception-probes.cc +83 -0
  446. package/test/native/image-probes.cc +105 -0
  447. package/test/native/matrix-probes.cc +67 -0
  448. package/test/native/network-oracle.cc +32 -0
  449. package/test/native/render-texture-probes.cc +193 -0
  450. package/test/native/shader-probes.cc +69 -0
  451. package/test/native/shape-probes.cc +160 -0
  452. package/test/native/sprite-probes.cc +146 -0
  453. package/test/native/system-probes.cc +109 -0
  454. package/test/native/text-probes.cc +211 -0
  455. package/test/native/texture-probes.cc +200 -0
  456. package/test/native/time-probes.cc +143 -0
  457. package/test/native/transform-probes.cc +92 -0
  458. package/test/native/transformable-probes.cc +152 -0
  459. package/test/native/value-oracle.h +88 -0
  460. package/test/native/value-probes.cc +379 -0
  461. package/test/native/vertex-array-probes.cc +82 -0
  462. package/test/native/vertex-buffer-probes.cc +87 -0
  463. package/test/native/view-probes.cc +150 -0
  464. package/test/native/window-probes.cc +172 -0
  465. package/test/tsconfig.json +8 -0
  466. package/tools/configure-lsp.cjs +23 -0
  467. package/tools/constant-docs.cjs +109 -0
  468. package/tools/constant-docs.json +1318 -0
  469. package/tools/generate-network-constants.cjs +59 -0
  470. package/tools/generate-window-constants.cjs +178 -0
  471. package/tools/lib_downloader.cjs +92 -0
  472. package/tools/lib_downloader_urls.cjs +23 -0
  473. package/tsconfig.json +11 -4
  474. package/index.d.ts +0 -1
  475. package/lib/clock.d.ts +0 -8
  476. package/lib/clock.js +0 -5
  477. package/lib/color.d.ts +0 -11
  478. package/lib/color.js +0 -98
  479. package/lib/common.js +0 -47
  480. package/lib/drawable/circle_shape.d.ts +0 -5
  481. package/lib/drawable/circle_shape.js +0 -26
  482. package/lib/drawable/convex_shape.d.ts +0 -5
  483. package/lib/drawable/convex_shape.js +0 -35
  484. package/lib/drawable/drawable.d.ts +0 -6
  485. package/lib/drawable/drawable.js +0 -18
  486. package/lib/drawable/plugin_package.d.ts +0 -31
  487. package/lib/drawable/plugin_package.js +0 -102
  488. package/lib/drawable/rectangle_shape.d.ts +0 -9
  489. package/lib/drawable/rectangle_shape.js +0 -28
  490. package/lib/drawable/shape.d.ts +0 -14
  491. package/lib/drawable/shape.js +0 -30
  492. package/lib/drawable/sprite.d.ts +0 -17
  493. package/lib/drawable/sprite.js +0 -53
  494. package/lib/drawable/text.d.ts +0 -26
  495. package/lib/drawable/text.js +0 -88
  496. package/lib/drawable/transformable.d.ts +0 -28
  497. package/lib/drawable/transformable.js +0 -113
  498. package/lib/drawable/vertex_array.d.ts +0 -40
  499. package/lib/drawable/vertex_array.js +0 -128
  500. package/lib/font.d.ts +0 -24
  501. package/lib/font.js +0 -137
  502. package/lib/image.d.ts +0 -26
  503. package/lib/image.js +0 -147
  504. package/lib/joystick.d.ts +0 -21
  505. package/lib/joystick.js +0 -72
  506. package/lib/keyboard.d.ts +0 -113
  507. package/lib/keyboard.js +0 -17
  508. package/lib/mouse.d.ts +0 -6
  509. package/lib/mouse.js +0 -39
  510. package/lib/poll_event.d.ts +0 -138
  511. package/lib/rect.d.ts +0 -18
  512. package/lib/rect.js +0 -119
  513. package/lib/render_window.d.ts +0 -67
  514. package/lib/render_window.js +0 -197
  515. package/lib/sensor.d.ts +0 -12
  516. package/lib/sensor.js +0 -34
  517. package/lib/sfml.d.ts +0 -32
  518. package/lib/sfml.js +0 -36
  519. package/lib/sound/base.d.ts +0 -33
  520. package/lib/sound/base.js +0 -109
  521. package/lib/sound/music.d.ts +0 -15
  522. package/lib/sound/music.js +0 -65
  523. package/lib/sound/sound.d.ts +0 -16
  524. package/lib/sound/sound.js +0 -55
  525. package/lib/sound/sound_buffer.d.ts +0 -14
  526. package/lib/sound/sound_buffer.js +0 -78
  527. package/lib/texture.d.ts +0 -21
  528. package/lib/texture.js +0 -127
  529. package/lib/time.d.ts +0 -13
  530. package/lib/time.js +0 -41
  531. package/lib/touch.d.ts +0 -7
  532. package/lib/touch.js +0 -34
  533. package/lib/vector2.d.ts +0 -49
  534. package/lib/vector2.js +0 -141
  535. package/lib/vector3.d.ts +0 -47
  536. package/lib/vector3.js +0 -154
  537. package/lib/vertex.d.ts +0 -14
  538. package/lib/vertex.js +0 -177
  539. package/lib/video_mode.d.ts +0 -12
  540. package/lib/video_mode.js +0 -99
  541. package/src/base_class_with_loading.h +0 -21
  542. package/src/clock.cc +0 -71
  543. package/src/clock.h +0 -30
  544. package/src/color.cc +0 -189
  545. package/src/color.h +0 -49
  546. package/src/drawable/circle_shape.cc +0 -78
  547. package/src/drawable/circle_shape.h +0 -28
  548. package/src/drawable/convex_shape.cc +0 -57
  549. package/src/drawable/convex_shape.h +0 -29
  550. package/src/drawable/drawable-inl.h +0 -29
  551. package/src/drawable/drawable.cc +0 -41
  552. package/src/drawable/drawable.h +0 -49
  553. package/src/drawable/package_plugin-inl.h +0 -191
  554. package/src/drawable/package_plugin.h +0 -60
  555. package/src/drawable/rectangle_shape.cc +0 -69
  556. package/src/drawable/rectangle_shape.h +0 -29
  557. package/src/drawable/shape.cc +0 -67
  558. package/src/drawable/shape.h +0 -39
  559. package/src/drawable/sprite.cc +0 -122
  560. package/src/drawable/sprite.h +0 -45
  561. package/src/drawable/text.cc +0 -133
  562. package/src/drawable/text.h +0 -54
  563. package/src/drawable/vertex_array.cc +0 -248
  564. package/src/drawable/vertex_array.h +0 -46
  565. package/src/font.cc +0 -214
  566. package/src/font.h +0 -44
  567. package/src/gen/.gitkeep +0 -0
  568. package/src/gen/joystick_axis.cc +0 -30
  569. package/src/gen/keycode.cc +0 -226
  570. package/src/gen/mouse_button.cc +0 -30
  571. package/src/gen/sensor_type.cc +0 -26
  572. package/src/image.cc +0 -379
  573. package/src/image.h +0 -72
  574. package/src/joystick.cc +0 -132
  575. package/src/joystick.h +0 -32
  576. package/src/keyboard.cc +0 -65
  577. package/src/keyboard.h +0 -27
  578. package/src/mouse.cc +0 -95
  579. package/src/mouse.h +0 -30
  580. package/src/plugins/transformable_plugin-inl.h +0 -121
  581. package/src/plugins/transformable_plugin.h +0 -42
  582. package/src/poll_event.cc +0 -326
  583. package/src/poll_event.h +0 -18
  584. package/src/rect-inl.h +0 -154
  585. package/src/rect.cc +0 -28
  586. package/src/rect.h +0 -105
  587. package/src/render_window.cc +0 -413
  588. package/src/render_window.h +0 -111
  589. package/src/render_window_async_display.cc +0 -49
  590. package/src/render_window_async_draw.cc +0 -56
  591. package/src/resizable_buffer.h +0 -104
  592. package/src/sensor.cc +0 -82
  593. package/src/sensor.h +0 -28
  594. package/src/sfml.cc +0 -85
  595. package/src/sound/music.cc +0 -113
  596. package/src/sound/music.h +0 -35
  597. package/src/sound/sound.cc +0 -116
  598. package/src/sound/sound.h +0 -41
  599. package/src/sound/sound_buffer.cc +0 -226
  600. package/src/sound/sound_buffer.h +0 -46
  601. package/src/sound/sound_source.cc +0 -124
  602. package/src/sound/sound_source.h +0 -80
  603. package/src/texture.cc +0 -246
  604. package/src/texture.h +0 -47
  605. package/src/time.cc +0 -177
  606. package/src/time.h +0 -42
  607. package/src/touch.cc +0 -54
  608. package/src/touch.h +0 -23
  609. package/src/utils-inl.h +0 -48
  610. package/src/utils.h +0 -21
  611. package/src/vector2-inl.h +0 -198
  612. package/src/vector2.cc +0 -36
  613. package/src/vector2.h +0 -133
  614. package/src/vector3-inl.h +0 -200
  615. package/src/vector3.cc +0 -36
  616. package/src/vector3.h +0 -134
  617. package/src/vertex.cc +0 -238
  618. package/src/vertex.h +0 -114
  619. package/src/video_mode.cc +0 -184
  620. package/src/video_mode.h +0 -38
  621. package/src/workers/load_from_file_worker.h +0 -79
  622. package/src/workers/save_to_file_worker.h +0 -79
  623. package/third_party/sfml/include/SFML/Audio/AlResource.hpp +0 -70
  624. package/third_party/sfml/include/SFML/Audio/Export.hpp +0 -48
  625. package/third_party/sfml/include/SFML/Audio/InputSoundFile.hpp +0 -268
  626. package/third_party/sfml/include/SFML/Audio/Listener.hpp +0 -234
  627. package/third_party/sfml/include/SFML/Audio/Music.hpp +0 -337
  628. package/third_party/sfml/include/SFML/Audio/OutputSoundFile.hpp +0 -133
  629. package/third_party/sfml/include/SFML/Audio/Sound.hpp +0 -264
  630. package/third_party/sfml/include/SFML/Audio/SoundBuffer.hpp +0 -352
  631. package/third_party/sfml/include/SFML/Audio/SoundBufferRecorder.hpp +0 -144
  632. package/third_party/sfml/include/SFML/Audio/SoundFileFactory.hpp +0 -197
  633. package/third_party/sfml/include/SFML/Audio/SoundFileFactory.inl +0 -100
  634. package/third_party/sfml/include/SFML/Audio/SoundFileReader.hpp +0 -165
  635. package/third_party/sfml/include/SFML/Audio/SoundFileWriter.hpp +0 -125
  636. package/third_party/sfml/include/SFML/Audio/SoundRecorder.hpp +0 -410
  637. package/third_party/sfml/include/SFML/Audio/SoundSource.hpp +0 -332
  638. package/third_party/sfml/include/SFML/Audio/SoundStream.hpp +0 -420
  639. package/third_party/sfml/include/SFML/Audio.hpp +0 -56
  640. package/third_party/sfml/include/SFML/Config.hpp +0 -248
  641. package/third_party/sfml/include/SFML/GpuPreference.hpp +0 -74
  642. package/third_party/sfml/include/SFML/Graphics/BlendMode.hpp +0 -219
  643. package/third_party/sfml/include/SFML/Graphics/CircleShape.hpp +0 -154
  644. package/third_party/sfml/include/SFML/Graphics/Color.hpp +0 -275
  645. package/third_party/sfml/include/SFML/Graphics/ConvexShape.hpp +0 -153
  646. package/third_party/sfml/include/SFML/Graphics/Drawable.hpp +0 -126
  647. package/third_party/sfml/include/SFML/Graphics/Export.hpp +0 -48
  648. package/third_party/sfml/include/SFML/Graphics/Font.hpp +0 -496
  649. package/third_party/sfml/include/SFML/Graphics/Glsl.hpp +0 -227
  650. package/third_party/sfml/include/SFML/Graphics/Glsl.inl +0 -155
  651. package/third_party/sfml/include/SFML/Graphics/Glyph.hpp +0 -81
  652. package/third_party/sfml/include/SFML/Graphics/Image.hpp +0 -346
  653. package/third_party/sfml/include/SFML/Graphics/PrimitiveType.hpp +0 -58
  654. package/third_party/sfml/include/SFML/Graphics/Rect.hpp +0 -274
  655. package/third_party/sfml/include/SFML/Graphics/Rect.inl +0 -171
  656. package/third_party/sfml/include/SFML/Graphics/RectangleShape.hpp +0 -132
  657. package/third_party/sfml/include/SFML/Graphics/RenderStates.hpp +0 -174
  658. package/third_party/sfml/include/SFML/Graphics/RenderTarget.hpp +0 -518
  659. package/third_party/sfml/include/SFML/Graphics/RenderTexture.hpp +0 -334
  660. package/third_party/sfml/include/SFML/Graphics/RenderWindow.hpp +0 -302
  661. package/third_party/sfml/include/SFML/Graphics/Shader.hpp +0 -875
  662. package/third_party/sfml/include/SFML/Graphics/Shape.hpp +0 -355
  663. package/third_party/sfml/include/SFML/Graphics/Sprite.hpp +0 -279
  664. package/third_party/sfml/include/SFML/Graphics/Text.hpp +0 -513
  665. package/third_party/sfml/include/SFML/Graphics/Texture.hpp +0 -733
  666. package/third_party/sfml/include/SFML/Graphics/Transform.hpp +0 -497
  667. package/third_party/sfml/include/SFML/Graphics/Transformable.hpp +0 -429
  668. package/third_party/sfml/include/SFML/Graphics/Vertex.hpp +0 -148
  669. package/third_party/sfml/include/SFML/Graphics/VertexArray.hpp +0 -223
  670. package/third_party/sfml/include/SFML/Graphics/VertexBuffer.hpp +0 -408
  671. package/third_party/sfml/include/SFML/Graphics/View.hpp +0 -343
  672. package/third_party/sfml/include/SFML/Graphics.hpp +0 -68
  673. package/third_party/sfml/include/SFML/Main.hpp +0 -43
  674. package/third_party/sfml/include/SFML/Network/Export.hpp +0 -48
  675. package/third_party/sfml/include/SFML/Network/Ftp.hpp +0 -616
  676. package/third_party/sfml/include/SFML/Network/Http.hpp +0 -482
  677. package/third_party/sfml/include/SFML/Network/IpAddress.hpp +0 -328
  678. package/third_party/sfml/include/SFML/Network/Packet.hpp +0 -545
  679. package/third_party/sfml/include/SFML/Network/Socket.hpp +0 -219
  680. package/third_party/sfml/include/SFML/Network/SocketHandle.hpp +0 -57
  681. package/third_party/sfml/include/SFML/Network/SocketSelector.hpp +0 -263
  682. package/third_party/sfml/include/SFML/Network/TcpListener.hpp +0 -170
  683. package/third_party/sfml/include/SFML/Network/TcpSocket.hpp +0 -316
  684. package/third_party/sfml/include/SFML/Network/UdpSocket.hpp +0 -292
  685. package/third_party/sfml/include/SFML/Network.hpp +0 -53
  686. package/third_party/sfml/include/SFML/OpenGL.hpp +0 -78
  687. package/third_party/sfml/include/SFML/System/Clock.hpp +0 -117
  688. package/third_party/sfml/include/SFML/System/Err.hpp +0 -80
  689. package/third_party/sfml/include/SFML/System/Export.hpp +0 -48
  690. package/third_party/sfml/include/SFML/System/FileInputStream.hpp +0 -169
  691. package/third_party/sfml/include/SFML/System/InputStream.hpp +0 -152
  692. package/third_party/sfml/include/SFML/System/Lock.hpp +0 -139
  693. package/third_party/sfml/include/SFML/System/MemoryInputStream.hpp +0 -148
  694. package/third_party/sfml/include/SFML/System/Mutex.hpp +0 -148
  695. package/third_party/sfml/include/SFML/System/NativeActivity.hpp +0 -62
  696. package/third_party/sfml/include/SFML/System/NonCopyable.hpp +0 -129
  697. package/third_party/sfml/include/SFML/System/Sleep.hpp +0 -52
  698. package/third_party/sfml/include/SFML/System/String.hpp +0 -669
  699. package/third_party/sfml/include/SFML/System/String.inl +0 -53
  700. package/third_party/sfml/include/SFML/System/Thread.hpp +0 -282
  701. package/third_party/sfml/include/SFML/System/Thread.inl +0 -90
  702. package/third_party/sfml/include/SFML/System/ThreadLocal.hpp +0 -103
  703. package/third_party/sfml/include/SFML/System/ThreadLocalPtr.hpp +0 -158
  704. package/third_party/sfml/include/SFML/System/ThreadLocalPtr.inl +0 -77
  705. package/third_party/sfml/include/SFML/System/Time.hpp +0 -488
  706. package/third_party/sfml/include/SFML/System/Utf.hpp +0 -763
  707. package/third_party/sfml/include/SFML/System/Utf.inl +0 -752
  708. package/third_party/sfml/include/SFML/System/Vector2.hpp +0 -301
  709. package/third_party/sfml/include/SFML/System/Vector2.inl +0 -161
  710. package/third_party/sfml/include/SFML/System/Vector3.hpp +0 -302
  711. package/third_party/sfml/include/SFML/System/Vector3.inl +0 -168
  712. package/third_party/sfml/include/SFML/System.hpp +0 -60
  713. package/third_party/sfml/include/SFML/Window/Clipboard.hpp +0 -119
  714. package/third_party/sfml/include/SFML/Window/Context.hpp +0 -195
  715. package/third_party/sfml/include/SFML/Window/ContextSettings.hpp +0 -149
  716. package/third_party/sfml/include/SFML/Window/Cursor.hpp +0 -241
  717. package/third_party/sfml/include/SFML/Window/Event.hpp +0 -285
  718. package/third_party/sfml/include/SFML/Window/Export.hpp +0 -48
  719. package/third_party/sfml/include/SFML/Window/GlResource.hpp +0 -109
  720. package/third_party/sfml/include/SFML/Window/Joystick.hpp +0 -227
  721. package/third_party/sfml/include/SFML/Window/Keyboard.hpp +0 -491
  722. package/third_party/sfml/include/SFML/Window/Mouse.hpp +0 -180
  723. package/third_party/sfml/include/SFML/Window/Sensor.hpp +0 -150
  724. package/third_party/sfml/include/SFML/Window/Touch.hpp +0 -137
  725. package/third_party/sfml/include/SFML/Window/VideoMode.hpp +0 -228
  726. package/third_party/sfml/include/SFML/Window/Vulkan.hpp +0 -115
  727. package/third_party/sfml/include/SFML/Window/Window.hpp +0 -354
  728. package/third_party/sfml/include/SFML/Window/WindowBase.hpp +0 -518
  729. package/third_party/sfml/include/SFML/Window/WindowHandle.hpp +0 -101
  730. package/third_party/sfml/include/SFML/Window/WindowStyle.hpp +0 -53
  731. package/third_party/sfml/include/SFML/Window.hpp +0 -58
  732. package/tools/clang_format.js +0 -9
  733. package/tools/copier/linux.js +0 -21
  734. package/tools/copier/macos.js +0 -34
  735. package/tools/copier/windows.js +0 -33
  736. package/tools/joystick_axis.js +0 -63
  737. package/tools/keycode.js +0 -92
  738. package/tools/lib_downloader.js +0 -107
  739. package/tools/lib_downloader_urls.js +0 -59
  740. package/tools/mouse_button.js +0 -92
  741. package/tools/sensor_type.js +0 -63
@@ -0,0 +1,173 @@
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/ported/README.zh-CN.md) 保留原演示,并适配 SFML 3 API。其中依赖 `drawAsync()` 或 `displayAsync()` 的两个入口报告 `UNSUPPORTED`;当前绑定不提供这两个方法。
140
+
141
+ [node-sfml-demos](https://github.com/XadillaX/node-sfml-demos) 和 [play-nes](https://github.com/XadillaX/play-nes) 使用旧版 API,需要适配后使用。
142
+
143
+ ## 参与贡献
144
+
145
+ 请按 [开发指南](docs/development.zh-CN.md) 准备环境。欢迎提交修复、文档与示例的 PR。反馈问题时,请提供可运行的复现程序,以及 Node.js 版本、操作系统和架构。
146
+
147
+ <a id="contributors-"></a>
148
+ <a id="maintenance-XadillaX"></a>
149
+
150
+ ## 贡献者 ✨
151
+
152
+ 感谢以下贡献者([表情含义](https://allcontributors.org/docs/en/emoji-key)):
153
+
154
+ <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
155
+ <!-- prettier-ignore-start -->
156
+ <!-- markdownlint-disable -->
157
+ <table>
158
+ <tr>
159
+ <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>
160
+ <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>
161
+ <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>
162
+ </tr>
163
+ </table>
164
+
165
+ <!-- markdownlint-restore -->
166
+ <!-- prettier-ignore-end -->
167
+ <!-- ALL-CONTRIBUTORS-LIST:END -->
168
+
169
+ 本项目遵循 [all-contributors](https://github.com/all-contributors/all-contributors) 规范,欢迎各种形式的贡献。
170
+
171
+ ## 许可证
172
+
173
+ [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
package/binding.gyp CHANGED
@@ -1,203 +1,115 @@
1
1
  {
2
2
  "targets": [{
3
- "target_name": "mouse_button.cc",
4
- "type": "none",
3
+ "target_name": "sfml",
5
4
  "sources": [
6
- "./third_party/sfml/include/SFML/Window/Mouse.hpp",
7
- "./tools/mouse_button.js"
5
+ "native/addon.cc",
6
+ "native/deferred-delete.cc",
7
+ "native/system-binding.cc",
8
+ "native/audio-binding.cc",
9
+ "native/audio-file-binding.cc",
10
+ "native/audio-device-binding.cc",
11
+ "native/audio-worker-binding.cc",
12
+ "native/audio-recorder-binding.cc",
13
+ "native/audio-stream-binding.cc",
14
+ "native/audio-codec-binding.cc",
15
+ "native/error-stream-binding.cc",
16
+ "native/context-binding.cc",
17
+ "native/values-binding.cc",
18
+ "native/graphics-binding.cc",
19
+ "native/texture-binding.cc",
20
+ "native/batch-drawable.cc",
21
+ "native/vertex-binding.cc",
22
+ "native/vertex-buffer-binding.cc",
23
+ "native/shader-binding.cc",
24
+ "native/image-binding.cc",
25
+ "native/stream-binding.cc",
26
+ "native/window-binding.cc",
27
+ "native/render-window-binding.cc",
28
+ "native/input-binding.cc",
29
+ "native/transformable-binding.cc",
30
+ "native/shape-binding.cc",
31
+ "native/font-binding.cc",
32
+ "native/text-binding.cc",
33
+ "test/native/value-probes.cc",
34
+ "test/native/deferred-delete-probes.cc",
35
+ "test/native/exception-probes.cc",
36
+ "test/native/time-probes.cc",
37
+ "test/native/system-probes.cc",
38
+ "test/native/audio-probes.cc",
39
+ "test/native/transform-probes.cc",
40
+ "test/native/matrix-probes.cc",
41
+ "test/native/image-probes.cc",
42
+ "test/native/transformable-probes.cc",
43
+ "test/native/sprite-probes.cc",
44
+ "test/native/shape-probes.cc",
45
+ "test/native/text-probes.cc",
46
+ "test/native/drawable-probes.cc",
47
+ "test/native/vertex-array-probes.cc",
48
+ "test/native/vertex-buffer-probes.cc",
49
+ "test/native/shader-probes.cc",
50
+ "test/native/texture-probes.cc",
51
+ "test/native/render-texture-probes.cc",
52
+ "test/native/view-probes.cc",
53
+ "test/native/window-probes.cc"
8
54
  ],
9
- "actions": [{
10
- "action_name": "gen_mouse_button",
11
- "inputs": [
12
- "./third_party/sfml/include/SFML/Window/Mouse.hpp",
13
- "./tools/mouse_button.js"
14
- ],
15
- "outputs": [
16
- "./src/gen/mouse_button.cc"
17
- ],
18
- "action": [
19
- "node",
20
- "./tools/mouse_button.js"
21
- ]
22
- }]
23
- }, {
24
- "target_name": "keycode.cc",
25
- "type": "none",
26
- "sources": [
27
- "./third_party/sfml/include/SFML/Window/Keyboard.hpp",
28
- "./tools/keycode.js"
29
- ],
30
- "actions": [{
31
- "action_name": "gen_keycode",
32
- "inputs": [
33
- "./third_party/sfml/include/SFML/Window/Keyboard.hpp",
34
- "./tools/keycode.js"
35
- ],
36
- "outputs": [
37
- "./src/gen/keycode.cc"
38
- ],
39
- "action": [
40
- "node",
41
- "./tools/keycode.js"
42
- ]
43
- }]
44
- }, {
45
- "target_name": "joystick_axis.cc",
46
- "type": "none",
47
- "sources": [
48
- "./third_party/sfml/include/SFML/Window/Joystick.hpp",
49
- "./tools/joystick_axis.js"
50
- ],
51
- "actions": [{
52
- "action_name": "gen_joystick_axis",
53
- "inputs": [
54
- "./third_party/sfml/include/SFML/Window/Joystick.hpp",
55
- "./tools/joystick_axis.js"
56
- ],
57
- "outputs": [
58
- "./src/gen/joystick_axis.cc"
59
- ],
60
- "action": [
61
- "node",
62
- "./tools/joystick_axis.js"
63
- ]
64
- }]
65
- }, {
66
- "target_name": "sensor_type.cc",
67
- "type": "none",
68
- "sources": [
69
- "./third_party/sfml/include/SFML/Window/Sensor.hpp",
70
- "./tools/sensor_type.js"
71
- ],
72
- "actions": [{
73
- "action_name": "gen_sensor_type",
74
- "inputs": [
75
- "./third_party/sfml/include/SFML/Window/Sensor.hpp",
76
- "./tools/sensor_type.js"
77
- ],
78
- "outputs": [
79
- "./src/gen/sensor_type.cc"
80
- ],
81
- "action": [
82
- "node",
83
- "./tools/sensor_type.js"
84
- ]
85
- }]
86
- }, {
87
- "target_name": "binding",
88
55
  "include_dirs": [
89
- "./third_party/sfml/include",
90
- "<!(node -e \"require('nan')\")"
56
+ "<!(node -e \"require('nan')\")",
57
+ "<(module_root_dir)/third_party/sfml/include"
91
58
  ],
59
+ "cflags_cc": ["-std=c++20", "-ffp-contract=off"],
60
+ "cflags_cc!": ["-fno-exceptions"],
92
61
  "conditions": [
93
- ["OS==\"linux\"", {
62
+ ["OS=='mac'", {
63
+ "xcode_settings": {
64
+ "CLANG_CXX_LANGUAGE_STANDARD": "c++20",
65
+ "GCC_ENABLE_CPP_EXCEPTIONS": "YES",
66
+ "OTHER_CPLUSPLUSFLAGS": ["-ffp-contract=off"],
67
+ "MACOSX_DEPLOYMENT_TARGET": "13.0"
68
+ },
94
69
  "libraries": [
95
- "../third_party/sfml/platform/linux/lib/libsfml-audio.so",
96
- "../third_party/sfml/platform/linux/lib/libsfml-system.so",
97
- "../third_party/sfml/platform/linux/lib/libsfml-window.so",
98
- "../third_party/sfml/platform/linux/lib/libsfml-network.so",
99
- "../third_party/sfml/platform/linux/lib/libsfml-graphics.so"
100
- ],
101
- "ldflags": [
102
- "-Wl,-rpath='$$ORIGIN/../../third_party/sfml/platform/linux/lib'"
70
+ "<(module_root_dir)/third_party/sfml/lib/libsfml-graphics.dylib",
71
+ "<(module_root_dir)/third_party/sfml/lib/libsfml-audio.dylib",
72
+ "<(module_root_dir)/third_party/sfml/lib/libsfml-window.dylib",
73
+ "<(module_root_dir)/third_party/sfml/lib/libsfml-system.dylib",
74
+ "-Wl,-rpath,@loader_path/../../third_party/sfml/lib"
103
75
  ]
104
76
  }],
105
- ["OS==\"win\"", {
106
- "defines": [
107
- "NOMINMAX"
108
- ],
109
- "copies": [{
110
- "destination": "<(module_root_dir)/build/Release/",
111
- "files": [
112
- "<(module_root_dir)/third_party/sfml/platform/win/bin/openal32.dll",
113
- "<(module_root_dir)/third_party/sfml/platform/win/bin/sfml-audio-2.dll",
114
- "<(module_root_dir)/third_party/sfml/platform/win/bin/sfml-graphics-2.dll",
115
- "<(module_root_dir)/third_party/sfml/platform/win/bin/sfml-network-2.dll",
116
- "<(module_root_dir)/third_party/sfml/platform/win/bin/sfml-system-2.dll",
117
- "<(module_root_dir)/third_party/sfml/platform/win/bin/sfml-window-2.dll"
118
- ]
119
- }],
77
+ ["OS=='linux'", {
120
78
  "libraries": [
121
- "../third_party/sfml/platform/win/lib/flac.lib",
122
- "../third_party/sfml/platform/win/lib/freetype.lib",
123
- "../third_party/sfml/platform/win/lib/ogg.lib",
124
- "../third_party/sfml/platform/win/lib/openal32.lib",
125
- "../third_party/sfml/platform/win/lib/sfml-audio.lib",
126
- "../third_party/sfml/platform/win/lib/sfml-graphics.lib",
127
- "../third_party/sfml/platform/win/lib/sfml-main.lib",
128
- "../third_party/sfml/platform/win/lib/sfml-network.lib",
129
- "../third_party/sfml/platform/win/lib/sfml-system.lib",
130
- "../third_party/sfml/platform/win/lib/sfml-window.lib",
131
- "../third_party/sfml/platform/win/lib/vorbis.lib",
132
- "../third_party/sfml/platform/win/lib/vorbisenc.lib",
133
- "../third_party/sfml/platform/win/lib/vorbisfile.lib",
79
+ "-L<(module_root_dir)/third_party/sfml/lib",
80
+ "-lsfml-graphics",
81
+ "-lsfml-audio",
82
+ "-lsfml-window",
83
+ "-lsfml-system",
84
+ "-lGL"
134
85
  ],
86
+ "ldflags": ["-Wl,-rpath,'$$ORIGIN/../../third_party/sfml/lib'"]
135
87
  }],
136
- ["OS==\"mac\"", {
88
+ ["OS=='win'", {
89
+ "defines": ["NOMINMAX"],
90
+ "msvs_settings": {
91
+ "VCCLCompilerTool": {
92
+ "ExceptionHandling": 1,
93
+ "AdditionalOptions": ["/std:c++20", "/fp:strict"]
94
+ }
95
+ },
137
96
  "libraries": [
138
- "../third_party/sfml/platform/macOS/lib/libsfml-audio.dylib",
139
- "../third_party/sfml/platform/macOS/lib/libsfml-system.dylib",
140
- "../third_party/sfml/platform/macOS/lib/libsfml-window.dylib",
141
- "../third_party/sfml/platform/macOS/lib/libsfml-network.dylib",
142
- "../third_party/sfml/platform/macOS/lib/libsfml-graphics.dylib"
97
+ "<(module_root_dir)/third_party/sfml/lib/sfml-graphics.lib",
98
+ "<(module_root_dir)/third_party/sfml/lib/sfml-audio.lib",
99
+ "<(module_root_dir)/third_party/sfml/lib/sfml-window.lib",
100
+ "<(module_root_dir)/third_party/sfml/lib/sfml-system.lib",
101
+ "opengl32.lib"
143
102
  ],
144
- "link_settings": {
145
- "libraries": [
146
- "-Wl,-rpath,@loader_path",
147
- "-Wl,-rpath,@loader_path/..",
148
- "-Wl,-rpath,@loader_path/../../third_party/sfml/platform/macOS/lib"
103
+ "copies": [{
104
+ "destination": "<(PRODUCT_DIR)",
105
+ "files": [
106
+ "<(module_root_dir)/third_party/sfml/bin/sfml-graphics-3.dll",
107
+ "<(module_root_dir)/third_party/sfml/bin/sfml-audio-3.dll",
108
+ "<(module_root_dir)/third_party/sfml/bin/sfml-window-3.dll",
109
+ "<(module_root_dir)/third_party/sfml/bin/sfml-system-3.dll"
149
110
  ]
150
- }
111
+ }]
151
112
  }]
152
- ],
153
- "sources": [
154
- "./src/sfml.cc",
155
-
156
- "./src/clock.cc",
157
- "./src/color.cc",
158
- "./src/font.cc",
159
- "./src/image.cc",
160
- "./src/joystick.cc",
161
- "./src/keyboard.cc",
162
- "./src/mouse.cc",
163
- "./src/poll_event.cc",
164
- "./src/rect.cc",
165
- "./src/render_window.cc",
166
- "./src/render_window_async_display.cc",
167
- "./src/render_window_async_draw.cc",
168
- "./src/sensor.cc",
169
- "./src/touch.cc",
170
- "./src/texture.cc",
171
- "./src/time.cc",
172
- "./src/vector2.cc",
173
- "./src/vector3.cc",
174
- "./src/vertex.cc",
175
- "./src/video_mode.cc",
176
-
177
- "./src/drawable/circle_shape.cc",
178
- "./src/drawable/convex_shape.cc",
179
- "./src/drawable/drawable.cc",
180
- "./src/drawable/rectangle_shape.cc",
181
- "./src/drawable/shape.cc",
182
- "./src/drawable/sprite.cc",
183
- "./src/drawable/text.cc",
184
- "./src/drawable/vertex_array.cc",
185
-
186
- "./src/gen/joystick_axis.cc",
187
- "./src/gen/keycode.cc",
188
- "./src/gen/mouse_button.cc",
189
- "./src/gen/sensor_type.cc",
190
-
191
- "./src/sound/music.cc",
192
- "./src/sound/sound.cc",
193
- "./src/sound/sound_buffer.cc",
194
- "./src/sound/sound_source.cc"
195
- ],
196
- "dependencies": [
197
- "keycode.cc",
198
- "joystick_axis.cc",
199
- "sensor_type.cc",
200
- "mouse_button.cc"
201
113
  ]
202
114
  }]
203
115
  }
@@ -0,0 +1,67 @@
1
+ import { audioHandle, type AudioHandle } from '../internal/audio-native';
2
+ import type { AudioWorkerOptions, AudioWorkerStats } from './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
+ */
9
+ export interface EffectProcessorOptions extends AudioWorkerOptions {
10
+ /**
11
+ * Maximum engine output channels; input is already spatialized.
12
+ * @zh 引擎输出声道数上限;输入已完成空间音效处理。
13
+ * @ja エンジンの最大出力チャンネル数。入力は空間音響処理済みです。
14
+ * @ko 엔진의 최대 출력 채널 수이며, 입력은 이미 공간 음향 처리가 되어 있습니다.
15
+ */
16
+ maxChannelCount?: number;
17
+ }
18
+ /**
19
+ * Buffered DSP on native float blocks. Underflow produces silence.
20
+ * @zh 对原生浮点块进行缓冲式 DSP 处理,欠载时输出静音。
21
+ * @ja ネイティブ浮動小数点ブロックに対するバッファー付き DSP。
22
+ * アンダーフロー時は無音を出力します。
23
+ * @ko 네이티브 부동 소수점 블록을 버퍼링하여 DSP 처리합니다.
24
+ * 언더플로 시 무음을 출력합니다.
25
+ */
26
+ export declare class EffectProcessor {
27
+ readonly [audioHandle]: AudioHandle<'worker'>;
28
+ /**
29
+ * Initialization result of the Worker effect factory.
30
+ * @zh Worker 效果工厂初始化结果。
31
+ * @ja Worker エフェクトファクトリーの初期化結果。
32
+ * @ko Worker 효과 팩토리의 초기화 결과입니다.
33
+ */
34
+ readonly ready: Promise<boolean>;
35
+ private readonly session;
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
+ */
45
+ constructor(options: EffectProcessorOptions);
46
+ /**
47
+ * Return block processing and queue underrun/overrun statistics.
48
+ * @zh 返回分块处理和队列欠载、溢出统计。
49
+ * @ja ブロック処理とキューのアンダーラン・オーバーランの統計を返します。
50
+ * @ko 블록 처리 및 큐 언더런과 오버런 통계를 반환합니다.
51
+ */
52
+ getWorkerStats(): AudioWorkerStats;
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
+ */
59
+ getWorkerError(): Error | undefined;
60
+ /**
61
+ * Asynchronously close the effect Worker session.
62
+ * @zh 异步关闭效果 Worker 会话。
63
+ * @ja エフェクト Worker セッションを非同期で閉じます。
64
+ * @ko 효과 Worker 세션을 비동기로 닫습니다.
65
+ */
66
+ close(): Promise<void>;
67
+ }