@lightningjs/renderer 0.7.5 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (252) hide show
  1. package/LICENSE +202 -202
  2. package/NOTICE +3 -3
  3. package/README.md +233 -221
  4. package/dist/src/common/CommonTypes.d.ts +12 -0
  5. package/dist/src/core/CoreNode.d.ts +83 -9
  6. package/dist/src/core/CoreNode.js +232 -44
  7. package/dist/src/core/CoreNode.js.map +1 -1
  8. package/dist/src/core/CoreTextNode.d.ts +6 -1
  9. package/dist/src/core/CoreTextNode.js +33 -20
  10. package/dist/src/core/CoreTextNode.js.map +1 -1
  11. package/dist/src/core/CoreTextureManager.d.ts +3 -1
  12. package/dist/src/core/CoreTextureManager.js +11 -2
  13. package/dist/src/core/CoreTextureManager.js.map +1 -1
  14. package/dist/src/core/Stage.d.ts +6 -0
  15. package/dist/src/core/Stage.js +16 -1
  16. package/dist/src/core/Stage.js.map +1 -1
  17. package/dist/src/core/TextureMemoryManager.d.ts +12 -0
  18. package/dist/src/core/TextureMemoryManager.js +42 -0
  19. package/dist/src/core/TextureMemoryManager.js.map +1 -0
  20. package/dist/src/core/lib/ImageWorker.d.ts +0 -1
  21. package/dist/src/core/lib/ImageWorker.js +55 -40
  22. package/dist/src/core/lib/ImageWorker.js.map +1 -1
  23. package/dist/src/core/lib/RenderCoords.d.ts +13 -0
  24. package/dist/src/core/lib/RenderCoords.js +63 -0
  25. package/dist/src/core/lib/RenderCoords.js.map +1 -0
  26. package/dist/src/core/lib/WebGlContext.d.ts +414 -0
  27. package/dist/src/core/lib/WebGlContext.js +640 -0
  28. package/dist/src/core/lib/WebGlContext.js.map +1 -0
  29. package/dist/src/core/lib/utils.d.ts +1 -0
  30. package/dist/src/core/lib/utils.js +6 -0
  31. package/dist/src/core/lib/utils.js.map +1 -1
  32. package/dist/src/core/platform.js +8 -0
  33. package/dist/src/core/platform.js.map +1 -1
  34. package/dist/src/core/renderers/CoreContextTexture.d.ts +5 -1
  35. package/dist/src/core/renderers/CoreContextTexture.js +3 -1
  36. package/dist/src/core/renderers/CoreContextTexture.js.map +1 -1
  37. package/dist/src/core/renderers/webgl/WebGlCoreCtxSubTexture.d.ts +2 -1
  38. package/dist/src/core/renderers/webgl/WebGlCoreCtxSubTexture.js +2 -2
  39. package/dist/src/core/renderers/webgl/WebGlCoreCtxSubTexture.js.map +1 -1
  40. package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.d.ts +3 -1
  41. package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.js +26 -6
  42. package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.js.map +1 -1
  43. package/dist/src/core/renderers/webgl/WebGlCoreRenderer.d.ts +3 -0
  44. package/dist/src/core/renderers/webgl/WebGlCoreRenderer.js +4 -2
  45. package/dist/src/core/renderers/webgl/WebGlCoreRenderer.js.map +1 -1
  46. package/dist/src/core/renderers/webgl/internal/RendererUtils.d.ts +9 -0
  47. package/dist/src/core/renderers/webgl/internal/RendererUtils.js +14 -0
  48. package/dist/src/core/renderers/webgl/internal/RendererUtils.js.map +1 -1
  49. package/dist/src/core/renderers/webgl/shaders/DefaultShader.js +47 -47
  50. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js +61 -61
  51. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js +93 -93
  52. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js +63 -63
  53. package/dist/src/core/renderers/webgl/shaders/SdfShader.js +49 -49
  54. package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.js +15 -15
  55. package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.js +5 -5
  56. package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.js +15 -15
  57. package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.js +15 -15
  58. package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.js +15 -15
  59. package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.js +42 -42
  60. package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.js +44 -44
  61. package/dist/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.js +3 -3
  62. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js +44 -57
  63. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js.map +1 -1
  64. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.d.ts +1 -0
  65. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js +33 -39
  66. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js.map +1 -1
  67. package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.js +37 -37
  68. package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js +19 -19
  69. package/dist/src/core/scene/Scene.d.ts +59 -0
  70. package/dist/src/core/scene/Scene.js +106 -0
  71. package/dist/src/core/scene/Scene.js.map +1 -0
  72. package/dist/src/core/text-rendering/TrFontManager.js +30 -25
  73. package/dist/src/core/text-rendering/TrFontManager.js.map +1 -1
  74. package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.d.ts +2 -0
  75. package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.js +26 -2
  76. package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.js.map +1 -1
  77. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.d.ts +8 -0
  78. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js +34 -6
  79. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js.map +1 -1
  80. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/findNearestMultiple.d.ts +8 -0
  81. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/findNearestMultiple.js +29 -0
  82. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/findNearestMultiple.js.map +1 -0
  83. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.js +1 -3
  84. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.js.map +1 -1
  85. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/SdfBufferHelper.d.ts +19 -0
  86. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/SdfBufferHelper.js +84 -0
  87. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/SdfBufferHelper.js.map +1 -0
  88. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/layoutLine.d.ts +8 -0
  89. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/layoutLine.js +40 -0
  90. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/layoutLine.js.map +1 -0
  91. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/layoutText2.d.ts +2 -0
  92. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/layoutText2.js +41 -0
  93. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/layoutText2.js.map +1 -0
  94. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/utils.d.ts +1 -0
  95. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/utils.js +4 -0
  96. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/utils.js.map +1 -0
  97. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2.d.ts +1 -0
  98. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2.js +2 -0
  99. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2.js.map +1 -0
  100. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.d.ts +20 -0
  101. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.js +55 -0
  102. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.js.map +1 -0
  103. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/roundUpToMultiple.d.ts +9 -0
  104. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/roundUpToMultiple.js +32 -0
  105. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/roundUpToMultiple.js.map +1 -0
  106. package/dist/src/core/text-rendering/renderers/TextRenderer.d.ts +31 -0
  107. package/dist/src/core/text-rendering/renderers/TextRenderer.js +26 -0
  108. package/dist/src/core/text-rendering/renderers/TextRenderer.js.map +1 -1
  109. package/dist/src/core/textures/ImageTexture.js +16 -2
  110. package/dist/src/core/textures/ImageTexture.js.map +1 -1
  111. package/dist/src/core/textures/Texture.d.ts +27 -2
  112. package/dist/src/core/textures/Texture.js +30 -1
  113. package/dist/src/core/textures/Texture.js.map +1 -1
  114. package/dist/src/core/utils.d.ts +1 -1
  115. package/dist/src/main-api/ICoreDriver.d.ts +1 -0
  116. package/dist/src/main-api/Inspector.js +2 -1
  117. package/dist/src/main-api/Inspector.js.map +1 -1
  118. package/dist/src/main-api/RendererMain.d.ts +15 -0
  119. package/dist/src/main-api/RendererMain.js +7 -1
  120. package/dist/src/main-api/RendererMain.js.map +1 -1
  121. package/dist/src/render-drivers/main/MainCoreDriver.d.ts +1 -0
  122. package/dist/src/render-drivers/main/MainCoreDriver.js +8 -0
  123. package/dist/src/render-drivers/main/MainCoreDriver.js.map +1 -1
  124. package/dist/src/render-drivers/main/MainOnlyNode.d.ts +5 -0
  125. package/dist/src/render-drivers/main/MainOnlyNode.js +26 -0
  126. package/dist/src/render-drivers/main/MainOnlyNode.js.map +1 -1
  127. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js +2 -0
  128. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js.map +1 -1
  129. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.d.ts +2 -0
  130. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js.map +1 -1
  131. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js +3 -0
  132. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js.map +1 -1
  133. package/dist/src/render-drivers/threadx/worker/renderer.js +2 -0
  134. package/dist/src/render-drivers/threadx/worker/renderer.js.map +1 -1
  135. package/dist/src/utils.d.ts +6 -0
  136. package/dist/src/utils.js +9 -1
  137. package/dist/src/utils.js.map +1 -1
  138. package/dist/tsconfig.dist.tsbuildinfo +1 -1
  139. package/exports/core-api.ts +102 -102
  140. package/exports/main-api.ts +60 -60
  141. package/exports/utils.ts +41 -41
  142. package/package.json +1 -1
  143. package/scripts/please-use-pnpm.js +13 -13
  144. package/src/common/CommonTypes.ts +132 -113
  145. package/src/common/EventEmitter.ts +77 -77
  146. package/src/common/IAnimationController.ts +29 -29
  147. package/src/core/CoreExtension.ts +32 -32
  148. package/src/core/CoreNode.ts +1199 -955
  149. package/src/core/CoreShaderManager.ts +243 -243
  150. package/src/core/CoreTextNode.ts +400 -391
  151. package/src/core/CoreTextureManager.ts +339 -326
  152. package/src/core/Stage.ts +375 -354
  153. package/src/core/TextureMemoryManager.ts +66 -0
  154. package/src/core/animations/AnimationManager.ts +38 -38
  155. package/src/core/animations/CoreAnimation.ts +181 -181
  156. package/src/core/animations/CoreAnimationController.ts +148 -148
  157. package/src/core/lib/ContextSpy.ts +41 -41
  158. package/src/core/lib/ImageWorker.ts +149 -135
  159. package/src/core/lib/Matrix3d.ts +290 -290
  160. package/src/core/lib/RenderCoords.ts +86 -0
  161. package/src/core/lib/WebGlContextWrapper.ts +992 -992
  162. package/src/core/lib/textureCompression.ts +152 -152
  163. package/src/core/lib/utils.ts +250 -241
  164. package/src/core/platform.ts +54 -46
  165. package/src/core/renderers/CoreContextTexture.ts +35 -30
  166. package/src/core/renderers/CoreRenderOp.ts +22 -22
  167. package/src/core/renderers/CoreRenderer.ts +63 -63
  168. package/src/core/renderers/CoreShader.ts +41 -41
  169. package/src/core/renderers/webgl/WebGlCoreCtxSubTexture.ts +42 -37
  170. package/src/core/renderers/webgl/WebGlCoreCtxTexture.ts +261 -230
  171. package/src/core/renderers/webgl/WebGlCoreRenderOp.ts +107 -107
  172. package/src/core/renderers/webgl/WebGlCoreRenderer.ts +528 -520
  173. package/src/core/renderers/webgl/WebGlCoreShader.ts +337 -337
  174. package/src/core/renderers/webgl/internal/BufferCollection.ts +54 -54
  175. package/src/core/renderers/webgl/internal/RendererUtils.ts +148 -131
  176. package/src/core/renderers/webgl/internal/ShaderUtils.ts +136 -136
  177. package/src/core/renderers/webgl/internal/WebGlUtils.ts +35 -35
  178. package/src/core/renderers/webgl/shaders/DefaultShader.ts +95 -95
  179. package/src/core/renderers/webgl/shaders/DefaultShaderBatched.ts +132 -132
  180. package/src/core/renderers/webgl/shaders/DynamicShader.ts +474 -474
  181. package/src/core/renderers/webgl/shaders/RoundedRectangle.ts +161 -161
  182. package/src/core/renderers/webgl/shaders/SdfShader.ts +174 -174
  183. package/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.ts +101 -101
  184. package/src/core/renderers/webgl/shaders/effects/BorderEffect.ts +86 -86
  185. package/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.ts +101 -101
  186. package/src/core/renderers/webgl/shaders/effects/BorderRightEffect.ts +101 -101
  187. package/src/core/renderers/webgl/shaders/effects/BorderTopEffect.ts +101 -101
  188. package/src/core/renderers/webgl/shaders/effects/EffectUtils.ts +33 -33
  189. package/src/core/renderers/webgl/shaders/effects/FadeOutEffect.ts +135 -135
  190. package/src/core/renderers/webgl/shaders/effects/GlitchEffect.ts +145 -145
  191. package/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.ts +67 -67
  192. package/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.ts +160 -176
  193. package/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.ts +153 -159
  194. package/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.ts +186 -186
  195. package/src/core/renderers/webgl/shaders/effects/RadiusEffect.ts +121 -121
  196. package/src/core/renderers/webgl/shaders/effects/ShaderEffect.ts +114 -114
  197. package/src/core/text-rendering/TextTextureRendererUtils.ts +189 -189
  198. package/src/core/text-rendering/TrFontManager.ts +170 -166
  199. package/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts +141 -141
  200. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/FontShaper.ts +139 -139
  201. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.test.ts +173 -173
  202. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.ts +169 -169
  203. package/src/core/text-rendering/font-face-types/TrFontFace.ts +105 -105
  204. package/src/core/text-rendering/font-face-types/WebTrFontFace.ts +77 -77
  205. package/src/core/text-rendering/renderers/CanvasTextRenderer.ts +780 -751
  206. package/src/core/text-rendering/renderers/LightningTextTextureRenderer.ts +741 -741
  207. package/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts +812 -778
  208. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.test.ts +48 -48
  209. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.ts +66 -66
  210. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/SpecialCodepoints.ts +52 -52
  211. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/constants.ts +32 -32
  212. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getStartConditions.ts +84 -84
  213. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.test.ts +133 -133
  214. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.ts +38 -38
  215. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.ts +391 -393
  216. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.test.ts +49 -49
  217. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.ts +51 -51
  218. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.test.ts +205 -205
  219. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.ts +93 -93
  220. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/util.ts +40 -40
  221. package/src/core/text-rendering/renderers/TextRenderer.ts +548 -504
  222. package/src/core/textures/ColorTexture.ts +86 -86
  223. package/src/core/textures/ImageTexture.ts +154 -140
  224. package/src/core/textures/NoiseTexture.ts +96 -96
  225. package/src/core/textures/SubTexture.ts +143 -143
  226. package/src/core/textures/Texture.ts +261 -218
  227. package/src/core/utils.ts +224 -224
  228. package/src/env.d.ts +7 -7
  229. package/src/main-api/ICoreDriver.ts +68 -66
  230. package/src/main-api/INode.ts +499 -499
  231. package/src/main-api/Inspector.ts +440 -439
  232. package/src/main-api/RendererMain.ts +676 -652
  233. package/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.ts +45 -45
  234. package/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.ts +154 -154
  235. package/src/main-api/texture-usage-trackers/TextureUsageTracker.ts +54 -54
  236. package/src/render-drivers/main/MainCoreDriver.ts +158 -148
  237. package/src/render-drivers/main/MainOnlyNode.ts +500 -466
  238. package/src/render-drivers/main/MainOnlyTextNode.ts +261 -261
  239. package/src/render-drivers/threadx/NodeStruct.ts +300 -300
  240. package/src/render-drivers/threadx/SharedNode.ts +97 -97
  241. package/src/render-drivers/threadx/TextNodeStruct.ts +211 -211
  242. package/src/render-drivers/threadx/ThreadXCoreDriver.ts +287 -285
  243. package/src/render-drivers/threadx/ThreadXMainAnimationController.ts +99 -99
  244. package/src/render-drivers/threadx/ThreadXMainNode.ts +192 -192
  245. package/src/render-drivers/threadx/ThreadXMainTextNode.ts +85 -85
  246. package/src/render-drivers/threadx/ThreadXRendererMessage.ts +112 -110
  247. package/src/render-drivers/threadx/worker/ThreadXRendererNode.ts +245 -238
  248. package/src/render-drivers/threadx/worker/ThreadXRendererTextNode.ts +149 -149
  249. package/src/render-drivers/threadx/worker/renderer.ts +153 -151
  250. package/src/render-drivers/utils.ts +97 -97
  251. package/src/utils.ts +216 -207
  252. package/COPYING +0 -1
