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.
- package/LICENSE +1 -1
- package/README.ja.md +173 -0
- package/README.ko.md +173 -0
- package/README.md +129 -20
- package/README.zh-CN.md +173 -0
- package/assets/branding/sfml-js-symbol-pentagon.svg +24 -0
- package/assets/branding/sfml-js-wordmark-dark.svg +20 -0
- package/assets/branding/sfml-js-wordmark.svg +19 -0
- package/assets/breakout.png +0 -0
- package/binding.gyp +95 -183
- package/dist/audio/effect-processor.d.ts +67 -0
- package/dist/audio/effect-processor.js +58 -0
- package/dist/audio/input-sound-file.d.ts +138 -0
- package/dist/audio/input-sound-file.js +253 -0
- package/dist/audio/listener.d.ts +90 -0
- package/dist/audio/listener.js +148 -0
- package/dist/audio/music.d.ts +210 -0
- package/dist/audio/music.js +353 -0
- package/dist/audio/output-sound-file.d.ts +47 -0
- package/dist/audio/output-sound-file.js +102 -0
- package/dist/audio/playback-device.d.ts +121 -0
- package/dist/audio/playback-device.js +152 -0
- package/dist/audio/sound-buffer-recorder.d.ts +114 -0
- package/dist/audio/sound-buffer-recorder.js +142 -0
- package/dist/audio/sound-buffer.d.ts +150 -0
- package/dist/audio/sound-buffer.js +237 -0
- package/dist/audio/sound-file-factory.d.ts +100 -0
- package/dist/audio/sound-file-factory.js +225 -0
- package/dist/audio/sound-file-reader.d.ts +191 -0
- package/dist/audio/sound-file-reader.js +132 -0
- package/dist/audio/sound-file-writer.d.ts +59 -0
- package/dist/audio/sound-file-writer.js +20 -0
- package/dist/audio/sound-recorder.d.ts +184 -0
- package/dist/audio/sound-recorder.js +286 -0
- package/dist/audio/sound-source.d.ts +336 -0
- package/dist/audio/sound-source.js +389 -0
- package/dist/audio/sound-stream.d.ts +76 -0
- package/dist/audio/sound-stream.js +83 -0
- package/dist/audio/sound.d.ts +41 -0
- package/dist/audio/sound.js +66 -0
- package/dist/audio/value.d.ts +359 -0
- package/dist/audio/value.js +353 -0
- package/dist/audio/worker.d.ts +306 -0
- package/dist/audio/worker.js +2 -0
- package/dist/graphics/blend-mode.d.ts +248 -0
- package/dist/graphics/blend-mode.js +234 -0
- package/dist/graphics/boolean-vector.d.ts +134 -0
- package/dist/graphics/boolean-vector.js +202 -0
- package/dist/graphics/circle-shape.d.ts +84 -0
- package/dist/graphics/circle-shape.js +72 -0
- package/dist/graphics/color.d.ts +278 -0
- package/dist/graphics/color.js +291 -0
- package/dist/graphics/convex-shape.d.ts +56 -0
- package/dist/graphics/convex-shape.js +59 -0
- package/dist/graphics/drawable.d.ts +22 -0
- package/dist/graphics/drawable.js +20 -0
- package/dist/graphics/font.d.ts +199 -0
- package/dist/graphics/font.js +319 -0
- package/dist/graphics/glsl-matrix.d.ts +62 -0
- package/dist/graphics/glsl-matrix.js +106 -0
- package/dist/graphics/glsl.d.ts +165 -0
- package/dist/graphics/glsl.js +215 -0
- package/dist/graphics/glyph.d.ts +133 -0
- package/dist/graphics/glyph.js +138 -0
- package/dist/graphics/image.d.ts +192 -0
- package/dist/graphics/image.js +285 -0
- package/dist/graphics/primitive-type.d.ts +51 -0
- package/dist/graphics/primitive-type.js +60 -0
- package/dist/graphics/rect.d.ts +203 -0
- package/dist/graphics/rect.js +249 -0
- package/dist/graphics/rectangle-shape.d.ts +55 -0
- package/dist/graphics/rectangle-shape.js +60 -0
- package/dist/graphics/render-states.d.ts +188 -0
- package/dist/graphics/render-states.js +115 -0
- package/dist/graphics/render-target.d.ts +222 -0
- package/dist/graphics/render-target.js +434 -0
- package/dist/graphics/render-texture.d.ts +130 -0
- package/dist/graphics/render-texture.js +187 -0
- package/dist/graphics/render-window.d.ts +138 -0
- package/dist/graphics/render-window.js +154 -0
- package/dist/graphics/shader.d.ts +192 -0
- package/dist/graphics/shader.js +321 -0
- package/dist/graphics/shape.d.ts +189 -0
- package/dist/graphics/shape.js +277 -0
- package/dist/graphics/sprite.d.ts +104 -0
- package/dist/graphics/sprite.js +164 -0
- package/dist/graphics/stencil-mode.d.ts +230 -0
- package/dist/graphics/stencil-mode.js +173 -0
- package/dist/graphics/swap.d.ts +17 -0
- package/dist/graphics/swap.js +16 -0
- package/dist/graphics/text.d.ts +759 -0
- package/dist/graphics/text.js +724 -0
- package/dist/graphics/texture.d.ts +255 -0
- package/dist/graphics/texture.js +390 -0
- package/dist/graphics/transform.d.ts +129 -0
- package/dist/graphics/transform.js +274 -0
- package/dist/graphics/transformable.d.ts +24 -0
- package/dist/graphics/transformable.js +38 -0
- package/dist/graphics/vertex-array.d.ts +123 -0
- package/dist/graphics/vertex-array.js +234 -0
- package/dist/graphics/vertex-buffer.d.ts +205 -0
- package/dist/graphics/vertex-buffer.js +256 -0
- package/dist/graphics/vertex.d.ts +111 -0
- package/dist/graphics/vertex.js +134 -0
- package/dist/graphics/view.d.ts +172 -0
- package/dist/graphics/view.js +296 -0
- package/dist/index.d.ts +116 -0
- package/dist/index.js +251 -0
- package/dist/internal/audio-codec-registry.d.ts +13 -0
- package/dist/internal/audio-codec-registry.js +64 -0
- package/dist/internal/audio-input-stream.d.ts +13 -0
- package/dist/internal/audio-input-stream.js +44 -0
- package/dist/internal/audio-music-pump.d.ts +63 -0
- package/dist/internal/audio-music-pump.js +193 -0
- package/dist/internal/audio-native.d.ts +145 -0
- package/dist/internal/audio-native.js +24 -0
- package/dist/internal/audio-recorder-session.d.ts +77 -0
- package/dist/internal/audio-recorder-session.js +182 -0
- package/dist/internal/audio-worker-session.d.ts +18 -0
- package/dist/internal/audio-worker-session.js +82 -0
- package/dist/internal/audio-worker.d.ts +1 -0
- package/dist/internal/audio-worker.js +134 -0
- package/dist/internal/glsl-value.d.ts +51 -0
- package/dist/internal/glsl-value.js +69 -0
- package/dist/internal/graphics-state.d.ts +45 -0
- package/dist/internal/graphics-state.js +123 -0
- package/dist/internal/input-stream.d.ts +4 -0
- package/dist/internal/input-stream.js +25 -0
- package/dist/internal/lazy-value.d.ts +17 -0
- package/dist/internal/lazy-value.js +43 -0
- package/dist/internal/native.d.ts +317 -0
- package/dist/internal/native.js +8 -0
- package/dist/internal/numeric-properties.d.ts +2 -0
- package/dist/internal/numeric-properties.js +39 -0
- package/dist/internal/render-states.d.ts +4 -0
- package/dist/internal/render-states.js +44 -0
- package/dist/internal/scalar.d.ts +52 -0
- package/dist/internal/scalar.js +95 -0
- package/dist/internal/shaped-glyph.d.ts +32 -0
- package/dist/internal/shaped-glyph.js +51 -0
- package/dist/internal/struct-view.d.ts +11 -0
- package/dist/internal/struct-view.js +39 -0
- package/dist/internal/text-indices.d.ts +7 -0
- package/dist/internal/text-indices.js +22 -0
- package/dist/internal/transformable.d.ts +124 -0
- package/dist/internal/transformable.js +121 -0
- package/dist/internal/value-storage.d.ts +33 -0
- package/dist/internal/value-storage.js +21 -0
- package/dist/network/common.d.ts +23 -0
- package/dist/network/common.js +78 -0
- package/dist/network/dns.d.ts +124 -0
- package/dist/network/dns.js +142 -0
- package/dist/network/ftp.d.ts +265 -0
- package/dist/network/ftp.js +417 -0
- package/dist/network/gen/constants.d.ts +878 -0
- package/dist/network/gen/constants.js +886 -0
- package/dist/network/http.d.ts +458 -0
- package/dist/network/http.js +732 -0
- package/dist/network/ip-address.d.ts +210 -0
- package/dist/network/ip-address.js +301 -0
- package/dist/network/packet.d.ts +249 -0
- package/dist/network/packet.js +326 -0
- package/dist/network/sftp.d.ts +661 -0
- package/dist/network/sftp.js +826 -0
- package/dist/network/socket-selector.d.ts +132 -0
- package/dist/network/socket-selector.js +214 -0
- package/dist/network/socket.d.ts +301 -0
- package/dist/network/socket.js +402 -0
- package/dist/network/tcp-listener.d.ts +114 -0
- package/dist/network/tcp-listener.js +199 -0
- package/dist/network/tcp-socket.d.ts +307 -0
- package/dist/network/tcp-socket.js +493 -0
- package/dist/network/tls-material.d.ts +22 -0
- package/dist/network/tls-material.js +52 -0
- package/dist/network/udp-socket.d.ts +178 -0
- package/dist/network/udp-socket.js +285 -0
- package/dist/system/angle.d.ts +77 -0
- package/dist/system/angle.js +122 -0
- package/dist/system/clock.d.ts +65 -0
- package/dist/system/clock.js +99 -0
- package/dist/system/err.d.ts +18 -0
- package/dist/system/err.js +61 -0
- package/dist/system/error.d.ts +15 -0
- package/dist/system/error.js +22 -0
- package/dist/system/file-input-stream.d.ts +68 -0
- package/dist/system/file-input-stream.js +148 -0
- package/dist/system/input-stream.d.ts +114 -0
- package/dist/system/input-stream.js +106 -0
- package/dist/system/operators.d.ts +291 -0
- package/dist/system/operators.js +505 -0
- package/dist/system/sleep.d.ts +9 -0
- package/dist/system/sleep.js +28 -0
- package/dist/system/suspend-aware-clock.d.ts +22 -0
- package/dist/system/suspend-aware-clock.js +29 -0
- package/dist/system/time.d.ts +100 -0
- package/dist/system/time.js +188 -0
- package/dist/system/timeout-with-predicate.d.ts +60 -0
- package/dist/system/timeout-with-predicate.js +52 -0
- package/dist/system/unicode.d.ts +54 -0
- package/dist/system/unicode.js +67 -0
- package/dist/system/vector2.d.ts +302 -0
- package/dist/system/vector2.js +314 -0
- package/dist/system/vector3.d.ts +249 -0
- package/dist/system/vector3.js +266 -0
- package/dist/system/version.d.ts +51 -0
- package/dist/system/version.js +24 -0
- package/dist/window/clipboard.d.ts +14 -0
- package/dist/window/clipboard.js +26 -0
- package/dist/window/context-settings.d.ts +94 -0
- package/dist/window/context-settings.js +84 -0
- package/dist/window/context.d.ts +87 -0
- package/dist/window/context.js +122 -0
- package/dist/window/cursor.d.ts +58 -0
- package/dist/window/cursor.js +80 -0
- package/dist/window/event.d.ts +529 -0
- package/dist/window/event.js +87 -0
- package/dist/window/gen/constants.d.ts +2213 -0
- package/dist/window/gen/constants.js +2227 -0
- package/dist/window/joystick.d.ts +81 -0
- package/dist/window/joystick.js +80 -0
- package/dist/window/keyboard.d.ts +50 -0
- package/dist/window/keyboard.js +59 -0
- package/dist/window/mouse.d.ts +31 -0
- package/dist/window/mouse.js +57 -0
- package/dist/window/sensor.d.ts +26 -0
- package/dist/window/sensor.js +40 -0
- package/dist/window/touch.d.ts +27 -0
- package/dist/window/touch.js +44 -0
- package/dist/window/video-mode.d.ts +77 -0
- package/dist/window/video-mode.js +99 -0
- package/dist/window/vulkan.d.ts +32 -0
- package/dist/window/vulkan.js +45 -0
- package/dist/window/window.d.ts +355 -0
- package/dist/window/window.js +434 -0
- package/docs/README.ja.md +30 -0
- package/docs/README.ko.md +30 -0
- package/docs/README.md +30 -0
- package/docs/README.zh-CN.md +30 -0
- package/docs/api.ja.md +84 -0
- package/docs/api.ko.md +84 -0
- package/docs/api.md +81 -0
- package/docs/api.zh-CN.md +81 -0
- package/docs/audio.ja.md +249 -0
- package/docs/audio.ko.md +251 -0
- package/docs/audio.md +252 -0
- package/docs/audio.zh-CN.md +252 -0
- package/docs/concepts.ja.md +130 -0
- package/docs/concepts.ko.md +130 -0
- package/docs/concepts.md +131 -0
- package/docs/concepts.zh-CN.md +131 -0
- package/docs/development.ja.md +148 -0
- package/docs/development.ko.md +148 -0
- package/docs/development.md +150 -0
- package/docs/development.zh-CN.md +150 -0
- package/docs/getting-started.ja.md +154 -0
- package/docs/getting-started.ko.md +154 -0
- package/docs/getting-started.md +156 -0
- package/docs/getting-started.zh-CN.md +156 -0
- package/docs/graphics.ja.md +256 -0
- package/docs/graphics.ko.md +254 -0
- package/docs/graphics.md +255 -0
- package/docs/graphics.zh-CN.md +257 -0
- package/docs/network.ja.md +214 -0
- package/docs/network.ko.md +216 -0
- package/docs/network.md +218 -0
- package/docs/network.zh-CN.md +218 -0
- package/docs/system.ja.md +169 -0
- package/docs/system.ko.md +171 -0
- package/docs/system.md +173 -0
- package/docs/system.zh-CN.md +173 -0
- package/docs/window.ja.md +138 -0
- package/docs/window.ko.md +140 -0
- package/docs/window.md +141 -0
- package/docs/window.zh-CN.md +141 -0
- package/native/addon.cc +129 -0
- package/native/audio-binding.cc +543 -0
- package/native/audio-codec-binding.cc +246 -0
- package/native/audio-device-binding.cc +160 -0
- package/native/audio-file-binding.cc +192 -0
- package/native/audio-recorder-binding.cc +237 -0
- package/native/audio-recorder.h +39 -0
- package/native/audio-state.h +220 -0
- package/native/audio-stream-binding.cc +284 -0
- package/native/audio-stream.h +28 -0
- package/native/audio-worker-binding.cc +447 -0
- package/native/audio-worker.h +121 -0
- package/native/batch-drawable.cc +189 -0
- package/native/batch-drawable.h +57 -0
- package/native/context-binding.cc +180 -0
- package/native/context-settings.h +74 -0
- package/native/deferred-delete.cc +49 -0
- package/native/deferred-delete.h +84 -0
- package/native/error-stream-binding.cc +270 -0
- package/native/exception-boundary.h +97 -0
- package/native/font-binding.cc +210 -0
- package/native/font-state.h +27 -0
- package/native/graphics-binding.cc +338 -0
- package/native/graphics-state.h +253 -0
- package/native/image-binding.cc +258 -0
- package/native/image-state.h +93 -0
- package/native/input-binding.cc +246 -0
- package/native/numeric-fields.h +96 -0
- package/native/render-window-binding.cc +103 -0
- package/native/render-window-state.h +22 -0
- package/native/shader-binding.cc +292 -0
- package/native/shape-binding.cc +283 -0
- package/native/shape-state.h +68 -0
- package/native/shaped-glyph-storage.h +45 -0
- package/native/shared-handle.h +69 -0
- package/native/stream-binding.cc +286 -0
- package/native/system-binding.cc +91 -0
- package/native/text-binding.cc +205 -0
- package/native/text-state.h +101 -0
- package/native/texture-binding.cc +330 -0
- package/native/texture-resource.h +52 -0
- package/native/time-value.h +28 -0
- package/native/transformable-binding.cc +23 -0
- package/native/transformable-state.h +44 -0
- package/native/value-binding.h +200 -0
- package/native/value-layout.h +116 -0
- package/native/values-binding.cc +27 -0
- package/native/vertex-binding.cc +50 -0
- package/native/vertex-buffer-binding.cc +232 -0
- package/native/vertex-storage.h +20 -0
- package/native/view-data.h +24 -0
- package/native/window-binding.cc +388 -0
- package/native/window-event.h +92 -0
- package/native/window-owner.h +81 -0
- package/package.json +87 -35
- package/src/audio/effect-processor.ts +86 -0
- package/src/audio/input-sound-file.ts +259 -0
- package/src/audio/listener.ts +136 -0
- package/src/audio/music.ts +357 -0
- package/src/audio/output-sound-file.ts +96 -0
- package/src/audio/playback-device.ts +145 -0
- package/src/audio/sound-buffer-recorder.ts +141 -0
- package/src/audio/sound-buffer.ts +275 -0
- package/src/audio/sound-file-factory.ts +235 -0
- package/src/audio/sound-file-reader.ts +224 -0
- package/src/audio/sound-file-writer.ts +61 -0
- package/src/audio/sound-recorder.ts +315 -0
- package/src/audio/sound-source.ts +396 -0
- package/src/audio/sound-stream.ts +108 -0
- package/src/audio/sound.ts +63 -0
- package/src/audio/value.ts +408 -0
- package/src/audio/worker.ts +308 -0
- package/src/graphics/blend-mode.ts +291 -0
- package/src/graphics/boolean-vector.ts +225 -0
- package/src/graphics/circle-shape.ts +113 -0
- package/src/graphics/color.ts +374 -0
- package/src/graphics/convex-shape.ts +76 -0
- package/src/graphics/drawable.ts +32 -0
- package/src/graphics/font.ts +377 -0
- package/src/graphics/glsl-matrix.ts +110 -0
- package/src/graphics/glsl.ts +229 -0
- package/src/graphics/glyph.ts +186 -0
- package/src/graphics/image.ts +366 -0
- package/src/graphics/primitive-type.ts +56 -0
- package/src/graphics/rect.ts +350 -0
- package/src/graphics/rectangle-shape.ts +76 -0
- package/src/graphics/render-states.ts +238 -0
- package/src/graphics/render-target.ts +554 -0
- package/src/graphics/render-texture.ts +234 -0
- package/src/graphics/render-window.ts +250 -0
- package/src/graphics/shader.ts +353 -0
- package/src/graphics/shape.ts +343 -0
- package/src/graphics/sprite.ts +203 -0
- package/src/graphics/stencil-mode.ts +258 -0
- package/src/graphics/swap.ts +28 -0
- package/src/graphics/text.ts +944 -0
- package/src/graphics/texture.ts +529 -0
- package/src/graphics/transform.ts +321 -0
- package/src/graphics/transformable.ts +37 -0
- package/src/graphics/vertex-array.ts +270 -0
- package/src/graphics/vertex-buffer.ts +345 -0
- package/src/graphics/vertex.ts +211 -0
- package/src/graphics/view.ts +355 -0
- package/src/index.ts +147 -0
- package/src/internal/audio-codec-registry.ts +68 -0
- package/src/internal/audio-input-stream.ts +42 -0
- package/src/internal/audio-music-pump.ts +199 -0
- package/src/internal/audio-native.ts +176 -0
- package/src/internal/audio-recorder-session.ts +234 -0
- package/src/internal/audio-worker-session.ts +89 -0
- package/src/internal/audio-worker.ts +146 -0
- package/src/internal/glsl-value.ts +79 -0
- package/src/internal/graphics-state.ts +131 -0
- package/src/internal/input-stream.ts +30 -0
- package/src/internal/lazy-value.ts +62 -0
- package/src/internal/native.ts +581 -0
- package/src/internal/numeric-properties.ts +37 -0
- package/src/internal/render-states.ts +42 -0
- package/src/internal/scalar.ts +117 -0
- package/src/internal/shaped-glyph.ts +68 -0
- package/src/internal/struct-view.ts +49 -0
- package/src/internal/text-indices.ts +19 -0
- package/src/internal/transformable.ts +260 -0
- package/src/internal/value-storage.ts +40 -0
- package/src/network/common.ts +58 -0
- package/src/network/dns.ts +191 -0
- package/src/network/ftp.ts +386 -0
- package/src/network/gen/constants.ts +879 -0
- package/src/network/http.ts +680 -0
- package/src/network/ip-address.ts +311 -0
- package/src/network/packet.ts +388 -0
- package/src/network/sftp.ts +1015 -0
- package/src/network/socket-selector.ts +206 -0
- package/src/network/socket.ts +415 -0
- package/src/network/tcp-listener.ts +193 -0
- package/src/network/tcp-socket.ts +569 -0
- package/src/network/tls-material.ts +46 -0
- package/src/network/udp-socket.ts +294 -0
- package/src/system/angle.ts +132 -0
- package/src/system/clock.ts +104 -0
- package/src/system/err.ts +58 -0
- package/src/system/error.ts +18 -0
- package/src/system/file-input-stream.ts +147 -0
- package/src/system/input-stream.ts +150 -0
- package/src/system/operators.ts +681 -0
- package/src/system/sleep.ts +25 -0
- package/src/system/suspend-aware-clock.ts +27 -0
- package/src/system/time.ts +218 -0
- package/src/system/timeout-with-predicate.ts +94 -0
- package/src/system/unicode.ts +64 -0
- package/src/system/vector2.ts +549 -0
- package/src/system/vector3.ts +433 -0
- package/src/system/version.ts +66 -0
- package/src/window/clipboard.ts +22 -0
- package/src/window/context-settings.ts +143 -0
- package/src/window/context.ts +152 -0
- package/src/window/cursor.ts +116 -0
- package/src/window/event.ts +580 -0
- package/src/window/gen/constants.ts +2231 -0
- package/src/window/joystick.ts +108 -0
- package/src/window/keyboard.ts +78 -0
- package/src/window/mouse.ts +58 -0
- package/src/window/sensor.ts +37 -0
- package/src/window/touch.ts +42 -0
- package/src/window/video-mode.ts +136 -0
- package/src/window/vulkan.ts +42 -0
- package/src/window/window.ts +579 -0
- package/test/native/audio-probes.cc +181 -0
- package/test/native/deferred-delete-probes.cc +62 -0
- package/test/native/drawable-probes.cc +168 -0
- package/test/native/exception-probes.cc +83 -0
- package/test/native/image-probes.cc +105 -0
- package/test/native/matrix-probes.cc +67 -0
- package/test/native/network-oracle.cc +32 -0
- package/test/native/render-texture-probes.cc +193 -0
- package/test/native/shader-probes.cc +69 -0
- package/test/native/shape-probes.cc +160 -0
- package/test/native/sprite-probes.cc +146 -0
- package/test/native/system-probes.cc +109 -0
- package/test/native/text-probes.cc +211 -0
- package/test/native/texture-probes.cc +200 -0
- package/test/native/time-probes.cc +143 -0
- package/test/native/transform-probes.cc +92 -0
- package/test/native/transformable-probes.cc +152 -0
- package/test/native/value-oracle.h +88 -0
- package/test/native/value-probes.cc +379 -0
- package/test/native/vertex-array-probes.cc +82 -0
- package/test/native/vertex-buffer-probes.cc +87 -0
- package/test/native/view-probes.cc +150 -0
- package/test/native/window-probes.cc +172 -0
- package/test/tsconfig.json +8 -0
- package/tools/configure-lsp.cjs +23 -0
- package/tools/constant-docs.cjs +109 -0
- package/tools/constant-docs.json +1318 -0
- package/tools/generate-network-constants.cjs +59 -0
- package/tools/generate-window-constants.cjs +178 -0
- package/tools/lib_downloader.cjs +92 -0
- package/tools/lib_downloader_urls.cjs +23 -0
- package/tsconfig.json +11 -4
- package/index.d.ts +0 -1
- package/lib/clock.d.ts +0 -8
- package/lib/clock.js +0 -5
- package/lib/color.d.ts +0 -11
- package/lib/color.js +0 -98
- package/lib/common.js +0 -47
- package/lib/drawable/circle_shape.d.ts +0 -5
- package/lib/drawable/circle_shape.js +0 -26
- package/lib/drawable/convex_shape.d.ts +0 -5
- package/lib/drawable/convex_shape.js +0 -35
- package/lib/drawable/drawable.d.ts +0 -6
- package/lib/drawable/drawable.js +0 -18
- package/lib/drawable/plugin_package.d.ts +0 -31
- package/lib/drawable/plugin_package.js +0 -102
- package/lib/drawable/rectangle_shape.d.ts +0 -9
- package/lib/drawable/rectangle_shape.js +0 -28
- package/lib/drawable/shape.d.ts +0 -14
- package/lib/drawable/shape.js +0 -30
- package/lib/drawable/sprite.d.ts +0 -17
- package/lib/drawable/sprite.js +0 -53
- package/lib/drawable/text.d.ts +0 -26
- package/lib/drawable/text.js +0 -88
- package/lib/drawable/transformable.d.ts +0 -28
- package/lib/drawable/transformable.js +0 -113
- package/lib/drawable/vertex_array.d.ts +0 -40
- package/lib/drawable/vertex_array.js +0 -128
- package/lib/font.d.ts +0 -24
- package/lib/font.js +0 -137
- package/lib/image.d.ts +0 -26
- package/lib/image.js +0 -147
- package/lib/joystick.d.ts +0 -21
- package/lib/joystick.js +0 -72
- package/lib/keyboard.d.ts +0 -113
- package/lib/keyboard.js +0 -17
- package/lib/mouse.d.ts +0 -6
- package/lib/mouse.js +0 -39
- package/lib/poll_event.d.ts +0 -138
- package/lib/rect.d.ts +0 -18
- package/lib/rect.js +0 -119
- package/lib/render_window.d.ts +0 -67
- package/lib/render_window.js +0 -197
- package/lib/sensor.d.ts +0 -12
- package/lib/sensor.js +0 -34
- package/lib/sfml.d.ts +0 -32
- package/lib/sfml.js +0 -36
- package/lib/sound/base.d.ts +0 -33
- package/lib/sound/base.js +0 -109
- package/lib/sound/music.d.ts +0 -15
- package/lib/sound/music.js +0 -65
- package/lib/sound/sound.d.ts +0 -16
- package/lib/sound/sound.js +0 -55
- package/lib/sound/sound_buffer.d.ts +0 -14
- package/lib/sound/sound_buffer.js +0 -78
- package/lib/texture.d.ts +0 -21
- package/lib/texture.js +0 -127
- package/lib/time.d.ts +0 -13
- package/lib/time.js +0 -41
- package/lib/touch.d.ts +0 -7
- package/lib/touch.js +0 -34
- package/lib/vector2.d.ts +0 -49
- package/lib/vector2.js +0 -141
- package/lib/vector3.d.ts +0 -47
- package/lib/vector3.js +0 -154
- package/lib/vertex.d.ts +0 -14
- package/lib/vertex.js +0 -177
- package/lib/video_mode.d.ts +0 -12
- package/lib/video_mode.js +0 -99
- package/src/base_class_with_loading.h +0 -21
- package/src/clock.cc +0 -71
- package/src/clock.h +0 -30
- package/src/color.cc +0 -189
- package/src/color.h +0 -49
- package/src/drawable/circle_shape.cc +0 -78
- package/src/drawable/circle_shape.h +0 -28
- package/src/drawable/convex_shape.cc +0 -57
- package/src/drawable/convex_shape.h +0 -29
- package/src/drawable/drawable-inl.h +0 -29
- package/src/drawable/drawable.cc +0 -41
- package/src/drawable/drawable.h +0 -49
- package/src/drawable/package_plugin-inl.h +0 -191
- package/src/drawable/package_plugin.h +0 -60
- package/src/drawable/rectangle_shape.cc +0 -69
- package/src/drawable/rectangle_shape.h +0 -29
- package/src/drawable/shape.cc +0 -67
- package/src/drawable/shape.h +0 -39
- package/src/drawable/sprite.cc +0 -122
- package/src/drawable/sprite.h +0 -45
- package/src/drawable/text.cc +0 -133
- package/src/drawable/text.h +0 -54
- package/src/drawable/vertex_array.cc +0 -248
- package/src/drawable/vertex_array.h +0 -46
- package/src/font.cc +0 -214
- package/src/font.h +0 -44
- package/src/gen/.gitkeep +0 -0
- package/src/gen/joystick_axis.cc +0 -30
- package/src/gen/keycode.cc +0 -226
- package/src/gen/mouse_button.cc +0 -30
- package/src/gen/sensor_type.cc +0 -26
- package/src/image.cc +0 -379
- package/src/image.h +0 -72
- package/src/joystick.cc +0 -132
- package/src/joystick.h +0 -32
- package/src/keyboard.cc +0 -65
- package/src/keyboard.h +0 -27
- package/src/mouse.cc +0 -95
- package/src/mouse.h +0 -30
- package/src/plugins/transformable_plugin-inl.h +0 -121
- package/src/plugins/transformable_plugin.h +0 -42
- package/src/poll_event.cc +0 -326
- package/src/poll_event.h +0 -18
- package/src/rect-inl.h +0 -154
- package/src/rect.cc +0 -28
- package/src/rect.h +0 -105
- package/src/render_window.cc +0 -413
- package/src/render_window.h +0 -111
- package/src/render_window_async_display.cc +0 -49
- package/src/render_window_async_draw.cc +0 -56
- package/src/resizable_buffer.h +0 -104
- package/src/sensor.cc +0 -82
- package/src/sensor.h +0 -28
- package/src/sfml.cc +0 -85
- package/src/sound/music.cc +0 -113
- package/src/sound/music.h +0 -35
- package/src/sound/sound.cc +0 -116
- package/src/sound/sound.h +0 -41
- package/src/sound/sound_buffer.cc +0 -226
- package/src/sound/sound_buffer.h +0 -46
- package/src/sound/sound_source.cc +0 -124
- package/src/sound/sound_source.h +0 -80
- package/src/texture.cc +0 -246
- package/src/texture.h +0 -47
- package/src/time.cc +0 -177
- package/src/time.h +0 -42
- package/src/touch.cc +0 -54
- package/src/touch.h +0 -23
- package/src/utils-inl.h +0 -48
- package/src/utils.h +0 -21
- package/src/vector2-inl.h +0 -198
- package/src/vector2.cc +0 -36
- package/src/vector2.h +0 -133
- package/src/vector3-inl.h +0 -200
- package/src/vector3.cc +0 -36
- package/src/vector3.h +0 -134
- package/src/vertex.cc +0 -238
- package/src/vertex.h +0 -114
- package/src/video_mode.cc +0 -184
- package/src/video_mode.h +0 -38
- package/src/workers/load_from_file_worker.h +0 -79
- package/src/workers/save_to_file_worker.h +0 -79
- package/third_party/sfml/include/SFML/Audio/AlResource.hpp +0 -70
- package/third_party/sfml/include/SFML/Audio/Export.hpp +0 -48
- package/third_party/sfml/include/SFML/Audio/InputSoundFile.hpp +0 -268
- package/third_party/sfml/include/SFML/Audio/Listener.hpp +0 -234
- package/third_party/sfml/include/SFML/Audio/Music.hpp +0 -337
- package/third_party/sfml/include/SFML/Audio/OutputSoundFile.hpp +0 -133
- package/third_party/sfml/include/SFML/Audio/Sound.hpp +0 -264
- package/third_party/sfml/include/SFML/Audio/SoundBuffer.hpp +0 -352
- package/third_party/sfml/include/SFML/Audio/SoundBufferRecorder.hpp +0 -144
- package/third_party/sfml/include/SFML/Audio/SoundFileFactory.hpp +0 -197
- package/third_party/sfml/include/SFML/Audio/SoundFileFactory.inl +0 -100
- package/third_party/sfml/include/SFML/Audio/SoundFileReader.hpp +0 -165
- package/third_party/sfml/include/SFML/Audio/SoundFileWriter.hpp +0 -125
- package/third_party/sfml/include/SFML/Audio/SoundRecorder.hpp +0 -410
- package/third_party/sfml/include/SFML/Audio/SoundSource.hpp +0 -332
- package/third_party/sfml/include/SFML/Audio/SoundStream.hpp +0 -420
- package/third_party/sfml/include/SFML/Audio.hpp +0 -56
- package/third_party/sfml/include/SFML/Config.hpp +0 -248
- package/third_party/sfml/include/SFML/GpuPreference.hpp +0 -74
- package/third_party/sfml/include/SFML/Graphics/BlendMode.hpp +0 -219
- package/third_party/sfml/include/SFML/Graphics/CircleShape.hpp +0 -154
- package/third_party/sfml/include/SFML/Graphics/Color.hpp +0 -275
- package/third_party/sfml/include/SFML/Graphics/ConvexShape.hpp +0 -153
- package/third_party/sfml/include/SFML/Graphics/Drawable.hpp +0 -126
- package/third_party/sfml/include/SFML/Graphics/Export.hpp +0 -48
- package/third_party/sfml/include/SFML/Graphics/Font.hpp +0 -496
- package/third_party/sfml/include/SFML/Graphics/Glsl.hpp +0 -227
- package/third_party/sfml/include/SFML/Graphics/Glsl.inl +0 -155
- package/third_party/sfml/include/SFML/Graphics/Glyph.hpp +0 -81
- package/third_party/sfml/include/SFML/Graphics/Image.hpp +0 -346
- package/third_party/sfml/include/SFML/Graphics/PrimitiveType.hpp +0 -58
- package/third_party/sfml/include/SFML/Graphics/Rect.hpp +0 -274
- package/third_party/sfml/include/SFML/Graphics/Rect.inl +0 -171
- package/third_party/sfml/include/SFML/Graphics/RectangleShape.hpp +0 -132
- package/third_party/sfml/include/SFML/Graphics/RenderStates.hpp +0 -174
- package/third_party/sfml/include/SFML/Graphics/RenderTarget.hpp +0 -518
- package/third_party/sfml/include/SFML/Graphics/RenderTexture.hpp +0 -334
- package/third_party/sfml/include/SFML/Graphics/RenderWindow.hpp +0 -302
- package/third_party/sfml/include/SFML/Graphics/Shader.hpp +0 -875
- package/third_party/sfml/include/SFML/Graphics/Shape.hpp +0 -355
- package/third_party/sfml/include/SFML/Graphics/Sprite.hpp +0 -279
- package/third_party/sfml/include/SFML/Graphics/Text.hpp +0 -513
- package/third_party/sfml/include/SFML/Graphics/Texture.hpp +0 -733
- package/third_party/sfml/include/SFML/Graphics/Transform.hpp +0 -497
- package/third_party/sfml/include/SFML/Graphics/Transformable.hpp +0 -429
- package/third_party/sfml/include/SFML/Graphics/Vertex.hpp +0 -148
- package/third_party/sfml/include/SFML/Graphics/VertexArray.hpp +0 -223
- package/third_party/sfml/include/SFML/Graphics/VertexBuffer.hpp +0 -408
- package/third_party/sfml/include/SFML/Graphics/View.hpp +0 -343
- package/third_party/sfml/include/SFML/Graphics.hpp +0 -68
- package/third_party/sfml/include/SFML/Main.hpp +0 -43
- package/third_party/sfml/include/SFML/Network/Export.hpp +0 -48
- package/third_party/sfml/include/SFML/Network/Ftp.hpp +0 -616
- package/third_party/sfml/include/SFML/Network/Http.hpp +0 -482
- package/third_party/sfml/include/SFML/Network/IpAddress.hpp +0 -328
- package/third_party/sfml/include/SFML/Network/Packet.hpp +0 -545
- package/third_party/sfml/include/SFML/Network/Socket.hpp +0 -219
- package/third_party/sfml/include/SFML/Network/SocketHandle.hpp +0 -57
- package/third_party/sfml/include/SFML/Network/SocketSelector.hpp +0 -263
- package/third_party/sfml/include/SFML/Network/TcpListener.hpp +0 -170
- package/third_party/sfml/include/SFML/Network/TcpSocket.hpp +0 -316
- package/third_party/sfml/include/SFML/Network/UdpSocket.hpp +0 -292
- package/third_party/sfml/include/SFML/Network.hpp +0 -53
- package/third_party/sfml/include/SFML/OpenGL.hpp +0 -78
- package/third_party/sfml/include/SFML/System/Clock.hpp +0 -117
- package/third_party/sfml/include/SFML/System/Err.hpp +0 -80
- package/third_party/sfml/include/SFML/System/Export.hpp +0 -48
- package/third_party/sfml/include/SFML/System/FileInputStream.hpp +0 -169
- package/third_party/sfml/include/SFML/System/InputStream.hpp +0 -152
- package/third_party/sfml/include/SFML/System/Lock.hpp +0 -139
- package/third_party/sfml/include/SFML/System/MemoryInputStream.hpp +0 -148
- package/third_party/sfml/include/SFML/System/Mutex.hpp +0 -148
- package/third_party/sfml/include/SFML/System/NativeActivity.hpp +0 -62
- package/third_party/sfml/include/SFML/System/NonCopyable.hpp +0 -129
- package/third_party/sfml/include/SFML/System/Sleep.hpp +0 -52
- package/third_party/sfml/include/SFML/System/String.hpp +0 -669
- package/third_party/sfml/include/SFML/System/String.inl +0 -53
- package/third_party/sfml/include/SFML/System/Thread.hpp +0 -282
- package/third_party/sfml/include/SFML/System/Thread.inl +0 -90
- package/third_party/sfml/include/SFML/System/ThreadLocal.hpp +0 -103
- package/third_party/sfml/include/SFML/System/ThreadLocalPtr.hpp +0 -158
- package/third_party/sfml/include/SFML/System/ThreadLocalPtr.inl +0 -77
- package/third_party/sfml/include/SFML/System/Time.hpp +0 -488
- package/third_party/sfml/include/SFML/System/Utf.hpp +0 -763
- package/third_party/sfml/include/SFML/System/Utf.inl +0 -752
- package/third_party/sfml/include/SFML/System/Vector2.hpp +0 -301
- package/third_party/sfml/include/SFML/System/Vector2.inl +0 -161
- package/third_party/sfml/include/SFML/System/Vector3.hpp +0 -302
- package/third_party/sfml/include/SFML/System/Vector3.inl +0 -168
- package/third_party/sfml/include/SFML/System.hpp +0 -60
- package/third_party/sfml/include/SFML/Window/Clipboard.hpp +0 -119
- package/third_party/sfml/include/SFML/Window/Context.hpp +0 -195
- package/third_party/sfml/include/SFML/Window/ContextSettings.hpp +0 -149
- package/third_party/sfml/include/SFML/Window/Cursor.hpp +0 -241
- package/third_party/sfml/include/SFML/Window/Event.hpp +0 -285
- package/third_party/sfml/include/SFML/Window/Export.hpp +0 -48
- package/third_party/sfml/include/SFML/Window/GlResource.hpp +0 -109
- package/third_party/sfml/include/SFML/Window/Joystick.hpp +0 -227
- package/third_party/sfml/include/SFML/Window/Keyboard.hpp +0 -491
- package/third_party/sfml/include/SFML/Window/Mouse.hpp +0 -180
- package/third_party/sfml/include/SFML/Window/Sensor.hpp +0 -150
- package/third_party/sfml/include/SFML/Window/Touch.hpp +0 -137
- package/third_party/sfml/include/SFML/Window/VideoMode.hpp +0 -228
- package/third_party/sfml/include/SFML/Window/Vulkan.hpp +0 -115
- package/third_party/sfml/include/SFML/Window/Window.hpp +0 -354
- package/third_party/sfml/include/SFML/Window/WindowBase.hpp +0 -518
- package/third_party/sfml/include/SFML/Window/WindowHandle.hpp +0 -101
- package/third_party/sfml/include/SFML/Window/WindowStyle.hpp +0 -53
- package/third_party/sfml/include/SFML/Window.hpp +0 -58
- package/tools/clang_format.js +0 -9
- package/tools/copier/linux.js +0 -21
- package/tools/copier/macos.js +0 -34
- package/tools/copier/windows.js +0 -33
- package/tools/joystick_axis.js +0 -63
- package/tools/keycode.js +0 -92
- package/tools/lib_downloader.js +0 -107
- package/tools/lib_downloader_urls.js +0 -59
- package/tools/mouse_button.js +0 -92
- package/tools/sensor_type.js +0 -63
package/docs/window.md
ADDED
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
# Window
|
|
2
|
+
|
|
3
|
+
**English** · [简体中文](window.zh-CN.md) · [日本語](window.ja.md) · [한국어](window.ko.md)
|
|
4
|
+
|
|
5
|
+
> Use RenderWindow for 2D drawing, or Window when integrating OpenGL yourself. Window operations run on the main thread.
|
|
6
|
+
|
|
7
|
+
[API guide](api.md) · [Graphics](graphics.md) · [Quick start](getting-started.md)
|
|
8
|
+
|
|
9
|
+
## Creation and closing
|
|
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 and RenderWindow support default construction followed by `create()`. They also accept a Vector2u size or a bigint handle to an existing system window. `close()` closes the window, but the JS object can still create another window.
|
|
27
|
+
|
|
28
|
+
RenderWindow satisfies both `instanceof Window` and `instanceof RenderTarget`. It supports drawing directly, querying relative mouse coordinates and serving as the source of `Texture.update(window)`.
|
|
29
|
+
|
|
30
|
+
| API | Purpose |
|
|
31
|
+
| --- | --- |
|
|
32
|
+
| `get/setPosition()`, `get/setSize()` | Window position and client-area size |
|
|
33
|
+
| `setMinimumSize()`, `setMaximumSize()` | Size limits; undefined removes the limit |
|
|
34
|
+
| `setTitle()`, `setVisible()`, `setIcon()` | Title, visibility and RGBA icon |
|
|
35
|
+
| `requestFocus()`, `hasFocus()` | Request and query focus |
|
|
36
|
+
| `setMouseCursor()`, `setMouseCursorVisible()`, `setMouseCursorGrabbed()` | Cursor and mouse confinement |
|
|
37
|
+
| `setKeyRepeatEnabled()`, `setJoystickThreshold()` | Input behavior |
|
|
38
|
+
| `setVerticalSyncEnabled()`, `setFramerateLimit()` | Presentation timing |
|
|
39
|
+
| `getSettings()`, `getNativeHandle()` | Actual context settings and system window handle |
|
|
40
|
+
|
|
41
|
+
Positions use Vector2i; sizes use Vector2u. `setIcon(size, pixels)` accepts RGBA8 bytes; RenderWindow also accepts Image.
|
|
42
|
+
|
|
43
|
+
## Event loop
|
|
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?)` drains the event queue, preferring the handler for each event type. You can also pass a single function to handle all events.
|
|
68
|
+
|
|
69
|
+
Use `pollEvent()` for manual dispatch:
|
|
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()` returns undefined when no event is available. Event data is a union discriminated by kind; use `is()`, `getIf()` and `visit()` to narrow or access it. TextEntered uses Unicode code points.
|
|
81
|
+
|
|
82
|
+
`waitEvent(timeout = Time.Zero)` blocks synchronously and returns undefined on timeout or closing. Frame loops that also need to process Node I/O should use pollEvent/handleEvents and yield to the event loop between frames.
|
|
83
|
+
|
|
84
|
+
## Real-time input and system features
|
|
85
|
+
|
|
86
|
+
| API | Description |
|
|
87
|
+
| --- | --- |
|
|
88
|
+
| `Keyboard.isKeyPressed(key)` | Current key-code state |
|
|
89
|
+
| `Keyboard.isKeyPressed(scancode, 'scancode')` | Current physical scancode state |
|
|
90
|
+
| `Keyboard.localize()`/`delocalize()`/`getDescription()` | Current keyboard layout mapping and descriptions |
|
|
91
|
+
| `Mouse.getPosition(window?)`/`setPosition(position, window?)` | Uses screen coordinates when the window is omitted |
|
|
92
|
+
| `Mouse.isButtonPressed(button)` | Current mouse-button state |
|
|
93
|
+
| Joystick | Connection, buttons, axes and device identification; call `update()` without a window loop |
|
|
94
|
+
| Sensor | Check `isAvailable()` before enabling and reading |
|
|
95
|
+
| Clipboard | `getString()`/`setString()`, supporting JS Unicode strings |
|
|
96
|
+
| Touch | Touch-point state and position; SFML 3.1.0 deprecates the real-time Touch API |
|
|
97
|
+
|
|
98
|
+
Enums in input namespaces share the same objects as their top-level counterparts, such as `Keyboard.Key` and `KeyboardKey`.
|
|
99
|
+
|
|
100
|
+
`Cursor.createFromSystem()` and `createFromPixels()` return undefined on failure; constructor failures throw. A window keeps its active Cursor alive. On macOS, create a window before using system cursors.
|
|
101
|
+
|
|
102
|
+
VideoMode uses `size` and `bitsPerPixel`; `getDesktopMode()` and `getFullscreenModes()` query device modes, and `isValid()` validates fullscreen modes. Do not assume a machine provides any particular number of fullscreen modes.
|
|
103
|
+
|
|
104
|
+
## OpenGL and Vulkan
|
|
105
|
+
|
|
106
|
+
Context can create an independent OpenGL context, with activation, actual settings, extension queries and function-address queries. `Context.getActiveContextId()` returns a bigint, or `0n` when no context is active. `getFunction()` returns an address as bigint; calling it requires native code with a matching signature.
|
|
107
|
+
|
|
108
|
+
RenderWindow's `setActive()`, `pushGLStates()`, `popGLStates()` and `resetGLStates()` support mixing SFML with custom OpenGL. Submit SFML commands before modifying GL state directly, and pair push/pop in the same context.
|
|
109
|
+
|
|
110
|
+
The Vulkan namespace provides:
|
|
111
|
+
|
|
112
|
+
- `isAvailable(requireGraphics = true)`.
|
|
113
|
+
- `getFunction(name)`.
|
|
114
|
+
- `getGraphicsRequiredInstanceExtensions()`.
|
|
115
|
+
|
|
116
|
+
`window.createVulkanSurface(instance, allocator = 0n)` returns a bigint surface handle, or undefined on failure. The caller is responsible for the instance, allocator and surface destruction.
|
|
117
|
+
|
|
118
|
+
SFML 3.1.0's macOS build does not provide a Vulkan backend, so these queries report unavailability. Installing MoltenVK does not change SFML's platform branch. Successful Windows/X11 paths require validation in those environments.
|
|
119
|
+
|
|
120
|
+
## Run the demo
|
|
121
|
+
|
|
122
|
+
After building, run `node examples/window.cjs --frames=120` to inspect events, key codes, pointer positions and window properties; omit the frame count to run continuously.
|
|
123
|
+
|
|
124
|
+
| Key | Action |
|
|
125
|
+
| --- | --- |
|
|
126
|
+
| F1/F2 | Cursor type/visibility |
|
|
127
|
+
| F3/F4 | Key repeat/vertical sync |
|
|
128
|
+
| F5/F6 | Window size/size limits |
|
|
129
|
+
| F7/F8 | Change title/hide for 1 second, then restore |
|
|
130
|
+
| F9/F10 | Event API/move window |
|
|
131
|
+
| Esc | Close |
|
|
132
|
+
|
|
133
|
+
On macOS, you may also need to hold Fn. Determine joystick, sensor, touch and Vulkan capabilities from device queries; a passing CI build does not mean all of these hardware paths have been verified.
|
|
134
|
+
|
|
135
|
+
<a id="sfml-cpp-reference"></a>
|
|
136
|
+
|
|
137
|
+
## SFML C++ reference
|
|
138
|
+
|
|
139
|
+
See the original [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) and [Cursor](https://www.sfml-dev.org/documentation/3.1.0/classsf_1_1Cursor.html) references for upstream window, event and cursor concepts.
|
|
140
|
+
|
|
141
|
+
C++ event types and coordinate rules apply as documented here. JavaScript dispatch uses string event names and typed payloads, and frame loops yield through `setImmediate()`; `waitEvent()` remains synchronous.
|
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
# Window
|
|
2
|
+
|
|
3
|
+
[English](window.md) · **简体中文** · [日本語](window.ja.md) · [한국어](window.ko.md)
|
|
4
|
+
|
|
5
|
+
> 二维绘制使用 RenderWindow;自行接入 OpenGL 时可使用 Window。窗口操作在主线程执行。
|
|
6
|
+
|
|
7
|
+
[API 导航](api.zh-CN.md) · [Graphics](graphics.zh-CN.md) · [快速开始](getting-started.zh-CN.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
|
+
|
|
137
|
+
## SFML C++ 参考
|
|
138
|
+
|
|
139
|
+
窗口与事件参考 [sf::Window](https://www.sfml-dev.org/documentation/3.1.0/classsf_1_1Window.html)、[sf::RenderWindow](https://www.sfml-dev.org/documentation/3.1.0/classsf_1_1RenderWindow.html)、[sf::Event](https://www.sfml-dev.org/documentation/3.1.0/classsf_1_1Event.html);显示模式与光标参考 [sf::VideoMode](https://www.sfml-dev.org/documentation/3.1.0/classsf_1_1VideoMode.html) 和 [sf::Cursor](https://www.sfml-dev.org/documentation/3.1.0/classsf_1_1Cursor.html)。
|
|
140
|
+
|
|
141
|
+
上游事件类型和坐标规则可作为概念参考。JS 用字符串事件名和类型化载荷分派事件,并通过 `setImmediate()` 在帧间让出事件循环;`waitEvent()` 仍是同步等待,不能将 C++ 主循环直接搬入 Node.js。
|
package/native/addon.cc
ADDED
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
#include <nan.h>
|
|
2
|
+
#include "deferred-delete.h"
|
|
3
|
+
#include "exception-boundary.h"
|
|
4
|
+
#include <SFML/Config.hpp>
|
|
5
|
+
#include <SFML/System/Clock.hpp>
|
|
6
|
+
#include <SFML/System/Time.hpp>
|
|
7
|
+
|
|
8
|
+
#include <string>
|
|
9
|
+
|
|
10
|
+
NAN_MODULE_INIT(InitializeSystem);
|
|
11
|
+
NAN_MODULE_INIT(InitializeAudio);
|
|
12
|
+
NAN_MODULE_INIT(InitializeAudioFiles);
|
|
13
|
+
NAN_MODULE_INIT(InitializeAudioDevices);
|
|
14
|
+
NAN_MODULE_INIT(InitializeAudioWorkers);
|
|
15
|
+
NAN_MODULE_INIT(InitializeAudioRecorders);
|
|
16
|
+
NAN_MODULE_INIT(InitializeAudioProbes);
|
|
17
|
+
NAN_MODULE_INIT(InitializeAudioStreams);
|
|
18
|
+
NAN_MODULE_INIT(InitializeAudioCodecs);
|
|
19
|
+
NAN_MODULE_INIT(InitializeErrorStream);
|
|
20
|
+
NAN_MODULE_INIT(InitializeSystemProbes);
|
|
21
|
+
NAN_MODULE_INIT(InitializeContext);
|
|
22
|
+
NAN_MODULE_INIT(InitializeGraphics);
|
|
23
|
+
NAN_MODULE_INIT(InitializeTexture);
|
|
24
|
+
NAN_MODULE_INIT(InitializeTextureProbes);
|
|
25
|
+
NAN_MODULE_INIT(InitializeRenderTextureProbes);
|
|
26
|
+
NAN_MODULE_INIT(InitializeVertexStorage);
|
|
27
|
+
NAN_MODULE_INIT(InitializeVertexBuffer);
|
|
28
|
+
NAN_MODULE_INIT(InitializeShader);
|
|
29
|
+
NAN_MODULE_INIT(InitializeShaderProbes);
|
|
30
|
+
NAN_MODULE_INIT(InitializeVertexBufferProbes);
|
|
31
|
+
NAN_MODULE_INIT(InitializeVertexArrayProbes);
|
|
32
|
+
NAN_MODULE_INIT(InitializeImage);
|
|
33
|
+
NAN_MODULE_INIT(InitializeStream);
|
|
34
|
+
NAN_MODULE_INIT(InitializeWindow);
|
|
35
|
+
NAN_MODULE_INIT(InitializeRenderWindow);
|
|
36
|
+
NAN_MODULE_INIT(InitializeInput);
|
|
37
|
+
NAN_MODULE_INIT(InitializeWindowProbes);
|
|
38
|
+
NAN_MODULE_INIT(InitializeDeletionProbes);
|
|
39
|
+
NAN_MODULE_INIT(InitializeImageProbes);
|
|
40
|
+
NAN_MODULE_INIT(InitializeValues);
|
|
41
|
+
NAN_MODULE_INIT(InitializeValueProbes);
|
|
42
|
+
NAN_MODULE_INIT(InitializeTimeProbes);
|
|
43
|
+
NAN_MODULE_INIT(InitializeTransformProbes);
|
|
44
|
+
NAN_MODULE_INIT(InitializeMatrixProbes);
|
|
45
|
+
NAN_MODULE_INIT(InitializeTransformable);
|
|
46
|
+
NAN_MODULE_INIT(InitializeTransformableProbes);
|
|
47
|
+
NAN_MODULE_INIT(InitializeSpriteProbes);
|
|
48
|
+
NAN_MODULE_INIT(InitializeShape);
|
|
49
|
+
NAN_MODULE_INIT(InitializeFont);
|
|
50
|
+
NAN_MODULE_INIT(InitializeText);
|
|
51
|
+
NAN_MODULE_INIT(InitializeTextProbes);
|
|
52
|
+
NAN_MODULE_INIT(InitializeShapeProbes);
|
|
53
|
+
NAN_MODULE_INIT(InitializeDrawableProbes);
|
|
54
|
+
NAN_MODULE_INIT(InitializeViewProbes);
|
|
55
|
+
NAN_MODULE_INIT(InitializeExceptionProbes);
|
|
56
|
+
|
|
57
|
+
namespace {
|
|
58
|
+
|
|
59
|
+
NAN_METHOD(SystemElapsedMicroseconds) {
|
|
60
|
+
// Calling a non-inline SFML method verifies the downloaded dynamic library.
|
|
61
|
+
sf::Clock clock;
|
|
62
|
+
info.GetReturnValue().Set(
|
|
63
|
+
Nan::New(static_cast<double>(clock.getElapsedTime().asMicroseconds())));
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
NAN_MODULE_INIT(InitializeModule) {
|
|
67
|
+
sfmljs::DeferredDelete::Initialize(v8::Isolate::GetCurrent());
|
|
68
|
+
sfmljs::InitializeErrors(target);
|
|
69
|
+
InitializeErrorStream(target);
|
|
70
|
+
InitializeSystem(target);
|
|
71
|
+
InitializeAudio(target);
|
|
72
|
+
InitializeAudioFiles(target);
|
|
73
|
+
InitializeAudioDevices(target);
|
|
74
|
+
InitializeAudioWorkers(target);
|
|
75
|
+
InitializeAudioRecorders(target);
|
|
76
|
+
InitializeAudioProbes(target);
|
|
77
|
+
InitializeAudioStreams(target);
|
|
78
|
+
InitializeAudioCodecs(target);
|
|
79
|
+
InitializeSystemProbes(target);
|
|
80
|
+
InitializeContext(target);
|
|
81
|
+
InitializeDeletionProbes(target);
|
|
82
|
+
InitializeValues(target);
|
|
83
|
+
InitializeValueProbes(target);
|
|
84
|
+
InitializeTimeProbes(target);
|
|
85
|
+
InitializeTransformProbes(target);
|
|
86
|
+
InitializeMatrixProbes(target);
|
|
87
|
+
InitializeTransformable(target);
|
|
88
|
+
InitializeTransformableProbes(target);
|
|
89
|
+
InitializeSpriteProbes(target);
|
|
90
|
+
InitializeShape(target);
|
|
91
|
+
InitializeFont(target);
|
|
92
|
+
InitializeText(target);
|
|
93
|
+
InitializeTextProbes(target);
|
|
94
|
+
InitializeShapeProbes(target);
|
|
95
|
+
InitializeDrawableProbes(target);
|
|
96
|
+
InitializeViewProbes(target);
|
|
97
|
+
InitializeGraphics(target);
|
|
98
|
+
InitializeTexture(target);
|
|
99
|
+
InitializeTextureProbes(target);
|
|
100
|
+
InitializeRenderTextureProbes(target);
|
|
101
|
+
InitializeVertexStorage(target);
|
|
102
|
+
InitializeVertexBuffer(target);
|
|
103
|
+
InitializeShader(target);
|
|
104
|
+
InitializeShaderProbes(target);
|
|
105
|
+
InitializeVertexBufferProbes(target);
|
|
106
|
+
InitializeVertexArrayProbes(target);
|
|
107
|
+
InitializeImage(target);
|
|
108
|
+
InitializeStream(target);
|
|
109
|
+
InitializeWindow(target);
|
|
110
|
+
InitializeRenderWindow(target);
|
|
111
|
+
InitializeInput(target);
|
|
112
|
+
InitializeWindowProbes(target);
|
|
113
|
+
InitializeImageProbes(target);
|
|
114
|
+
InitializeExceptionProbes(target);
|
|
115
|
+
sfmljs::SetMethod<SystemElapsedMicroseconds>(target, "systemElapsedMicroseconds");
|
|
116
|
+
Nan::Set(target, Nan::New("sfmlVersion").ToLocalChecked(),
|
|
117
|
+
Nan::New(std::to_string(SFML_VERSION_MAJOR) + "." +
|
|
118
|
+
std::to_string(SFML_VERSION_MINOR) + "." +
|
|
119
|
+
std::to_string(SFML_VERSION_PATCH)).ToLocalChecked()).FromJust();
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
NAN_MODULE_INIT(Initialize) {
|
|
123
|
+
sfmljs::GuardExceptions([&] { InitializeModule(target); },
|
|
124
|
+
[](const char* message) { sfmljs::ThrowError(message); });
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
} // namespace
|
|
128
|
+
|
|
129
|
+
NAN_MODULE_WORKER_ENABLED(sfml, Initialize)
|