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
@@ -1,420 +0,0 @@
1
- ////////////////////////////////////////////////////////////
2
- //
3
- // SFML - Simple and Fast Multimedia Library
4
- // Copyright (C) 2007-2023 Laurent Gomila (laurent@sfml-dev.org)
5
- //
6
- // This software is provided 'as-is', without any express or implied warranty.
7
- // In no event will the authors be held liable for any damages arising from the use of this software.
8
- //
9
- // Permission is granted to anyone to use this software for any purpose,
10
- // including commercial applications, and to alter it and redistribute it freely,
11
- // subject to the following restrictions:
12
- //
13
- // 1. The origin of this software must not be misrepresented;
14
- // you must not claim that you wrote the original software.
15
- // If you use this software in a product, an acknowledgment
16
- // in the product documentation would be appreciated but is not required.
17
- //
18
- // 2. Altered source versions must be plainly marked as such,
19
- // and must not be misrepresented as being the original software.
20
- //
21
- // 3. This notice may not be removed or altered from any source distribution.
22
- //
23
- ////////////////////////////////////////////////////////////
24
-
25
- #ifndef SFML_SOUNDSTREAM_HPP
26
- #define SFML_SOUNDSTREAM_HPP
27
-
28
- ////////////////////////////////////////////////////////////
29
- // Headers
30
- ////////////////////////////////////////////////////////////
31
- #include <SFML/Audio/Export.hpp>
32
- #include <SFML/Audio/SoundSource.hpp>
33
- #include <SFML/System/Thread.hpp>
34
- #include <SFML/System/Time.hpp>
35
- #include <SFML/System/Mutex.hpp>
36
- #include <cstdlib>
37
-
38
-
39
- namespace sf
40
- {
41
- ////////////////////////////////////////////////////////////
42
- /// \brief Abstract base class for streamed audio sources
43
- ///
44
- ////////////////////////////////////////////////////////////
45
- class SFML_AUDIO_API SoundStream : public SoundSource
46
- {
47
- public:
48
-
49
- ////////////////////////////////////////////////////////////
50
- /// \brief Structure defining a chunk of audio data to stream
51
- ///
52
- ////////////////////////////////////////////////////////////
53
- struct Chunk
54
- {
55
- const Int16* samples; //!< Pointer to the audio samples
56
- std::size_t sampleCount; //!< Number of samples pointed by Samples
57
- };
58
-
59
- ////////////////////////////////////////////////////////////
60
- /// \brief Destructor
61
- ///
62
- ////////////////////////////////////////////////////////////
63
- virtual ~SoundStream();
64
-
65
- ////////////////////////////////////////////////////////////
66
- /// \brief Start or resume playing the audio stream
67
- ///
68
- /// This function starts the stream if it was stopped, resumes
69
- /// it if it was paused, and restarts it from the beginning if
70
- /// it was already playing.
71
- /// This function uses its own thread so that it doesn't block
72
- /// the rest of the program while the stream is played.
73
- ///
74
- /// \see pause, stop
75
- ///
76
- ////////////////////////////////////////////////////////////
77
- void play();
78
-
79
- ////////////////////////////////////////////////////////////
80
- /// \brief Pause the audio stream
81
- ///
82
- /// This function pauses the stream if it was playing,
83
- /// otherwise (stream already paused or stopped) it has no effect.
84
- ///
85
- /// \see play, stop
86
- ///
87
- ////////////////////////////////////////////////////////////
88
- void pause();
89
-
90
- ////////////////////////////////////////////////////////////
91
- /// \brief Stop playing the audio stream
92
- ///
93
- /// This function stops the stream if it was playing or paused,
94
- /// and does nothing if it was already stopped.
95
- /// It also resets the playing position (unlike pause()).
96
- ///
97
- /// \see play, pause
98
- ///
99
- ////////////////////////////////////////////////////////////
100
- void stop();
101
-
102
- ////////////////////////////////////////////////////////////
103
- /// \brief Return the number of channels of the stream
104
- ///
105
- /// 1 channel means a mono sound, 2 means stereo, etc.
106
- ///
107
- /// \return Number of channels
108
- ///
109
- ////////////////////////////////////////////////////////////
110
- unsigned int getChannelCount() const;
111
-
112
- ////////////////////////////////////////////////////////////
113
- /// \brief Get the stream sample rate of the stream
114
- ///
115
- /// The sample rate is the number of audio samples played per
116
- /// second. The higher, the better the quality.
117
- ///
118
- /// \return Sample rate, in number of samples per second
119
- ///
120
- ////////////////////////////////////////////////////////////
121
- unsigned int getSampleRate() const;
122
-
123
- ////////////////////////////////////////////////////////////
124
- /// \brief Get the current status of the stream (stopped, paused, playing)
125
- ///
126
- /// \return Current status
127
- ///
128
- ////////////////////////////////////////////////////////////
129
- Status getStatus() const;
130
-
131
- ////////////////////////////////////////////////////////////
132
- /// \brief Change the current playing position of the stream
133
- ///
134
- /// The playing position can be changed when the stream is
135
- /// either paused or playing. Changing the playing position
136
- /// when the stream is stopped has no effect, since playing
137
- /// the stream would reset its position.
138
- ///
139
- /// \param timeOffset New playing position, from the beginning of the stream
140
- ///
141
- /// \see getPlayingOffset
142
- ///
143
- ////////////////////////////////////////////////////////////
144
- void setPlayingOffset(Time timeOffset);
145
-
146
- ////////////////////////////////////////////////////////////
147
- /// \brief Get the current playing position of the stream
148
- ///
149
- /// \return Current playing position, from the beginning of the stream
150
- ///
151
- /// \see setPlayingOffset
152
- ///
153
- ////////////////////////////////////////////////////////////
154
- Time getPlayingOffset() const;
155
-
156
- ////////////////////////////////////////////////////////////
157
- /// \brief Set whether or not the stream should loop after reaching the end
158
- ///
159
- /// If set, the stream will restart from beginning after
160
- /// reaching the end and so on, until it is stopped or
161
- /// setLoop(false) is called.
162
- /// The default looping state for streams is false.
163
- ///
164
- /// \param loop True to play in loop, false to play once
165
- ///
166
- /// \see getLoop
167
- ///
168
- ////////////////////////////////////////////////////////////
169
- void setLoop(bool loop);
170
-
171
- ////////////////////////////////////////////////////////////
172
- /// \brief Tell whether or not the stream is in loop mode
173
- ///
174
- /// \return True if the stream is looping, false otherwise
175
- ///
176
- /// \see setLoop
177
- ///
178
- ////////////////////////////////////////////////////////////
179
- bool getLoop() const;
180
-
181
- protected:
182
-
183
- enum
184
- {
185
- NoLoop = -1 //!< "Invalid" endSeeks value, telling us to continue uninterrupted
186
- };
187
-
188
- ////////////////////////////////////////////////////////////
189
- /// \brief Default constructor
190
- ///
191
- /// This constructor is only meant to be called by derived classes.
192
- ///
193
- ////////////////////////////////////////////////////////////
194
- SoundStream();
195
-
196
- ////////////////////////////////////////////////////////////
197
- /// \brief Define the audio stream parameters
198
- ///
199
- /// This function must be called by derived classes as soon
200
- /// as they know the audio settings of the stream to play.
201
- /// Any attempt to manipulate the stream (play(), ...) before
202
- /// calling this function will fail.
203
- /// It can be called multiple times if the settings of the
204
- /// audio stream change, but only when the stream is stopped.
205
- ///
206
- /// \param channelCount Number of channels of the stream
207
- /// \param sampleRate Sample rate, in samples per second
208
- ///
209
- ////////////////////////////////////////////////////////////
210
- void initialize(unsigned int channelCount, unsigned int sampleRate);
211
-
212
- ////////////////////////////////////////////////////////////
213
- /// \brief Request a new chunk of audio samples from the stream source
214
- ///
215
- /// This function must be overridden by derived classes to provide
216
- /// the audio samples to play. It is called continuously by the
217
- /// streaming loop, in a separate thread.
218
- /// The source can choose to stop the streaming loop at any time, by
219
- /// returning false to the caller.
220
- /// If you return true (i.e. continue streaming) it is important that
221
- /// the returned array of samples is not empty; this would stop the stream
222
- /// due to an internal limitation.
223
- ///
224
- /// \param data Chunk of data to fill
225
- ///
226
- /// \return True to continue playback, false to stop
227
- ///
228
- ////////////////////////////////////////////////////////////
229
- virtual bool onGetData(Chunk& data) = 0;
230
-
231
- ////////////////////////////////////////////////////////////
232
- /// \brief Change the current playing position in the stream source
233
- ///
234
- /// This function must be overridden by derived classes to
235
- /// allow random seeking into the stream source.
236
- ///
237
- /// \param timeOffset New playing position, relative to the beginning of the stream
238
- ///
239
- ////////////////////////////////////////////////////////////
240
- virtual void onSeek(Time timeOffset) = 0;
241
-
242
- ////////////////////////////////////////////////////////////
243
- /// \brief Change the current playing position in the stream source to the beginning of the loop
244
- ///
245
- /// This function can be overridden by derived classes to
246
- /// allow implementation of custom loop points. Otherwise,
247
- /// it just calls onSeek(Time::Zero) and returns 0.
248
- ///
249
- /// \return The seek position after looping (or -1 if there's no loop)
250
- ///
251
- ////////////////////////////////////////////////////////////
252
- virtual Int64 onLoop();
253
-
254
- ////////////////////////////////////////////////////////////
255
- /// \brief Set the processing interval
256
- ///
257
- /// The processing interval controls the period at which the
258
- /// audio buffers are filled by calls to onGetData. A smaller
259
- /// interval may be useful for low-latency streams. Note that
260
- /// the given period is only a hint and the actual period may
261
- /// vary. The default processing interval is 10 ms.
262
- ///
263
- /// \param interval Processing interval
264
- ///
265
- ////////////////////////////////////////////////////////////
266
- void setProcessingInterval(Time interval);
267
-
268
- private:
269
-
270
- ////////////////////////////////////////////////////////////
271
- /// \brief Function called as the entry point of the thread
272
- ///
273
- /// This function starts the streaming loop, and returns
274
- /// only when the sound is stopped.
275
- ///
276
- ////////////////////////////////////////////////////////////
277
- void streamData();
278
-
279
- ////////////////////////////////////////////////////////////
280
- /// \brief Fill a new buffer with audio samples, and append
281
- /// it to the playing queue
282
- ///
283
- /// This function is called as soon as a buffer has been fully
284
- /// consumed; it fills it again and inserts it back into the
285
- /// playing queue.
286
- ///
287
- /// \param bufferNum Number of the buffer to fill (in [0, BufferCount])
288
- /// \param immediateLoop Treat empty buffers as spent, and act on loops immediately
289
- ///
290
- /// \return True if the stream source has requested to stop, false otherwise
291
- ///
292
- ////////////////////////////////////////////////////////////
293
- bool fillAndPushBuffer(unsigned int bufferNum, bool immediateLoop = false);
294
-
295
- ////////////////////////////////////////////////////////////
296
- /// \brief Fill the audio buffers and put them all into the playing queue
297
- ///
298
- /// This function is called when playing starts and the
299
- /// playing queue is empty.
300
- ///
301
- /// \return True if the derived class has requested to stop, false otherwise
302
- ///
303
- ////////////////////////////////////////////////////////////
304
- bool fillQueue();
305
-
306
- ////////////////////////////////////////////////////////////
307
- /// \brief Clear all the audio buffers and empty the playing queue
308
- ///
309
- /// This function is called when the stream is stopped.
310
- ///
311
- ////////////////////////////////////////////////////////////
312
- void clearQueue();
313
-
314
- enum
315
- {
316
- BufferCount = 3, //!< Number of audio buffers used by the streaming loop
317
- BufferRetries = 2 //!< Number of retries (excluding initial try) for onGetData()
318
- };
319
-
320
- ////////////////////////////////////////////////////////////
321
- // Member data
322
- ////////////////////////////////////////////////////////////
323
- Thread m_thread; //!< Thread running the background tasks
324
- mutable Mutex m_threadMutex; //!< Thread mutex
325
- Status m_threadStartState; //!< State the thread starts in (Playing, Paused, Stopped)
326
- bool m_isStreaming; //!< Streaming state (true = playing, false = stopped)
327
- unsigned int m_buffers[BufferCount]; //!< Sound buffers used to store temporary audio data
328
- unsigned int m_channelCount; //!< Number of channels (1 = mono, 2 = stereo, ...)
329
- unsigned int m_sampleRate; //!< Frequency (samples / second)
330
- Int32 m_format; //!< Format of the internal sound buffers
331
- bool m_loop; //!< Loop flag (true to loop, false to play once)
332
- Uint64 m_samplesProcessed; //!< Number of samples processed since beginning of the stream
333
- Int64 m_bufferSeeks[BufferCount]; //!< If buffer is an "end buffer", holds next seek position, else NoLoop. For play offset calculation.
334
- Time m_processingInterval; //!< Interval for checking and filling the internal sound buffers.
335
- };
336
-
337
- } // namespace sf
338
-
339
-
340
- #endif // SFML_SOUNDSTREAM_HPP
341
-
342
-
343
- ////////////////////////////////////////////////////////////
344
- /// \class sf::SoundStream
345
- /// \ingroup audio
346
- ///
347
- /// Unlike audio buffers (see sf::SoundBuffer), audio streams
348
- /// are never completely loaded in memory. Instead, the audio
349
- /// data is acquired continuously while the stream is playing.
350
- /// This behavior allows to play a sound with no loading delay,
351
- /// and keeps the memory consumption very low.
352
- ///
353
- /// Sound sources that need to be streamed are usually big files
354
- /// (compressed audio musics that would eat hundreds of MB in memory)
355
- /// or files that would take a lot of time to be received
356
- /// (sounds played over the network).
357
- ///
358
- /// sf::SoundStream is a base class that doesn't care about the
359
- /// stream source, which is left to the derived class. SFML provides
360
- /// a built-in specialization for big files (see sf::Music).
361
- /// No network stream source is provided, but you can write your own
362
- /// by combining this class with the network module.
363
- ///
364
- /// A derived class has to override two virtual functions:
365
- /// \li onGetData fills a new chunk of audio data to be played
366
- /// \li onSeek changes the current playing position in the source
367
- ///
368
- /// It is important to note that each SoundStream is played in its
369
- /// own separate thread, so that the streaming loop doesn't block the
370
- /// rest of the program. In particular, the OnGetData and OnSeek
371
- /// virtual functions may sometimes be called from this separate thread.
372
- /// It is important to keep this in mind, because you may have to take
373
- /// care of synchronization issues if you share data between threads.
374
- ///
375
- /// Usage example:
376
- /// \code
377
- /// class CustomStream : public sf::SoundStream
378
- /// {
379
- /// public:
380
- ///
381
- /// bool open(const std::string& location)
382
- /// {
383
- /// // Open the source and get audio settings
384
- /// ...
385
- /// unsigned int channelCount = ...;
386
- /// unsigned int sampleRate = ...;
387
- ///
388
- /// // Initialize the stream -- important!
389
- /// initialize(channelCount, sampleRate);
390
- /// }
391
- ///
392
- /// private:
393
- ///
394
- /// virtual bool onGetData(Chunk& data)
395
- /// {
396
- /// // Fill the chunk with audio data from the stream source
397
- /// // (note: must not be empty if you want to continue playing)
398
- /// data.samples = ...;
399
- /// data.sampleCount = ...;
400
- ///
401
- /// // Return true to continue playing
402
- /// return true;
403
- /// }
404
- ///
405
- /// virtual void onSeek(sf::Time timeOffset)
406
- /// {
407
- /// // Change the current position in the stream source
408
- /// ...
409
- /// }
410
- /// };
411
- ///
412
- /// // Usage
413
- /// CustomStream stream;
414
- /// stream.open("path/to/stream");
415
- /// stream.play();
416
- /// \endcode
417
- ///
418
- /// \see sf::Music
419
- ///
420
- ////////////////////////////////////////////////////////////
@@ -1,56 +0,0 @@
1
- ////////////////////////////////////////////////////////////
2
- //
3
- // SFML - Simple and Fast Multimedia Library
4
- // Copyright (C) 2007-2023 Laurent Gomila (laurent@sfml-dev.org)
5
- //
6
- // This software is provided 'as-is', without any express or implied warranty.
7
- // In no event will the authors be held liable for any damages arising from the use of this software.
8
- //
9
- // Permission is granted to anyone to use this software for any purpose,
10
- // including commercial applications, and to alter it and redistribute it freely,
11
- // subject to the following restrictions:
12
- //
13
- // 1. The origin of this software must not be misrepresented;
14
- // you must not claim that you wrote the original software.
15
- // If you use this software in a product, an acknowledgment
16
- // in the product documentation would be appreciated but is not required.
17
- //
18
- // 2. Altered source versions must be plainly marked as such,
19
- // and must not be misrepresented as being the original software.
20
- //
21
- // 3. This notice may not be removed or altered from any source distribution.
22
- //
23
- ////////////////////////////////////////////////////////////
24
-
25
- #ifndef SFML_AUDIO_HPP
26
- #define SFML_AUDIO_HPP
27
-
28
- ////////////////////////////////////////////////////////////
29
- // Headers
30
- ////////////////////////////////////////////////////////////
31
-
32
- #include <SFML/System.hpp>
33
- #include <SFML/Audio/InputSoundFile.hpp>
34
- #include <SFML/Audio/Listener.hpp>
35
- #include <SFML/Audio/Music.hpp>
36
- #include <SFML/Audio/OutputSoundFile.hpp>
37
- #include <SFML/Audio/Sound.hpp>
38
- #include <SFML/Audio/SoundBuffer.hpp>
39
- #include <SFML/Audio/SoundBufferRecorder.hpp>
40
- #include <SFML/Audio/SoundFileFactory.hpp>
41
- #include <SFML/Audio/SoundFileReader.hpp>
42
- #include <SFML/Audio/SoundFileWriter.hpp>
43
- #include <SFML/Audio/SoundRecorder.hpp>
44
- #include <SFML/Audio/SoundSource.hpp>
45
- #include <SFML/Audio/SoundStream.hpp>
46
-
47
-
48
- #endif // SFML_AUDIO_HPP
49
-
50
- ////////////////////////////////////////////////////////////
51
- /// \defgroup audio Audio module
52
- ///
53
- /// Sounds, streaming (musics or custom sources), recording,
54
- /// spatialization.
55
- ///
56
- ////////////////////////////////////////////////////////////