@@ -1,992 +1,992 @@
1
- /* eslint-disable @typescript-eslint/no-unsafe-return */
2
- /* eslint-disable @typescript-eslint/no-explicit-any */
3
- /* eslint-disable @typescript-eslint/no-unsafe-argument */
4
-
5
- import { assertTruthy } from '../../utils.js';
6
- import { isWebGl2 } from '../renderers/webgl/internal/WebGlUtils.js';
7
-
8
- /**
9
- * Optimized WebGL Context Wrapper
10
- *
11
- * @remarks
12
- * This class contains the subset of the WebGLRenderingContext & WebGL2RenderingContext
13
- * API that is used by the renderer. Select high volume WebGL methods include
14
- * caching optimizations to avoid making WebGL calls if the state is already set
15
- * to the desired value.
16
- *
17
- * While most methods contained are direct passthroughs to the WebGL context,
18
- * some methods combine multiple WebGL calls into one for convenience, modify
19
- * arguments to be more convenient, or are replaced by more specific methods.
20
- *
21
- * Not all methods are optimized. Only methods that are called frequently
22
- * and/or have a high cost are optimized.
23
- *
24
- * A subset of GLenum constants are also exposed as properties on this class
25
- * for convenience.
26
- */
27
- export class WebGlContextWrapper {
28
- //#region Cached WebGL State
29
- private activeTextureUnit = 0;
30
- private texture2dUnits: Array<WebGLTexture | null>;
31
- private texture2dParams: WeakMap<
32
- WebGLTexture,
33
- Record<number, number | undefined>
34
- > = new WeakMap();
35
- private scissorEnabled;
36
- private scissorX: number;
37
- private scissorY: number;
38
- private scissorWidth: number;
39
- private scissorHeight: number;
40
- private blendEnabled;
41
- private blendSrcRgb: number;
42
- private blendDstRgb: number;
43
- private blendSrcAlpha: number;
44
- private blendDstAlpha: number;
45
- private boundArrayBuffer: WebGLBuffer | null;
46
- private boundElementArrayBuffer: WebGLBuffer | null;
47
- private curProgram: WebGLProgram | null;
48
- private programUniforms: WeakMap<
49
- WebGLProgram,
50
- Map<WebGLUniformLocation, any[]>
51
- > = new WeakMap();
52
- //#endregion Cached WebGL State
53
-
54
- //#region Canvas
55
- public readonly canvas;
56
- //#endregion Canvas
57
-
58
- //#region WebGL Enums
59
- public readonly MAX_RENDERBUFFER_SIZE;
60
- public readonly MAX_TEXTURE_SIZE;
61
- public readonly MAX_VIEWPORT_DIMS;
62
- public readonly MAX_VERTEX_TEXTURE_IMAGE_UNITS;
63
- public readonly MAX_TEXTURE_IMAGE_UNITS;
64
- public readonly MAX_COMBINED_TEXTURE_IMAGE_UNITS;
65
- public readonly MAX_VERTEX_ATTRIBS;
66
- public readonly MAX_VARYING_VECTORS;
67
- public readonly MAX_VERTEX_UNIFORM_VECTORS;
68
- public readonly MAX_FRAGMENT_UNIFORM_VECTORS;
69
- public readonly TEXTURE_MAG_FILTER;
70
- public readonly TEXTURE_MIN_FILTER;
71
- public readonly TEXTURE_WRAP_S;
72
- public readonly TEXTURE_WRAP_T;
73
- public readonly LINEAR;
74
- public readonly CLAMP_TO_EDGE;
75
- public readonly RGBA;
76
- public readonly UNSIGNED_BYTE;
77
- public readonly UNPACK_PREMULTIPLY_ALPHA_WEBGL;
78
- public readonly FLOAT;
79
- public readonly TRIANGLES;
80
- public readonly UNSIGNED_SHORT;
81
- public readonly ONE;
82
- public readonly ONE_MINUS_SRC_ALPHA;
83
- public readonly VERTEX_SHADER;
84
- public readonly FRAGMENT_SHADER;
85
- public readonly STATIC_DRAW;
86
- public readonly COMPILE_STATUS;
87
- public readonly LINK_STATUS;
88
- public readonly DYNAMIC_DRAW;
89
- //#endregion WebGL Enums
90
-
91
- constructor(private gl: WebGLRenderingContext | WebGL2RenderingContext) {
92
- // The following code extracts the current state of the WebGL context
93
- // to our local JavaScript cached version of it. This is so we can
94
- // avoid making WebGL calls if we don't need to.
95
- // We could assume that the WebGL context is in a default state, but
96
- // in the future we may want to support restoring a broken WebGL context
97
- // and this will help with that.
98
- this.activeTextureUnit =
99
- (gl.getParameter(gl.ACTIVE_TEXTURE) as number) - gl.TEXTURE0;
100
- const maxTextureUnits = gl.getParameter(
101
- gl.MAX_TEXTURE_IMAGE_UNITS,
102
- ) as number;
103
- // save current texture units
104
- this.texture2dUnits = new Array<undefined>(maxTextureUnits)
105
- .fill(undefined)
106
- .map((_, i) => {
107
- this.activeTexture(i);
108
- return gl.getParameter(gl.TEXTURE_BINDING_2D) as WebGLTexture;
109
- });
110
- // restore active texture unit
111
- this.activeTexture(this.activeTextureUnit);
112
- this.scissorEnabled = gl.isEnabled(gl.SCISSOR_TEST);
113
-
114
- const scissorBox = gl.getParameter(gl.SCISSOR_BOX) as [
115
- number,
116
- number,
117
- number,
118
- number,
119
- ];
120
- this.scissorX = scissorBox[0];
121
- this.scissorY = scissorBox[1];
122
- this.scissorWidth = scissorBox[2];
123
- this.scissorHeight = scissorBox[3];
124
-
125
- this.blendEnabled = gl.isEnabled(gl.BLEND);
126
- this.blendSrcRgb = gl.getParameter(gl.BLEND_SRC_RGB) as number;
127
- this.blendDstRgb = gl.getParameter(gl.BLEND_DST_RGB) as number;
128
- this.blendSrcAlpha = gl.getParameter(gl.BLEND_SRC_ALPHA) as number;
129
- this.blendDstAlpha = gl.getParameter(gl.BLEND_DST_ALPHA) as number;
130
-
131
- this.boundArrayBuffer = gl.getParameter(
132
- gl.ARRAY_BUFFER_BINDING,
133
- ) as WebGLBuffer;
134
- this.boundElementArrayBuffer = gl.getParameter(
135
- gl.ELEMENT_ARRAY_BUFFER_BINDING,
136
- ) as WebGLBuffer;
137
-
138
- this.curProgram = gl.getParameter(
139
- gl.CURRENT_PROGRAM,
140
- ) as WebGLProgram | null;
141
-
142
- this.canvas = gl.canvas;
143
-
144
- // Extract GLenums
145
- this.MAX_RENDERBUFFER_SIZE = gl.MAX_RENDERBUFFER_SIZE;
146
- this.MAX_TEXTURE_SIZE = gl.MAX_TEXTURE_SIZE;
147
- this.MAX_VIEWPORT_DIMS = gl.MAX_VIEWPORT_DIMS;
148
- this.MAX_VERTEX_TEXTURE_IMAGE_UNITS = gl.MAX_VERTEX_TEXTURE_IMAGE_UNITS;
149
- this.MAX_TEXTURE_IMAGE_UNITS = gl.MAX_TEXTURE_IMAGE_UNITS;
150
- this.MAX_COMBINED_TEXTURE_IMAGE_UNITS = gl.MAX_COMBINED_TEXTURE_IMAGE_UNITS;
151
- this.MAX_VERTEX_ATTRIBS = gl.MAX_VERTEX_ATTRIBS;
152
- this.MAX_VARYING_VECTORS = gl.MAX_VARYING_VECTORS;
153
- this.MAX_VERTEX_UNIFORM_VECTORS = gl.MAX_VERTEX_UNIFORM_VECTORS;
154
- this.MAX_FRAGMENT_UNIFORM_VECTORS = gl.MAX_FRAGMENT_UNIFORM_VECTORS;
155
- this.TEXTURE_MAG_FILTER = gl.TEXTURE_MAG_FILTER;
156
- this.TEXTURE_MIN_FILTER = gl.TEXTURE_MIN_FILTER;
157
- this.TEXTURE_WRAP_S = gl.TEXTURE_WRAP_S;
158
- this.TEXTURE_WRAP_T = gl.TEXTURE_WRAP_T;
159
- this.LINEAR = gl.LINEAR;
160
- this.CLAMP_TO_EDGE = gl.CLAMP_TO_EDGE;
161
- this.RGBA = gl.RGBA;
162
- this.UNSIGNED_BYTE = gl.UNSIGNED_BYTE;
163
- this.UNPACK_PREMULTIPLY_ALPHA_WEBGL = gl.UNPACK_PREMULTIPLY_ALPHA_WEBGL;
164
- this.FLOAT = gl.FLOAT;
165
- this.TRIANGLES = gl.TRIANGLES;
166
- this.UNSIGNED_SHORT = gl.UNSIGNED_SHORT;
167
- this.ONE = gl.ONE;
168
- this.ONE_MINUS_SRC_ALPHA = gl.ONE_MINUS_SRC_ALPHA;
169
- this.MAX_VERTEX_TEXTURE_IMAGE_UNITS = gl.MAX_VERTEX_TEXTURE_IMAGE_UNITS;
170
- this.TRIANGLES = gl.TRIANGLES;
171
- this.UNSIGNED_SHORT = gl.UNSIGNED_SHORT;
172
- this.VERTEX_SHADER = gl.VERTEX_SHADER;
173
- this.FRAGMENT_SHADER = gl.FRAGMENT_SHADER;
174
- this.STATIC_DRAW = gl.STATIC_DRAW;
175
- this.COMPILE_STATUS = gl.COMPILE_STATUS;
176
- this.LINK_STATUS = gl.LINK_STATUS;
177
- this.DYNAMIC_DRAW = gl.DYNAMIC_DRAW;
178
- }
179
- /**
180
- * Returns true if the WebGL context is WebGL2
181
- *
182
- * @returns
183
- */
184
- isWebGl2() {
185
- return isWebGl2(this.gl);
186
- }
187
-
188
- /**
189
- * ```
190
- * gl.activeTexture(textureUnit + gl.TEXTURE0);
191
- * ```
192
- *
193
- * @remarks
194
- * **WebGL Difference**: `textureUnit` is based from 0, not `gl.TEXTURE0`.
195
- *
196
- * @param textureUnit
197
- */
198
- activeTexture(textureUnit: number) {
199
- const { gl } = this;
200
- if (this.activeTextureUnit !== textureUnit) {
201
- gl.activeTexture(textureUnit + gl.TEXTURE0);
202
- this.activeTextureUnit = textureUnit;
203
- }
204
- }
205
-
206
- /**
207
- * ```
208
- * gl.bindTexture(gl.TEXTURE_2D, texture);
209
- * ```
210
- * @remarks
211
- * **WebGL Difference**: Bind target is always `gl.TEXTURE_2D`
212
- *
213
- * @param texture
214
- */
215
- bindTexture(texture: WebGLTexture | null) {
216
- const { gl, activeTextureUnit, texture2dUnits } = this;
217
-
218
- if (texture2dUnits[activeTextureUnit] === texture) {
219
- return;
220
- }
221
- texture2dUnits[activeTextureUnit] = texture;
222
-
223
- gl.bindTexture(this.gl.TEXTURE_2D, texture);
224
- }
225
-
226
- private _getActiveTexture(): WebGLTexture | null {
227
- const { activeTextureUnit, texture2dUnits } = this;
228
- return texture2dUnits[activeTextureUnit]!;
229
- }
230
-
231
- /**
232
- * ```
233
- * gl.texParameteri(gl.TEXTURE_2D, pname, param);
234
- * ```
235
- * @remarks
236
- * **WebGL Difference**: Bind target is always `gl.TEXTURE_2D`
237
- *
238
- * @param pname
239
- * @param param
240
- * @returns
241
- */
242
- texParameteri(pname: number, param: number) {
243
- const { gl, texture2dParams } = this;
244
-
245
- const activeTexture = this._getActiveTexture();
246
- if (!activeTexture) {
247
- throw new Error('No active texture');
248
- }
249
- let textureParams = texture2dParams.get(activeTexture);
250
- if (!textureParams) {
251
- textureParams = {};
252
- texture2dParams.set(activeTexture, textureParams);
253
- }
254
- if (textureParams[pname] === param) {
255
- return;
256
- }
257
- textureParams[pname] = param;
258
- gl.texParameteri(gl.TEXTURE_2D, pname, param);
259
- }
260
-
261
- /**
262
- * ```
263
- * gl.texImage2D(
264
- * gl.TEXTURE_2D,
265
- * level,
266
- * internalFormat,
267
- * width,
268
- * height,
269
- * border,
270
- * format,
271
- * type,
272
- * pixels,
273
- * );
274
- * ```
275
- * @remarks
276
- * **WebGL Difference**: Bind target is always `gl.TEXTURE_2D`
277
- *
278
- * @param level
279
- * @param internalFormat
280
- * @param width
281
- * @param height
282
- * @param border
283
- * @param format
284
- * @param type
285
- * @param pixels
286
- */
287
- texImage2D(
288
- level: GLint,
289
- internalformat: GLint,
290
- width: GLsizei,
291
- height: GLsizei,
292
- border: GLint,
293
- format: GLenum,
294
- type: GLenum,
295
- pixels: ArrayBufferView | null,
296
- ): void;
297
- texImage2D(
298
- level: GLint,
299
- internalformat: GLint,
300
- format: GLenum,
301
- type: GLenum,
302
- source: TexImageSource,
303
- ): void;
304
- texImage2D(
305
- level: any,
306
- internalFormat: any,
307
- widthOrFormat: any,
308
- heightOrType: any,
309
- borderOrSource: any,
310
- format?: any,
311
- type?: any,
312
- pixels?: any,
313
- ) {
314
- const { gl } = this;
315
- if (format) {
316
- gl.texImage2D(
317
- gl.TEXTURE_2D,
318
- level,
319
- internalFormat,
320
- widthOrFormat,
321
- heightOrType,
322
- borderOrSource,
323
- format,
324
- type,
325
- pixels,
326
- );
327
- } else {
328
- gl.texImage2D(
329
- gl.TEXTURE_2D,
330
- level,
331
- internalFormat,
332
- widthOrFormat,
333
- heightOrType,
334
- borderOrSource,
335
- );
336
- }
337
- }
338
- /**
339
- * ```
340
- * gl.compressedTexImage2D(gl.TEXTURE_2D, level, internalFormat, width, height, border, data);
341
- * ```
342
- *
343
- * @remarks
344
- * **WebGL Difference**: Bind target is always `gl.TEXTURE_2D`
345
- */
346
-
347
- compressedTexImage2D(
348
- level: GLint,
349
- internalformat: GLenum,
350
- width: GLsizei,
351
- height: GLsizei,
352
- border: GLint,
353
- data?: ArrayBufferView,
354
- ): void {
355
- const { gl } = this;
356
- gl.compressedTexImage2D(
357
- gl.TEXTURE_2D,
358
- level,
359
- internalformat,
360
- width,
361
- height,
362
- border,
363
- data as ArrayBufferView,
364
- );
365
- }
366
- /**
367
- * ```
368
- * gl.pixelStorei(pname, param);
369
- * ```
370
- *
371
- * @param pname
372
- * @param param
373
- */
374
- pixelStorei(pname: GLenum, param: GLint | GLboolean) {
375
- const { gl } = this;
376
- gl.pixelStorei(pname, param);
377
- }
378
-
379
- /**
380
- * ```
381
- * gl.generateMipmap(gl.TEXTURE_2D);
382
- * ```
383
- *
384
- * @remarks
385
- * **WebGL Difference**: Bind target is always `gl.TEXTURE_2D`
386
- */
387
- generateMipmap() {
388
- const { gl } = this;
389
- gl.generateMipmap(gl.TEXTURE_2D);
390
- }
391
-
392
- /**
393
- * ```
394
- * gl.createTexture();
395
- * ```
396
- *
397
- * @returns
398
- */
399
- createTexture() {
400
- const { gl } = this;
401
- return gl.createTexture();
402
- }
403
-
404
- /**
405
- * ```
406
- * gl.deleteTexture(texture);
407
- * ```
408
- *
409
- * @param texture
410
- */
411
- deleteTexture(texture: WebGLTexture | null) {
412
- const { gl } = this;
413
- if (texture) {
414
- this.texture2dParams.delete(texture);
415
- }
416
- gl.deleteTexture(texture);
417
- }
418
-
419
- /**
420
- * ```
421
- * gl.viewport(x, y, width, height);
422
- * ```
423
- */
424
- viewport(x: GLint, y: GLint, width: GLsizei, height: GLsizei) {
425
- const { gl } = this;
426
- gl.viewport(x, y, width, height);
427
- }
428
-
429
- /**
430
- * ```
431
- * gl.clearColor(red, green, blue, alpha);
432
- * ```
433
- *
434
- * @param red
435
- * @param green
436
- * @param blue
437
- * @param alpha
438
- */
439
- clearColor(red: GLclampf, green: GLclampf, blue: GLclampf, alpha: GLclampf) {
440
- const { gl } = this;
441
- gl.clearColor(red, green, blue, alpha);
442
- }
443
-
444
- /**
445
- * ```
446
- * gl["enable"|"disable"](gl.SCISSOR_TEST);
447
- * ```
448
- * @param enable
449
- */
450
- setScissorTest(enable: boolean) {
451
- const { gl, scissorEnabled } = this;
452
- if (enable === scissorEnabled) {
453
- return;
454
- }
455
- if (enable) {
456
- gl.enable(gl.SCISSOR_TEST);
457
- } else {
458
- gl.disable(gl.SCISSOR_TEST);
459
- }
460
- this.scissorEnabled = enable;
461
- }
462
-
463
- /**
464
- * ```
465
- * gl.scissor(x, y, width, height);
466
- * ```
467
- *
468
- * @param x
469
- * @param y
470
- * @param width
471
- * @param height
472
- */
473
- scissor(x: GLint, y: GLint, width: GLsizei, height: GLsizei) {
474
- const { gl, scissorX, scissorY, scissorWidth, scissorHeight } = this;
475
- if (
476
- x !== scissorX ||
477
- y !== scissorY ||
478
- width !== scissorWidth ||
479
- height !== scissorHeight
480
- ) {
481
- gl.scissor(x, y, width, height);
482
- this.scissorX = x;
483
- this.scissorY = y;
484
- this.scissorWidth = width;
485
- this.scissorHeight = height;
486
- }
487
- }
488
-
489
- /**
490
- * ```
491
- * gl["enable"|"disable"](gl.BLEND);
492
- * ```
493
- *
494
- * @param blend
495
- * @returns
496
- */
497
- setBlend(blend: boolean) {
498
- const { gl, blendEnabled } = this;
499
- if (blend === blendEnabled) {
500
- return;
501
- }
502
- if (blend) {
503
- gl.enable(gl.BLEND);
504
- } else {
505
- gl.disable(gl.BLEND);
506
- }
507
- this.blendEnabled = blend;
508
- }
509
-
510
- /**
511
- * ```
512
- * gl.blendFunc(src, dst);
513
- * ```
514
- *
515
- * @param src
516
- * @param dst
517
- */
518
- blendFunc(src: GLenum, dst: GLenum) {
519
- const { gl, blendSrcRgb, blendDstRgb, blendSrcAlpha, blendDstAlpha } = this;
520
- if (
521
- src !== blendSrcRgb ||
522
- dst !== blendDstRgb ||
523
- src !== blendSrcAlpha ||
524
- dst !== blendDstAlpha
525
- ) {
526
- gl.blendFunc(src, dst);
527
- this.blendSrcRgb = src;
528
- this.blendDstRgb = dst;
529
- this.blendSrcAlpha = src;
530
- this.blendDstAlpha = dst;
531
- }
532
- }
533
-
534
- /**
535
- * ```
536
- * createBuffer();
537
- * ```
538
- *
539
- * @returns
540
- */
541
- createBuffer() {
542
- const { gl } = this;
543
- return gl.createBuffer();
544
- }
545
-
546
- /**
547
- * ```
548
- * gl.clear(gl.COLOR_BUFFER_BIT);
549
- * ```
550
- *
551
- * @remarks
552
- * **WebGL Difference**: Clear mask is always `gl.COLOR_BUFFER_BIT`
553
- */
554
- clear() {
555
- const { gl } = this;
556
- gl.clear(gl.COLOR_BUFFER_BIT);
557
- }
558
-
559
- /**
560
- * ```
561
- * gl.bindBuffer(gl.ARRAY_BUFFER, buffer);
562
- * gl.bufferData(gl.ARRAY_BUFFER, data, usage);
563
- * ```
564
- *
565
- * @remarks
566
- * **WebGL Combo**: `gl.bindBuffer` and `gl.bufferData` are combined into one function.
567
- *
568
- * @param buffer
569
- * @param data
570
- * @param usage
571
- */
572
- arrayBufferData(
573
- buffer: WebGLBuffer | null,
574
- data: ArrayBufferView,
575
- usage: GLenum,
576
- ) {
577
- const { gl, boundArrayBuffer } = this;
578
- if (boundArrayBuffer !== buffer) {
579
- gl.bindBuffer(gl.ARRAY_BUFFER, buffer);
580
- this.boundArrayBuffer = buffer;
581
- }
582
- gl.bufferData(gl.ARRAY_BUFFER, data, usage);
583
- }
584
-
585
- /**
586
- * ```
587
- * gl.bindBuffer(gl.ELEMENT_ARRAY_BUFFER, buffer);
588
- * gl.bufferData(gl.ELEMENT_ARRAY_BUFFER, data, usage);
589
- * ```
590
- * @remarks
591
- * **WebGL Combo**: `gl.bindBuffer` and `gl.bufferData` are combined into one function.
592
- *
593
- * @param buffer
594
- * @param data
595
- * @param usage
596
- */
597
- elementArrayBufferData(
598
- buffer: WebGLBuffer | null,
599
- data: ArrayBufferView,
600
- usage: GLenum,
601
- ) {
602
- const { gl, boundElementArrayBuffer } = this;
603
- if (boundElementArrayBuffer !== buffer) {
604
- gl.bindBuffer(gl.ELEMENT_ARRAY_BUFFER, buffer);
605
- this.boundElementArrayBuffer = buffer;
606
- }
607
- gl.bufferData(gl.ELEMENT_ARRAY_BUFFER, data, usage);
608
- }
609
-
610
- /**
611
- * ```
612
- * gl.bindBuffer(gl.ARRAY_BUFFER, buffer);
613
- * gl.vertexAttribPointer(index, size, type, normalized, stride, offset);
614
- * ```
615
- *
616
- * @remarks
617
- * **WebGL Combo**: `gl.bindBuffer` and `gl.vertexAttribPointer` are combined into one function.
618
- *
619
- * @param buffer
620
- * @param index
621
- * @param size
622
- * @param type
623
- * @param normalized
624
- * @param stride
625
- * @param offset
626
- */
627
- vertexAttribPointer(
628
- buffer: WebGLBuffer,
629
- index: GLuint,
630
- size: GLint,
631
- type: GLenum,
632
- normalized: GLboolean,
633
- stride: GLsizei,
634
- offset: GLintptr,
635
- ) {
636
- const { gl, boundArrayBuffer } = this;
637
- if (boundArrayBuffer !== buffer) {
638
- gl.bindBuffer(gl.ARRAY_BUFFER, buffer);
639
- this.boundArrayBuffer = buffer;
640
- }
641
- gl.vertexAttribPointer(index, size, type, normalized, stride, offset);
642
- }
643
-
644
- /**
645
- * ```
646
- * gl.useProgram(program);
647
- * ```
648
- *
649
- * @param program
650
- * @returns
651
- */
652
- useProgram(program: WebGLProgram | null) {
653
- const { gl, curProgram } = this;
654
- if (curProgram === program) {
655
- return;
656
- }
657
- gl.useProgram(program);
658
- this.curProgram = program;
659
- }
660
-
661
- setUniform<T extends keyof UniformMethodMap>(
662
- type: T,
663
- location: WebGLUniformLocation,
664
- ...args: UniformMethodMap[T]
665
- ) {
666
- const { gl, programUniforms } = this;
667
- let uniforms = programUniforms.get(this.curProgram!);
668
- if (!uniforms) {
669
- uniforms = new Map();
670
- programUniforms.set(this.curProgram!, uniforms);
671
- }
672
- const uniformArgs = uniforms.get(location);
673
- if (!uniformArgs || !compareArrays(uniformArgs, args)) {
674
- uniforms.set(location, args);
675
- gl[type](location, ...(args as [never, never, never, never]));
676
- }
677
- }
678
-
679
- /**
680
- * ```
681
- * gl.getParameter(pname);
682
- * ```
683
- *
684
- * @param pname
685
- * @returns
686
- */
687
- getParameter(pname: GLenum): any {
688
- const { gl } = this;
689
- return gl.getParameter(pname);
690
- }
691
-
692
- /**
693
- * ```
694
- * gl.drawElements(mode, count, type, offset);
695
- * ```
696
- *
697
- * @param mode
698
- * @param count
699
- * @param type
700
- * @param offset
701
- */
702
- drawElements(mode: GLenum, count: GLsizei, type: GLenum, offset: GLintptr) {
703
- const { gl } = this;
704
- gl.drawElements(mode, count, type, offset);
705
- }
706
-
707
- /**
708
- * ```
709
- * gl.drawArrays(mode, first, count);
710
- * ```
711
- *
712
- * @param name
713
- * @returns
714
- */
715
- getExtension(name: string) {
716
- const { gl } = this;
717
- return gl.getExtension(name);
718
- }
719
-
720
- /**
721
- * ```
722
- * gl.createVertexArray();
723
- * ```
724
- *
725
- * @returns
726
- */
727
- createVertexArray() {
728
- const { gl } = this;
729
- assertTruthy(gl instanceof WebGL2RenderingContext);
730
- return gl.createVertexArray();
731
- }
732
-
733
- /**
734
- * ```
735
- * gl.bindVertexArray(vertexArray);
736
- * ```
737
- *
738
- * @param vertexArray
739
- */
740
- bindVertexArray(vertexArray: WebGLVertexArrayObject | null) {
741
- const { gl } = this;
742
- assertTruthy(gl instanceof WebGL2RenderingContext);
743
- gl.bindVertexArray(vertexArray);
744
- }
745
-
746
- /**
747
- * ```
748
- * gl.getAttribLocation(program, name);
749
- * ```
750
- *
751
- * @param program
752
- * @param name
753
- * @returns
754
- */
755
- getAttribLocation(program: WebGLProgram, name: string) {
756
- const { gl } = this;
757
- return gl.getAttribLocation(program, name);
758
- }
759
-
760
- /**
761
- * ```
762
- * gl.getUniformLocation(program, name);
763
- * ```
764
- *
765
- * @param program
766
- * @param name
767
- * @returns
768
- */
769
- getUniformLocation(program: WebGLProgram, name: string) {
770
- const { gl } = this;
771
- return gl.getUniformLocation(program, name);
772
- }
773
-
774
- /**
775
- * ```
776
- * gl.enableVertexAttribArray(index);
777
- * ```
778
- *
779
- * @param index
780
- */
781
- enableVertexAttribArray(index: number) {
782
- const { gl } = this;
783
- gl.enableVertexAttribArray(index);
784
- }
785
-
786
- /**
787
- * ```
788
- * gl.disableVertexAttribArray(index);
789
- * ```
790
- *
791
- * @param index
792
- */
793
- disableVertexAttribArray(index: number) {
794
- const { gl } = this;
795
- gl.disableVertexAttribArray(index);
796
- }
797
-
798
- /**
799
- * ```
800
- * gl.createShader(type);
801
- * ```
802
- *
803
- * @param type
804
- * @returns
805
- */
806
- createShader(type: number) {
807
- const { gl } = this;
808
- return gl.createShader(type);
809
- }
810
-
811
- /**
812
- * ```
813
- * gl.compileShader(shader);
814
- * ```
815
- *
816
- * @param shader
817
- * @returns
818
- */
819
- compileShader(shader: WebGLShader) {
820
- const { gl } = this;
821
- gl.compileShader(shader);
822
- }
823
-
824
- /**
825
- * ```
826
- * gl.attachShader(program, shader);
827
- * ```
828
- *
829
- * @param program
830
- * @param shader
831
- */
832
- attachShader(program: WebGLProgram, shader: WebGLShader) {
833
- const { gl } = this;
834
- gl.attachShader(program, shader);
835
- }
836
-
837
- /**
838
- * ```
839
- * gl.linkProgram(program);
840
- * ```
841
- *
842
- * @param program
843
- */
844
- linkProgram(program: WebGLProgram) {
845
- const { gl } = this;
846
- gl.linkProgram(program);
847
- }
848
-
849
- /**
850
- * ```
851
- * gl.deleteProgram(shader);
852
- * ```
853
- *
854
- * @param shader
855
- */
856
- deleteProgram(shader: WebGLProgram) {
857
- const { gl } = this;
858
- gl.deleteProgram(shader);
859
- }
860
-
861
- /**
862
- * ```
863
- * gl.getShaderParameter(shader, pname);
864
- * ```
865
- *
866
- * @param shader
867
- * @param pname
868
- */
869
- getShaderParameter(shader: WebGLShader, pname: GLenum) {
870
- const { gl } = this;
871
- return gl.getShaderParameter(shader, pname);
872
- }
873
-
874
- /**
875
- * ```
876
- * gl.getShaderInfoLog(shader);
877
- * ```
878
- *
879
- * @param shader
880
- */
881
- getShaderInfoLog(shader: WebGLShader) {
882
- const { gl } = this;
883
- return gl.getShaderInfoLog(shader);
884
- }
885
-
886
- /**
887
- * ```
888
- * gl.createProgram();
889
- * ```
890
- *
891
- * @returns
892
- */
893
- createProgram() {
894
- const { gl } = this;
895
- return gl.createProgram();
896
- }
897
-
898
- /**
899
- * ```
900
- * gl.getProgramParameter(program, pname);
901
- * ```
902
- *
903
- * @param program
904
- * @param pname
905
- * @returns
906
- */
907
- getProgramParameter(program: WebGLProgram, pname: GLenum) {
908
- const { gl } = this;
909
- return gl.getProgramParameter(program, pname);
910
- }
911
-
912
- /**
913
- * ```
914
- * gl.getProgramInfoLog(program);
915
- * ```
916
- *
917
- * @param program
918
- * @returns
919
- */
920
- getProgramInfoLog(program: WebGLProgram) {
921
- const { gl } = this;
922
- return gl.getProgramInfoLog(program);
923
- }
924
-
925
- /**
926
- * ```
927
- * gl.shaderSource(shader, source);
928
- * ```
929
- *
930
- * @param shader
931
- * @param source
932
- */
933
- shaderSource(shader: WebGLShader, source: string) {
934
- const { gl } = this;
935
- gl.shaderSource(shader, source);
936
- }
937
-
938
- /**
939
- * ```
940
- * gl.deleteShader(shader);
941
- * ```
942
- *
943
- * @param shader
944
- */
945
- deleteShader(shader: WebGLShader) {
946
- const { gl } = this;
947
- gl.deleteShader(shader);
948
- }
949
- }
950
-
951
- // prettier-ignore
952
- type IsUniformMethod<MethodName, MethodType> = MethodName extends `uniform${string}`
953
- ? // eslint-disable-next-line @typescript-eslint/no-explicit-any
954
- MethodType extends (location: WebGLUniformLocation | null, ...args: any[]) => void
955
- ? true
956
- : false
957
- : false;
958
-
959
- // prettier-ignore
960
- export type UniformMethodMap = {
961
- [Key in keyof WebGLRenderingContext as IsUniformMethod<Key, WebGLRenderingContext[Key]> extends true ? Key : never]: WebGLRenderingContext[Key] extends (
962
- location: WebGLUniformLocation | null,
963
- ...args: infer T
964
- ) => void
965
- ? T
966
- : never;
967
- };
968
-
969
- /**
970
- * Compare two arrays for equality.
971
- *
972
- * @remarks
973
- * This function will not try to compare nested arrays or Float32Arrays and
974
- * instead will always return false when they are encountered.
975
- *
976
- * @param a
977
- * @param b
978
- * @returns
979
- */
980
- export function compareArrays<T>(a: T[], b: T[]): boolean {
981
- if (a.length !== b.length) {
982
- return false;
983
- }
984
- return a.every((v, i) => {
985
- // Don't bother to compare nested arrays or Float32Arrays
986
- if (Array.isArray(v) || v instanceof Float32Array) {
987
- return false;
988
- } else {
989
- return v === b[i];
990
- }
991
- });
992
- }
1
+ /* eslint-disable @typescript-eslint/no-unsafe-return */
2
+ /* eslint-disable @typescript-eslint/no-explicit-any */
3
+ /* eslint-disable @typescript-eslint/no-unsafe-argument */
4
+
5
+ import { assertTruthy } from '../../utils.js';
6
+ import { isWebGl2 } from '../renderers/webgl/internal/WebGlUtils.js';
7
+
8
+ /**
9
+ * Optimized WebGL Context Wrapper
10
+ *
11
+ * @remarks
12
+ * This class contains the subset of the WebGLRenderingContext & WebGL2RenderingContext
13
+ * API that is used by the renderer. Select high volume WebGL methods include
14
+ * caching optimizations to avoid making WebGL calls if the state is already set
15
+ * to the desired value.
16
+ *
17
+ * While most methods contained are direct passthroughs to the WebGL context,
18
+ * some methods combine multiple WebGL calls into one for convenience, modify
19
+ * arguments to be more convenient, or are replaced by more specific methods.
20
+ *
21
+ * Not all methods are optimized. Only methods that are called frequently
22
+ * and/or have a high cost are optimized.
23
+ *
24
+ * A subset of GLenum constants are also exposed as properties on this class
25
+ * for convenience.
26
+ */
27
+ export class WebGlContextWrapper {
28
+ //#region Cached WebGL State
29
+ private activeTextureUnit = 0;
30
+ private texture2dUnits: Array<WebGLTexture | null>;
31
+ private texture2dParams: WeakMap<
32
+ WebGLTexture,
33
+ Record<number, number | undefined>
34
+ > = new WeakMap();
35
+ private scissorEnabled;
36
+ private scissorX: number;
37
+ private scissorY: number;
38
+ private scissorWidth: number;
39
+ private scissorHeight: number;
40
+ private blendEnabled;
41
+ private blendSrcRgb: number;
42
+ private blendDstRgb: number;
43
+ private blendSrcAlpha: number;
44
+ private blendDstAlpha: number;
45
+ private boundArrayBuffer: WebGLBuffer | null;
46
+ private boundElementArrayBuffer: WebGLBuffer | null;
47
+ private curProgram: WebGLProgram | null;
48
+ private programUniforms: WeakMap<
49
+ WebGLProgram,
50
+ Map<WebGLUniformLocation, any[]>
51
+ > = new WeakMap();
52
+ //#endregion Cached WebGL State
53
+
54
+ //#region Canvas
55
+ public readonly canvas;
56
+ //#endregion Canvas
57
+
58
+ //#region WebGL Enums
59
+ public readonly MAX_RENDERBUFFER_SIZE;
60
+ public readonly MAX_TEXTURE_SIZE;
61
+ public readonly MAX_VIEWPORT_DIMS;
62
+ public readonly MAX_VERTEX_TEXTURE_IMAGE_UNITS;
63
+ public readonly MAX_TEXTURE_IMAGE_UNITS;
64
+ public readonly MAX_COMBINED_TEXTURE_IMAGE_UNITS;
65
+ public readonly MAX_VERTEX_ATTRIBS;
66
+ public readonly MAX_VARYING_VECTORS;
67
+ public readonly MAX_VERTEX_UNIFORM_VECTORS;
68
+ public readonly MAX_FRAGMENT_UNIFORM_VECTORS;
69
+ public readonly TEXTURE_MAG_FILTER;
70
+ public readonly TEXTURE_MIN_FILTER;
71
+ public readonly TEXTURE_WRAP_S;
72
+ public readonly TEXTURE_WRAP_T;
73
+ public readonly LINEAR;
74
+ public readonly CLAMP_TO_EDGE;
75
+ public readonly RGBA;
76
+ public readonly UNSIGNED_BYTE;
77
+ public readonly UNPACK_PREMULTIPLY_ALPHA_WEBGL;
78
+ public readonly FLOAT;
79
+ public readonly TRIANGLES;
80
+ public readonly UNSIGNED_SHORT;
81
+ public readonly ONE;
82
+ public readonly ONE_MINUS_SRC_ALPHA;
83
+ public readonly VERTEX_SHADER;
84
+ public readonly FRAGMENT_SHADER;
85
+ public readonly STATIC_DRAW;
86
+ public readonly COMPILE_STATUS;
87
+ public readonly LINK_STATUS;
88
+ public readonly DYNAMIC_DRAW;
89
+ //#endregion WebGL Enums
90
+
91
+ constructor(private gl: WebGLRenderingContext | WebGL2RenderingContext) {
92
+ // The following code extracts the current state of the WebGL context
93
+ // to our local JavaScript cached version of it. This is so we can
94
+ // avoid making WebGL calls if we don't need to.
95
+ // We could assume that the WebGL context is in a default state, but
96
+ // in the future we may want to support restoring a broken WebGL context
97
+ // and this will help with that.
98
+ this.activeTextureUnit =
99
+ (gl.getParameter(gl.ACTIVE_TEXTURE) as number) - gl.TEXTURE0;
100
+ const maxTextureUnits = gl.getParameter(
101
+ gl.MAX_TEXTURE_IMAGE_UNITS,
102
+ ) as number;
103
+ // save current texture units
104
+ this.texture2dUnits = new Array<undefined>(maxTextureUnits)
105
+ .fill(undefined)
106
+ .map((_, i) => {
107
+ this.activeTexture(i);
108
+ return gl.getParameter(gl.TEXTURE_BINDING_2D) as WebGLTexture;
109
+ });
110
+ // restore active texture unit
111
+ this.activeTexture(this.activeTextureUnit);
112
+ this.scissorEnabled = gl.isEnabled(gl.SCISSOR_TEST);
113
+
114
+ const scissorBox = gl.getParameter(gl.SCISSOR_BOX) as [
115
+ number,
116
+ number,
117
+ number,
118
+ number,
119
+ ];
120
+ this.scissorX = scissorBox[0];
121
+ this.scissorY = scissorBox[1];
122
+ this.scissorWidth = scissorBox[2];
123
+ this.scissorHeight = scissorBox[3];
124
+
125
+ this.blendEnabled = gl.isEnabled(gl.BLEND);
126
+ this.blendSrcRgb = gl.getParameter(gl.BLEND_SRC_RGB) as number;
127
+ this.blendDstRgb = gl.getParameter(gl.BLEND_DST_RGB) as number;
128
+ this.blendSrcAlpha = gl.getParameter(gl.BLEND_SRC_ALPHA) as number;
129
+ this.blendDstAlpha = gl.getParameter(gl.BLEND_DST_ALPHA) as number;
130
+
131
+ this.boundArrayBuffer = gl.getParameter(
132
+ gl.ARRAY_BUFFER_BINDING,
133
+ ) as WebGLBuffer;
134
+ this.boundElementArrayBuffer = gl.getParameter(
135
+ gl.ELEMENT_ARRAY_BUFFER_BINDING,
136
+ ) as WebGLBuffer;
137
+
138
+ this.curProgram = gl.getParameter(
139
+ gl.CURRENT_PROGRAM,
140
+ ) as WebGLProgram | null;
141
+
142
+ this.canvas = gl.canvas;
143
+
144
+ // Extract GLenums
145
+ this.MAX_RENDERBUFFER_SIZE = gl.MAX_RENDERBUFFER_SIZE;
146
+ this.MAX_TEXTURE_SIZE = gl.MAX_TEXTURE_SIZE;
147
+ this.MAX_VIEWPORT_DIMS = gl.MAX_VIEWPORT_DIMS;
148
+ this.MAX_VERTEX_TEXTURE_IMAGE_UNITS = gl.MAX_VERTEX_TEXTURE_IMAGE_UNITS;
149
+ this.MAX_TEXTURE_IMAGE_UNITS = gl.MAX_TEXTURE_IMAGE_UNITS;
150
+ this.MAX_COMBINED_TEXTURE_IMAGE_UNITS = gl.MAX_COMBINED_TEXTURE_IMAGE_UNITS;
151
+ this.MAX_VERTEX_ATTRIBS = gl.MAX_VERTEX_ATTRIBS;
152
+ this.MAX_VARYING_VECTORS = gl.MAX_VARYING_VECTORS;
153
+ this.MAX_VERTEX_UNIFORM_VECTORS = gl.MAX_VERTEX_UNIFORM_VECTORS;
154
+ this.MAX_FRAGMENT_UNIFORM_VECTORS = gl.MAX_FRAGMENT_UNIFORM_VECTORS;
155
+ this.TEXTURE_MAG_FILTER = gl.TEXTURE_MAG_FILTER;
156
+ this.TEXTURE_MIN_FILTER = gl.TEXTURE_MIN_FILTER;
157
+ this.TEXTURE_WRAP_S = gl.TEXTURE_WRAP_S;
158
+ this.TEXTURE_WRAP_T = gl.TEXTURE_WRAP_T;
159
+ this.LINEAR = gl.LINEAR;
160
+ this.CLAMP_TO_EDGE = gl.CLAMP_TO_EDGE;
161
+ this.RGBA = gl.RGBA;
162
+ this.UNSIGNED_BYTE = gl.UNSIGNED_BYTE;
163
+ this.UNPACK_PREMULTIPLY_ALPHA_WEBGL = gl.UNPACK_PREMULTIPLY_ALPHA_WEBGL;
164
+ this.FLOAT = gl.FLOAT;
165
+ this.TRIANGLES = gl.TRIANGLES;
166
+ this.UNSIGNED_SHORT = gl.UNSIGNED_SHORT;
167
+ this.ONE = gl.ONE;
168
+ this.ONE_MINUS_SRC_ALPHA = gl.ONE_MINUS_SRC_ALPHA;
169
+ this.MAX_VERTEX_TEXTURE_IMAGE_UNITS = gl.MAX_VERTEX_TEXTURE_IMAGE_UNITS;
170
+ this.TRIANGLES = gl.TRIANGLES;
171
+ this.UNSIGNED_SHORT = gl.UNSIGNED_SHORT;
172
+ this.VERTEX_SHADER = gl.VERTEX_SHADER;
173
+ this.FRAGMENT_SHADER = gl.FRAGMENT_SHADER;
174
+ this.STATIC_DRAW = gl.STATIC_DRAW;
175
+ this.COMPILE_STATUS = gl.COMPILE_STATUS;
176
+ this.LINK_STATUS = gl.LINK_STATUS;
177
+ this.DYNAMIC_DRAW = gl.DYNAMIC_DRAW;
178
+ }
179
+ /**
180
+ * Returns true if the WebGL context is WebGL2
181
+ *
182
+ * @returns
183
+ */
184
+ isWebGl2() {
185
+ return isWebGl2(this.gl);
186
+ }
187
+
188
+ /**
189
+ * ```
190
+ * gl.activeTexture(textureUnit + gl.TEXTURE0);
191
+ * ```
192
+ *
193
+ * @remarks
194
+ * **WebGL Difference**: `textureUnit` is based from 0, not `gl.TEXTURE0`.
195
+ *
196
+ * @param textureUnit
197
+ */
198
+ activeTexture(textureUnit: number) {
199
+ const { gl } = this;
200
+ if (this.activeTextureUnit !== textureUnit) {
201
+ gl.activeTexture(textureUnit + gl.TEXTURE0);
202
+ this.activeTextureUnit = textureUnit;
203
+ }
204
+ }
205
+
206
+ /**
207
+ * ```
208
+ * gl.bindTexture(gl.TEXTURE_2D, texture);
209
+ * ```
210
+ * @remarks
211
+ * **WebGL Difference**: Bind target is always `gl.TEXTURE_2D`
212
+ *
213
+ * @param texture
214
+ */
215
+ bindTexture(texture: WebGLTexture | null) {
216
+ const { gl, activeTextureUnit, texture2dUnits } = this;
217
+
218
+ if (texture2dUnits[activeTextureUnit] === texture) {
219
+ return;
220
+ }
221
+ texture2dUnits[activeTextureUnit] = texture;
222
+
223
+ gl.bindTexture(this.gl.TEXTURE_2D, texture);
224
+ }
225
+
226
+ private _getActiveTexture(): WebGLTexture | null {
227
+ const { activeTextureUnit, texture2dUnits } = this;
228
+ return texture2dUnits[activeTextureUnit]!;
229
+ }
230
+
231
+ /**
232
+ * ```
233
+ * gl.texParameteri(gl.TEXTURE_2D, pname, param);
234
+ * ```
235
+ * @remarks
236
+ * **WebGL Difference**: Bind target is always `gl.TEXTURE_2D`
237
+ *
238
+ * @param pname
239
+ * @param param
240
+ * @returns
241
+ */
242
+ texParameteri(pname: number, param: number) {
243
+ const { gl, texture2dParams } = this;
244
+
245
+ const activeTexture = this._getActiveTexture();
246
+ if (!activeTexture) {
247
+ throw new Error('No active texture');
248
+ }
249
+ let textureParams = texture2dParams.get(activeTexture);
250
+ if (!textureParams) {
251
+ textureParams = {};
252
+ texture2dParams.set(activeTexture, textureParams);
253
+ }
254
+ if (textureParams[pname] === param) {
255
+ return;
256
+ }
257
+ textureParams[pname] = param;
258
+ gl.texParameteri(gl.TEXTURE_2D, pname, param);
259
+ }
260
+
261
+ /**
262
+ * ```
263
+ * gl.texImage2D(
264
+ * gl.TEXTURE_2D,
265
+ * level,
266
+ * internalFormat,
267
+ * width,
268
+ * height,
269
+ * border,
270
+ * format,
271
+ * type,
272
+ * pixels,
273
+ * );
274
+ * ```
275
+ * @remarks
276
+ * **WebGL Difference**: Bind target is always `gl.TEXTURE_2D`
277
+ *
278
+ * @param level
279
+ * @param internalFormat
280
+ * @param width
281
+ * @param height
282
+ * @param border
283
+ * @param format
284
+ * @param type
285
+ * @param pixels
286
+ */
287
+ texImage2D(
288
+ level: GLint,
289
+ internalformat: GLint,
290
+ width: GLsizei,
291
+ height: GLsizei,
292
+ border: GLint,
293
+ format: GLenum,
294
+ type: GLenum,
295
+ pixels: ArrayBufferView | null,
296
+ ): void;
297
+ texImage2D(
298
+ level: GLint,
299
+ internalformat: GLint,
300
+ format: GLenum,
301
+ type: GLenum,
302
+ source: TexImageSource,
303
+ ): void;
304
+ texImage2D(
305
+ level: any,
306
+ internalFormat: any,
307
+ widthOrFormat: any,
308
+ heightOrType: any,
309
+ borderOrSource: any,
310
+ format?: any,
311
+ type?: any,
312
+ pixels?: any,
313
+ ) {
314
+ const { gl } = this;
315
+ if (format) {
316
+ gl.texImage2D(
317
+ gl.TEXTURE_2D,
318
+ level,
319
+ internalFormat,
320
+ widthOrFormat,
321
+ heightOrType,
322
+ borderOrSource,
323
+ format,
324
+ type,
325
+ pixels,
326
+ );
327
+ } else {
328
+ gl.texImage2D(
329
+ gl.TEXTURE_2D,
330
+ level,
331
+ internalFormat,
332
+ widthOrFormat,
333
+ heightOrType,
334
+ borderOrSource,
335
+ );
336
+ }
337
+ }
338
+ /**
339
+ * ```
340
+ * gl.compressedTexImage2D(gl.TEXTURE_2D, level, internalFormat, width, height, border, data);
341
+ * ```
342
+ *
343
+ * @remarks
344
+ * **WebGL Difference**: Bind target is always `gl.TEXTURE_2D`
345
+ */
346
+
347
+ compressedTexImage2D(
348
+ level: GLint,
349
+ internalformat: GLenum,
350
+ width: GLsizei,
351
+ height: GLsizei,
352
+ border: GLint,
353
+ data?: ArrayBufferView,
354
+ ): void {
355
+ const { gl } = this;
356
+ gl.compressedTexImage2D(
357
+ gl.TEXTURE_2D,
358
+ level,
359
+ internalformat,
360
+ width,
361
+ height,
362
+ border,
363
+ data as ArrayBufferView,
364
+ );
365
+ }
366
+ /**
367
+ * ```
368
+ * gl.pixelStorei(pname, param);
369
+ * ```
370
+ *
371
+ * @param pname
372
+ * @param param
373
+ */
374
+ pixelStorei(pname: GLenum, param: GLint | GLboolean) {
375
+ const { gl } = this;
376
+ gl.pixelStorei(pname, param);
377
+ }
378
+
379
+ /**
380
+ * ```
381
+ * gl.generateMipmap(gl.TEXTURE_2D);
382
+ * ```
383
+ *
384
+ * @remarks
385
+ * **WebGL Difference**: Bind target is always `gl.TEXTURE_2D`
386
+ */
387
+ generateMipmap() {
388
+ const { gl } = this;
389
+ gl.generateMipmap(gl.TEXTURE_2D);
390
+ }
391
+
392
+ /**
393
+ * ```
394
+ * gl.createTexture();
395
+ * ```
396
+ *
397
+ * @returns
398
+ */
399
+ createTexture() {
400
+ const { gl } = this;
401
+ return gl.createTexture();
402
+ }
403
+
404
+ /**
405
+ * ```
406
+ * gl.deleteTexture(texture);
407
+ * ```
408
+ *
409
+ * @param texture
410
+ */
411
+ deleteTexture(texture: WebGLTexture | null) {
412
+ const { gl } = this;
413
+ if (texture) {
414
+ this.texture2dParams.delete(texture);
415
+ }
416
+ gl.deleteTexture(texture);
417
+ }
418
+
419
+ /**
420
+ * ```
421
+ * gl.viewport(x, y, width, height);
422
+ * ```
423
+ */
424
+ viewport(x: GLint, y: GLint, width: GLsizei, height: GLsizei) {
425
+ const { gl } = this;
426
+ gl.viewport(x, y, width, height);
427
+ }
428
+
429
+ /**
430
+ * ```
431
+ * gl.clearColor(red, green, blue, alpha);
432
+ * ```
433
+ *
434
+ * @param red
435
+ * @param green
436
+ * @param blue
437
+ * @param alpha
438
+ */
439
+ clearColor(red: GLclampf, green: GLclampf, blue: GLclampf, alpha: GLclampf) {
440
+ const { gl } = this;
441
+ gl.clearColor(red, green, blue, alpha);
442
+ }
443
+
444
+ /**
445
+ * ```
446
+ * gl["enable"|"disable"](gl.SCISSOR_TEST);
447
+ * ```
448
+ * @param enable
449
+ */
450
+ setScissorTest(enable: boolean) {
451
+ const { gl, scissorEnabled } = this;
452
+ if (enable === scissorEnabled) {
453
+ return;
454
+ }
455
+ if (enable) {
456
+ gl.enable(gl.SCISSOR_TEST);
457
+ } else {
458
+ gl.disable(gl.SCISSOR_TEST);
459
+ }
460
+ this.scissorEnabled = enable;
461
+ }
462
+
463
+ /**
464
+ * ```
465
+ * gl.scissor(x, y, width, height);
466
+ * ```
467
+ *
468
+ * @param x
469
+ * @param y
470
+ * @param width
471
+ * @param height
472
+ */
473
+ scissor(x: GLint, y: GLint, width: GLsizei, height: GLsizei) {
474
+ const { gl, scissorX, scissorY, scissorWidth, scissorHeight } = this;
475
+ if (
476
+ x !== scissorX ||
477
+ y !== scissorY ||
478
+ width !== scissorWidth ||
479
+ height !== scissorHeight
480
+ ) {
481
+ gl.scissor(x, y, width, height);
482
+ this.scissorX = x;
483
+ this.scissorY = y;
484
+ this.scissorWidth = width;
485
+ this.scissorHeight = height;
486
+ }
487
+ }
488
+
489
+ /**
490
+ * ```
491
+ * gl["enable"|"disable"](gl.BLEND);
492
+ * ```
493
+ *
494
+ * @param blend
495
+ * @returns
496
+ */
497
+ setBlend(blend: boolean) {
498
+ const { gl, blendEnabled } = this;
499
+ if (blend === blendEnabled) {
500
+ return;
501
+ }
502
+ if (blend) {
503
+ gl.enable(gl.BLEND);
504
+ } else {
505
+ gl.disable(gl.BLEND);
506
+ }
507
+ this.blendEnabled = blend;
508
+ }
509
+
510
+ /**
511
+ * ```
512
+ * gl.blendFunc(src, dst);
513
+ * ```
514
+ *
515
+ * @param src
516
+ * @param dst
517
+ */
518
+ blendFunc(src: GLenum, dst: GLenum) {
519
+ const { gl, blendSrcRgb, blendDstRgb, blendSrcAlpha, blendDstAlpha } = this;
520
+ if (
521
+ src !== blendSrcRgb ||
522
+ dst !== blendDstRgb ||
523
+ src !== blendSrcAlpha ||
524
+ dst !== blendDstAlpha
525
+ ) {
526
+ gl.blendFunc(src, dst);
527
+ this.blendSrcRgb = src;
528
+ this.blendDstRgb = dst;
529
+ this.blendSrcAlpha = src;
530
+ this.blendDstAlpha = dst;
531
+ }
532
+ }
533
+
534
+ /**
535
+ * ```
536
+ * createBuffer();
537
+ * ```
538
+ *
539
+ * @returns
540
+ */
541
+ createBuffer() {
542
+ const { gl } = this;
543
+ return gl.createBuffer();
544
+ }
545
+
546
+ /**
547
+ * ```
548
+ * gl.clear(gl.COLOR_BUFFER_BIT);
549
+ * ```
550
+ *
551
+ * @remarks
552
+ * **WebGL Difference**: Clear mask is always `gl.COLOR_BUFFER_BIT`
553
+ */
554
+ clear() {
555
+ const { gl } = this;
556
+ gl.clear(gl.COLOR_BUFFER_BIT);
557
+ }
558
+
559
+ /**
560
+ * ```
561
+ * gl.bindBuffer(gl.ARRAY_BUFFER, buffer);
562
+ * gl.bufferData(gl.ARRAY_BUFFER, data, usage);
563
+ * ```
564
+ *
565
+ * @remarks
566
+ * **WebGL Combo**: `gl.bindBuffer` and `gl.bufferData` are combined into one function.
567
+ *
568
+ * @param buffer
569
+ * @param data
570
+ * @param usage
571
+ */
572
+ arrayBufferData(
573
+ buffer: WebGLBuffer | null,
574
+ data: ArrayBufferView,
575
+ usage: GLenum,
576
+ ) {
577
+ const { gl, boundArrayBuffer } = this;
578
+ if (boundArrayBuffer !== buffer) {
579
+ gl.bindBuffer(gl.ARRAY_BUFFER, buffer);
580
+ this.boundArrayBuffer = buffer;
581
+ }
582
+ gl.bufferData(gl.ARRAY_BUFFER, data, usage);
583
+ }
584
+
585
+ /**
586
+ * ```
587
+ * gl.bindBuffer(gl.ELEMENT_ARRAY_BUFFER, buffer);
588
+ * gl.bufferData(gl.ELEMENT_ARRAY_BUFFER, data, usage);
589
+ * ```
590
+ * @remarks
591
+ * **WebGL Combo**: `gl.bindBuffer` and `gl.bufferData` are combined into one function.
592
+ *
593
+ * @param buffer
594
+ * @param data
595
+ * @param usage
596
+ */
597
+ elementArrayBufferData(
598
+ buffer: WebGLBuffer | null,
599
+ data: ArrayBufferView,
600
+ usage: GLenum,
601
+ ) {
602
+ const { gl, boundElementArrayBuffer } = this;
603
+ if (boundElementArrayBuffer !== buffer) {
604
+ gl.bindBuffer(gl.ELEMENT_ARRAY_BUFFER, buffer);
605
+ this.boundElementArrayBuffer = buffer;
606
+ }
607
+ gl.bufferData(gl.ELEMENT_ARRAY_BUFFER, data, usage);
608
+ }
609
+
610
+ /**
611
+ * ```
612
+ * gl.bindBuffer(gl.ARRAY_BUFFER, buffer);
613
+ * gl.vertexAttribPointer(index, size, type, normalized, stride, offset);
614
+ * ```
615
+ *
616
+ * @remarks
617
+ * **WebGL Combo**: `gl.bindBuffer` and `gl.vertexAttribPointer` are combined into one function.
618
+ *
619
+ * @param buffer
620
+ * @param index
621
+ * @param size
622
+ * @param type
623
+ * @param normalized
624
+ * @param stride
625
+ * @param offset
626
+ */
627
+ vertexAttribPointer(
628
+ buffer: WebGLBuffer,
629
+ index: GLuint,
630
+ size: GLint,
631
+ type: GLenum,
632
+ normalized: GLboolean,
633
+ stride: GLsizei,
634
+ offset: GLintptr,
635
+ ) {
636
+ const { gl, boundArrayBuffer } = this;
637
+ if (boundArrayBuffer !== buffer) {
638
+ gl.bindBuffer(gl.ARRAY_BUFFER, buffer);
639
+ this.boundArrayBuffer = buffer;
640
+ }
641
+ gl.vertexAttribPointer(index, size, type, normalized, stride, offset);
642
+ }
643
+
644
+ /**
645
+ * ```
646
+ * gl.useProgram(program);
647
+ * ```
648
+ *
649
+ * @param program
650
+ * @returns
651
+ */
652
+ useProgram(program: WebGLProgram | null) {
653
+ const { gl, curProgram } = this;
654
+ if (curProgram === program) {
655
+ return;
656
+ }
657
+ gl.useProgram(program);
658
+ this.curProgram = program;
659
+ }
660
+
661
+ setUniform<T extends keyof UniformMethodMap>(
662
+ type: T,
663
+ location: WebGLUniformLocation,
664
+ ...args: UniformMethodMap[T]
665
+ ) {
666
+ const { gl, programUniforms } = this;
667
+ let uniforms = programUniforms.get(this.curProgram!);
668
+ if (!uniforms) {
669
+ uniforms = new Map();
670
+ programUniforms.set(this.curProgram!, uniforms);
671
+ }
672
+ const uniformArgs = uniforms.get(location);
673
+ if (!uniformArgs || !compareArrays(uniformArgs, args)) {
674
+ uniforms.set(location, args);
675
+ gl[type](location, ...(args as [never, never, never, never]));
676
+ }
677
+ }
678
+
679
+ /**
680
+ * ```
681
+ * gl.getParameter(pname);
682
+ * ```
683
+ *
684
+ * @param pname
685
+ * @returns
686
+ */
687
+ getParameter(pname: GLenum): any {
688
+ const { gl } = this;
689
+ return gl.getParameter(pname);
690
+ }
691
+
692
+ /**
693
+ * ```
694
+ * gl.drawElements(mode, count, type, offset);
695
+ * ```
696
+ *
697
+ * @param mode
698
+ * @param count
699
+ * @param type
700
+ * @param offset
701
+ */
702
+ drawElements(mode: GLenum, count: GLsizei, type: GLenum, offset: GLintptr) {
703
+ const { gl } = this;
704
+ gl.drawElements(mode, count, type, offset);
705
+ }
706
+
707
+ /**
708
+ * ```
709
+ * gl.drawArrays(mode, first, count);
710
+ * ```
711
+ *
712
+ * @param name
713
+ * @returns
714
+ */
715
+ getExtension(name: string) {
716
+ const { gl } = this;
717
+ return gl.getExtension(name);
718
+ }
719
+
720
+ /**
721
+ * ```
722
+ * gl.createVertexArray();
723
+ * ```
724
+ *
725
+ * @returns
726
+ */
727
+ createVertexArray() {
728
+ const { gl } = this;
729
+ assertTruthy(gl instanceof WebGL2RenderingContext);
730
+ return gl.createVertexArray();
731
+ }
732
+
733
+ /**
734
+ * ```
735
+ * gl.bindVertexArray(vertexArray);
736
+ * ```
737
+ *
738
+ * @param vertexArray
739
+ */
740
+ bindVertexArray(vertexArray: WebGLVertexArrayObject | null) {
741
+ const { gl } = this;
742
+ assertTruthy(gl instanceof WebGL2RenderingContext);
743
+ gl.bindVertexArray(vertexArray);
744
+ }
745
+
746
+ /**
747
+ * ```
748
+ * gl.getAttribLocation(program, name);
749
+ * ```
750
+ *
751
+ * @param program
752
+ * @param name
753
+ * @returns
754
+ */
755
+ getAttribLocation(program: WebGLProgram, name: string) {
756
+ const { gl } = this;
757
+ return gl.getAttribLocation(program, name);
758
+ }
759
+
760
+ /**
761
+ * ```
762
+ * gl.getUniformLocation(program, name);
763
+ * ```
764
+ *
765
+ * @param program
766
+ * @param name
767
+ * @returns
768
+ */
769
+ getUniformLocation(program: WebGLProgram, name: string) {
770
+ const { gl } = this;
771
+ return gl.getUniformLocation(program, name);
772
+ }
773
+
774
+ /**
775
+ * ```
776
+ * gl.enableVertexAttribArray(index);
777
+ * ```
778
+ *
779
+ * @param index
780
+ */
781
+ enableVertexAttribArray(index: number) {
782
+ const { gl } = this;
783
+ gl.enableVertexAttribArray(index);
784
+ }
785
+
786
+ /**
787
+ * ```
788
+ * gl.disableVertexAttribArray(index);
789
+ * ```
790
+ *
791
+ * @param index
792
+ */
793
+ disableVertexAttribArray(index: number) {
794
+ const { gl } = this;
795
+ gl.disableVertexAttribArray(index);
796
+ }
797
+
798
+ /**
799
+ * ```
800
+ * gl.createShader(type);
801
+ * ```
802
+ *
803
+ * @param type
804
+ * @returns
805
+ */
806
+ createShader(type: number) {
807
+ const { gl } = this;
808
+ return gl.createShader(type);
809
+ }
810
+
811
+ /**
812
+ * ```
813
+ * gl.compileShader(shader);
814
+ * ```
815
+ *
816
+ * @param shader
817
+ * @returns
818
+ */
819
+ compileShader(shader: WebGLShader) {
820
+ const { gl } = this;
821
+ gl.compileShader(shader);
822
+ }
823
+
824
+ /**
825
+ * ```
826
+ * gl.attachShader(program, shader);
827
+ * ```
828
+ *
829
+ * @param program
830
+ * @param shader
831
+ */
832
+ attachShader(program: WebGLProgram, shader: WebGLShader) {
833
+ const { gl } = this;
834
+ gl.attachShader(program, shader);
835
+ }
836
+
837
+ /**
838
+ * ```
839
+ * gl.linkProgram(program);
840
+ * ```
841
+ *
842
+ * @param program
843
+ */
844
+ linkProgram(program: WebGLProgram) {
845
+ const { gl } = this;
846
+ gl.linkProgram(program);
847
+ }
848
+
849
+ /**
850
+ * ```
851
+ * gl.deleteProgram(shader);
852
+ * ```
853
+ *
854
+ * @param shader
855
+ */
856
+ deleteProgram(shader: WebGLProgram) {
857
+ const { gl } = this;
858
+ gl.deleteProgram(shader);
859
+ }
860
+
861
+ /**
862
+ * ```
863
+ * gl.getShaderParameter(shader, pname);
864
+ * ```
865
+ *
866
+ * @param shader
867
+ * @param pname
868
+ */
869
+ getShaderParameter(shader: WebGLShader, pname: GLenum) {
870
+ const { gl } = this;
871
+ return gl.getShaderParameter(shader, pname);
872
+ }
873
+
874
+ /**
875
+ * ```
876
+ * gl.getShaderInfoLog(shader);
877
+ * ```
878
+ *
879
+ * @param shader
880
+ */
881
+ getShaderInfoLog(shader: WebGLShader) {
882
+ const { gl } = this;
883
+ return gl.getShaderInfoLog(shader);
884
+ }
885
+
886
+ /**
887
+ * ```
888
+ * gl.createProgram();
889
+ * ```
890
+ *
891
+ * @returns
892
+ */
893
+ createProgram() {
894
+ const { gl } = this;
895
+ return gl.createProgram();
896
+ }
897
+
898
+ /**
899
+ * ```
900
+ * gl.getProgramParameter(program, pname);
901
+ * ```
902
+ *
903
+ * @param program
904
+ * @param pname
905
+ * @returns
906
+ */
907
+ getProgramParameter(program: WebGLProgram, pname: GLenum) {
908
+ const { gl } = this;
909
+ return gl.getProgramParameter(program, pname);
910
+ }
911
+
912
+ /**
913
+ * ```
914
+ * gl.getProgramInfoLog(program);
915
+ * ```
916
+ *
917
+ * @param program
918
+ * @returns
919
+ */
920
+ getProgramInfoLog(program: WebGLProgram) {
921
+ const { gl } = this;
922
+ return gl.getProgramInfoLog(program);
923
+ }
924
+
925
+ /**
926
+ * ```
927
+ * gl.shaderSource(shader, source);
928
+ * ```
929
+ *
930
+ * @param shader
931
+ * @param source
932
+ */
933
+ shaderSource(shader: WebGLShader, source: string) {
934
+ const { gl } = this;
935
+ gl.shaderSource(shader, source);
936
+ }
937
+
938
+ /**
939
+ * ```
940
+ * gl.deleteShader(shader);
941
+ * ```
942
+ *
943
+ * @param shader
944
+ */
945
+ deleteShader(shader: WebGLShader) {
946
+ const { gl } = this;
947
+ gl.deleteShader(shader);
948
+ }
949
+ }
950
+
951
+ // prettier-ignore
952
+ type IsUniformMethod<MethodName, MethodType> = MethodName extends `uniform${string}`
953
+ ? // eslint-disable-next-line @typescript-eslint/no-explicit-any
954
+ MethodType extends (location: WebGLUniformLocation | null, ...args: any[]) => void
955
+ ? true
956
+ : false
957
+ : false;
958
+
959
+ // prettier-ignore
960
+ export type UniformMethodMap = {
961
+ [Key in keyof WebGLRenderingContext as IsUniformMethod<Key, WebGLRenderingContext[Key]> extends true ? Key : never]: WebGLRenderingContext[Key] extends (
962
+ location: WebGLUniformLocation | null,
963
+ ...args: infer T
964
+ ) => void
965
+ ? T
966
+ : never;
967
+ };
968
+
969
+ /**
970
+ * Compare two arrays for equality.
971
+ *
972
+ * @remarks
973
+ * This function will not try to compare nested arrays or Float32Arrays and
974
+ * instead will always return false when they are encountered.
975
+ *
976
+ * @param a
977
+ * @param b
978
+ * @returns
979
+ */
980
+ export function compareArrays<T>(a: T[], b: T[]): boolean {
981
+ if (a.length !== b.length) {
982
+ return false;
983
+ }
984
+ return a.every((v, i) => {
985
+ // Don't bother to compare nested arrays or Float32Arrays
986
+ if (Array.isArray(v) || v instanceof Float32Array) {
987
+ return false;
988
+ } else {
989
+ return v === b[i];
990
+ }
991
+ });
992
+ }