@lightningjs/renderer 3.0.0-beta4 → 3.0.0-beta5
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 +202 -202
- package/NOTICE +3 -3
- package/README.md +147 -147
- package/dist/exports/core-api.d.ts +74 -0
- package/dist/exports/core-api.js +96 -0
- package/dist/exports/core-api.js.map +1 -0
- package/dist/exports/main-api.d.ts +30 -0
- package/dist/exports/main-api.js +45 -0
- package/dist/exports/main-api.js.map +1 -0
- package/dist/src/core/CoreExtension.d.ts +12 -0
- package/dist/src/core/CoreExtension.js +29 -0
- package/dist/src/core/CoreExtension.js.map +1 -0
- package/dist/src/core/CoreNode.js +1 -1
- package/dist/src/core/CoreNode.js.map +1 -1
- package/dist/src/core/CoreStuff.js +138 -0
- package/dist/src/core/CoreStuff.js.map +1 -0
- package/dist/src/core/CoreTextNode.js +1 -0
- package/dist/src/core/CoreTextNode.js.map +1 -1
- package/dist/src/core/CoreTexturizer.d.ts +14 -0
- package/dist/src/core/CoreTexturizer.js +47 -0
- package/dist/src/core/CoreTexturizer.js.map +1 -0
- package/dist/src/core/LngNode.d.ts +736 -0
- package/dist/src/core/LngNode.js +1174 -0
- package/dist/src/core/LngNode.js.map +1 -0
- package/dist/src/core/Matrix2DContext.d.ts +15 -0
- package/dist/src/core/Matrix2DContext.js +45 -0
- package/dist/src/core/Matrix2DContext.js.map +1 -0
- package/dist/src/core/ShaderNode.d.ts +10 -0
- package/dist/src/core/ShaderNode.js +30 -0
- package/dist/src/core/ShaderNode.js.map +1 -0
- package/dist/src/core/TextNode.d.ts +103 -0
- package/dist/src/core/TextNode.js +331 -0
- package/dist/src/core/TextNode.js.map +1 -0
- package/dist/src/core/lib/Coords.d.ts +14 -0
- package/dist/src/core/lib/Coords.js +55 -0
- package/dist/src/core/lib/Coords.js.map +1 -0
- package/dist/src/core/lib/glm/common.d.ts +162 -0
- package/dist/src/core/lib/glm/common.js +81 -0
- package/dist/src/core/lib/glm/common.js.map +1 -0
- package/dist/src/core/lib/glm/index.d.ts +11 -0
- package/dist/src/core/lib/glm/index.js +30 -0
- package/dist/src/core/lib/glm/index.js.map +1 -0
- package/dist/src/core/lib/glm/mat2.d.ts +219 -0
- package/dist/src/core/lib/glm/mat2.js +396 -0
- package/dist/src/core/lib/glm/mat2.js.map +1 -0
- package/dist/src/core/lib/glm/mat2d.d.ts +237 -0
- package/dist/src/core/lib/glm/mat2d.js +442 -0
- package/dist/src/core/lib/glm/mat2d.js.map +1 -0
- package/dist/src/core/lib/glm/mat3.d.ts +283 -0
- package/dist/src/core/lib/glm/mat3.js +680 -0
- package/dist/src/core/lib/glm/mat3.js.map +1 -0
- package/dist/src/core/lib/glm/mat4.d.ts +550 -0
- package/dist/src/core/lib/glm/mat4.js +1802 -0
- package/dist/src/core/lib/glm/mat4.js.map +1 -0
- package/dist/src/core/lib/glm/quat.d.ts +363 -0
- package/dist/src/core/lib/glm/quat.js +693 -0
- package/dist/src/core/lib/glm/quat.js.map +1 -0
- package/dist/src/core/lib/glm/quat2.d.ts +356 -0
- package/dist/src/core/lib/glm/quat2.js +754 -0
- package/dist/src/core/lib/glm/quat2.js.map +1 -0
- package/dist/src/core/lib/glm/vec2.d.ts +365 -0
- package/dist/src/core/lib/glm/vec2.js +569 -0
- package/dist/src/core/lib/glm/vec2.js.map +1 -0
- package/dist/src/core/lib/glm/vec3.d.ts +406 -0
- package/dist/src/core/lib/glm/vec3.js +720 -0
- package/dist/src/core/lib/glm/vec3.js.map +1 -0
- package/dist/src/core/lib/glm/vec4.d.ts +330 -0
- package/dist/src/core/lib/glm/vec4.js +608 -0
- package/dist/src/core/lib/glm/vec4.js.map +1 -0
- package/dist/src/core/renderers/CoreShaderManager.d.ts +19 -0
- package/dist/src/core/renderers/CoreShaderManager.js +33 -0
- package/dist/src/core/renderers/CoreShaderManager.js.map +1 -0
- package/dist/src/core/renderers/webgl/WebGlCoreShaderManager.d.ts +27 -0
- package/dist/src/core/renderers/webgl/WebGlCoreShaderManager.js +82 -0
- package/dist/src/core/renderers/webgl/WebGlCoreShaderManager.js.map +1 -0
- package/dist/src/core/renderers/webgl/WebGlCoreShaderProgram.d.ts +11 -0
- package/dist/src/core/renderers/webgl/WebGlCoreShaderProgram.js +34 -0
- package/dist/src/core/renderers/webgl/WebGlCoreShaderProgram.js.map +1 -0
- package/dist/src/core/renderers/webgl/internal/ShaderUtils.js +35 -35
- package/dist/src/core/renderers/webgl/shaders/DefaultShader.js +45 -45
- package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js +61 -61
- package/dist/src/core/renderers/webgl/shaders/DynamicShader.js +93 -93
- package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js +63 -63
- package/dist/src/core/renderers/webgl/shaders/SdfShader.js +62 -62
- package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.js +15 -15
- package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.js +6 -6
- package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.js +15 -15
- package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.js +15 -15
- package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.js +15 -15
- package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.js +42 -42
- package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.js +44 -44
- package/dist/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.js +3 -3
- package/dist/src/core/renderers/webgl/shaders/effects/HolePunchEffect.js +22 -22
- package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js +28 -28
- package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js +10 -10
- package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.js +37 -37
- package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js +19 -19
- package/dist/src/core/scene/Scene.d.ts +59 -0
- package/dist/src/core/scene/Scene.js +106 -0
- package/dist/src/core/scene/Scene.js.map +1 -0
- package/dist/src/core/shaders/webgl/Border.js +59 -59
- package/dist/src/core/shaders/webgl/Default.js +47 -47
- package/dist/src/core/shaders/webgl/DefaultBatched.js +61 -61
- package/dist/src/core/shaders/webgl/HolePunch.js +32 -32
- package/dist/src/core/shaders/webgl/LinearGradient.js +36 -36
- package/dist/src/core/shaders/webgl/RadialGradient.js +33 -33
- package/dist/src/core/shaders/webgl/Rounded.js +71 -71
- package/dist/src/core/shaders/webgl/RoundedWithBorder.js +66 -66
- package/dist/src/core/shaders/webgl/RoundedWithBorderAndShadow.js +79 -79
- package/dist/src/core/shaders/webgl/RoundedWithShadow.js +54 -54
- package/dist/src/core/shaders/webgl/SdfShader.js +62 -62
- package/dist/src/core/shaders/webgl/Shadow.js +83 -83
- package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.d.ts +20 -0
- package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.js +55 -0
- package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.js.map +1 -0
- package/dist/src/main-api/ICoreDriver.d.ts +27 -0
- package/dist/src/main-api/ICoreDriver.js +20 -0
- package/dist/src/main-api/ICoreDriver.js.map +1 -0
- package/dist/src/main-api/IRenderDriver.d.ts +20 -0
- package/dist/src/main-api/IRenderDriver.js +20 -0
- package/dist/src/main-api/IRenderDriver.js.map +1 -0
- package/dist/src/main-api/IShaderController.d.ts +14 -0
- package/dist/src/main-api/IShaderController.js +30 -0
- package/dist/src/main-api/IShaderController.js.map +1 -0
- package/dist/src/main-api/IShaderNode.d.ts +17 -0
- package/dist/src/main-api/IShaderNode.js +19 -0
- package/dist/src/main-api/IShaderNode.js.map +1 -0
- package/dist/src/main-api/RendererMain.d.ts +375 -0
- package/dist/src/main-api/RendererMain.js +365 -0
- package/dist/src/main-api/RendererMain.js.map +1 -0
- package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.d.ts +9 -0
- package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js +38 -0
- package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js.map +1 -0
- package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.d.ts +56 -0
- package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js +101 -0
- package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js.map +1 -0
- package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.d.ts +32 -0
- package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js +28 -0
- package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js.map +1 -0
- package/dist/src/render-drivers/main/MainCoreDriver.d.ts +24 -0
- package/dist/src/render-drivers/main/MainCoreDriver.js +118 -0
- package/dist/src/render-drivers/main/MainCoreDriver.js.map +1 -0
- package/dist/src/render-drivers/main/MainOnlyNode.d.ts +99 -0
- package/dist/src/render-drivers/main/MainOnlyNode.js +396 -0
- package/dist/src/render-drivers/main/MainOnlyNode.js.map +1 -0
- package/dist/src/render-drivers/main/MainOnlyShaderController.d.ts +6 -0
- package/dist/src/render-drivers/main/MainOnlyShaderController.js +15 -0
- package/dist/src/render-drivers/main/MainOnlyShaderController.js.map +1 -0
- package/dist/src/render-drivers/main/MainOnlyShaderNode.d.ts +7 -0
- package/dist/src/render-drivers/main/MainOnlyShaderNode.js +34 -0
- package/dist/src/render-drivers/main/MainOnlyShaderNode.js.map +1 -0
- package/dist/src/render-drivers/main/MainOnlyTextNode.d.ts +47 -0
- package/dist/src/render-drivers/main/MainOnlyTextNode.js +205 -0
- package/dist/src/render-drivers/main/MainOnlyTextNode.js.map +1 -0
- package/dist/src/render-drivers/main/MainRenderDriver.d.ts +17 -0
- package/dist/src/render-drivers/main/MainRenderDriver.js +88 -0
- package/dist/src/render-drivers/main/MainRenderDriver.js.map +1 -0
- package/dist/src/render-drivers/threadx/NodeStruct.d.ts +90 -0
- package/dist/src/render-drivers/threadx/NodeStruct.js +281 -0
- package/dist/src/render-drivers/threadx/NodeStruct.js.map +1 -0
- package/dist/src/render-drivers/threadx/SharedNode.d.ts +39 -0
- package/dist/src/render-drivers/threadx/SharedNode.js +60 -0
- package/dist/src/render-drivers/threadx/SharedNode.js.map +1 -0
- package/dist/src/render-drivers/threadx/TextNodeStruct.d.ts +44 -0
- package/dist/src/render-drivers/threadx/TextNodeStruct.js +201 -0
- package/dist/src/render-drivers/threadx/TextNodeStruct.js.map +1 -0
- package/dist/src/render-drivers/threadx/ThreadXCoreDriver.d.ts +28 -0
- package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js +234 -0
- package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js.map +1 -0
- package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.d.ts +20 -0
- package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js +84 -0
- package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js.map +1 -0
- package/dist/src/render-drivers/threadx/ThreadXMainNode.d.ts +44 -0
- package/dist/src/render-drivers/threadx/ThreadXMainNode.js +154 -0
- package/dist/src/render-drivers/threadx/ThreadXMainNode.js.map +1 -0
- package/dist/src/render-drivers/threadx/ThreadXMainShaderController.d.ts +6 -0
- package/dist/src/render-drivers/threadx/ThreadXMainShaderController.js +16 -0
- package/dist/src/render-drivers/threadx/ThreadXMainShaderController.js.map +1 -0
- package/dist/src/render-drivers/threadx/ThreadXMainShaderNode.d.ts +7 -0
- package/dist/src/render-drivers/threadx/ThreadXMainShaderNode.js +15 -0
- package/dist/src/render-drivers/threadx/ThreadXMainShaderNode.js.map +1 -0
- package/dist/src/render-drivers/threadx/ThreadXMainTextNode.d.ts +28 -0
- package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js +55 -0
- package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js.map +1 -0
- package/dist/src/render-drivers/threadx/ThreadXRenderDriver.d.ts +21 -0
- package/dist/src/render-drivers/threadx/ThreadXRenderDriver.js +198 -0
- package/dist/src/render-drivers/threadx/ThreadXRenderDriver.js.map +1 -0
- package/dist/src/render-drivers/threadx/ThreadXRendererMessage.d.ts +70 -0
- package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js +32 -0
- package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js.map +1 -0
- package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.d.ts +19 -0
- package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js +177 -0
- package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js.map +1 -0
- package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.d.ts +27 -0
- package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js +108 -0
- package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js.map +1 -0
- package/dist/src/render-drivers/threadx/worker/renderer.d.ts +1 -0
- package/dist/src/render-drivers/threadx/worker/renderer.js +145 -0
- package/dist/src/render-drivers/threadx/worker/renderer.js.map +1 -0
- package/dist/src/render-drivers/utils.d.ts +12 -0
- package/dist/src/render-drivers/utils.js +69 -0
- package/dist/src/render-drivers/utils.js.map +1 -0
- package/dist/tsconfig.dist.tsbuildinfo +1 -1
- package/exports/canvas-shaders.ts +28 -28
- package/exports/canvas.ts +45 -45
- package/exports/index.ts +90 -90
- package/exports/inspector.ts +24 -24
- package/exports/utils.ts +44 -44
- package/exports/webgl-shaders.ts +28 -28
- package/exports/webgl.ts +50 -50
- package/package.json +2 -1
- package/scripts/please-use-pnpm.js +13 -13
- package/src/common/CommonTypes.ts +146 -146
- package/src/common/EventEmitter.ts +77 -77
- package/src/common/IAnimationController.ts +92 -92
- package/src/common/IEventEmitter.ts +28 -28
- package/src/core/CoreNode.test.ts +203 -203
- package/src/core/CoreNode.ts +2494 -2494
- package/src/core/CoreShaderManager.ts +188 -188
- package/src/core/CoreTextNode.ts +449 -448
- package/src/core/CoreTextureManager.ts +601 -601
- package/src/core/Stage.ts +754 -754
- package/src/core/TextureMemoryManager.ts +395 -395
- package/src/core/animations/AnimationManager.ts +38 -38
- package/src/core/animations/CoreAnimation.ts +284 -284
- package/src/core/animations/CoreAnimationController.ts +157 -157
- package/src/core/lib/ContextSpy.ts +41 -41
- package/src/core/lib/ImageWorker.ts +280 -280
- package/src/core/lib/Matrix3d.ts +244 -244
- package/src/core/lib/RenderCoords.ts +71 -71
- package/src/core/lib/WebGlContextWrapper.ts +1374 -1374
- package/src/core/lib/textureCompression.ts +152 -152
- package/src/core/lib/textureSvg.ts +78 -78
- package/src/core/lib/utils.ts +386 -386
- package/src/core/lib/validateImageBitmap.ts +87 -87
- package/src/core/platform.ts +64 -64
- package/src/core/platforms/Platform.ts +77 -77
- package/src/core/platforms/web/WebPlatform.ts +84 -84
- package/src/core/renderers/CoreContextTexture.ts +43 -43
- package/src/core/renderers/CoreRenderOp.ts +22 -22
- package/src/core/renderers/CoreRenderer.ts +109 -109
- package/src/core/renderers/CoreShaderNode.ts +165 -165
- package/src/core/renderers/CoreShaderProgram.ts +23 -23
- package/src/core/renderers/canvas/CanvasRenderer.ts +298 -298
- package/src/core/renderers/canvas/CanvasShaderNode.ts +99 -99
- package/src/core/renderers/canvas/CanvasTexture.ts +156 -156
- package/src/core/renderers/canvas/internal/C2DShaderUtils.ts +220 -220
- package/src/core/renderers/canvas/internal/ColorUtils.ts +85 -85
- package/src/core/renderers/webgl/WebGlCtxRenderTexture.ts +86 -86
- package/src/core/renderers/webgl/WebGlCtxSubTexture.ts +50 -50
- package/src/core/renderers/webgl/WebGlCtxTexture.ts +301 -301
- package/src/core/renderers/webgl/WebGlRenderOp.ts +161 -161
- package/src/core/renderers/webgl/WebGlRenderer.ts +750 -750
- package/src/core/renderers/webgl/WebGlShaderNode.ts +437 -437
- package/src/core/renderers/webgl/WebGlShaderProgram.ts +318 -318
- package/src/core/renderers/webgl/internal/BufferCollection.ts +54 -54
- package/src/core/renderers/webgl/internal/RendererUtils.ts +155 -155
- package/src/core/renderers/webgl/internal/ShaderUtils.ts +281 -281
- package/src/core/renderers/webgl/internal/WebGlUtils.ts +35 -35
- package/src/core/shaders/canvas/Border.ts +78 -78
- package/src/core/shaders/canvas/HolePunch.ts +62 -62
- package/src/core/shaders/canvas/LinearGradient.ts +69 -69
- package/src/core/shaders/canvas/RadialGradient.ts +113 -113
- package/src/core/shaders/canvas/Rounded.ts +55 -55
- package/src/core/shaders/canvas/RoundedWithBorder.ts +68 -68
- package/src/core/shaders/canvas/RoundedWithBorderAndShadow.ts +88 -88
- package/src/core/shaders/canvas/RoundedWithShadow.ts +69 -69
- package/src/core/shaders/canvas/Shadow.ts +52 -52
- package/src/core/shaders/canvas/utils/render.ts +151 -151
- package/src/core/shaders/templates/BorderTemplate.ts +115 -115
- package/src/core/shaders/templates/HolePunchTemplate.ts +82 -82
- package/src/core/shaders/templates/LinearGradientTemplate.ts +71 -71
- package/src/core/shaders/templates/RadialGradientTemplate.ts +81 -81
- package/src/core/shaders/templates/RoundedTemplate.ts +98 -98
- package/src/core/shaders/templates/RoundedWithBorderAndShadowTemplate.ts +38 -38
- package/src/core/shaders/templates/RoundedWithBorderTemplate.ts +35 -35
- package/src/core/shaders/templates/RoundedWithShadowTemplate.ts +35 -35
- package/src/core/shaders/templates/ShadowTemplate.ts +106 -106
- package/src/core/shaders/templates/shaderUtils.ts +47 -47
- package/src/core/shaders/webgl/Border.ts +96 -96
- package/src/core/shaders/webgl/Default.ts +89 -89
- package/src/core/shaders/webgl/DefaultBatched.ts +129 -129
- package/src/core/shaders/webgl/HolePunch.ts +78 -78
- package/src/core/shaders/webgl/LinearGradient.ts +81 -81
- package/src/core/shaders/webgl/RadialGradient.ts +84 -84
- package/src/core/shaders/webgl/Rounded.ts +117 -117
- package/src/core/shaders/webgl/RoundedWithBorder.ts +114 -114
- package/src/core/shaders/webgl/RoundedWithBorderAndShadow.ts +133 -133
- package/src/core/shaders/webgl/RoundedWithShadow.ts +98 -98
- package/src/core/shaders/webgl/SdfShader.ts +134 -134
- package/src/core/shaders/webgl/Shadow.ts +115 -115
- package/src/core/text-rendering/TextRenderingUtils.ts +36 -36
- package/src/core/text-rendering/TextTextureRendererUtils.ts +263 -263
- package/src/core/text-rendering/TrFontManager.ts +183 -183
- package/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts +176 -176
- package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/FontShaper.ts +139 -139
- package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.test.ts +173 -173
- package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.ts +171 -171
- package/src/core/text-rendering/font-face-types/TrFontFace.ts +187 -187
- package/src/core/text-rendering/font-face-types/WebTrFontFace.ts +94 -94
- package/src/core/text-rendering/font-face-types/utils.ts +39 -39
- package/src/core/text-rendering/renderers/CanvasTextRenderer.ts +514 -514
- package/src/core/text-rendering/renderers/LightningTextTextureRenderer.ts +863 -863
- package/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts +846 -846
- package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.test.ts +48 -48
- package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.ts +66 -66
- package/src/core/text-rendering/renderers/SdfTextRenderer/internal/SpecialCodepoints.ts +52 -52
- package/src/core/text-rendering/renderers/SdfTextRenderer/internal/constants.ts +32 -32
- package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getStartConditions.ts +117 -117
- package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.test.ts +133 -133
- package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.ts +38 -38
- package/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.ts +497 -497
- package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.test.ts +49 -49
- package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.ts +52 -52
- package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.test.ts +205 -205
- package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.ts +93 -93
- package/src/core/text-rendering/renderers/SdfTextRenderer/internal/util.ts +40 -40
- package/src/core/text-rendering/renderers/TextRenderer.ts +567 -567
- package/src/core/textures/ColorTexture.ts +102 -102
- package/src/core/textures/ImageTexture.ts +410 -410
- package/src/core/textures/NoiseTexture.ts +104 -104
- package/src/core/textures/RenderTexture.ts +85 -85
- package/src/core/textures/SubTexture.ts +205 -205
- package/src/core/textures/Texture.ts +358 -358
- package/src/core/utils.ts +227 -227
- package/src/env.d.ts +7 -7
- package/src/main-api/INode.ts +100 -100
- package/src/main-api/Inspector.ts +522 -522
- package/src/main-api/Renderer.ts +675 -675
- package/src/main-api/utils.ts +45 -45
- package/src/utils.ts +267 -267
- package/COPYING +0 -1
- package/dist/src/core/temp.js +0 -77
- package/dist/src/core/temp.js.map +0 -1
- /package/dist/src/core/{temp.d.ts → CoreStuff.d.ts} +0 -0
|
@@ -1,395 +1,395 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* If not stated otherwise in this file or this component's LICENSE file the
|
|
3
|
-
* following copyright and licenses apply:
|
|
4
|
-
*
|
|
5
|
-
* Copyright 2024 Comcast Cable Communications Management, LLC.
|
|
6
|
-
*
|
|
7
|
-
* Licensed under the Apache License, Version 2.0 (the License);
|
|
8
|
-
* you may not use this file except in compliance with the License.
|
|
9
|
-
* You may obtain a copy of the License at
|
|
10
|
-
*
|
|
11
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
12
|
-
*
|
|
13
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
14
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
15
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
16
|
-
* See the License for the specific language governing permissions and
|
|
17
|
-
* limitations under the License.
|
|
18
|
-
*/
|
|
19
|
-
import { isProductionEnvironment } from '../utils.js';
|
|
20
|
-
import { getTimeStamp } from './platform.js';
|
|
21
|
-
import type { Stage } from './Stage.js';
|
|
22
|
-
import { TextureType, type Texture } from './textures/Texture.js';
|
|
23
|
-
import { bytesToMb } from './utils.js';
|
|
24
|
-
|
|
25
|
-
export interface TextureMemoryManagerSettings {
|
|
26
|
-
/**
|
|
27
|
-
* Critical Threshold (in bytes)
|
|
28
|
-
*
|
|
29
|
-
* @remarks
|
|
30
|
-
* When the amount of memory used by textures exceeds this threshold,
|
|
31
|
-
* the Renderer will immediately trigger a Texture Cleanup towards the
|
|
32
|
-
* Target Threshold Level.
|
|
33
|
-
*
|
|
34
|
-
* When set to `0`, the Texture Memory Manager is disabled.
|
|
35
|
-
*
|
|
36
|
-
* @defaultValue `124e6` (118 MB)
|
|
37
|
-
*/
|
|
38
|
-
criticalThreshold: number;
|
|
39
|
-
|
|
40
|
-
/**
|
|
41
|
-
* Target Threshold Level (as fraction of Critical Threshold)
|
|
42
|
-
*
|
|
43
|
-
* @remarks
|
|
44
|
-
* This value is the fractional level of the Critical Threshold that the
|
|
45
|
-
* Texture Memory Manager will attempt to maintain by cleaning up textures.
|
|
46
|
-
* The Texture Memory Manager will attempt to keep the memory usage below
|
|
47
|
-
* this level by freeing up non-renderable textures.
|
|
48
|
-
*
|
|
49
|
-
* Valid Range: 0.0 - 1.0
|
|
50
|
-
*
|
|
51
|
-
* @defaultValue `0.5`
|
|
52
|
-
*/
|
|
53
|
-
targetThresholdLevel: number;
|
|
54
|
-
|
|
55
|
-
/**
|
|
56
|
-
* Interval between non-aggressive Texture Cleanups (in milliseconds)
|
|
57
|
-
*
|
|
58
|
-
* @remarks
|
|
59
|
-
* Texture Memory Manager will perform a non aggressive Texture Cleanup no more
|
|
60
|
-
* frequently than this interval when the scene becomes idle.
|
|
61
|
-
*
|
|
62
|
-
* @defaultValue `5,000` (5 seconds)
|
|
63
|
-
*/
|
|
64
|
-
cleanupInterval: number;
|
|
65
|
-
|
|
66
|
-
/**
|
|
67
|
-
* Whether or not to log debug information
|
|
68
|
-
*
|
|
69
|
-
* @defaultValue `false`
|
|
70
|
-
*/
|
|
71
|
-
debugLogging: boolean;
|
|
72
|
-
|
|
73
|
-
/**
|
|
74
|
-
* Baseline memory allocation for the Texture Memory Manager
|
|
75
|
-
*
|
|
76
|
-
* @remarks
|
|
77
|
-
* Baseline texture memory is an allocation of memory by simply having a 1080p WebGL context.
|
|
78
|
-
* This will be used on top of the memory used by textures to determine when to trigger a cleanup.
|
|
79
|
-
*
|
|
80
|
-
* @defaultValue `25e6` (25 MB)
|
|
81
|
-
*/
|
|
82
|
-
baselineMemoryAllocation: number;
|
|
83
|
-
|
|
84
|
-
/**
|
|
85
|
-
* Do not exceed critical threshold
|
|
86
|
-
*
|
|
87
|
-
* @defaultValue `false`
|
|
88
|
-
*/
|
|
89
|
-
doNotExceedCriticalThreshold: boolean;
|
|
90
|
-
}
|
|
91
|
-
|
|
92
|
-
export interface MemoryInfo {
|
|
93
|
-
criticalThreshold: number;
|
|
94
|
-
targetThreshold: number;
|
|
95
|
-
renderableMemUsed: number;
|
|
96
|
-
memUsed: number;
|
|
97
|
-
renderableTexturesLoaded: number;
|
|
98
|
-
loadedTextures: number;
|
|
99
|
-
baselineMemoryAllocation: number;
|
|
100
|
-
}
|
|
101
|
-
|
|
102
|
-
/**
|
|
103
|
-
* LRU (Least Recently Used) style memory manager for textures
|
|
104
|
-
*
|
|
105
|
-
* @remarks
|
|
106
|
-
* This class is responsible for managing the memory usage of textures
|
|
107
|
-
* in the Renderer. It keeps track of the memory used by each texture
|
|
108
|
-
* and triggers a cleanup when the memory usage exceeds a critical
|
|
109
|
-
* threshold (`criticalThreshold`).
|
|
110
|
-
*
|
|
111
|
-
* The cleanup process will free up non-renderable textures until the
|
|
112
|
-
* memory usage is below a target threshold (`targetThresholdLevel`).
|
|
113
|
-
*
|
|
114
|
-
* The memory manager's clean up process will also be triggered when the
|
|
115
|
-
* scene is idle for a certain amount of time (`cleanupInterval`).
|
|
116
|
-
*/
|
|
117
|
-
export class TextureMemoryManager {
|
|
118
|
-
private memUsed = 0;
|
|
119
|
-
private loadedTextures: Map<Texture, number> = new Map();
|
|
120
|
-
private orphanedTextures: Texture[] = [];
|
|
121
|
-
private criticalThreshold: number;
|
|
122
|
-
private targetThreshold: number;
|
|
123
|
-
private cleanupInterval: number;
|
|
124
|
-
private debugLogging: boolean;
|
|
125
|
-
private lastCleanupTime = 0;
|
|
126
|
-
private baselineMemoryAllocation: number;
|
|
127
|
-
|
|
128
|
-
public criticalCleanupRequested = false;
|
|
129
|
-
public doNotExceedCriticalThreshold: boolean;
|
|
130
|
-
|
|
131
|
-
/**
|
|
132
|
-
* The current frame time in milliseconds
|
|
133
|
-
*
|
|
134
|
-
* @remarks
|
|
135
|
-
* This is used to determine when to perform Idle Texture Cleanups.
|
|
136
|
-
*
|
|
137
|
-
* Set by stage via `updateFrameTime` method.
|
|
138
|
-
*/
|
|
139
|
-
public frameTime = 0;
|
|
140
|
-
|
|
141
|
-
constructor(private stage: Stage, settings: TextureMemoryManagerSettings) {
|
|
142
|
-
const { criticalThreshold, doNotExceedCriticalThreshold } = settings;
|
|
143
|
-
this.doNotExceedCriticalThreshold = doNotExceedCriticalThreshold || false;
|
|
144
|
-
this.criticalThreshold = Math.round(criticalThreshold);
|
|
145
|
-
const targetFraction = Math.max(
|
|
146
|
-
0,
|
|
147
|
-
Math.min(1, settings.targetThresholdLevel),
|
|
148
|
-
);
|
|
149
|
-
this.cleanupInterval = settings.cleanupInterval;
|
|
150
|
-
this.debugLogging = settings.debugLogging;
|
|
151
|
-
this.baselineMemoryAllocation = Math.round(
|
|
152
|
-
settings.baselineMemoryAllocation,
|
|
153
|
-
);
|
|
154
|
-
this.targetThreshold = Math.max(
|
|
155
|
-
Math.round(criticalThreshold * targetFraction),
|
|
156
|
-
this.baselineMemoryAllocation,
|
|
157
|
-
);
|
|
158
|
-
this.memUsed = Math.round(settings.baselineMemoryAllocation);
|
|
159
|
-
|
|
160
|
-
if (settings.debugLogging) {
|
|
161
|
-
let lastMemUse = 0;
|
|
162
|
-
setInterval(() => {
|
|
163
|
-
if (lastMemUse !== this.memUsed) {
|
|
164
|
-
lastMemUse = this.memUsed;
|
|
165
|
-
console.log(
|
|
166
|
-
`[TextureMemoryManager] Memory used: ${bytesToMb(
|
|
167
|
-
this.memUsed,
|
|
168
|
-
)} mb / ${bytesToMb(this.criticalThreshold)} mb (${(
|
|
169
|
-
(this.memUsed / this.criticalThreshold) *
|
|
170
|
-
100
|
|
171
|
-
).toFixed(1)}%)`,
|
|
172
|
-
);
|
|
173
|
-
}
|
|
174
|
-
}, 1000);
|
|
175
|
-
}
|
|
176
|
-
|
|
177
|
-
// If the threshold is 0, we disable the memory manager by replacing the
|
|
178
|
-
// setTextureMemUse method with a no-op function.
|
|
179
|
-
if (criticalThreshold === 0) {
|
|
180
|
-
this.setTextureMemUse = () => {};
|
|
181
|
-
}
|
|
182
|
-
}
|
|
183
|
-
|
|
184
|
-
/**
|
|
185
|
-
* Add a texture to the orphaned textures list
|
|
186
|
-
*
|
|
187
|
-
* @param texture - The texture to add to the orphaned textures list
|
|
188
|
-
*/
|
|
189
|
-
addToOrphanedTextures(texture: Texture) {
|
|
190
|
-
// if the texture is already in the orphaned textures list add it at the end
|
|
191
|
-
if (this.orphanedTextures.includes(texture)) {
|
|
192
|
-
this.removeFromOrphanedTextures(texture);
|
|
193
|
-
}
|
|
194
|
-
|
|
195
|
-
// If the texture can be cleaned up, add it to the orphaned textures list
|
|
196
|
-
if (texture.preventCleanup === false) {
|
|
197
|
-
this.orphanedTextures.push(texture);
|
|
198
|
-
}
|
|
199
|
-
}
|
|
200
|
-
|
|
201
|
-
/**
|
|
202
|
-
* Remove a texture from the orphaned textures list
|
|
203
|
-
*
|
|
204
|
-
* @param texture - The texture to remove from the orphaned textures list
|
|
205
|
-
*/
|
|
206
|
-
removeFromOrphanedTextures(texture: Texture) {
|
|
207
|
-
const index = this.orphanedTextures.indexOf(texture);
|
|
208
|
-
if (index !== -1) {
|
|
209
|
-
this.orphanedTextures.splice(index, 1);
|
|
210
|
-
}
|
|
211
|
-
}
|
|
212
|
-
|
|
213
|
-
/**
|
|
214
|
-
* Set the memory usage of a texture
|
|
215
|
-
*
|
|
216
|
-
* @param texture - The texture to set memory usage for
|
|
217
|
-
* @param byteSize - The size of the texture in bytes
|
|
218
|
-
*/
|
|
219
|
-
setTextureMemUse(texture: Texture, byteSize: number) {
|
|
220
|
-
if (this.loadedTextures.has(texture)) {
|
|
221
|
-
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
|
|
222
|
-
this.memUsed -= this.loadedTextures.get(texture)!;
|
|
223
|
-
}
|
|
224
|
-
|
|
225
|
-
if (byteSize === 0) {
|
|
226
|
-
this.loadedTextures.delete(texture);
|
|
227
|
-
return;
|
|
228
|
-
} else {
|
|
229
|
-
this.memUsed += byteSize;
|
|
230
|
-
this.loadedTextures.set(texture, byteSize);
|
|
231
|
-
}
|
|
232
|
-
|
|
233
|
-
if (this.memUsed > this.criticalThreshold) {
|
|
234
|
-
this.criticalCleanupRequested = true;
|
|
235
|
-
}
|
|
236
|
-
}
|
|
237
|
-
|
|
238
|
-
checkCleanup() {
|
|
239
|
-
return (
|
|
240
|
-
this.criticalCleanupRequested ||
|
|
241
|
-
(this.memUsed > this.targetThreshold &&
|
|
242
|
-
this.frameTime - this.lastCleanupTime >= this.cleanupInterval)
|
|
243
|
-
);
|
|
244
|
-
}
|
|
245
|
-
|
|
246
|
-
checkCriticalCleanup() {
|
|
247
|
-
return this.memUsed > this.criticalThreshold;
|
|
248
|
-
}
|
|
249
|
-
|
|
250
|
-
cleanupQuick(critical: boolean) {
|
|
251
|
-
// Free non-renderable textures until we reach the target threshold
|
|
252
|
-
const memTarget = this.targetThreshold;
|
|
253
|
-
const txManager = this.stage.txManager;
|
|
254
|
-
const timestamp = getTimeStamp();
|
|
255
|
-
|
|
256
|
-
while (
|
|
257
|
-
this.memUsed >= memTarget &&
|
|
258
|
-
this.orphanedTextures.length > 0 &&
|
|
259
|
-
(critical || getTimeStamp() - timestamp < 10)
|
|
260
|
-
) {
|
|
261
|
-
const texture = this.orphanedTextures.shift();
|
|
262
|
-
|
|
263
|
-
if (texture === undefined) {
|
|
264
|
-
continue;
|
|
265
|
-
}
|
|
266
|
-
|
|
267
|
-
if (texture.renderable === true) {
|
|
268
|
-
// If the texture is renderable, we can't free it up
|
|
269
|
-
continue;
|
|
270
|
-
}
|
|
271
|
-
|
|
272
|
-
texture.free();
|
|
273
|
-
txManager.removeTextureFromCache(texture);
|
|
274
|
-
}
|
|
275
|
-
}
|
|
276
|
-
|
|
277
|
-
cleanupDeep(critical: boolean) {
|
|
278
|
-
// Free non-renderable textures until we reach the target threshold
|
|
279
|
-
const memTarget = critical ? this.criticalThreshold : this.targetThreshold;
|
|
280
|
-
const txManager = this.stage.txManager;
|
|
281
|
-
|
|
282
|
-
// sort by renderability
|
|
283
|
-
const filteredAndSortedTextures: Texture[] = [];
|
|
284
|
-
const textures = [...this.loadedTextures.keys()];
|
|
285
|
-
for (let i = 0; i < textures.length; i++) {
|
|
286
|
-
const texture = textures[i];
|
|
287
|
-
if (texture === undefined) {
|
|
288
|
-
continue;
|
|
289
|
-
}
|
|
290
|
-
|
|
291
|
-
if (
|
|
292
|
-
texture.type === TextureType.image ||
|
|
293
|
-
texture.type === TextureType.noise ||
|
|
294
|
-
texture.type === TextureType.renderToTexture
|
|
295
|
-
) {
|
|
296
|
-
if (texture.renderable === true) {
|
|
297
|
-
filteredAndSortedTextures.push(texture);
|
|
298
|
-
} else {
|
|
299
|
-
filteredAndSortedTextures.unshift(texture);
|
|
300
|
-
}
|
|
301
|
-
}
|
|
302
|
-
}
|
|
303
|
-
|
|
304
|
-
while (this.memUsed >= memTarget && filteredAndSortedTextures.length > 0) {
|
|
305
|
-
const texture = filteredAndSortedTextures.shift();
|
|
306
|
-
if (texture === undefined) {
|
|
307
|
-
continue;
|
|
308
|
-
}
|
|
309
|
-
|
|
310
|
-
if (texture.preventCleanup === true) {
|
|
311
|
-
continue;
|
|
312
|
-
}
|
|
313
|
-
|
|
314
|
-
if (texture.renderable === true) {
|
|
315
|
-
break;
|
|
316
|
-
}
|
|
317
|
-
|
|
318
|
-
texture.free();
|
|
319
|
-
this.removeFromOrphanedTextures(texture);
|
|
320
|
-
txManager.removeTextureFromCache(texture);
|
|
321
|
-
txManager.removeTextureFromQueue(texture);
|
|
322
|
-
}
|
|
323
|
-
}
|
|
324
|
-
|
|
325
|
-
cleanup(aggressive: boolean = false) {
|
|
326
|
-
const critical = this.criticalCleanupRequested;
|
|
327
|
-
this.lastCleanupTime = this.frameTime;
|
|
328
|
-
|
|
329
|
-
if (critical === true) {
|
|
330
|
-
this.stage.queueFrameEvent('criticalCleanup', {
|
|
331
|
-
memUsed: this.memUsed,
|
|
332
|
-
criticalThreshold: this.criticalThreshold,
|
|
333
|
-
});
|
|
334
|
-
}
|
|
335
|
-
|
|
336
|
-
if (this.debugLogging === true) {
|
|
337
|
-
console.log(
|
|
338
|
-
`[TextureMemoryManager] Cleaning up textures. Critical: ${critical}. Aggressive: ${aggressive}`,
|
|
339
|
-
);
|
|
340
|
-
}
|
|
341
|
-
|
|
342
|
-
// try a quick cleanup first
|
|
343
|
-
this.cleanupQuick(critical);
|
|
344
|
-
|
|
345
|
-
// if we're still above the target threshold, do a deep cleanup
|
|
346
|
-
if (aggressive === true && this.memUsed >= this.criticalThreshold) {
|
|
347
|
-
this.cleanupDeep(critical);
|
|
348
|
-
}
|
|
349
|
-
|
|
350
|
-
if (this.memUsed >= this.criticalThreshold) {
|
|
351
|
-
this.stage.queueFrameEvent('criticalCleanupFailed', {
|
|
352
|
-
memUsed: this.memUsed,
|
|
353
|
-
criticalThreshold: this.criticalThreshold,
|
|
354
|
-
});
|
|
355
|
-
|
|
356
|
-
if (this.debugLogging === true || isProductionEnvironment() === false) {
|
|
357
|
-
console.warn(
|
|
358
|
-
`[TextureMemoryManager] Memory usage above critical threshold after cleanup: ${this.memUsed}`,
|
|
359
|
-
);
|
|
360
|
-
}
|
|
361
|
-
} else {
|
|
362
|
-
this.criticalCleanupRequested = false;
|
|
363
|
-
}
|
|
364
|
-
}
|
|
365
|
-
|
|
366
|
-
/**
|
|
367
|
-
* Get the current texture memory usage information
|
|
368
|
-
*
|
|
369
|
-
* @remarks
|
|
370
|
-
* This method is for debugging purposes and returns information about the
|
|
371
|
-
* current memory usage of the textures in the Renderer.
|
|
372
|
-
*/
|
|
373
|
-
getMemoryInfo(): MemoryInfo {
|
|
374
|
-
let renderableTexturesLoaded = 0;
|
|
375
|
-
const renderableMemUsed = [...this.loadedTextures.keys()].reduce(
|
|
376
|
-
(acc, texture) => {
|
|
377
|
-
renderableTexturesLoaded += texture.renderable ? 1 : 0;
|
|
378
|
-
return (
|
|
379
|
-
acc + (texture.renderable ? this.loadedTextures.get(texture)! : 0)
|
|
380
|
-
);
|
|
381
|
-
},
|
|
382
|
-
this.baselineMemoryAllocation,
|
|
383
|
-
);
|
|
384
|
-
|
|
385
|
-
return {
|
|
386
|
-
criticalThreshold: this.criticalThreshold,
|
|
387
|
-
targetThreshold: this.targetThreshold,
|
|
388
|
-
renderableMemUsed,
|
|
389
|
-
memUsed: this.memUsed,
|
|
390
|
-
renderableTexturesLoaded,
|
|
391
|
-
loadedTextures: this.loadedTextures.size,
|
|
392
|
-
baselineMemoryAllocation: this.baselineMemoryAllocation,
|
|
393
|
-
};
|
|
394
|
-
}
|
|
395
|
-
}
|
|
1
|
+
/*
|
|
2
|
+
* If not stated otherwise in this file or this component's LICENSE file the
|
|
3
|
+
* following copyright and licenses apply:
|
|
4
|
+
*
|
|
5
|
+
* Copyright 2024 Comcast Cable Communications Management, LLC.
|
|
6
|
+
*
|
|
7
|
+
* Licensed under the Apache License, Version 2.0 (the License);
|
|
8
|
+
* you may not use this file except in compliance with the License.
|
|
9
|
+
* You may obtain a copy of the License at
|
|
10
|
+
*
|
|
11
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
12
|
+
*
|
|
13
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
14
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
15
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
16
|
+
* See the License for the specific language governing permissions and
|
|
17
|
+
* limitations under the License.
|
|
18
|
+
*/
|
|
19
|
+
import { isProductionEnvironment } from '../utils.js';
|
|
20
|
+
import { getTimeStamp } from './platform.js';
|
|
21
|
+
import type { Stage } from './Stage.js';
|
|
22
|
+
import { TextureType, type Texture } from './textures/Texture.js';
|
|
23
|
+
import { bytesToMb } from './utils.js';
|
|
24
|
+
|
|
25
|
+
export interface TextureMemoryManagerSettings {
|
|
26
|
+
/**
|
|
27
|
+
* Critical Threshold (in bytes)
|
|
28
|
+
*
|
|
29
|
+
* @remarks
|
|
30
|
+
* When the amount of memory used by textures exceeds this threshold,
|
|
31
|
+
* the Renderer will immediately trigger a Texture Cleanup towards the
|
|
32
|
+
* Target Threshold Level.
|
|
33
|
+
*
|
|
34
|
+
* When set to `0`, the Texture Memory Manager is disabled.
|
|
35
|
+
*
|
|
36
|
+
* @defaultValue `124e6` (118 MB)
|
|
37
|
+
*/
|
|
38
|
+
criticalThreshold: number;
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* Target Threshold Level (as fraction of Critical Threshold)
|
|
42
|
+
*
|
|
43
|
+
* @remarks
|
|
44
|
+
* This value is the fractional level of the Critical Threshold that the
|
|
45
|
+
* Texture Memory Manager will attempt to maintain by cleaning up textures.
|
|
46
|
+
* The Texture Memory Manager will attempt to keep the memory usage below
|
|
47
|
+
* this level by freeing up non-renderable textures.
|
|
48
|
+
*
|
|
49
|
+
* Valid Range: 0.0 - 1.0
|
|
50
|
+
*
|
|
51
|
+
* @defaultValue `0.5`
|
|
52
|
+
*/
|
|
53
|
+
targetThresholdLevel: number;
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* Interval between non-aggressive Texture Cleanups (in milliseconds)
|
|
57
|
+
*
|
|
58
|
+
* @remarks
|
|
59
|
+
* Texture Memory Manager will perform a non aggressive Texture Cleanup no more
|
|
60
|
+
* frequently than this interval when the scene becomes idle.
|
|
61
|
+
*
|
|
62
|
+
* @defaultValue `5,000` (5 seconds)
|
|
63
|
+
*/
|
|
64
|
+
cleanupInterval: number;
|
|
65
|
+
|
|
66
|
+
/**
|
|
67
|
+
* Whether or not to log debug information
|
|
68
|
+
*
|
|
69
|
+
* @defaultValue `false`
|
|
70
|
+
*/
|
|
71
|
+
debugLogging: boolean;
|
|
72
|
+
|
|
73
|
+
/**
|
|
74
|
+
* Baseline memory allocation for the Texture Memory Manager
|
|
75
|
+
*
|
|
76
|
+
* @remarks
|
|
77
|
+
* Baseline texture memory is an allocation of memory by simply having a 1080p WebGL context.
|
|
78
|
+
* This will be used on top of the memory used by textures to determine when to trigger a cleanup.
|
|
79
|
+
*
|
|
80
|
+
* @defaultValue `25e6` (25 MB)
|
|
81
|
+
*/
|
|
82
|
+
baselineMemoryAllocation: number;
|
|
83
|
+
|
|
84
|
+
/**
|
|
85
|
+
* Do not exceed critical threshold
|
|
86
|
+
*
|
|
87
|
+
* @defaultValue `false`
|
|
88
|
+
*/
|
|
89
|
+
doNotExceedCriticalThreshold: boolean;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
export interface MemoryInfo {
|
|
93
|
+
criticalThreshold: number;
|
|
94
|
+
targetThreshold: number;
|
|
95
|
+
renderableMemUsed: number;
|
|
96
|
+
memUsed: number;
|
|
97
|
+
renderableTexturesLoaded: number;
|
|
98
|
+
loadedTextures: number;
|
|
99
|
+
baselineMemoryAllocation: number;
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
/**
|
|
103
|
+
* LRU (Least Recently Used) style memory manager for textures
|
|
104
|
+
*
|
|
105
|
+
* @remarks
|
|
106
|
+
* This class is responsible for managing the memory usage of textures
|
|
107
|
+
* in the Renderer. It keeps track of the memory used by each texture
|
|
108
|
+
* and triggers a cleanup when the memory usage exceeds a critical
|
|
109
|
+
* threshold (`criticalThreshold`).
|
|
110
|
+
*
|
|
111
|
+
* The cleanup process will free up non-renderable textures until the
|
|
112
|
+
* memory usage is below a target threshold (`targetThresholdLevel`).
|
|
113
|
+
*
|
|
114
|
+
* The memory manager's clean up process will also be triggered when the
|
|
115
|
+
* scene is idle for a certain amount of time (`cleanupInterval`).
|
|
116
|
+
*/
|
|
117
|
+
export class TextureMemoryManager {
|
|
118
|
+
private memUsed = 0;
|
|
119
|
+
private loadedTextures: Map<Texture, number> = new Map();
|
|
120
|
+
private orphanedTextures: Texture[] = [];
|
|
121
|
+
private criticalThreshold: number;
|
|
122
|
+
private targetThreshold: number;
|
|
123
|
+
private cleanupInterval: number;
|
|
124
|
+
private debugLogging: boolean;
|
|
125
|
+
private lastCleanupTime = 0;
|
|
126
|
+
private baselineMemoryAllocation: number;
|
|
127
|
+
|
|
128
|
+
public criticalCleanupRequested = false;
|
|
129
|
+
public doNotExceedCriticalThreshold: boolean;
|
|
130
|
+
|
|
131
|
+
/**
|
|
132
|
+
* The current frame time in milliseconds
|
|
133
|
+
*
|
|
134
|
+
* @remarks
|
|
135
|
+
* This is used to determine when to perform Idle Texture Cleanups.
|
|
136
|
+
*
|
|
137
|
+
* Set by stage via `updateFrameTime` method.
|
|
138
|
+
*/
|
|
139
|
+
public frameTime = 0;
|
|
140
|
+
|
|
141
|
+
constructor(private stage: Stage, settings: TextureMemoryManagerSettings) {
|
|
142
|
+
const { criticalThreshold, doNotExceedCriticalThreshold } = settings;
|
|
143
|
+
this.doNotExceedCriticalThreshold = doNotExceedCriticalThreshold || false;
|
|
144
|
+
this.criticalThreshold = Math.round(criticalThreshold);
|
|
145
|
+
const targetFraction = Math.max(
|
|
146
|
+
0,
|
|
147
|
+
Math.min(1, settings.targetThresholdLevel),
|
|
148
|
+
);
|
|
149
|
+
this.cleanupInterval = settings.cleanupInterval;
|
|
150
|
+
this.debugLogging = settings.debugLogging;
|
|
151
|
+
this.baselineMemoryAllocation = Math.round(
|
|
152
|
+
settings.baselineMemoryAllocation,
|
|
153
|
+
);
|
|
154
|
+
this.targetThreshold = Math.max(
|
|
155
|
+
Math.round(criticalThreshold * targetFraction),
|
|
156
|
+
this.baselineMemoryAllocation,
|
|
157
|
+
);
|
|
158
|
+
this.memUsed = Math.round(settings.baselineMemoryAllocation);
|
|
159
|
+
|
|
160
|
+
if (settings.debugLogging) {
|
|
161
|
+
let lastMemUse = 0;
|
|
162
|
+
setInterval(() => {
|
|
163
|
+
if (lastMemUse !== this.memUsed) {
|
|
164
|
+
lastMemUse = this.memUsed;
|
|
165
|
+
console.log(
|
|
166
|
+
`[TextureMemoryManager] Memory used: ${bytesToMb(
|
|
167
|
+
this.memUsed,
|
|
168
|
+
)} mb / ${bytesToMb(this.criticalThreshold)} mb (${(
|
|
169
|
+
(this.memUsed / this.criticalThreshold) *
|
|
170
|
+
100
|
|
171
|
+
).toFixed(1)}%)`,
|
|
172
|
+
);
|
|
173
|
+
}
|
|
174
|
+
}, 1000);
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
// If the threshold is 0, we disable the memory manager by replacing the
|
|
178
|
+
// setTextureMemUse method with a no-op function.
|
|
179
|
+
if (criticalThreshold === 0) {
|
|
180
|
+
this.setTextureMemUse = () => {};
|
|
181
|
+
}
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
/**
|
|
185
|
+
* Add a texture to the orphaned textures list
|
|
186
|
+
*
|
|
187
|
+
* @param texture - The texture to add to the orphaned textures list
|
|
188
|
+
*/
|
|
189
|
+
addToOrphanedTextures(texture: Texture) {
|
|
190
|
+
// if the texture is already in the orphaned textures list add it at the end
|
|
191
|
+
if (this.orphanedTextures.includes(texture)) {
|
|
192
|
+
this.removeFromOrphanedTextures(texture);
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
// If the texture can be cleaned up, add it to the orphaned textures list
|
|
196
|
+
if (texture.preventCleanup === false) {
|
|
197
|
+
this.orphanedTextures.push(texture);
|
|
198
|
+
}
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
/**
|
|
202
|
+
* Remove a texture from the orphaned textures list
|
|
203
|
+
*
|
|
204
|
+
* @param texture - The texture to remove from the orphaned textures list
|
|
205
|
+
*/
|
|
206
|
+
removeFromOrphanedTextures(texture: Texture) {
|
|
207
|
+
const index = this.orphanedTextures.indexOf(texture);
|
|
208
|
+
if (index !== -1) {
|
|
209
|
+
this.orphanedTextures.splice(index, 1);
|
|
210
|
+
}
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
/**
|
|
214
|
+
* Set the memory usage of a texture
|
|
215
|
+
*
|
|
216
|
+
* @param texture - The texture to set memory usage for
|
|
217
|
+
* @param byteSize - The size of the texture in bytes
|
|
218
|
+
*/
|
|
219
|
+
setTextureMemUse(texture: Texture, byteSize: number) {
|
|
220
|
+
if (this.loadedTextures.has(texture)) {
|
|
221
|
+
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
|
|
222
|
+
this.memUsed -= this.loadedTextures.get(texture)!;
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
if (byteSize === 0) {
|
|
226
|
+
this.loadedTextures.delete(texture);
|
|
227
|
+
return;
|
|
228
|
+
} else {
|
|
229
|
+
this.memUsed += byteSize;
|
|
230
|
+
this.loadedTextures.set(texture, byteSize);
|
|
231
|
+
}
|
|
232
|
+
|
|
233
|
+
if (this.memUsed > this.criticalThreshold) {
|
|
234
|
+
this.criticalCleanupRequested = true;
|
|
235
|
+
}
|
|
236
|
+
}
|
|
237
|
+
|
|
238
|
+
checkCleanup() {
|
|
239
|
+
return (
|
|
240
|
+
this.criticalCleanupRequested ||
|
|
241
|
+
(this.memUsed > this.targetThreshold &&
|
|
242
|
+
this.frameTime - this.lastCleanupTime >= this.cleanupInterval)
|
|
243
|
+
);
|
|
244
|
+
}
|
|
245
|
+
|
|
246
|
+
checkCriticalCleanup() {
|
|
247
|
+
return this.memUsed > this.criticalThreshold;
|
|
248
|
+
}
|
|
249
|
+
|
|
250
|
+
cleanupQuick(critical: boolean) {
|
|
251
|
+
// Free non-renderable textures until we reach the target threshold
|
|
252
|
+
const memTarget = this.targetThreshold;
|
|
253
|
+
const txManager = this.stage.txManager;
|
|
254
|
+
const timestamp = getTimeStamp();
|
|
255
|
+
|
|
256
|
+
while (
|
|
257
|
+
this.memUsed >= memTarget &&
|
|
258
|
+
this.orphanedTextures.length > 0 &&
|
|
259
|
+
(critical || getTimeStamp() - timestamp < 10)
|
|
260
|
+
) {
|
|
261
|
+
const texture = this.orphanedTextures.shift();
|
|
262
|
+
|
|
263
|
+
if (texture === undefined) {
|
|
264
|
+
continue;
|
|
265
|
+
}
|
|
266
|
+
|
|
267
|
+
if (texture.renderable === true) {
|
|
268
|
+
// If the texture is renderable, we can't free it up
|
|
269
|
+
continue;
|
|
270
|
+
}
|
|
271
|
+
|
|
272
|
+
texture.free();
|
|
273
|
+
txManager.removeTextureFromCache(texture);
|
|
274
|
+
}
|
|
275
|
+
}
|
|
276
|
+
|
|
277
|
+
cleanupDeep(critical: boolean) {
|
|
278
|
+
// Free non-renderable textures until we reach the target threshold
|
|
279
|
+
const memTarget = critical ? this.criticalThreshold : this.targetThreshold;
|
|
280
|
+
const txManager = this.stage.txManager;
|
|
281
|
+
|
|
282
|
+
// sort by renderability
|
|
283
|
+
const filteredAndSortedTextures: Texture[] = [];
|
|
284
|
+
const textures = [...this.loadedTextures.keys()];
|
|
285
|
+
for (let i = 0; i < textures.length; i++) {
|
|
286
|
+
const texture = textures[i];
|
|
287
|
+
if (texture === undefined) {
|
|
288
|
+
continue;
|
|
289
|
+
}
|
|
290
|
+
|
|
291
|
+
if (
|
|
292
|
+
texture.type === TextureType.image ||
|
|
293
|
+
texture.type === TextureType.noise ||
|
|
294
|
+
texture.type === TextureType.renderToTexture
|
|
295
|
+
) {
|
|
296
|
+
if (texture.renderable === true) {
|
|
297
|
+
filteredAndSortedTextures.push(texture);
|
|
298
|
+
} else {
|
|
299
|
+
filteredAndSortedTextures.unshift(texture);
|
|
300
|
+
}
|
|
301
|
+
}
|
|
302
|
+
}
|
|
303
|
+
|
|
304
|
+
while (this.memUsed >= memTarget && filteredAndSortedTextures.length > 0) {
|
|
305
|
+
const texture = filteredAndSortedTextures.shift();
|
|
306
|
+
if (texture === undefined) {
|
|
307
|
+
continue;
|
|
308
|
+
}
|
|
309
|
+
|
|
310
|
+
if (texture.preventCleanup === true) {
|
|
311
|
+
continue;
|
|
312
|
+
}
|
|
313
|
+
|
|
314
|
+
if (texture.renderable === true) {
|
|
315
|
+
break;
|
|
316
|
+
}
|
|
317
|
+
|
|
318
|
+
texture.free();
|
|
319
|
+
this.removeFromOrphanedTextures(texture);
|
|
320
|
+
txManager.removeTextureFromCache(texture);
|
|
321
|
+
txManager.removeTextureFromQueue(texture);
|
|
322
|
+
}
|
|
323
|
+
}
|
|
324
|
+
|
|
325
|
+
cleanup(aggressive: boolean = false) {
|
|
326
|
+
const critical = this.criticalCleanupRequested;
|
|
327
|
+
this.lastCleanupTime = this.frameTime;
|
|
328
|
+
|
|
329
|
+
if (critical === true) {
|
|
330
|
+
this.stage.queueFrameEvent('criticalCleanup', {
|
|
331
|
+
memUsed: this.memUsed,
|
|
332
|
+
criticalThreshold: this.criticalThreshold,
|
|
333
|
+
});
|
|
334
|
+
}
|
|
335
|
+
|
|
336
|
+
if (this.debugLogging === true) {
|
|
337
|
+
console.log(
|
|
338
|
+
`[TextureMemoryManager] Cleaning up textures. Critical: ${critical}. Aggressive: ${aggressive}`,
|
|
339
|
+
);
|
|
340
|
+
}
|
|
341
|
+
|
|
342
|
+
// try a quick cleanup first
|
|
343
|
+
this.cleanupQuick(critical);
|
|
344
|
+
|
|
345
|
+
// if we're still above the target threshold, do a deep cleanup
|
|
346
|
+
if (aggressive === true && this.memUsed >= this.criticalThreshold) {
|
|
347
|
+
this.cleanupDeep(critical);
|
|
348
|
+
}
|
|
349
|
+
|
|
350
|
+
if (this.memUsed >= this.criticalThreshold) {
|
|
351
|
+
this.stage.queueFrameEvent('criticalCleanupFailed', {
|
|
352
|
+
memUsed: this.memUsed,
|
|
353
|
+
criticalThreshold: this.criticalThreshold,
|
|
354
|
+
});
|
|
355
|
+
|
|
356
|
+
if (this.debugLogging === true || isProductionEnvironment() === false) {
|
|
357
|
+
console.warn(
|
|
358
|
+
`[TextureMemoryManager] Memory usage above critical threshold after cleanup: ${this.memUsed}`,
|
|
359
|
+
);
|
|
360
|
+
}
|
|
361
|
+
} else {
|
|
362
|
+
this.criticalCleanupRequested = false;
|
|
363
|
+
}
|
|
364
|
+
}
|
|
365
|
+
|
|
366
|
+
/**
|
|
367
|
+
* Get the current texture memory usage information
|
|
368
|
+
*
|
|
369
|
+
* @remarks
|
|
370
|
+
* This method is for debugging purposes and returns information about the
|
|
371
|
+
* current memory usage of the textures in the Renderer.
|
|
372
|
+
*/
|
|
373
|
+
getMemoryInfo(): MemoryInfo {
|
|
374
|
+
let renderableTexturesLoaded = 0;
|
|
375
|
+
const renderableMemUsed = [...this.loadedTextures.keys()].reduce(
|
|
376
|
+
(acc, texture) => {
|
|
377
|
+
renderableTexturesLoaded += texture.renderable ? 1 : 0;
|
|
378
|
+
return (
|
|
379
|
+
acc + (texture.renderable ? this.loadedTextures.get(texture)! : 0)
|
|
380
|
+
);
|
|
381
|
+
},
|
|
382
|
+
this.baselineMemoryAllocation,
|
|
383
|
+
);
|
|
384
|
+
|
|
385
|
+
return {
|
|
386
|
+
criticalThreshold: this.criticalThreshold,
|
|
387
|
+
targetThreshold: this.targetThreshold,
|
|
388
|
+
renderableMemUsed,
|
|
389
|
+
memUsed: this.memUsed,
|
|
390
|
+
renderableTexturesLoaded,
|
|
391
|
+
loadedTextures: this.loadedTextures.size,
|
|
392
|
+
baselineMemoryAllocation: this.baselineMemoryAllocation,
|
|
393
|
+
};
|
|
394
|
+
}
|
|
395
|
+
}
|