sfml.js 1.0.0-rc.1 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (334) hide show
  1. package/README.ja.md +177 -0
  2. package/README.ko.md +177 -0
  3. package/README.md +119 -14
  4. package/README.zh-CN.md +177 -0
  5. package/assets/branding/sfml-js-symbol-pentagon.svg +24 -0
  6. package/assets/branding/sfml-js-wordmark-dark.svg +20 -0
  7. package/assets/branding/sfml-js-wordmark.svg +19 -0
  8. package/assets/breakout.png +0 -0
  9. package/dist/audio/effect-processor.d.ts +53 -8
  10. package/dist/audio/effect-processor.js +35 -5
  11. package/dist/audio/input-sound-file.d.ts +101 -15
  12. package/dist/audio/input-sound-file.js +101 -15
  13. package/dist/audio/listener.d.ts +74 -12
  14. package/dist/audio/listener.js +74 -12
  15. package/dist/audio/music.d.ts +172 -22
  16. package/dist/audio/music.js +185 -24
  17. package/dist/audio/output-sound-file.d.ts +36 -4
  18. package/dist/audio/output-sound-file.js +36 -4
  19. package/dist/audio/playback-device.d.ts +103 -17
  20. package/dist/audio/playback-device.js +97 -16
  21. package/dist/audio/sound-buffer-recorder.d.ts +89 -9
  22. package/dist/audio/sound-buffer-recorder.js +89 -9
  23. package/dist/audio/sound-buffer.d.ts +121 -16
  24. package/dist/audio/sound-buffer.js +98 -13
  25. package/dist/audio/sound-file-factory.d.ts +84 -11
  26. package/dist/audio/sound-file-factory.js +84 -11
  27. package/dist/audio/sound-file-reader.d.ts +155 -24
  28. package/dist/audio/sound-file-reader.js +84 -13
  29. package/dist/audio/sound-file-writer.d.ts +49 -7
  30. package/dist/audio/sound-file-writer.js +13 -2
  31. package/dist/audio/sound-recorder.d.ts +143 -19
  32. package/dist/audio/sound-recorder.js +142 -18
  33. package/dist/audio/sound-source.d.ts +273 -45
  34. package/dist/audio/sound-source.js +273 -45
  35. package/dist/audio/sound-stream.d.ts +57 -9
  36. package/dist/audio/sound-stream.js +43 -7
  37. package/dist/audio/sound.d.ts +32 -5
  38. package/dist/audio/sound.js +32 -5
  39. package/dist/audio/value.d.ts +291 -48
  40. package/dist/audio/value.js +235 -39
  41. package/dist/audio/worker.d.ts +256 -38
  42. package/dist/graphics/blend-mode.d.ts +199 -33
  43. package/dist/graphics/blend-mode.js +163 -27
  44. package/dist/graphics/boolean-vector.d.ts +102 -16
  45. package/dist/graphics/boolean-vector.js +102 -16
  46. package/dist/graphics/circle-shape.d.ts +68 -11
  47. package/dist/graphics/circle-shape.js +37 -6
  48. package/dist/graphics/color.d.ts +227 -42
  49. package/dist/graphics/color.js +177 -32
  50. package/dist/graphics/convex-shape.d.ts +45 -7
  51. package/dist/graphics/convex-shape.js +31 -5
  52. package/dist/graphics/drawable.d.ts +15 -2
  53. package/dist/graphics/drawable.js +6 -1
  54. package/dist/graphics/font.d.ts +153 -24
  55. package/dist/graphics/font.js +116 -18
  56. package/dist/graphics/glsl-matrix.d.ts +44 -7
  57. package/dist/graphics/glsl-matrix.js +44 -7
  58. package/dist/graphics/glsl.d.ts +129 -21
  59. package/dist/graphics/glsl.js +123 -20
  60. package/dist/graphics/glyph.d.ts +106 -17
  61. package/dist/graphics/glyph.js +76 -12
  62. package/dist/graphics/image.d.ts +159 -24
  63. package/dist/graphics/image.js +122 -18
  64. package/dist/graphics/primitive-type.d.ts +42 -7
  65. package/dist/graphics/primitive-type.js +42 -7
  66. package/dist/graphics/rect.d.ts +162 -26
  67. package/dist/graphics/rect.js +101 -16
  68. package/dist/graphics/rectangle-shape.d.ts +44 -7
  69. package/dist/graphics/rectangle-shape.js +31 -5
  70. package/dist/graphics/render-states.d.ts +153 -25
  71. package/dist/graphics/render-states.js +49 -8
  72. package/dist/graphics/render-target.d.ts +145 -22
  73. package/dist/graphics/render-target.js +110 -17
  74. package/dist/graphics/render-texture.d.ts +100 -16
  75. package/dist/graphics/render-texture.js +80 -13
  76. package/dist/graphics/render-window.d.ts +106 -17
  77. package/dist/graphics/render-window.js +57 -9
  78. package/dist/graphics/shader.d.ts +153 -24
  79. package/dist/graphics/shader.js +126 -20
  80. package/dist/graphics/shape.d.ts +133 -21
  81. package/dist/graphics/shape.js +115 -18
  82. package/dist/graphics/sprite.d.ts +71 -11
  83. package/dist/graphics/sprite.js +57 -9
  84. package/dist/graphics/stencil-mode.d.ts +193 -32
  85. package/dist/graphics/stencil-mode.js +121 -20
  86. package/dist/graphics/swap.d.ts +13 -2
  87. package/dist/graphics/text.d.ts +624 -103
  88. package/dist/graphics/text.js +443 -73
  89. package/dist/graphics/texture.d.ts +209 -32
  90. package/dist/graphics/texture.js +137 -21
  91. package/dist/graphics/transform.d.ts +93 -14
  92. package/dist/graphics/transform.js +93 -14
  93. package/dist/graphics/transformable.d.ts +13 -2
  94. package/dist/graphics/transformable.js +13 -2
  95. package/dist/graphics/vertex-array.d.ts +83 -14
  96. package/dist/graphics/vertex-array.js +70 -12
  97. package/dist/graphics/vertex-buffer.d.ts +162 -26
  98. package/dist/graphics/vertex-buffer.js +106 -17
  99. package/dist/graphics/vertex.d.ts +83 -14
  100. package/dist/graphics/vertex.js +43 -7
  101. package/dist/graphics/view.d.ts +140 -22
  102. package/dist/graphics/view.js +103 -16
  103. package/dist/internal/glsl-value.d.ts +30 -5
  104. package/dist/internal/glsl-value.js +30 -5
  105. package/dist/internal/scalar.d.ts +9 -1
  106. package/dist/internal/transformable.d.ts +84 -13
  107. package/dist/internal/value-storage.d.ts +8 -1
  108. package/dist/network/common.d.ts +6 -1
  109. package/dist/network/common.js +6 -1
  110. package/dist/network/dns.d.ts +103 -14
  111. package/dist/network/dns.js +55 -6
  112. package/dist/network/ftp.d.ts +217 -33
  113. package/dist/network/ftp.js +217 -33
  114. package/dist/network/gen/constants.d.ts +750 -124
  115. package/dist/network/gen/constants.js +750 -124
  116. package/dist/network/http.d.ts +365 -57
  117. package/dist/network/http.js +365 -57
  118. package/dist/network/ip-address.d.ts +179 -26
  119. package/dist/network/ip-address.js +164 -24
  120. package/dist/network/packet.d.ts +200 -29
  121. package/dist/network/packet.js +101 -13
  122. package/dist/network/sftp.d.ts +525 -84
  123. package/dist/network/sftp.js +322 -53
  124. package/dist/network/socket-selector.d.ts +109 -15
  125. package/dist/network/socket-selector.js +103 -14
  126. package/dist/network/socket.d.ts +245 -33
  127. package/dist/network/socket.js +205 -28
  128. package/dist/network/tcp-listener.d.ts +91 -13
  129. package/dist/network/tcp-listener.js +85 -12
  130. package/dist/network/tcp-socket.d.ts +232 -33
  131. package/dist/network/tcp-socket.js +153 -22
  132. package/dist/network/tls-material.d.ts +18 -2
  133. package/dist/network/tls-material.js +18 -2
  134. package/dist/network/udp-socket.d.ts +137 -19
  135. package/dist/network/udp-socket.js +101 -13
  136. package/dist/system/angle.d.ts +60 -10
  137. package/dist/system/angle.js +60 -10
  138. package/dist/system/clock.d.ts +51 -8
  139. package/dist/system/clock.js +51 -8
  140. package/dist/system/err.d.ts +14 -2
  141. package/dist/system/err.js +14 -2
  142. package/dist/system/error.d.ts +12 -2
  143. package/dist/system/error.js +12 -2
  144. package/dist/system/file-input-stream.d.ts +54 -7
  145. package/dist/system/file-input-stream.js +54 -7
  146. package/dist/system/input-stream.d.ts +97 -13
  147. package/dist/system/input-stream.js +60 -8
  148. package/dist/system/operators.d.ts +146 -19
  149. package/dist/system/operators.js +118 -15
  150. package/dist/system/sleep.d.ts +6 -1
  151. package/dist/system/sleep.js +6 -1
  152. package/dist/system/suspend-aware-clock.d.ts +18 -3
  153. package/dist/system/suspend-aware-clock.js +18 -3
  154. package/dist/system/time.d.ts +81 -12
  155. package/dist/system/time.js +63 -9
  156. package/dist/system/timeout-with-predicate.d.ts +48 -7
  157. package/dist/system/timeout-with-predicate.js +20 -3
  158. package/dist/system/unicode.d.ts +42 -6
  159. package/dist/system/unicode.js +42 -6
  160. package/dist/system/vector2.d.ts +240 -36
  161. package/dist/system/vector2.js +105 -16
  162. package/dist/system/vector3.d.ts +197 -31
  163. package/dist/system/vector3.js +104 -16
  164. package/dist/system/version.d.ts +43 -7
  165. package/dist/system/version.js +7 -1
  166. package/dist/window/clipboard.d.ts +12 -2
  167. package/dist/window/clipboard.js +12 -2
  168. package/dist/window/context-settings.d.ts +78 -13
  169. package/dist/window/context-settings.js +30 -5
  170. package/dist/window/context.d.ts +70 -10
  171. package/dist/window/context.js +52 -7
  172. package/dist/window/cursor.d.ts +44 -6
  173. package/dist/window/cursor.js +28 -4
  174. package/dist/window/event.d.ts +423 -70
  175. package/dist/window/event.js +36 -6
  176. package/dist/window/gen/constants.d.ts +1890 -314
  177. package/dist/window/gen/constants.js +1890 -314
  178. package/dist/window/joystick.d.ts +67 -11
  179. package/dist/window/joystick.js +43 -7
  180. package/dist/window/keyboard.d.ts +42 -6
  181. package/dist/window/keyboard.js +26 -4
  182. package/dist/window/mouse.d.ts +24 -3
  183. package/dist/window/mouse.js +24 -3
  184. package/dist/window/sensor.d.ts +20 -3
  185. package/dist/window/sensor.js +20 -3
  186. package/dist/window/touch.d.ts +19 -4
  187. package/dist/window/touch.js +19 -4
  188. package/dist/window/video-mode.d.ts +61 -10
  189. package/dist/window/video-mode.js +36 -6
  190. package/dist/window/vulkan.d.ts +26 -3
  191. package/dist/window/vulkan.js +26 -3
  192. package/dist/window/window.d.ts +296 -44
  193. package/dist/window/window.js +241 -34
  194. package/docs/README.ja.md +30 -0
  195. package/docs/README.ko.md +30 -0
  196. package/docs/README.md +30 -0
  197. package/docs/README.zh-CN.md +30 -0
  198. package/docs/api.ja.md +84 -0
  199. package/docs/api.ko.md +84 -0
  200. package/docs/api.md +48 -1080
  201. package/docs/api.zh-CN.md +81 -0
  202. package/docs/audio.ja.md +249 -0
  203. package/docs/audio.ko.md +251 -0
  204. package/docs/audio.md +132 -92
  205. package/docs/audio.zh-CN.md +252 -0
  206. package/docs/concepts.ja.md +130 -0
  207. package/docs/concepts.ko.md +130 -0
  208. package/docs/concepts.md +131 -0
  209. package/docs/concepts.zh-CN.md +131 -0
  210. package/docs/development.ja.md +144 -0
  211. package/docs/development.ko.md +144 -0
  212. package/docs/development.md +112 -43
  213. package/docs/development.zh-CN.md +146 -0
  214. package/docs/getting-started.ja.md +154 -0
  215. package/docs/getting-started.ko.md +154 -0
  216. package/docs/getting-started.md +156 -0
  217. package/docs/getting-started.zh-CN.md +156 -0
  218. package/docs/graphics.ja.md +256 -0
  219. package/docs/graphics.ko.md +254 -0
  220. package/docs/graphics.md +255 -0
  221. package/docs/graphics.zh-CN.md +257 -0
  222. package/docs/network.ja.md +214 -0
  223. package/docs/network.ko.md +216 -0
  224. package/docs/network.md +133 -84
  225. package/docs/network.zh-CN.md +218 -0
  226. package/docs/system.ja.md +169 -0
  227. package/docs/system.ko.md +171 -0
  228. package/docs/system.md +173 -0
  229. package/docs/system.zh-CN.md +173 -0
  230. package/docs/window.ja.md +138 -0
  231. package/docs/window.ko.md +140 -0
  232. package/docs/window.md +141 -0
  233. package/docs/window.zh-CN.md +141 -0
  234. package/native/shared-handle.h +41 -3
  235. package/package.json +17 -6
  236. package/src/audio/effect-processor.ts +53 -8
  237. package/src/audio/input-sound-file.ts +101 -15
  238. package/src/audio/listener.ts +74 -12
  239. package/src/audio/music.ts +191 -25
  240. package/src/audio/output-sound-file.ts +36 -4
  241. package/src/audio/playback-device.ts +103 -17
  242. package/src/audio/sound-buffer-recorder.ts +89 -9
  243. package/src/audio/sound-buffer.ts +121 -16
  244. package/src/audio/sound-file-factory.ts +84 -11
  245. package/src/audio/sound-file-reader.ts +155 -24
  246. package/src/audio/sound-file-writer.ts +49 -7
  247. package/src/audio/sound-recorder.ts +155 -20
  248. package/src/audio/sound-source.ts +273 -45
  249. package/src/audio/sound-stream.ts +57 -9
  250. package/src/audio/sound.ts +32 -5
  251. package/src/audio/value.ts +291 -48
  252. package/src/audio/worker.ts +256 -38
  253. package/src/graphics/blend-mode.ts +199 -33
  254. package/src/graphics/boolean-vector.ts +102 -16
  255. package/src/graphics/circle-shape.ts +68 -11
  256. package/src/graphics/color.ts +227 -42
  257. package/src/graphics/convex-shape.ts +45 -7
  258. package/src/graphics/drawable.ts +15 -2
  259. package/src/graphics/font.ts +153 -24
  260. package/src/graphics/glsl-matrix.ts +44 -7
  261. package/src/graphics/glsl.ts +129 -21
  262. package/src/graphics/glyph.ts +106 -17
  263. package/src/graphics/image.ts +159 -24
  264. package/src/graphics/primitive-type.ts +42 -7
  265. package/src/graphics/rect.ts +162 -26
  266. package/src/graphics/rectangle-shape.ts +44 -7
  267. package/src/graphics/render-states.ts +153 -25
  268. package/src/graphics/render-target.ts +145 -22
  269. package/src/graphics/render-texture.ts +100 -16
  270. package/src/graphics/render-window.ts +113 -18
  271. package/src/graphics/shader.ts +153 -24
  272. package/src/graphics/shape.ts +133 -21
  273. package/src/graphics/sprite.ts +71 -11
  274. package/src/graphics/stencil-mode.ts +193 -32
  275. package/src/graphics/swap.ts +13 -2
  276. package/src/graphics/text.ts +624 -103
  277. package/src/graphics/texture.ts +209 -32
  278. package/src/graphics/transform.ts +93 -14
  279. package/src/graphics/transformable.ts +13 -2
  280. package/src/graphics/vertex-array.ts +83 -14
  281. package/src/graphics/vertex-buffer.ts +162 -26
  282. package/src/graphics/vertex.ts +83 -14
  283. package/src/graphics/view.ts +140 -22
  284. package/src/internal/glsl-value.ts +30 -5
  285. package/src/internal/scalar.ts +9 -1
  286. package/src/internal/transformable.ts +84 -13
  287. package/src/internal/value-storage.ts +8 -1
  288. package/src/network/common.ts +6 -1
  289. package/src/network/dns.ts +103 -14
  290. package/src/network/ftp.ts +217 -33
  291. package/src/network/gen/constants.ts +750 -124
  292. package/src/network/http.ts +365 -57
  293. package/src/network/ip-address.ts +179 -26
  294. package/src/network/packet.ts +200 -29
  295. package/src/network/sftp.ts +525 -84
  296. package/src/network/socket-selector.ts +109 -15
  297. package/src/network/socket.ts +245 -33
  298. package/src/network/tcp-listener.ts +91 -13
  299. package/src/network/tcp-socket.ts +232 -33
  300. package/src/network/tls-material.ts +18 -2
  301. package/src/network/udp-socket.ts +137 -19
  302. package/src/system/angle.ts +60 -10
  303. package/src/system/clock.ts +51 -8
  304. package/src/system/err.ts +14 -2
  305. package/src/system/error.ts +12 -2
  306. package/src/system/file-input-stream.ts +54 -7
  307. package/src/system/input-stream.ts +97 -13
  308. package/src/system/operators.ts +146 -19
  309. package/src/system/sleep.ts +6 -1
  310. package/src/system/suspend-aware-clock.ts +18 -3
  311. package/src/system/time.ts +81 -12
  312. package/src/system/timeout-with-predicate.ts +48 -7
  313. package/src/system/unicode.ts +42 -6
  314. package/src/system/vector2.ts +240 -36
  315. package/src/system/vector3.ts +197 -31
  316. package/src/system/version.ts +43 -7
  317. package/src/window/clipboard.ts +12 -2
  318. package/src/window/context-settings.ts +78 -13
  319. package/src/window/context.ts +70 -10
  320. package/src/window/cursor.ts +44 -6
  321. package/src/window/event.ts +423 -70
  322. package/src/window/gen/constants.ts +1890 -314
  323. package/src/window/joystick.ts +67 -11
  324. package/src/window/keyboard.ts +42 -6
  325. package/src/window/mouse.ts +24 -3
  326. package/src/window/sensor.ts +20 -3
  327. package/src/window/touch.ts +19 -4
  328. package/src/window/video-mode.ts +61 -10
  329. package/src/window/vulkan.ts +26 -3
  330. package/src/window/window.ts +314 -46
  331. package/tools/constant-docs.cjs +109 -0
  332. package/tools/constant-docs.json +1318 -0
  333. package/tools/generate-network-constants.cjs +21 -9
  334. package/tools/generate-window-constants.cjs +26 -12
