@lightningjs/renderer 2.12.1 → 3.0.0-beta1

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

@@ -1,580 +0,0 @@
-/*
- * 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,
-  type DimensionsShaderProp,
-  type AlphaShaderProp,
-} from '../WebGlCoreShader.js';
-import { type UniformInfo } from '../internal/ShaderUtils.js';
-import type { WebGlCoreCtxTexture } from '../WebGlCoreCtxTexture.js';
-import {
-  ShaderEffect,
-  type EffectDescUnion,
-  type ShaderEffectUniform,
-  type ShaderEffectValueMap,
-  type BaseEffectDesc,
-} from './effects/ShaderEffect.js';
-import type { EffectMap } from '../../../CoreShaderManager.js';
-import { assertTruthy } from '../../../../utils.js';
-import type { UniformMethodMap } from '../../../lib/WebGlContextWrapper.js';
-
-export interface DynamicShaderProps
-  extends DimensionsShaderProp,
-    AlphaShaderProp {
-  effects?: EffectDescUnion[];
-}
-
-const effectCache = new Map<string, BaseEffectDesc[]>();
-const getResolvedEffect = (
-  effects: BaseEffectDesc[],
-  effectContructors: Partial<EffectMap>,
-): BaseEffectDesc[] => {
-  const key = JSON.stringify(effects);
-  if (effectCache.has(key)) {
-    return effectCache.get(key)!;
-  }
-  effects = effects ?? [];
-  const resolvedEffects = [];
-  const effectsLength = effects.length;
-  let i = 0;
-  for (; i < effectsLength; i++) {
-    const { name, type, props } = effects[i] as BaseEffectDesc;
-    const resolvedEffect = {
-      name,
-      type,
-      props: {} as Record<string, any>,
-    };
-
-    const effectConstructor = effectContructors[type]!;
-    const defaultPropValues = effectConstructor.resolveDefaults(props);
-    const uniforms = effectConstructor.uniforms;
-    const uniformKeys = Object.keys(uniforms);
-    const uniformsLength = uniformKeys.length;
-    let j = 0;
-    for (; j < uniformsLength; j++) {
-      const key = uniformKeys[j]!;
-      const uniform = uniforms[key]!;
-
-      const result: ShaderEffectValueMap = {
-        value: defaultPropValues[key] as ShaderEffectUniform['value'],
-        programValue: undefined,
-        method: uniform.method,
-        updateOnBind: uniform.updateOnBind || false,
-        hasValidator: uniform.validator !== undefined,
-        hasProgramValueUpdater: uniform.updateProgramValue !== undefined,
-      };
-
-      const validatedValue =
-        (result.hasValidator &&
-          uniform.validator!(defaultPropValues[key], defaultPropValues)) ||
-        defaultPropValues[key];
-
-      if (defaultPropValues[key] !== validatedValue) {
-        result.validatedValue = validatedValue as number | number[];
-      }
-
-      if (result.hasProgramValueUpdater) {
-        uniform.updateProgramValue!(result);
-      }
-
-      if (result.programValue === undefined) {
-        result.programValue = result.value as number;
-      }
-
-      resolvedEffect.props[key] = result;
-    }
-    resolvedEffects.push(resolvedEffect);
-  }
-
-  effectCache.set(key, resolvedEffects);
-  return resolvedEffects;
-};
-
-export class DynamicShader extends WebGlCoreShader {
-  effects: Array<InstanceType<EffectMap[keyof EffectMap]>> = [];
-
-  constructor(
-    renderer: WebGlCoreRenderer,
-    props: DynamicShaderProps,
-    effectContructors: Partial<EffectMap>,
-  ) {
-    const shader = DynamicShader.createShader(props, effectContructors);
-    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' },
-        { name: 'u_dimensions', uniform: 'uniform2fv' },
-        { name: 'u_alpha', uniform: 'uniform1f' },
-        ...shader.uniforms,
-      ],
-      shaderSources: {
-        vertex: shader.vertex,
-        fragment: shader.fragment,
-      },
-    });
-
-    this.effects = shader.effects as Array<
-      InstanceType<EffectMap[keyof EffectMap]>
-    >;
-  }
-
-  override bindTextures(textures: WebGlCoreCtxTexture[]) {
-    const { glw } = this;
-    glw.activeTexture(0);
-    glw.bindTexture(textures[0]!.ctxTexture);
-  }
-
-  bindUniformMethods(props: DynamicShaderProps): void {
-    const glw = this.glw;
-    const effects = props.effects;
-    const effectsL = effects!.length;
-    for (let i = 0; i < effectsL; i++) {
-      const uniformInfo = this.effects[i]!.uniformInfo;
-      const effect = effects![i]! as Record<string, any>;
-      const propKeys = Object.keys(effect.props);
-      const propsLength = propKeys.length;
-      for (let j = 0; j < propsLength; j++) {
-        const key = propKeys[j]!;
-        const method = effect.props[key].method as keyof UniformMethodMap;
-        const location = this.getUniformLocation(uniformInfo[key]!.name);
-
-        if (
-          method === 'uniform2fv' ||
-          method === 'uniform2iv' ||
-          //uniform === 'uniform3fv	' || <--- check why this isnt recognized
-          method === 'uniform3iv' ||
-          method === 'uniform4fv' ||
-          method === 'uniform4iv' ||
-          method === 'uniformMatrix2fv' ||
-          method === 'uniformMatrix3fv' ||
-          method === 'uniformMatrix4fv' ||
-          method === 'uniform1f' ||
-          method === 'uniform1fv' ||
-          method === 'uniform1i' ||
-          method === 'uniform1iv'
-        ) {
-          effect.props[key].setUniformValue = function () {
-            glw[method](location, this.programValue);
-          };
-          continue;
-        }
-
-        if (method === 'uniform2f' || method === 'uniform2i') {
-          effect.props[key].setUniformValue = function () {
-            glw[method](location, this.programValue[0]!, this.programValue[1]!);
-          };
-          continue;
-        }
-
-        if (method === 'uniform3f' || method === 'uniform3i') {
-          effect.props[key].setUniformValue = function () {
-            glw[method](
-              location,
-              this.programValue[0]!,
-              this.programValue[1]!,
-              this.programValue[2]!,
-            );
-          };
-          continue;
-        }
-
-        if (method === 'uniform4f' || method === 'uniform4i') {
-          effect.props[key].setUniformValue = function () {
-            glw[method](
-              location,
-              this.programValue[0]!,
-              this.programValue[1]!,
-              this.programValue[2]!,
-              this.programValue[3]!,
-            );
-          };
-          continue;
-        }
-      }
-    }
-  }
-
-  protected override bindProps(props: Required<DynamicShaderProps>): void {
-    const effects = props.effects;
-    const effectsL = effects.length;
-    let i = 0;
-    for (; i < effectsL; i++) {
-      const effect = effects[i]! as Record<string, any>;
-      const propKeys = Object.keys(effect.props);
-      const propsLength = propKeys.length;
-      let j = 0;
-      for (; j < propsLength; j++) {
-        const key = propKeys[j]!;
-        const prop = effect.props[key]!;
-        if (prop.updateOnBind === true) {
-          const uniform =
-            this.renderer.shManager.getRegisteredEffects()[
-              effect.type as keyof EffectMap
-            ]?.uniforms[key];
-          uniform?.updateProgramValue!(effect.props[key], props);
-        }
-
-        prop.setUniformValue();
-      }
-    }
-  }
-
-  override canBatchShaderProps(
-    propsA: Required<DynamicShaderProps>,
-    propsB: Required<DynamicShaderProps>,
-  ): boolean {
-    if (
-      propsA.$alpha !== propsB.$alpha ||
-      propsA.$dimensions.width !== propsB.$dimensions.width ||
-      propsA.$dimensions.height !== propsB.$dimensions.height ||
-      propsA.effects.length !== propsB.effects.length
-    ) {
-      return false;
-    }
-    const propsEffectsLen = propsA.effects.length;
-    let i = 0;
-    for (; i < propsEffectsLen; i++) {
-      const effectA = propsA.effects[i]!;
-      const effectB = propsB.effects[i]!;
-      if (effectA.type !== effectB.type) {
-        return false;
-      }
-      for (const key in effectA.props) {
-        if (
-          (effectB.props && !effectB.props[key]) ||
-          (effectA.props[key] as ShaderEffectValueMap).value !==
-            (effectB.props[key] as ShaderEffectValueMap).value
-        ) {
-          return false;
-        }
-      }
-    }
-    return true;
-  }
-
-  static createShader(
-    props: DynamicShaderProps,
-    effectContructors: Partial<EffectMap>,
-  ) {
-    //counts duplicate effects
-    const effectNameCount: Record<string, number> = {};
-    const methods: Record<string, string> = {};
-
-    let declareUniforms = '';
-    const uniforms: UniformInfo[] = [];
-
-    const uFx: Record<string, unknown>[] = [];
-
-    const effects = props.effects!.map((effect) => {
-      const baseClass = effectContructors[effect.type]!;
-      const key = baseClass.getEffectKey(effect.props || {});
-
-      effectNameCount[key] = effectNameCount[key] ? ++effectNameCount[key] : 1;
-
-      const nr = effectNameCount[key]!;
-
-      if (nr === 1) {
-        uFx.push({ key, type: effect.type, props: effect.props });
-      }
-
-      //initialize new effect class;
-      const fxClass = new baseClass({
-        ref: `${key}${nr === 1 ? '' : nr}`,
-        target: key,
-        props: effect.props,
-      }) as ShaderEffect;
-
-      declareUniforms += fxClass.declaredUniforms;
-      uniforms.push(...Object.values(fxClass.uniformInfo));
-      return fxClass;
-    });
-
-    //build source
-    let effectMethods = '';
-
-    uFx?.forEach((fx) => {
-      const fxClass = effectContructors[fx.type as keyof EffectMap]!;
-      const fxProps = fxClass.resolveDefaults(
-        (fx.props ?? {}) as Record<string, unknown>,
-      );
-
-      const remap: Record<string, string>[] = [];
-      for (const m in fxClass.methods) {
-        let cm = m;
-        const fxMethod = fxClass.methods[m]!;
-        if (methods[m] && methods[m] !== fxMethod) {
-          cm = DynamicShader.resolveMethodDuplicate(m, fxMethod, methods);
-        }
-        methods[cm] = fxMethod.replace('function', cm);
-        remap.push({ m, cm });
-      }
-
-      let onShaderMask =
-        fxClass.onShaderMask instanceof Function
-          ? fxClass.onShaderMask(fxProps)
-          : fxClass.onShaderMask;
-
-      let onColorize =
-        fxClass.onColorize instanceof Function
-          ? fxClass.onColorize(fxProps)
-          : fxClass.onColorize;
-
-      let onEffectMask =
-        fxClass.onEffectMask instanceof Function
-          ? fxClass.onEffectMask(fxProps)
-          : fxClass.onEffectMask;
-
-      remap.forEach((r) => {
-        const { m, cm } = r;
-        const reg = new RegExp(`\\$${m!}`, 'g');
-        if (onShaderMask) {
-          onShaderMask = onShaderMask.replace(reg, cm!);
-        }
-        if (onColorize) {
-          onColorize = onColorize.replace(reg, cm!);
-        }
-        if (onEffectMask) {
-          onEffectMask = onEffectMask.replace(reg, cm!);
-        }
-      });
-
-      const methodParameters = fxClass.getMethodParameters(
-        fxClass.uniforms,
-        fxProps,
-      );
-      const pm = methodParameters.length > 0 ? `, ${methodParameters}` : '';
-      if (onShaderMask) {
-        effectMethods += `
-        float fx_${fx.key as string}_onShaderMask(float shaderMask ${pm}) {
-          ${onShaderMask}
-        }
-        `;
-      }
-      if (onColorize) {
-        effectMethods += `
-          vec4 fx_${
-            fx.key as string
-          }_onColorize(float shaderMask, vec4 maskColor, vec4 shaderColor${pm}) {
-            ${onColorize}
-          }
-        `;
-      }
-
-      if (onEffectMask) {
-        effectMethods += `
-          vec4 fx_${
-            fx.key as string
-          }_onEffectMask(float shaderMask, vec4 maskColor, vec4 shaderColor${pm}) {
-            ${onEffectMask}
-          }
-        `;
-      }
-    });
-
-    let sharedMethods = '';
-    for (const m in methods) {
-      sharedMethods += methods[m];
-    }
-
-    //fill main functions
-    let currentMask = `mix(shaderColor, maskColor, clamp(-(lng_DefaultMask), 0.0, 1.0))`;
-    let drawEffects = `
-
-    `;
-    for (let i = 0; i < effects.length; i++) {
-      const current = effects[i]!;
-      const pm =
-        current.passParameters.length > 0 ? `, ${current.passParameters}` : '';
-      const currentClass = effectContructors[current.name as keyof EffectMap]!;
-
-      if (currentClass.onShaderMask) {
-        drawEffects += `
-        shaderMask = fx_${current.target}_onShaderMask(shaderMask ${pm});
-        `;
-      }
-      if (currentClass.onColorize) {
-        drawEffects += `
-        maskColor = fx_${current.target}_onColorize(shaderMask, maskColor, shaderColor${pm});
-        `;
-      }
-      if (currentClass.onEffectMask) {
-        currentMask = `fx_${current.target}_onEffectMask(shaderMask, maskColor, shaderColor${pm})`;
-      }
-
-      const next = effects[i + 1]!;
-      if (
-        next === undefined ||
-        effectContructors[next.name as keyof EffectMap]!.onEffectMask
-      ) {
-        drawEffects += `
-          shaderColor = ${currentMask};
-        `;
-      }
-    }
-
-    return {
-      effects,
-      uniforms,
-      fragment: DynamicShader.fragment(
-        declareUniforms,
-        sharedMethods,
-        effectMethods,
-        drawEffects,
-      ),
-      vertex: DynamicShader.vertex(),
-    };
-  }
-
-  static resolveMethodDuplicate(
-    key: string,
-    effectMethod: string,
-    methodCollection: Record<string, string>,
-    increment = 0,
-  ): string {
-    const m = key + (increment > 0 ? (increment as unknown as string) : '');
-    if (methodCollection[m] && methodCollection[m] !== effectMethod) {
-      return this.resolveMethodDuplicate(
-        key,
-        effectMethod,
-        methodCollection,
-        ++increment,
-      );
-    }
-    return m;
-  }
-
-  static override resolveDefaults(
-    props: DynamicShaderProps,
-    effectContructors?: Partial<EffectMap>,
-  ): Required<DynamicShaderProps> {
-    assertTruthy(effectContructors);
-    return {
-      effects: getResolvedEffect(
-        props.effects ?? [],
-        effectContructors,
-      ) as EffectDescUnion[],
-      $dimensions: {
-        width: 0,
-        height: 0,
-      },
-      $alpha: 0,
-    };
-  }
-
-  static override makeCacheKey(
-    props: DynamicShaderProps,
-    effectContructors?: Partial<EffectMap>,
-  ): string {
-    let fx = '';
-    props.effects?.forEach((effect) => {
-      const baseClass = effectContructors![effect.type]!;
-      const key = baseClass.getEffectKey(effect.props || {});
-      fx += `,${key}`;
-    });
-    return `DynamicShader${fx}`;
-  }
-
-  static z$__type__Props: DynamicShaderProps;
-
-  static vertex = () => `
-    # ifdef GL_FRAGMENT_PRECISION_HIGH
-    precision highp float;
-    # else
-    precision mediump float;
-    # endif
-
-    attribute vec2 a_textureCoordinate;
-    attribute vec2 a_position;
-    attribute vec4 a_color;
-    attribute float a_textureIndex;
-
-    uniform vec2 u_resolution;
-    uniform float u_pixelRatio;
-
-    varying vec4 v_color;
-    varying vec2 v_textureCoordinate;
-    varying float v_textureIndex;
-
-    void main(){
-      vec2 normalized = a_position * u_pixelRatio / u_resolution;
-      vec2 zero_two = normalized * 2.0;
-      vec2 clip_space = zero_two - 1.0;
-
-      // pass to fragment
-      v_color = a_color;
-      v_textureCoordinate = a_textureCoordinate;
-      v_textureIndex = a_textureIndex;
-
-      // flip y
-      gl_Position = vec4(clip_space * vec2(1.0, -1.0), 0, 1);
-    }
-  `;
-
-  static fragment = (
-    uniforms: string,
-    methods: string,
-    effectMethods: string,
-    drawEffects: string,
-  ) => `
-    # ifdef GL_FRAGMENT_PRECISION_HIGH
-    precision highp float;
-    # else
-    precision mediump float;
-    # endif
-
-    #define PI 3.14159265359
-
-    uniform vec2 u_resolution;
-    uniform vec2 u_dimensions;
-    uniform float u_alpha;
-    uniform float u_radius;
-    uniform sampler2D u_texture;
-    uniform float u_pixelRatio;
-
-    ${uniforms}
-
-    varying vec4 v_color;
-    varying vec2 v_textureCoordinate;
-
-    ${methods}
-
-    ${effectMethods}
-
-    void main() {
-      vec2 p = v_textureCoordinate.xy * u_dimensions - u_dimensions * 0.5;
-      vec2 d = abs(p) - (u_dimensions) * 0.5;
-      float lng_DefaultMask = min(max(d.x, d.y), 0.0) + length(max(d, 0.0));
-
-      vec4 shaderColor = vec4(0.0);
-      float shaderMask = lng_DefaultMask;
-
-      vec4 maskColor = texture2D(u_texture, v_textureCoordinate) * v_color;
-
-      shaderColor = mix(shaderColor, maskColor, clamp(-(lng_DefaultMask + 0.5), 0.0, 1.0));
-
-      ${drawEffects}
-
-      gl_FragColor = shaderColor * u_alpha;
-    }
-  `;
-}