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
package/docs/system.md ADDED
@@ -0,0 +1,173 @@
1
+ # System
2
+
3
+ **English** · [简体中文](system.zh-CN.md) · [日本語](system.ja.md) · [한국어](system.ko.md)
4
+
5
+ > System provides value types, time, input streams, Unicode boundaries and error handling. Ordinary numeric calculations run in JS; resource-related operations enter native code through the relevant APIs.
6
+
7
+ [API guide](api.md) · [Core concepts](concepts.md)
8
+
9
+ ## Vectors and operations
10
+
11
+ ```typescript
12
+ import { Vector2f, Vector2i, add, multiply, addAssign } from 'sfml.js';
13
+
14
+ const position = new Vector2f(10, 20);
15
+ const velocity = new Vector2f(2, 3);
16
+ const next = add(position, velocity);
17
+ const doubled = multiply(velocity, 2);
18
+ addAssign(position, velocity);
19
+ const pixels = new Vector2i(position);
20
+ ```
21
+
22
+ Ordinary operations return independent values; `*Assign` modifies and returns the left operand. Assignment does not automatically convert a vector's scalar type; use the corresponding constructor for conversion.
23
+
24
+ | Scalar tag | JS component type | Storage |
25
+ | --- | --- | --- |
26
+ | `i8`/`u8` | number | Int8Array/Uint8Array |
27
+ | `i16`/`u16` | number | Int16Array/Uint16Array |
28
+ | `i32`/`u32` | number | Int32Array/Uint32Array |
29
+ | `i64`/`u64` | bigint | BigInt64Array/BigUint64Array |
30
+ | `f32`/`f64` | number | Float32Array/Float64Array |
31
+
32
+ `Vector2i/u/f` and `Vector3i/u/f` correspond to i32/u32/f32. For other scalars, use forms such as `new Vector2('f64', x, y)`.
33
+
34
+ Both vector types provide `lengthSquared()`, `dot()`, `cross()` and component-wise multiplication and division; 2D vectors also provide `perpendicular()`. Floating-point vectors provide `length()` and `normalized()`, with additional angle, rotation and projection operations for floating-point 2D vectors. Integer vectors do not support floating-point-only methods.
35
+
36
+ Vector `multiply()`/`divide()` use scalars; use `componentWiseMul()`/`componentWiseDiv()` for component-wise operations. Zero divisors, normalizing a zero vector and projecting onto a zero axis throw errors. 64-bit integer calculations retain bigint; f32 calculations round according to SFML precision rules, with limited platform math-library differences allowed for trigonometric operations.
37
+
38
+ ## Angles
39
+
40
+ ```typescript
41
+ import { Angle, degrees, radians, divide } from 'sfml.js';
42
+
43
+ const heading = degrees(90);
44
+ const turn = radians(Math.PI);
45
+ const copy = new Angle(heading);
46
+ const ratio = divide(turn, heading);
47
+ console.log(copy.asDegrees(), ratio);
48
+ ```
49
+
50
+ Rotation APIs accept Angle. `wrapSigned()` and `wrapUnsigned()` return wrapped angles; comparisons do not wrap automatically. `Angle.Zero` is a read-only constant; copy it before modifying it. Angle uses float32, and modulo requires a positive divisor.
51
+
52
+ ## Time and clocks
53
+
54
+ ```typescript
55
+ import { Clock, milliseconds, microseconds, sleep } from 'sfml.js';
56
+
57
+ const clock = new Clock();
58
+ await sleep(milliseconds(16));
59
+ const elapsed = clock.restart();
60
+ console.log(elapsed.asSeconds(), elapsed.asMicroseconds());
61
+ console.log(microseconds(1000n).asMilliseconds());
62
+ ```
63
+
64
+ | API | Semantics |
65
+ | --- | --- |
66
+ | `new Time()`/`new Time(source)`/`new Time(bigint)` | Construct zero duration, a copy or a microsecond value |
67
+ | `seconds(number)` | Convert seconds to Time |
68
+ | `milliseconds(number)` | int32 millisecond input, with fractions truncated toward zero |
69
+ | `microseconds(bigint)` | Microsecond input |
70
+ | `asMicroseconds()`/`toDuration()` | Microsecond bigint |
71
+ | `asSeconds()`/`asMilliseconds()` | float32 seconds/int32 milliseconds |
72
+ | `Clock.start()`/`stop()` | Resume/pause timing |
73
+ | `Clock.restart()`/`reset()` | Return previous elapsed time, then zero and run/pause |
74
+
75
+ Time stores signed int64 microseconds, using bigint for integer scaling and number for floating-point scaling. `Time.Zero` is a read-only constant. Out-of-range values and invalid division throw RangeError; failed in-place operations preserve the original value.
76
+
77
+ Clock uses `process.hrtime.bigint()` and returns independent Time snapshots. It has no timer of its own; clock resolution and system-suspend semantics are determined by Node.js and the platform.
78
+
79
+ `sleep(time)` returns a promise and waits using a Node timer without blocking the event loop. Positive durations round up to milliseconds; zero and negative durations complete immediately. Actual resumption time depends on scheduling.
80
+
81
+ ### Timeout configuration
82
+
83
+ `TimeoutWithPredicate` stores a polling period and predicate; it does not start a timer itself:
84
+
85
+ - `new TimeoutWithPredicate(time)`: fixed period; the predicate always returns false.
86
+ - `new TimeoutWithPredicate(predicate, period?)`: default period of 1 ms; true means continue waiting.
87
+ - `getPeriod()` returns a read-only Time, and `getPredicate()` returns the original function.
88
+
89
+ The receiving API determines when checks occur. SFTP currently uses it to control waiting without progress; see [Network](network.md#sftp).
90
+
91
+ `SuspendAwareClock.now()` returns a native nanosecond time point that includes system suspend time. Only the Android branch supports it; desktop calls throw SFMLError. The current automatic download flow has no Android build target.
92
+
93
+ ## Colors, rectangles and vertices
94
+
95
+ | Type | Construction and main operations |
96
+ | --- | --- |
97
+ | Color | RGB/RGBA, `0xRRGGBBAA`, copying; `r/g/b/a`, `toInteger()` |
98
+ | FloatRect/IntRect | `position` + `size`, copying, explicit conversion; `contains()`, `findIntersection()`, `getCenter()` |
99
+ | Vertex | `position`, `color`, `texCoords`, or copy construction |
100
+
101
+ These values are primarily used by graphics APIs. Color components are stored as uint8, and direct writes narrow to that type. Color addition and subtraction saturate; multiplication computes `floor(a * b / 255)` per channel. Color constants are read-only.
102
+
103
+ Rectangle and vertex members are shared views. Rectangles include the left and top edges and exclude the right and bottom edges. Negative sizes use normalized bounds; an intersection without positive area returns `undefined`. Vertex defaults to zero position and texture coordinates, with white color.
104
+
105
+ <a id="input-streams"></a>
106
+
107
+ ## Input streams
108
+
109
+ InputStream is a seekable byte-stream protocol whose methods may return synchronous values or promises:
110
+
111
+ | Method | Return value |
112
+ | --- | --- |
113
+ | `read(data)` | Writes into a Uint8Array and returns the actual byte count as bigint; EOF is `0n` |
114
+ | `seek(position)` | Actual byte position as bigint |
115
+ | `tell()` | Current byte position as bigint |
116
+ | `getSize()` | Total byte count as bigint |
117
+
118
+ `undefined` indicates I/O failure; thrown errors propagate unchanged. Any object implementing these four methods can also be passed as a stream; a Node Readable needs an additional adapter to support seeking.
119
+
120
+ `MemoryInputStream(data)` retains a reference to the input bytes. Keep contents unchanged during loading and give each operation exclusive cursor access. `FileInputStream` uses a Node file handle, serializing asynchronous I/O and seeking per object:
121
+
122
+ ```typescript
123
+ import { FileInputStream, Image } from 'sfml.js';
124
+
125
+ async function readImage(filename: string) {
126
+ const stream = new FileInputStream();
127
+ try {
128
+ if (!await stream.open(filename)) throw new Error('Cannot open file');
129
+ const image = new Image();
130
+ if (!await image.loadFromStream(stream)) throw new Error('Cannot decode image');
131
+ return image;
132
+ } finally {
133
+ await stream.close();
134
+ }
135
+ }
136
+ ```
137
+
138
+ Wait for loading to finish before closing the stream. Await multiple loads on the same stream sequentially. FileInputStream supports file offsets from 0 to 2^53 - 1; EOF does not automatically close the file, so seeking again is allowed.
139
+
140
+ ## Unicode and version
141
+
142
+ `Unicode.isGraphemeBoundary(text, position)`, `isWordBoundary()` and `isSentenceBoundary()` use SFML's Unicode rules. position is a UTF-16 index into a JS string, ranging from 0 to `text.length`; the middle of a surrogate pair is not a boundary.
143
+
144
+ `version()` returns a cached, read-only SFML runtime version containing `major`, `minor`, `patch`, `isRelease` and `string`. It is not the npm package version.
145
+
146
+ ## Errors and logging
147
+
148
+ SFMLError indicates a binding or SFML runtime failure; test it with `instanceof SFMLError`. Argument errors use TypeError/RangeError; errors thrown by user callbacks propagate unchanged. Ordinary SFML failure statuses remain false/undefined rather than all being converted to exceptions.
149
+
150
+ `err()` returns a singleton Node Writable that writes to `sf::err()`. `setErrorOutput(writable)` redirects SFML logs; pass null to silence them, or no arguments to restore the default stderr:
151
+
152
+ ```typescript
153
+ import { createWriteStream } from 'node:fs';
154
+ import { finished } from 'node:stream/promises';
155
+ import { err, setErrorOutput } from 'sfml.js';
156
+
157
+ const output = createWriteStream('sfml.log');
158
+ setErrorOutput(output);
159
+ err().write('SFML diagnostic\n');
160
+ setErrorOutput();
161
+ output.end();
162
+ await finished(output);
163
+ ```
164
+
165
+ Log routing is process-wide, and Workers share the latest setting; Node's own stderr is unaffected. Background logs are dispatched in byte chunks without guaranteed UTF-8 character or line boundaries; use StringDecoder when parsing text.
166
+
167
+ <a id="sfml-cpp-reference"></a>
168
+
169
+ ## SFML C++ reference
170
+
171
+ The original references for [Vector2](https://www.sfml-dev.org/documentation/3.1.0/classsf_1_1Vector2.html), [Angle](https://www.sfml-dev.org/documentation/3.1.0/classsf_1_1Angle.html), [Time](https://www.sfml-dev.org/documentation/3.1.0/classsf_1_1Time.html), [Clock](https://www.sfml-dev.org/documentation/3.1.0/classsf_1_1Clock.html) and [InputStream](https://www.sfml-dev.org/documentation/3.1.0/classsf_1_1InputStream.html) describe the upstream math, time and stream concepts.
172
+
173
+ For JavaScript, follow this guide's named operators, bigint time representation, promise-based sleep and stream method contracts rather than copying C++ signatures.
@@ -0,0 +1,173 @@
1
+ # System
2
+
3
+ [English](system.md) · **简体中文** · [日本語](system.ja.md) · [한국어](system.ko.md)
4
+
5
+ > System 提供值类型、时间、输入流、Unicode 边界和错误处理。普通数值计算在 JS 中完成,资源相关操作按接口进入 Native。
6
+
7
+ [API 导航](api.zh-CN.md) · [核心概念](concepts.zh-CN.md)
8
+
9
+ ## 向量与运算
10
+
11
+ ```typescript
12
+ import { Vector2f, Vector2i, add, multiply, addAssign } from 'sfml.js';
13
+
14
+ const position = new Vector2f(10, 20);
15
+ const velocity = new Vector2f(2, 3);
16
+ const next = add(position, velocity);
17
+ const doubled = multiply(velocity, 2);
18
+ addAssign(position, velocity);
19
+ const pixels = new Vector2i(position);
20
+ ```
21
+
22
+ 普通运算返回独立值,`*Assign` 修改左操作数并返回它。赋值不自动转换向量的标量类型;需要转换时使用对应构造函数。
23
+
24
+ | 标量标签 | JS 分量类型 | 存储 |
25
+ | --- | --- | --- |
26
+ | `i8`/`u8` | number | Int8Array/Uint8Array |
27
+ | `i16`/`u16` | number | Int16Array/Uint16Array |
28
+ | `i32`/`u32` | number | Int32Array/Uint32Array |
29
+ | `i64`/`u64` | bigint | BigInt64Array/BigUint64Array |
30
+ | `f32`/`f64` | number | Float32Array/Float64Array |
31
+
32
+ `Vector2i/u/f` 和 `Vector3i/u/f` 分别对应 i32/u32/f32。其他标量使用 `new Vector2('f64', x, y)` 等形式。
33
+
34
+ 两种向量提供 `lengthSquared()`、`dot()`、`cross()` 和逐分量乘除,二维向量另有 `perpendicular()`。浮点向量提供 `length()` 与 `normalized()`,浮点二维向量还提供角度、旋转和投影操作。整数向量不支持浮点专属方法。
35
+
36
+ 向量的 `multiply()`/`divide()` 使用标量,逐分量操作使用 `componentWiseMul()`/`componentWiseDiv()`。零除数、零向量归一化和向零轴投影会抛错。64 位整数计算保留 bigint;f32 计算按 SFML 的精度规则舍入,三角运算允许平台数学库的有限差异。
37
+
38
+ ## 角度
39
+
40
+ ```typescript
41
+ import { Angle, degrees, radians, divide } from 'sfml.js';
42
+
43
+ const heading = degrees(90);
44
+ const turn = radians(Math.PI);
45
+ const copy = new Angle(heading);
46
+ const ratio = divide(turn, heading);
47
+ console.log(copy.asDegrees(), ratio);
48
+ ```
49
+
50
+ 旋转接口接受 Angle。`wrapSigned()`、`wrapUnsigned()` 返回折回后的角度;比较不会自动折回。`Angle.Zero` 为只读常量,复制后可修改。Angle 使用 float32,取模要求正除数。
51
+
52
+ ## 时间与时钟
53
+
54
+ ```typescript
55
+ import { Clock, milliseconds, microseconds, sleep } from 'sfml.js';
56
+
57
+ const clock = new Clock();
58
+ await sleep(milliseconds(16));
59
+ const elapsed = clock.restart();
60
+ console.log(elapsed.asSeconds(), elapsed.asMicroseconds());
61
+ console.log(microseconds(1000n).asMilliseconds());
62
+ ```
63
+
64
+ | 接口 | 语义 |
65
+ | --- | --- |
66
+ | `new Time()`/`new Time(source)`/`new Time(bigint)` | 零时长、复制、微秒构造 |
67
+ | `seconds(number)` | 秒转换为 Time |
68
+ | `milliseconds(number)` | int32 毫秒输入,小数向零截断 |
69
+ | `microseconds(bigint)` | 微秒输入 |
70
+ | `asMicroseconds()`/`toDuration()` | 微秒 bigint |
71
+ | `asSeconds()`/`asMilliseconds()` | float32 秒/int32 毫秒 |
72
+ | `Clock.start()`/`stop()` | 继续/暂停计时 |
73
+ | `Clock.restart()`/`reset()` | 返回原耗时,清零后运行/暂停 |
74
+
75
+ Time 保存有符号 int64 微秒,整数倍运算使用 bigint,浮点倍数使用 number。`Time.Zero` 为只读常量。超范围和非法除法抛出 RangeError,失败的原位运算保留原值。
76
+
77
+ Clock 使用 `process.hrtime.bigint()`,返回独立 Time 快照。它没有自己的定时器,时钟分辨率与系统休眠语义由 Node.js 和平台决定。
78
+
79
+ `sleep(time)` 返回 Promise,通过 Node 定时器等待,不阻塞事件循环。正时长向上取整到毫秒;零与负时长直接完成,实际恢复时间受调度影响。
80
+
81
+ ### 超时配置
82
+
83
+ `TimeoutWithPredicate` 保存检查周期与谓词,本身不启动计时器:
84
+
85
+ - `new TimeoutWithPredicate(time)`:固定周期,谓词始终返回 false。
86
+ - `new TimeoutWithPredicate(predicate, period?)`:默认周期 1 ms,true 表示继续等待。
87
+ - `getPeriod()` 返回只读 Time,`getPredicate()` 返回原函数。
88
+
89
+ 接收它的接口决定何时检查,当前 SFTP 使用它控制无进展等待,详见 [Network](network.zh-CN.md#sftp)。
90
+
91
+ `SuspendAwareClock.now()` 返回包含系统休眠时间的原生纳秒时间点,仅 Android 分支支持;桌面调用抛出 SFMLError。当前自动下载流程没有 Android 构建目标。
92
+
93
+ ## 颜色、矩形与顶点
94
+
95
+ | 类型 | 构造与主要操作 |
96
+ | --- | --- |
97
+ | Color | RGB/RGBA、`0xRRGGBBAA`、复制;`r/g/b/a`、`toInteger()` |
98
+ | FloatRect/IntRect | `position` + `size`、复制、显式转换;`contains()`、`findIntersection()`、`getCenter()` |
99
+ | Vertex | `position`、`color`、`texCoords`,或复制构造 |
100
+
101
+ 这些值主要用于图形接口。Color 分量按 uint8 存储,直接写入会窄化;颜色加减是饱和运算,颜色相乘按通道计算 `floor(a * b / 255)`。Color 常量只读。
102
+
103
+ 矩形成员和顶点成员是共享视图。矩形包含左、上边界,排除右、下边界;负尺寸按归一化范围计算,交集无正面积时返回 `undefined`。Vertex 默认位置、纹理坐标为零,颜色为白色。
104
+
105
+ <a id="input-streams"></a>
106
+
107
+ ## 输入流
108
+
109
+ InputStream 是可寻址字节流协议,方法可返回同步值或 Promise:
110
+
111
+ | 方法 | 返回值 |
112
+ | --- | --- |
113
+ | `read(data)` | 写入 Uint8Array,返回实际字节数 bigint;EOF 为 `0n` |
114
+ | `seek(position)` | 返回实际字节位置 bigint |
115
+ | `tell()` | 当前字节位置 bigint |
116
+ | `getSize()` | 总字节数 bigint |
117
+
118
+ `undefined` 表示 I/O 失败,抛出的错误原样传播。实现这四个方法的对象也可以作为流传入;Node Readable 需额外适配寻址能力。
119
+
120
+ `MemoryInputStream(data)` 保留输入字节引用。加载期间保持内容不变,并让单次操作独占游标。`FileInputStream` 使用 Node 文件句柄,按对象串行执行异步读写与寻址:
121
+
122
+ ```typescript
123
+ import { FileInputStream, Image } from 'sfml.js';
124
+
125
+ async function readImage(filename: string) {
126
+ const stream = new FileInputStream();
127
+ try {
128
+ if (!await stream.open(filename)) throw new Error('Cannot open file');
129
+ const image = new Image();
130
+ if (!await image.loadFromStream(stream)) throw new Error('Cannot decode image');
131
+ return image;
132
+ } finally {
133
+ await stream.close();
134
+ }
135
+ }
136
+ ```
137
+
138
+ 等待加载完成后再关闭流。同一个流的多次加载应逐次 await。FileInputStream 的文件偏移范围为 0~2⁵³−1;EOF 不会自动关闭文件,允许再次 seek。
139
+
140
+ ## Unicode 与版本
141
+
142
+ `Unicode.isGraphemeBoundary(text, position)`、`isWordBoundary()`、`isSentenceBoundary()` 使用 SFML 的 Unicode 规则。position 是 JS 字符串的 UTF-16 下标,范围为 0~`text.length`;代理对中间不是边界。
143
+
144
+ `version()` 返回缓存的只读 SFML 运行时版本,包含 `major`、`minor`、`patch`、`isRelease` 与 `string`。它不是 npm 包版本。
145
+
146
+ ## 错误与日志
147
+
148
+ SFMLError 表示绑定层或 SFML 运行失败,可用 `instanceof SFMLError` 判断。参数错误使用 TypeError/RangeError;用户回调抛出的错误原样传播。SFML 返回的普通失败状态仍是 false/undefined,不会全部转换成异常。
149
+
150
+ `err()` 返回单例 Node Writable,写入 `sf::err()`。`setErrorOutput(writable)` 重定向 SFML 日志,传入 null 静音,不传参数恢复默认 stderr:
151
+
152
+ ```typescript
153
+ import { createWriteStream } from 'node:fs';
154
+ import { finished } from 'node:stream/promises';
155
+ import { err, setErrorOutput } from 'sfml.js';
156
+
157
+ const output = createWriteStream('sfml.log');
158
+ setErrorOutput(output);
159
+ err().write('SFML diagnostic\n');
160
+ setErrorOutput();
161
+ output.end();
162
+ await finished(output);
163
+ ```
164
+
165
+ 日志路由是进程级配置,Worker 共用最近的设置;Node 自身的 stderr 不受影响。后台日志按字节块派发,不保证 UTF-8 字符或行边界,解析文本时可使用 StringDecoder。
166
+
167
+ <a id="sfml-cpp-reference"></a>
168
+
169
+ ## SFML C++ 参考
170
+
171
+ 数学与时间参考 [sf::Vector2](https://www.sfml-dev.org/documentation/3.1.0/classsf_1_1Vector2.html)、[sf::Angle](https://www.sfml-dev.org/documentation/3.1.0/classsf_1_1Angle.html)、[sf::Time](https://www.sfml-dev.org/documentation/3.1.0/classsf_1_1Time.html) 和 [sf::Clock](https://www.sfml-dev.org/documentation/3.1.0/classsf_1_1Clock.html);流协议参考 [sf::InputStream](https://www.sfml-dev.org/documentation/3.1.0/classsf_1_1InputStream.html)。
172
+
173
+ 上游说明可用于理解数学、时间和流的概念。JS 使用具名运算符、bigint 微秒、Promise sleep 和可异步的输入流方法,调用方式及边界以本文为准。
@@ -0,0 +1,138 @@
1
+ # Window
2
+
3
+ [English](window.md) / [简体中文](window.zh-CN.md) / **日本語** / [한국어](window.ko.md)
4
+
5
+ > 2D 描画には RenderWindow を使い、OpenGL を自分で組み込む場合は Window を利用できます。ウィンドウ操作はメインスレッドで実行します。
6
+
7
+ [API ナビゲーション](api.ja.md) · [Graphics](graphics.ja.md) · [クイックスタート](getting-started.ja.md)
8
+
9
+ ## 作成と終了
10
+
11
+ ```typescript
12
+ import { RenderWindow, VideoMode, Vector2u, State, Style } from 'sfml.js';
13
+
14
+ const window = new RenderWindow(
15
+ new VideoMode(new Vector2u(800, 600)),
16
+ 'sfml.js',
17
+ {
18
+ style: Style.Default,
19
+ state: State.Windowed,
20
+ settings: { depthBits: 24, stencilBits: 8 },
21
+ },
22
+ );
23
+ window.close();
24
+ ```
25
+
26
+ Window と RenderWindow は空のコンストラクターで作成してから `create()` を呼ぶ方法に対応しています。Vector2u のサイズや、既存の OS ウィンドウの bigint ハンドルも受け取れます。`close()` はウィンドウを閉じますが、JS オブジェクトは再び create できます。
27
+
28
+ RenderWindow は `instanceof Window` と `instanceof RenderTarget` の両方を満たします。直接描画でき、マウスの相対座標を照会できるほか、`Texture.update(window)` の入力元にも使えます。
29
+
30
+ | インターフェース | 用途 |
31
+ | --- | --- |
32
+ | `get/setPosition()`、`get/setSize()` | ウィンドウの位置とクライアント領域のサイズ |
33
+ | `setMinimumSize()`、`setMaximumSize()` | サイズ制限。undefined で制限を解除 |
34
+ | `setTitle()`、`setVisible()`、`setIcon()` | タイトル、表示と非表示、RGBA アイコン |
35
+ | `requestFocus()`、`hasFocus()` | フォーカスの要求と照会 |
36
+ | `setMouseCursor()`、`setMouseCursorVisible()`、`setMouseCursorGrabbed()` | カーソルとマウスの移動範囲の制限 |
37
+ | `setKeyRepeatEnabled()`、`setJoystickThreshold()` | 入力の挙動 |
38
+ | `setVerticalSyncEnabled()`、`setFramerateLimit()` | 表示のタイミング |
39
+ | `getSettings()`、`getNativeHandle()` | 実際のコンテキスト設定と OS ウィンドウのハンドル |
40
+
41
+ 位置には Vector2i、サイズには Vector2u を使います。`setIcon(size, pixels)` は RGBA8 のバイト列を受け取り、RenderWindow では Image も受け取れます。
42
+
43
+ ## イベントループ
44
+
45
+ ```typescript
46
+ import { RenderWindow, Vector2u, Keyboard } from 'sfml.js';
47
+
48
+ const window = new RenderWindow(new Vector2u(800, 600), 'Events');
49
+ window.setFramerateLimit(60);
50
+
51
+ function frame() {
52
+ window.handleEvents({
53
+ Closed: () => window.close(),
54
+ KeyPressed: event => {
55
+ if (event.code === Keyboard.Key.Escape) window.close();
56
+ },
57
+ Resized: event => console.log(event.size.x, event.size.y),
58
+ });
59
+ if (!window.isOpen()) return;
60
+ window.clear();
61
+ window.display();
62
+ setImmediate(frame);
63
+ }
64
+ frame();
65
+ ```
66
+
67
+ `handleEvents(handlers, fallback?)` はイベントキューを空になるまで処理し、対応する型のハンドラーを優先して呼び出します。単一の関数を渡して、すべてのイベントを処理することもできます。
68
+
69
+ 手動で振り分けたい場合は `pollEvent()` を使います。
70
+
71
+ ```typescript
72
+ let event;
73
+ while ((event = window.pollEvent())) {
74
+ if (event.is('Closed')) window.close();
75
+ const key = event.getIf('KeyPressed');
76
+ if (key) console.log(key.code, key.scancode);
77
+ }
78
+ ```
79
+
80
+ `pollEvent()` はイベントがなければ undefined を返します。Event の data は kind を判別子とするユニオン型です。`is()`、`getIf()`、`visit()` で型を絞り込んだりデータにアクセスしたりできます。TextEntered は Unicode コードポイントを使います。
81
+
82
+ `waitEvent(timeout = Time.Zero)` は同期的にブロックするインターフェースで、タイムアウトまたはウィンドウの終了時に undefined を返します。Node の I/O も処理するフレームループでは pollEvent/handleEvents を使い、フレーム間でイベントループに制御を返してください。
83
+
84
+ ## リアルタイム入力とシステム機能
85
+
86
+ | インターフェース | 説明 |
87
+ | --- | --- |
88
+ | `Keyboard.isKeyPressed(key)` | 現在のキーコードの状態 |
89
+ | `Keyboard.isKeyPressed(scancode, 'scancode')` | 現在の物理スキャンコードの状態 |
90
+ | `Keyboard.localize()`/`delocalize()`/`getDescription()` | 現在のキーボード配列とのマッピングと説明 |
91
+ | `Mouse.getPosition(window?)`/`setPosition(position, window?)` | ウィンドウを省略した場合はスクリーン座標を使用 |
92
+ | `Mouse.isButtonPressed(button)` | 現在のマウスボタンの状態 |
93
+ | Joystick | 接続、ボタン、軸、デバイス識別情報。ウィンドウループがない場合は `update()` を呼ぶ |
94
+ | Sensor | 最初に `isAvailable()` を確認し、その後に有効化と読み取りを行う |
95
+ | Clipboard | `getString()`/`setString()`。JS の Unicode 文字列に対応 |
96
+ | Touch | タッチ点の状態と位置。SFML 3.1.0 ではリアルタイム Touch API は非推奨 |
97
+
98
+ 入力名前空間内の列挙型とトップレベルの列挙型は同じオブジェクトを共有します。たとえば `Keyboard.Key` と `KeyboardKey` が該当します。
99
+
100
+ `Cursor.createFromSystem()`、`createFromPixels()` は失敗時に undefined を返し、コンストラクターは失敗時に例外を投げます。ウィンドウは使用中の Cursor の寿命を維持します。macOS では、システムカーソルを使う前にウィンドウを作成する必要があります。
101
+
102
+ VideoMode は `size` と `bitsPerPixel` を使います。`getDesktopMode()`、`getFullscreenModes()` でデバイスのモードを照会し、`isValid()` でフルスクリーンモードの有効性を判定します。特定の数のフルスクリーンモードが必ず提供されるとは想定しないでください。
103
+
104
+ ## OpenGL と Vulkan
105
+
106
+ Context は独立した OpenGL コンテキストを作成でき、有効化、実際の設定、拡張の照会、関数アドレスの照会を提供します。`Context.getActiveContextId()` は bigint を返し、有効なコンテキストがなければ `0n` です。`getFunction()` はアドレスを bigint で返します。その関数を呼び出すには、シグネチャが一致するネイティブコードが必要です。
107
+
108
+ RenderWindow の `setActive()`、`pushGLStates()`、`popGLStates()`、`resetGLStates()` は、SFML と独自の OpenGL 処理を混在させるために使います。GL の状態を直接変更する前に SFML のコマンドを送信してください。push/pop は同じコンテキスト内で対にする必要があります。
109
+
110
+ Vulkan 名前空間は以下を提供します。
111
+
112
+ - `isAvailable(requireGraphics = true)`。
113
+ - `getFunction(name)`。
114
+ - `getGraphicsRequiredInstanceExtensions()`。
115
+
116
+ `window.createVulkanSurface(instance, allocator = 0n)` はサーフェスハンドルを bigint で返し、失敗時は undefined です。インスタンス、アロケーター、サーフェスの破棄は呼び出し側が管理します。
117
+
118
+ SFML 3.1.0 の macOS ビルドには Vulkan バックエンドがありません。これらの照会は利用不可を示し、MoltenVK をインストールしても SFML のこのプラットフォーム分岐は変わりません。Windows/X11 の成功経路は、それぞれの環境で検証する必要があります。
119
+
120
+ ## デモの実行
121
+
122
+ ビルド後に `node examples/window.cjs --frames=120` を実行すると、イベント、キーコード、ポインターの位置、ウィンドウのプロパティを確認できます。フレーム数を省略すると継続して実行します。
123
+
124
+ | キー | 動作 |
125
+ | --- | --- |
126
+ | F1/F2 | カーソルの種類/表示と非表示 |
127
+ | F3/F4 | キーリピート/垂直同期 |
128
+ | F5/F6 | ウィンドウサイズ/サイズ制限 |
129
+ | F7/F8 | タイトルの変更/1 秒間非表示にしてから復元 |
130
+ | F9/F10 | イベント API/ウィンドウの移動 |
131
+ | Esc | 閉じる |
132
+
133
+ macOS では Fn キーも同時に押す必要がある場合があります。ジョイスティック、センサー、タッチ、Vulkan の機能は、デバイスの照会結果に基づいて判断してください。CI のビルド成功は、これらのハードウェア固有の処理がすべて検証済みであることを意味しません。
134
+
135
+ <a id="sfml-cpp-reference"></a>
136
+ ## SFML C++ リファレンス
137
+
138
+ 上流の [Window](https://www.sfml-dev.org/documentation/3.1.0/classsf_1_1Window.html)、[RenderWindow](https://www.sfml-dev.org/documentation/3.1.0/classsf_1_1RenderWindow.html)、[Event](https://www.sfml-dev.org/documentation/3.1.0/classsf_1_1Event.html)、[VideoMode](https://www.sfml-dev.org/documentation/3.1.0/classsf_1_1VideoMode.html)、[Cursor](https://www.sfml-dev.org/documentation/3.1.0/classsf_1_1Cursor.html) では、ウィンドウ、イベント型、座標規則を確認できます。それらの概念はこのガイドで説明する範囲で適用されますが、JS では文字列と型付きペイロードでイベントを振り分け、`setImmediate()` でイベントループに制御を返します。`waitEvent()` は同期的に待機する点に注意してください。
@@ -0,0 +1,140 @@
1
+ # Window
2
+
3
+ [English](window.md) / [简体中文](window.zh-CN.md) / [日本語](window.ja.md) / **한국어**
4
+
5
+ > 2D 그리기에는 RenderWindow를 사용하고, OpenGL을 직접 연결할 때는 Window를 사용할 수 있습니다. 창 작업은 메인 스레드에서 실행합니다.
6
+
7
+ [API 안내](api.ko.md) · [Graphics](graphics.ko.md) · [빠른 시작](getting-started.ko.md)
8
+
9
+ ## 생성과 닫기
10
+
11
+ ```typescript
12
+ import { RenderWindow, VideoMode, Vector2u, State, Style } from 'sfml.js';
13
+
14
+ const window = new RenderWindow(
15
+ new VideoMode(new Vector2u(800, 600)),
16
+ 'sfml.js',
17
+ {
18
+ style: Style.Default,
19
+ state: State.Windowed,
20
+ settings: { depthBits: 24, stencilBits: 8 },
21
+ },
22
+ );
23
+ window.close();
24
+ ```
25
+
26
+ Window와 RenderWindow는 빈 생성자로 만든 뒤 `create()`를 호출할 수 있으며, Vector2u 크기나 기존 시스템 창의 bigint 핸들도 받습니다. `close()`는 창을 닫으며, JS 객체에서는 다시 create를 호출할 수 있습니다.
27
+
28
+ RenderWindow는 `instanceof Window`와 `instanceof RenderTarget`을 모두 만족합니다. 직접 그리거나 창 기준 마우스 좌표를 조회할 수 있고, `Texture.update(window)`의 소스로도 사용할 수 있습니다.
29
+
30
+ | 인터페이스 | 용도 |
31
+ | --- | --- |
32
+ | `get/setPosition()`, `get/setSize()` | 창 위치와 클라이언트 영역 크기 |
33
+ | `setMinimumSize()`, `setMaximumSize()` | 크기 제한. undefined로 제한 해제 |
34
+ | `setTitle()`, `setVisible()`, `setIcon()` | 제목, 표시 여부, RGBA 아이콘 |
35
+ | `requestFocus()`, `hasFocus()` | 포커스 요청과 조회 |
36
+ | `setMouseCursor()`, `setMouseCursorVisible()`, `setMouseCursorGrabbed()` | 커서 및 마우스 이동 제한 |
37
+ | `setKeyRepeatEnabled()`, `setJoystickThreshold()` | 입력 동작 |
38
+ | `setVerticalSyncEnabled()`, `setFramerateLimit()` | 프레임 표시 간격 |
39
+ | `getSettings()`, `getNativeHandle()` | 실제 컨텍스트 설정과 시스템 창 핸들 |
40
+
41
+ 위치는 Vector2i, 크기는 Vector2u를 사용합니다. `setIcon(size, pixels)`는 RGBA8 바이트를 받으며, RenderWindow에서는 Image도 받습니다.
42
+
43
+ ## 이벤트 루프
44
+
45
+ ```typescript
46
+ import { RenderWindow, Vector2u, Keyboard } from 'sfml.js';
47
+
48
+ const window = new RenderWindow(new Vector2u(800, 600), 'Events');
49
+ window.setFramerateLimit(60);
50
+
51
+ function frame() {
52
+ window.handleEvents({
53
+ Closed: () => window.close(),
54
+ KeyPressed: event => {
55
+ if (event.code === Keyboard.Key.Escape) window.close();
56
+ },
57
+ Resized: event => console.log(event.size.x, event.size.y),
58
+ });
59
+ if (!window.isOpen()) return;
60
+ window.clear();
61
+ window.display();
62
+ setImmediate(frame);
63
+ }
64
+ frame();
65
+ ```
66
+
67
+ `handleEvents(handlers, fallback?)`는 이벤트 큐를 비우며, 해당 타입의 핸들러를 우선 호출합니다. 하나의 함수로 모든 이벤트를 처리하도록 전달할 수도 있습니다.
68
+
69
+ 직접 분기해야 한다면 `pollEvent()`를 사용하세요.
70
+
71
+ ```typescript
72
+ let event;
73
+ while ((event = window.pollEvent())) {
74
+ if (event.is('Closed')) window.close();
75
+ const key = event.getIf('KeyPressed');
76
+ if (key) console.log(key.code, key.scancode);
77
+ }
78
+ ```
79
+
80
+ `pollEvent()`는 이벤트가 없으면 undefined를 반환합니다. Event의 data는 kind로 구분하는 유니온 타입이며, `is()`, `getIf()`, `visit()`으로 타입을 좁히거나 데이터에 접근할 수 있습니다. TextEntered는 Unicode 코드 포인트를 사용합니다.
81
+
82
+ `waitEvent(timeout = Time.Zero)`는 동기식 블로킹 인터페이스로, 타임아웃되거나 창이 닫히면 undefined를 반환합니다. Node I/O를 함께 처리해야 하는 프레임 루프에서는 pollEvent/handleEvents를 사용하고, 프레임 사이에 이벤트 루프에 제어권을 넘기세요.
83
+
84
+ ## 실시간 입력과 시스템 기능
85
+
86
+ | 인터페이스 | 설명 |
87
+ | --- | --- |
88
+ | `Keyboard.isKeyPressed(key)` | 현재 키 코드 상태 |
89
+ | `Keyboard.isKeyPressed(scancode, 'scancode')` | 현재 물리 스캔 코드 상태 |
90
+ | `Keyboard.localize()`/`delocalize()`/`getDescription()` | 현재 키보드 레이아웃 매핑과 설명 |
91
+ | `Mouse.getPosition(window?)`/`setPosition(position, window?)` | 창을 생략하면 화면 좌표 사용 |
92
+ | `Mouse.isButtonPressed(button)` | 현재 마우스 버튼 상태 |
93
+ | Joystick | 연결, 버튼, 축, 장치 식별 정보. 창 루프가 없으면 `update()` 호출 |
94
+ | Sensor | 먼저 `isAvailable()`로 확인한 뒤 활성화하고 읽기 |
95
+ | Clipboard | `getString()`/`setString()`, JS Unicode 문자열 지원 |
96
+ | Touch | 터치 접점 상태와 위치. SFML 3.1.0에서 실시간 Touch API는 사용 중단 예정으로 지정됨 |
97
+
98
+ 입력 네임스페이스의 열거형과 최상위 열거형은 같은 객체를 공유합니다. 예를 들어 `Keyboard.Key`와 `KeyboardKey`가 그렇습니다.
99
+
100
+ `Cursor.createFromSystem()`, `createFromPixels()`는 실패 시 undefined를 반환하지만, 생성자 실패는 예외를 발생시킵니다. 창은 사용 중인 Cursor의 수명을 유지합니다. macOS에서는 시스템 커서를 사용하기 전에 창을 먼저 생성해야 합니다.
101
+
102
+ VideoMode는 `size`와 `bitsPerPixel`을 사용합니다. `getDesktopMode()`, `getFullscreenModes()`는 장치 모드를 조회하고, `isValid()`는 전체 화면 모드의 유효성을 판단합니다. 모든 컴퓨터가 특정 개수의 전체 화면 모드를 제공한다고 가정하지 마세요.
103
+
104
+ ## OpenGL과 Vulkan
105
+
106
+ Context는 독립적인 OpenGL 컨텍스트를 생성하며, 활성화, 실제 설정, 확장 조회, 함수 주소 조회 기능을 제공합니다. `Context.getActiveContextId()`는 bigint를 반환하고, 활성 컨텍스트가 없으면 `0n`입니다. `getFunction()`은 주소를 bigint로 반환하며, 이를 호출하려면 일치하는 시그니처의 네이티브 코드가 필요합니다.
107
+
108
+ RenderWindow의 `setActive()`, `pushGLStates()`, `popGLStates()`, `resetGLStates()`는 SFML과 사용자 정의 OpenGL을 함께 사용할 때 쓰입니다. GL 상태를 직접 수정하기 전에 SFML 명령을 제출하세요. push/pop은 같은 컨텍스트에서 쌍을 이루어야 합니다.
109
+
110
+ Vulkan 네임스페이스는 다음을 제공합니다.
111
+
112
+ - `isAvailable(requireGraphics = true)`.
113
+ - `getFunction(name)`.
114
+ - `getGraphicsRequiredInstanceExtensions()`.
115
+
116
+ `window.createVulkanSurface(instance, allocator = 0n)`는 bigint 서피스 핸들을 반환하고, 실패하면 undefined를 반환합니다. 인스턴스, 할당자, 서피스의 해제는 호출자가 책임집니다.
117
+
118
+ SFML 3.1.0의 macOS 빌드는 Vulkan 백엔드를 제공하지 않습니다. 이 조회 함수들은 사용 불가 상태를 반환하며, MoltenVK를 설치해도 SFML의 해당 플랫폼 분기는 바뀌지 않습니다. Windows/X11에서의 성공 경로는 해당 환경에서 검증해야 합니다.
119
+
120
+ ## 데모 실행
121
+
122
+ 빌드 후 `node examples/window.cjs --frames=120`을 실행하면 이벤트, 키 코드, 포인터 위치, 창 속성을 확인할 수 있습니다. 프레임 수를 생략하면 계속 실행됩니다.
123
+
124
+ | 키 | 동작 |
125
+ | --- | --- |
126
+ | F1/F2 | 커서 종류/표시 여부 |
127
+ | F3/F4 | 키 반복/수직 동기화 |
128
+ | F5/F6 | 창 크기/크기 제한 |
129
+ | F7/F8 | 제목 변경/1초 동안 숨긴 뒤 복원 |
130
+ | F9/F10 | 이벤트 API/창 이동 |
131
+ | Esc | 닫기 |
132
+
133
+ macOS에서는 Fn 키를 함께 눌러야 할 수 있습니다. 조이스틱, 센서, 터치, Vulkan 기능은 장치 조회 결과로 판단하세요. CI 빌드 통과가 이러한 하드웨어 경로를 모두 검증했다는 뜻은 아닙니다.
134
+
135
+ <a id="sfml-cpp-reference"></a>
136
+ ## SFML C++ 레퍼런스
137
+
138
+ 원본 클래스 문서: [Window](https://www.sfml-dev.org/documentation/3.1.0/classsf_1_1Window.html), [RenderWindow](https://www.sfml-dev.org/documentation/3.1.0/classsf_1_1RenderWindow.html), [Event](https://www.sfml-dev.org/documentation/3.1.0/classsf_1_1Event.html), [VideoMode](https://www.sfml-dev.org/documentation/3.1.0/classsf_1_1VideoMode.html), [Cursor](https://www.sfml-dev.org/documentation/3.1.0/classsf_1_1Cursor.html).
139
+
140
+ C++ 문서의 이벤트 타입과 좌표 규칙을 참고하되, JS에서는 문자열과 타입이 지정된 페이로드로 이벤트를 분기합니다. 프레임 사이에는 `setImmediate()`로 제어권을 넘기며, `waitEvent()`는 동기식이라는 점을 유지해야 합니다.