@@ -4,100 +4,328 @@ import { Time } from '../system/time';
4
4
  import { EffectProcessor } from './effect-processor';
5
5
  import type { ReadonlyValue as R } from '../internal/value-storage';
6
6
  import { Cone, type ConeInput, SoundStatus } from './value';
7
- /** Shared control/result fields; every engine operation still executes in SFML. */
7
+ /**
8
+ * Shared control/result fields; every engine operation still executes in SFML.
9
+ * @zh 共享控制和结果字段;所有引擎操作仍在 SFML 中执行。
10
+ * @ja 共有の制御・結果フィールド。エンジン操作はすべて SFML で実行されます。
11
+ * @ko 공유 제어 및 결과 필드이며, 모든 엔진 작업은 여전히 SFML에서 실행됩니다.
12
+ */
8
13
  export declare abstract class SoundSource {
9
- /** 播放状态枚举。 */
14
+ /**
15
+ * Playback status enumeration.
16
+ * @zh 播放状态枚举。
17
+ * @ja 再生状態の列挙型。
18
+ * @ko 재생 상태 열거형입니다.
19
+ */
10
20
  static readonly Status: typeof SoundStatus;
11
- /** 方向锥配置类型。 */
21
+ /**
22
+ * Directional cone configuration type.
23
+ * @zh 方向锥配置类型。
24
+ * @ja 指向性コーンの設定型。
25
+ * @ko 지향성 원뿔 설정 타입입니다.
26
+ */
12
27
  static readonly Cone: typeof Cone;
13
28
  readonly [audioHandle]: AudioHandle<'source'>;
14
29
  protected readonly values: Float32Array;
15
30
  protected readonly times: BigInt64Array;
16
31
  private effect?;
17
32
  protected constructor(mapping: AudioSourceMapping);
18
- /** Copy source attributes, retaining this source's content and playback. */
33
+ /**
34
+ * Copy source attributes, retaining this source's content and playback.
35
+ * @zh 复制声源属性,保留当前声源的内容和播放状态。
36
+ * @ja 音源の属性をコピーし、この音源の内容と再生状態を保持します。
37
+ * @ko 음원 속성을 복사하며 현재 음원의 콘텐츠와 재생 상태를 유지합니다.
38
+ */
19
39
  assign(source: SoundSource): this;
20
- /** 设置音高及播放速率倍率,1 为原速。 */
40
+ /**
41
+ * Set the pitch and playback rate multiplier; 1 is the original rate.
42
+ * @zh 设置音高及播放速率倍率,1 为原速。
43
+ * @ja ピッチと再生速度の倍率を設定します。1 は元の速度です。
44
+ * @ko 음높이와 재생 속도 배율을 설정합니다. 1은 원래 속도입니다.
45
+ */
21
46
  setPitch(value: number): void;
22
- /** 返回音高倍率。 */
47
+ /**
48
+ * Return the pitch multiplier.
49
+ * @zh 返回音高倍率。
50
+ * @ja ピッチの倍率を返します。
51
+ * @ko 음높이 배율을 반환합니다.
52
+ */
23
53
  getPitch(): number;
24
- /** 设置立体声声像,-1 为左、0 为中、1 为右。 */
54
+ /**
55
+ * Set stereo pan: -1 is left, 0 is center, and 1 is right.
56
+ * @zh 设置立体声声像,-1 为左、0 为中、1 为右。
57
+ * @ja ステレオパンを設定します。-1 は左、0 は中央、1 は右です。
58
+ * @ko 스테레오 팬을 설정합니다. -1은 왼쪽, 0은 중앙, 1은 오른쪽입니다.
59
+ */
25
60
  setPan(value: number): void;
26
- /** 返回立体声声像。 */
61
+ /**
62
+ * Return the stereo pan.
63
+ * @zh 返回立体声声像。
64
+ * @ja ステレオパンを返します。
65
+ * @ko 스테레오 팬을 반환합니다.
66
+ */
27
67
  getPan(): number;
28
- /** 设置音量百分比,0 为静音,100 为原始音量。 */
68
+ /**
69
+ * Set volume as a percentage; 0 is silent and 100 is the original volume.
70
+ * @zh 设置音量百分比,0 为静音,100 为原始音量。
71
+ * @ja 音量を百分率で設定します。0 は無音、100 は元の音量です。
72
+ * @ko 볼륨을 백분율로 설정합니다. 0은 무음, 100은 원래 볼륨입니다.
73
+ */
29
74
  setVolume(value: number): void;
30
- /** 返回音量百分比。 */
75
+ /**
76
+ * Return the volume percentage.
77
+ * @zh 返回音量百分比。
78
+ * @ja 音量の百分率を返します。
79
+ * @ko 볼륨 백분율을 반환합니다.
80
+ */
31
81
  getVolume(): number;
32
- /** 设置是否启用位置、距离和方向引起的空间音效。 */
82
+ /**
83
+ * Enable or disable spatial effects from position, distance, and direction.
84
+ * @zh 设置是否启用位置、距离和方向引起的空间音效。
85
+ * @ja 位置・距離・方向による空間音響効果の有効・無効を設定します。
86
+ * @ko 위치, 거리, 방향에 따른 공간 음향 효과의 활성화 여부를 설정합니다.
87
+ */
33
88
  setSpatializationEnabled(value: boolean): void;
34
- /** 返回是否启用空间音效。 */
89
+ /**
90
+ * Return whether spatialization is enabled.
91
+ * @zh 返回是否启用空间音效。
92
+ * @ja 空間音響効果が有効かどうかを返します。
93
+ * @ko 공간 음향 효과의 활성화 여부를 반환합니다.
94
+ */
35
95
  isSpatializationEnabled(): boolean;
36
- /** 设置三维位置,单位须与监听者位置及距离参数一致。 */
96
+ /**
97
+ * Set the 3D position using the same units as the listener and distances.
98
+ * @zh 设置三维位置,单位须与监听者位置及距离参数一致。
99
+ * @ja 3D 位置を設定します。単位はリスナー位置と距離パラメーターに合わせます。
100
+ * @ko 3차원 위치를 설정합니다. 리스너 위치 및 거리 매개변수와 단위가 같아야 합니다.
101
+ */
37
102
  setPosition(value: R<Vector3f>): void;
38
- /** 返回三维位置副本。 */
103
+ /**
104
+ * Return a copy of the 3D position.
105
+ * @zh 返回三维位置副本。
106
+ * @ja 3D 位置のコピーを返します。
107
+ * @ko 3차원 위치의 복사본을 반환합니다.
108
+ */
39
109
  getPosition(): Vector3f;
40
- /** 设置声源发声方向。 */
110
+ /**
111
+ * Set the sound source's emission direction.
112
+ * @zh 设置声源发声方向。
113
+ * @ja 音源の発音方向を設定します。
114
+ * @ko 음원의 소리 방출 방향을 설정합니다.
115
+ */
41
116
  setDirection(value: R<Vector3f>): void;
42
- /** 返回发声方向副本。 */
117
+ /**
118
+ * Return a copy of the emission direction.
119
+ * @zh 返回发声方向副本。
120
+ * @ja 発音方向のコピーを返します。
121
+ * @ko 소리 방출 방향의 복사본을 반환합니다.
122
+ */
43
123
  getDirection(): Vector3f;
44
- /** 设置内外方向锥角度及外部增益,并更新原生音频引擎。 */
124
+ /**
125
+ * Set the inner and outer cone angles and outer gain, updating the native
126
+ * audio engine.
127
+ * @zh 设置内外方向锥角度及外部增益,并更新原生音频引擎。
128
+ * @ja 内側・外側コーンの角度と外側ゲインを設定し、
129
+ * ネイティブ音声エンジンを更新します。
130
+ * @ko 내부 및 외부 원뿔 각도와 외부 게인을 설정하고 네이티브 오디오 엔진을 갱신합니다.
131
+ */
45
132
  setCone(value: Readonly<ConeInput>): void;
46
- /** 返回方向锥参数副本。 */
133
+ /**
134
+ * Return a copy of the directional cone parameters.
135
+ * @zh 返回方向锥参数副本。
136
+ * @ja 指向性コーンのパラメーターのコピーを返します。
137
+ * @ko 지향성 원뿔 매개변수의 복사본을 반환합니다.
138
+ */
47
139
  getCone(): Cone;
48
- /** 设置三维速度,用于多普勒效应,单位为位置单位/秒。 */
140
+ /**
141
+ * Set the 3D velocity for the Doppler effect, in position units per second.
142
+ * @zh 设置三维速度,用于多普勒效应,单位为位置单位/秒。
143
+ * @ja ドップラー効果用の 3D 速度を設定します。単位は位置単位/秒です。
144
+ * @ko 도플러 효과에 사용할 3차원 속도를 설정합니다. 단위는 위치 단위/초입니다.
145
+ */
49
146
  setVelocity(value: R<Vector3f>): void;
50
- /** 返回速度副本。 */
147
+ /**
148
+ * Return a copy of the velocity.
149
+ * @zh 返回速度副本。
150
+ * @ja 速度のコピーを返します。
151
+ * @ko 속도의 복사본을 반환합니다.
152
+ */
51
153
  getVelocity(): Vector3f;
52
- /** 设置多普勒效应倍率,0 禁用。 */
154
+ /**
155
+ * Set the Doppler effect multiplier; 0 disables it.
156
+ * @zh 设置多普勒效应倍率,0 禁用。
157
+ * @ja ドップラー効果の倍率を設定します。0 で無効になります。
158
+ * @ko 도플러 효과 배율을 설정합니다. 0은 비활성화합니다.
159
+ */
53
160
  setDopplerFactor(value: number): void;
54
- /** 返回多普勒效应倍率。 */
161
+ /**
162
+ * Return the Doppler effect multiplier.
163
+ * @zh 返回多普勒效应倍率。
164
+ * @ja ドップラー効果の倍率を返します。
165
+ * @ko 도플러 효과 배율을 반환합니다.
166
+ */
55
167
  getDopplerFactor(): number;
56
- /** 设置声源方向对衰减的影响因子。 */
168
+ /**
169
+ * Set the factor controlling the source direction's effect on attenuation.
170
+ * @zh 设置声源方向对衰减的影响因子。
171
+ * @ja 音源の方向が減衰に与える影響の係数を設定します。
172
+ * @ko 음원 방향이 감쇠에 미치는 영향 계수를 설정합니다.
173
+ */
57
174
  setDirectionalAttenuationFactor(value: number): void;
58
- /** 返回方向衰减因子。 */
175
+ /**
176
+ * Return the directional attenuation factor.
177
+ * @zh 返回方向衰减因子。
178
+ * @ja 指向性減衰係数を返します。
179
+ * @ko 지향성 감쇠 계수를 반환합니다.
180
+ */
59
181
  getDirectionalAttenuationFactor(): number;
60
- /** 设置位置是否相对于监听者;false 使用世界坐标。 */
182
+ /**
183
+ * Set whether the position is relative to the listener; false uses world
184
+ * coordinates.
185
+ * @zh 设置位置是否相对于监听者;false 使用世界坐标。
186
+ * @ja 位置をリスナー相対にするか設定します。false はワールド座標を使います。
187
+ * @ko 리스너 기준 상대 위치 여부를 설정합니다. false는 월드 좌표를 사용합니다.
188
+ */
61
189
  setRelativeToListener(value: boolean): void;
62
- /** 返回是否使用监听者相对坐标。 */
190
+ /**
191
+ * Return whether listener-relative coordinates are used.
192
+ * @zh 返回是否使用监听者相对坐标。
193
+ * @ja リスナー相対座標を使うかどうかを返します。
194
+ * @ko 리스너 기준 상대 좌표 사용 여부를 반환합니다.
195
+ */
63
196
  isRelativeToListener(): boolean;
64
- /** 设置保持最大音量的最小参考距离。 */
197
+ /**
198
+ * Set the minimum reference distance at which maximum volume is maintained.
199
+ * @zh 设置保持最大音量的最小参考距离。
200
+ * @ja 最大音量を維持する最小基準距離を設定します。
201
+ * @ko 최대 볼륨을 유지하는 최소 기준 거리를 설정합니다.
202
+ */
65
203
  setMinDistance(value: number): void;
66
- /** 返回最小参考距离。 */
204
+ /**
205
+ * Return the minimum reference distance.
206
+ * @zh 返回最小参考距离。
207
+ * @ja 最小基準距離を返します。
208
+ * @ko 최소 기준 거리를 반환합니다.
209
+ */
67
210
  getMinDistance(): number;
68
- /** 设置距离衰减使用的最大距离。 */
211
+ /**
212
+ * Set the maximum distance used for distance attenuation.
213
+ * @zh 设置距离衰减使用的最大距离。
214
+ * @ja 距離減衰に使う最大距離を設定します。
215
+ * @ko 거리 감쇠에 사용할 최대 거리를 설정합니다.
216
+ */
69
217
  setMaxDistance(value: number): void;
70
- /** 返回最大距离。 */
218
+ /**
219
+ * Return the maximum distance.
220
+ * @zh 返回最大距离。
221
+ * @ja 最大距離を返します。
222
+ * @ko 최대 거리를 반환합니다.
223
+ */
71
224
  getMaxDistance(): number;
72
- /** 设置距离衰减后的最小增益。 */
225
+ /**
226
+ * Set the minimum gain after distance attenuation.
227
+ * @zh 设置距离衰减后的最小增益。
228
+ * @ja 距離減衰後の最小ゲインを設定します。
229
+ * @ko 거리 감쇠 후의 최소 게인을 설정합니다.
230
+ */
73
231
  setMinGain(value: number): void;
74
- /** 返回最小增益。 */
232
+ /**
233
+ * Return the minimum gain.
234
+ * @zh 返回最小增益。
235
+ * @ja 最小ゲインを返します。
236
+ * @ko 최소 게인을 반환합니다.
237
+ */
75
238
  getMinGain(): number;
76
- /** 设置距离衰减后的最大增益。 */
239
+ /**
240
+ * Set the maximum gain after distance attenuation.
241
+ * @zh 设置距离衰减后的最大增益。
242
+ * @ja 距離減衰後の最大ゲインを設定します。
243
+ * @ko 거리 감쇠 후의 최대 게인을 설정합니다.
244
+ */
77
245
  setMaxGain(value: number): void;
78
- /** 返回最大增益。 */
246
+ /**
247
+ * Return the maximum gain.
248
+ * @zh 返回最大增益。
249
+ * @ja 最大ゲインを返します。
250
+ * @ko 최대 게인을 반환합니다.
251
+ */
79
252
  getMaxGain(): number;
80
- /** 设置距离衰减因子,0 禁用距离衰减。 */
253
+ /**
254
+ * Set the distance attenuation factor; 0 disables distance attenuation.
255
+ * @zh 设置距离衰减因子,0 禁用距离衰减。
256
+ * @ja 距離減衰係数を設定します。0 で距離減衰が無効になります。
257
+ * @ko 거리 감쇠 계수를 설정합니다. 0은 거리 감쇠를 비활성화합니다.
258
+ */
81
259
  setAttenuation(value: number): void;
82
- /** 返回距离衰减因子。 */
260
+ /**
261
+ * Return the distance attenuation factor.
262
+ * @zh 返回距离衰减因子。
263
+ * @ja 距離減衰係数を返します。
264
+ * @ko 거리 감쇠 계수를 반환합니다.
265
+ */
83
266
  getAttenuation(): number;
84
- /** 设置到达末尾后是否循环播放。 */
267
+ /**
268
+ * Set whether playback loops after reaching the end.
269
+ * @zh 设置到达末尾后是否循环播放。
270
+ * @ja 末尾に達した後にループ再生するか設定します。
271
+ * @ko 끝에 도달한 후 반복 재생할지 설정합니다.
272
+ */
85
273
  setLooping(value: boolean): void;
86
- /** 返回是否循环播放。 */
274
+ /**
275
+ * Return whether playback loops.
276
+ * @zh 返回是否循环播放。
277
+ * @ja ループ再生するかどうかを返します。
278
+ * @ko 반복 재생 여부를 반환합니다.
279
+ */
87
280
  isLooping(): boolean;
88
- /** 查询原生引擎的当前播放状态。 */
281
+ /**
282
+ * Query the native engine's current playback status.
283
+ * @zh 查询原生引擎的当前播放状态。
284
+ * @ja ネイティブエンジンの現在の再生状態を取得します。
285
+ * @ko 네이티브 엔진의 현재 재생 상태를 조회합니다.
286
+ */
89
287
  getStatus(): SoundStatus;
90
- /** 绑定并保留效果处理器引用;undefined 移除处理器。 */
288
+ /**
289
+ * Bind and retain an effect processor reference; undefined removes it.
290
+ * @zh 绑定并保留效果处理器引用;undefined 移除处理器。
291
+ * @ja エフェクトプロセッサーを関連付け、参照を保持します。undefined で解除します。
292
+ * @ko 효과 처리기를 연결하고 참조를 유지합니다. undefined는 처리기를 제거합니다.
293
+ */
91
294
  setEffectProcessor(processor?: EffectProcessor): void;
92
- /** 开始播放或恢复暂停;已播放时按 SFML 语义重新开始。 */
295
+ /**
296
+ * Start or resume playback; if already playing, restart per SFML semantics.
297
+ * @zh 开始播放或恢复暂停;已播放时按 SFML 语义重新开始。
298
+ * @ja 再生を開始または再開します。再生中なら SFML の仕様に従い最初から再生します。
299
+ * @ko 재생을 시작하거나 재개합니다. 이미 재생 중이면 SFML 동작에 따라 다시 시작합니다.
300
+ */
93
301
  play(): void;
94
- /** 暂停并保留播放位置。 */
302
+ /**
303
+ * Pause and retain the playback position.
304
+ * @zh 暂停并保留播放位置。
305
+ * @ja 再生位置を保持して一時停止します。
306
+ * @ko 재생 위치를 유지한 채 일시 정지합니다.
307
+ */
95
308
  pause(): void;
96
- /** 停止并将播放位置归零。 */
309
+ /**
310
+ * Stop and reset the playback position to zero.
311
+ * @zh 停止并将播放位置归零。
312
+ * @ja 停止して再生位置をゼロに戻します。
313
+ * @ko 정지하고 재생 위치를 0으로 되돌립니다.
314
+ */
97
315
  stop(): void;
98
- /** 设置相对于声音起点的播放时间。 */
316
+ /**
317
+ * Set the playback time relative to the beginning of the sound.
318
+ * @zh 设置相对于声音起点的播放时间。
319
+ * @ja 音声の先頭からの再生時刻を設定します。
320
+ * @ko 소리 시작점 기준 재생 시간을 설정합니다.
321
+ */
99
322
  setPlayingOffset(value: R<Time>): void;
100
- /** 返回当前播放位置的时间副本。 */
323
+ /**
324
+ * Return a copy of the current playback position as a time.
325
+ * @zh 返回当前播放位置的时间副本。
326
+ * @ja 現在の再生位置を表す時刻のコピーを返します。
327
+ * @ko 현재 재생 위치를 나타내는 시간의 복사본을 반환합니다.
328
+ */
101
329
  getPlayingOffset(): Time;
102
330
  protected command(command: number): void;
103
331
  protected field(field: number, write: boolean): void;