@lightningjs/renderer 2.10.0 → 2.11.0

package/src/core/renderers/webgl/internal/ShaderUtils.ts

@@ -1,143 +1,143 @@
-/*
- * If not stated otherwise in this file or this component's LICENSE file the
- * following copyright and licenses apply:
- *
- * Copyright 2023 Comcast Cable Communications Management, LLC.
- *
- * Licensed under the Apache License, Version 2.0 (the License);
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import type { WebGlContextWrapper } from '../../../lib/WebGlContextWrapper.js';
-import type { WebGlCoreRenderer } from '../WebGlCoreRenderer.js';
-
-//#region Types
-export interface AttributeInfo {
-  name: string;
-  size: number;
-  type: number;
-  normalized: boolean;
-  stride: number;
-  offset: number;
-}
-
-export interface UniformInfo {
-  name: string;
-  uniform: keyof UniformMethodMap;
-}
-
-export interface ShaderOptions {
-  renderer: WebGlCoreRenderer;
-  attributes: string[];
-  uniforms: UniformInfo[];
-  shaderSources?: ShaderProgramSources;
-  supportsIndexedTextures?: boolean;
-  webgl1Extensions?: string[];
-  webgl2Extensions?: string[];
-}
-
-// prettier-ignore
-type IsUniformMethod<MethodName, MethodType> = MethodName extends `uniform${string}`
-  ? // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  MethodType extends (location: WebGLUniformLocation | null, ...args: any[]) => void
-  ? true
-  : false
-  : false;
-
-// prettier-ignore
-export type UniformMethodMap = {
-  [Key in keyof WebGLRenderingContext as IsUniformMethod<Key, WebGLRenderingContext[Key]> extends true ? Key : never]: WebGLRenderingContext[Key] extends (
-    location: WebGLUniformLocation | null,
-    ...args: infer T
-  ) => void
-  ? T
-  : never;
-};
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-type TupleToObject<T extends any[]> = Omit<T, keyof any[]>;
-
-// Why the below has to be so insane is beyond me
-// prettier-ignore
-export type UniformTupleToMap<Uniforms extends [...UniformInfo[]]> = {
-  [Key in keyof TupleToObject<Uniforms> as TupleToObject<Uniforms>[Key] extends {
-    name: infer K extends string;
-  }
-  ? K
-  : never]: TupleToObject<Uniforms>[Key] extends {
-    uniform: infer T extends keyof UniformMethodMap;
-  }
-  ? UniformMethodMap[T]
-  : never;
-};
-
-type ShaderSource = string | ((textureUnits: number) => string);
-
-export interface ShaderProgramSources {
-  vertex: ShaderSource;
-  fragment: ShaderSource;
-  webGl2?: {
-    vertex: ShaderSource;
-    fragment: ShaderSource;
-  };
-}
-
-//#endregion Types
-
-export function createShader(
-  glw: WebGlContextWrapper,
-  type: number,
-  source: string,
-) {
-  const shader = glw.createShader(type);
-  if (!shader) {
-    const glError = glw.getError();
-    throw new Error(
-      `Unable to create the shader: ${
-        type === glw.VERTEX_SHADER ? 'VERTEX_SHADER' : 'FRAGMENT_SHADER'
-      }.${glError ? ` WebGlContext Error: ${glError}` : ''}`,
-    );
-  }
-
-  glw.shaderSource(shader, source);
-  glw.compileShader(shader);
-  const success = !!glw.getShaderParameter(shader, glw.COMPILE_STATUS);
-  if (success) {
-    return shader;
-  }
-
-  console.error(glw.getShaderInfoLog(shader));
-  glw.deleteShader(shader);
-}
-
-export function createProgram(
-  glw: WebGlContextWrapper,
-  vertexShader: WebGLShader,
-  fragmentShader: WebGLShader,
-) {
-  const program = glw.createProgram();
-  if (!program) {
-    throw new Error('Unable to create program');
-  }
-
-  glw.attachShader(program, vertexShader);
-  glw.attachShader(program, fragmentShader);
-  glw.linkProgram(program);
-  const success = !!glw.getProgramParameter(program, glw.LINK_STATUS);
-  if (success) {
-    return program;
-  }
-
-  console.warn(glw.getProgramInfoLog(program));
-  glw.deleteProgram(program);
-  return undefined;
-}
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast Cable Communications Management, LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { WebGlContextWrapper } from '../../../lib/WebGlContextWrapper.js';
+import type { WebGlCoreRenderer } from '../WebGlCoreRenderer.js';
+
+//#region Types
+export interface AttributeInfo {
+  name: string;
+  size: number;
+  type: number;
+  normalized: boolean;
+  stride: number;
+  offset: number;
+}
+
+export interface UniformInfo {
+  name: string;
+  uniform: keyof UniformMethodMap;
+}
+
+export interface ShaderOptions {
+  renderer: WebGlCoreRenderer;
+  attributes: string[];
+  uniforms: UniformInfo[];
+  shaderSources?: ShaderProgramSources;
+  supportsIndexedTextures?: boolean;
+  webgl1Extensions?: string[];
+  webgl2Extensions?: string[];
+}
+
+// prettier-ignore
+type IsUniformMethod<MethodName, MethodType> = MethodName extends `uniform${string}`
+  ? // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  MethodType extends (location: WebGLUniformLocation | null, ...args: any[]) => void
+  ? true
+  : false
+  : false;
+
+// prettier-ignore
+export type UniformMethodMap = {
+  [Key in keyof WebGLRenderingContext as IsUniformMethod<Key, WebGLRenderingContext[Key]> extends true ? Key : never]: WebGLRenderingContext[Key] extends (
+    location: WebGLUniformLocation | null,
+    ...args: infer T
+  ) => void
+  ? T
+  : never;
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type TupleToObject<T extends any[]> = Omit<T, keyof any[]>;
+
+// Why the below has to be so insane is beyond me
+// prettier-ignore
+export type UniformTupleToMap<Uniforms extends [...UniformInfo[]]> = {
+  [Key in keyof TupleToObject<Uniforms> as TupleToObject<Uniforms>[Key] extends {
+    name: infer K extends string;
+  }
+  ? K
+  : never]: TupleToObject<Uniforms>[Key] extends {
+    uniform: infer T extends keyof UniformMethodMap;
+  }
+  ? UniformMethodMap[T]
+  : never;
+};
+
+type ShaderSource = string | ((textureUnits: number) => string);
+
+export interface ShaderProgramSources {
+  vertex: ShaderSource;
+  fragment: ShaderSource;
+  webGl2?: {
+    vertex: ShaderSource;
+    fragment: ShaderSource;
+  };
+}
+
+//#endregion Types
+
+export function createShader(
+  glw: WebGlContextWrapper,
+  type: number,
+  source: string,
+) {
+  const shader = glw.createShader(type);
+  if (!shader) {
+    const glError = glw.getError();
+    throw new Error(
+      `Unable to create the shader: ${
+        type === glw.VERTEX_SHADER ? 'VERTEX_SHADER' : 'FRAGMENT_SHADER'
+      }.${glError ? ` WebGlContext Error: ${glError}` : ''}`,
+    );
+  }
+
+  glw.shaderSource(shader, source);
+  glw.compileShader(shader);
+  const success = !!glw.getShaderParameter(shader, glw.COMPILE_STATUS);
+  if (success) {
+    return shader;
+  }
+
+  console.error(glw.getShaderInfoLog(shader));
+  glw.deleteShader(shader);
+}
+
+export function createProgram(
+  glw: WebGlContextWrapper,
+  vertexShader: WebGLShader,
+  fragmentShader: WebGLShader,
+) {
+  const program = glw.createProgram();
+  if (!program) {
+    throw new Error('Unable to create program');
+  }
+
+  glw.attachShader(program, vertexShader);
+  glw.attachShader(program, fragmentShader);
+  glw.linkProgram(program);
+  const success = !!glw.getProgramParameter(program, glw.LINK_STATUS);
+  if (success) {
+    return program;
+  }
+
+  console.warn(glw.getProgramInfoLog(program));
+  glw.deleteProgram(program);
+  return undefined;
+}

package/src/core/renderers/webgl/internal/WebGlUtils.ts

@@ -1,35 +1,35 @@
-/*
- * If not stated otherwise in this file or this component's LICENSE file the
- * following copyright and licenses apply:
- *
- * Copyright 2023 Comcast Cable Communications Management, LLC.
- *
- * Licensed under the Apache License, Version 2.0 (the License);
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * Generic WebGL Utility Functions
- *
- * @remarks
- * Nothing here should be coupled to Renderer logic / types.
- *
- * @param gl
- * @returns
- */
-export function isWebGl2(
-  gl: WebGLRenderingContext,
-): gl is WebGL2RenderingContext {
-  return (
-    self.WebGL2RenderingContext && gl instanceof self.WebGL2RenderingContext
-  );
-}
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast Cable Communications Management, LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Generic WebGL Utility Functions
+ *
+ * @remarks
+ * Nothing here should be coupled to Renderer logic / types.
+ *
+ * @param gl
+ * @returns
+ */
+export function isWebGl2(
+  gl: WebGLRenderingContext,
+): gl is WebGL2RenderingContext {
+  return (
+    self.WebGL2RenderingContext && gl instanceof self.WebGL2RenderingContext
+  );
+}

package/src/core/renderers/webgl/shaders/DefaultShader.ts

@@ -1,93 +1,93 @@
-/*
- * If not stated otherwise in this file or this component's LICENSE file the
- * following copyright and licenses apply:
- *
- * Copyright 2023 Comcast Cable Communications Management, LLC.
- *
- * Licensed under the Apache License, Version 2.0 (the License);
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import type { WebGlCoreRenderer } from '../WebGlCoreRenderer.js';
-import { WebGlCoreShader } from '../WebGlCoreShader.js';
-import type { WebGlCoreCtxTexture } from '../WebGlCoreCtxTexture.js';
-import type { ShaderProgramSources } from '../internal/ShaderUtils.js';
-
-export class DefaultShader extends WebGlCoreShader {
-  constructor(renderer: WebGlCoreRenderer) {
-    super({
-      renderer,
-      attributes: ['a_position', 'a_textureCoordinate', 'a_color'],
-      uniforms: [
-        { name: 'u_resolution', uniform: 'uniform2fv' },
-        { name: 'u_pixelRatio', uniform: 'uniform1f' },
-        { name: 'u_texture', uniform: 'uniform2fv' },
-      ],
-    });
-  }
-
-  override bindTextures(textures: WebGlCoreCtxTexture[]) {
-    const { glw } = this;
-    glw.activeTexture(0);
-    glw.bindTexture(textures[0]!.ctxTexture);
-  }
-
-  static override shaderSources: ShaderProgramSources = {
-    vertex: `
-      # ifdef GL_FRAGMENT_PRECISION_HIGH
-      precision highp float;
-      # else
-      precision mediump float;
-      # endif
-
-      attribute vec2 a_position;
-      attribute vec2 a_textureCoordinate;
-      attribute vec4 a_color;
-
-      uniform vec2 u_resolution;
-      uniform float u_pixelRatio;
-
-
-      varying vec4 v_color;
-      varying vec2 v_textureCoordinate;
-
-      void main() {
-        vec2 normalized = a_position * u_pixelRatio;
-        vec2 screenSpace = vec2(2.0 / u_resolution.x, -2.0 / u_resolution.y);
-
-        v_color = a_color;
-        v_textureCoordinate = a_textureCoordinate;
-
-        gl_Position = vec4(normalized.x * screenSpace.x - 1.0, normalized.y * -abs(screenSpace.y) + 1.0, 0.0, 1.0);
-        gl_Position.y = -sign(screenSpace.y) * gl_Position.y;
-      }
-    `,
-    fragment: `
-      # ifdef GL_FRAGMENT_PRECISION_HIGH
-      precision highp float;
-      # else
-      precision mediump float;
-      # endif
-
-      uniform vec2 u_resolution;
-      uniform sampler2D u_texture;
-
-      varying vec4 v_color;
-      varying vec2 v_textureCoordinate;
-
-      void main() {
-          vec4 color = texture2D(u_texture, v_textureCoordinate);
-          gl_FragColor = vec4(v_color) * texture2D(u_texture, v_textureCoordinate);
-      }
-    `,
-  };
-}
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast Cable Communications Management, LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { WebGlCoreRenderer } from '../WebGlCoreRenderer.js';
+import { WebGlCoreShader } from '../WebGlCoreShader.js';
+import type { WebGlCoreCtxTexture } from '../WebGlCoreCtxTexture.js';
+import type { ShaderProgramSources } from '../internal/ShaderUtils.js';
+
+export class DefaultShader extends WebGlCoreShader {
+  constructor(renderer: WebGlCoreRenderer) {
+    super({
+      renderer,
+      attributes: ['a_position', 'a_textureCoordinate', 'a_color'],
+      uniforms: [
+        { name: 'u_resolution', uniform: 'uniform2fv' },
+        { name: 'u_pixelRatio', uniform: 'uniform1f' },
+        { name: 'u_texture', uniform: 'uniform2fv' },
+      ],
+    });
+  }
+
+  override bindTextures(textures: WebGlCoreCtxTexture[]) {
+    const { glw } = this;
+    glw.activeTexture(0);
+    glw.bindTexture(textures[0]!.ctxTexture);
+  }
+
+  static override shaderSources: ShaderProgramSources = {
+    vertex: `
+      # ifdef GL_FRAGMENT_PRECISION_HIGH
+      precision highp float;
+      # else
+      precision mediump float;
+      # endif
+
+      attribute vec2 a_position;
+      attribute vec2 a_textureCoordinate;
+      attribute vec4 a_color;
+
+      uniform vec2 u_resolution;
+      uniform float u_pixelRatio;
+
+
+      varying vec4 v_color;
+      varying vec2 v_textureCoordinate;
+
+      void main() {
+        vec2 normalized = a_position * u_pixelRatio;
+        vec2 screenSpace = vec2(2.0 / u_resolution.x, -2.0 / u_resolution.y);
+
+        v_color = a_color;
+        v_textureCoordinate = a_textureCoordinate;
+
+        gl_Position = vec4(normalized.x * screenSpace.x - 1.0, normalized.y * -abs(screenSpace.y) + 1.0, 0.0, 1.0);
+        gl_Position.y = -sign(screenSpace.y) * gl_Position.y;
+      }
+    `,
+    fragment: `
+      # ifdef GL_FRAGMENT_PRECISION_HIGH
+      precision highp float;
+      # else
+      precision mediump float;
+      # endif
+
+      uniform vec2 u_resolution;
+      uniform sampler2D u_texture;
+
+      varying vec4 v_color;
+      varying vec2 v_textureCoordinate;
+
+      void main() {
+          vec4 color = texture2D(u_texture, v_textureCoordinate);
+          gl_FragColor = vec4(v_color) * texture2D(u_texture, v_textureCoordinate);
+      }
+    `,
+  };
+}