@solidtv/renderer 1.0.0

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

@@ -0,0 +1,262 @@
+import type { WebGlContextWrapper } from '../../../lib/WebGlContextWrapper.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 type SingleValue = number | Float32Array | Int32Array;
+export type Vec2 = [number, number];
+export type Vec3 = [number, number, number];
+export type Vec4 = [number, number, number, number];
+
+export type UniformValue = SingleValue | Vec2 | Vec3 | Vec4;
+
+export interface UniformCollection {
+  single: Record<string, Uniform<SingleValue>>;
+  vec2: Record<string, Uniform<Vec2>>;
+  vec3: Record<string, Uniform<Vec3>>;
+  vec4: Record<string, Uniform<Vec4>>;
+}
+
+export interface Uniform<T = UniformValue> {
+  method: string;
+  value: T;
+}
+
+export interface SupportedSetUniforms {
+  uniform2fv: Float32Array;
+  uniform2iv: Int32Array;
+  uniform3fv:
+    | 'uniform2iv'
+    | 'uniform3fv'
+    | 'uniform3iv'
+    | 'uniform4fv'
+    | 'uniform4iv'
+    | 'uniformMatrix2fv'
+    | 'uniformMatrix3fv'
+    | 'uniformMatrix4fv'
+    | 'uniform1f'
+    | 'uniform1fv'
+    | 'uniform1i'
+    | 'uniform1iv'
+    | 'uniform3fv'
+    | 'uniform2f'
+    | 'uniform2i'
+    | 'uniform3f'
+    | 'uniform3i'
+    | 'uniform4f'
+    | 'uniform4i';
+}
+
+type SupportSetUniforms =
+  | 'uniform2fv'
+  | 'uniform2iv'
+  | 'uniform3fv'
+  | 'uniform3iv'
+  | 'uniform4fv'
+  | 'uniform4iv'
+  | 'uniformMatrix2fv'
+  | 'uniformMatrix3fv'
+  | 'uniformMatrix4fv'
+  | 'uniform1f'
+  | 'uniform1fv'
+  | 'uniform1i'
+  | 'uniform1iv'
+  | 'uniform3fv'
+  | 'uniform2f'
+  | 'uniform2i'
+  | 'uniform3f'
+  | 'uniform3i'
+  | 'uniform4f'
+  | 'uniform4i';
+
+export interface ShaderOptions {
+  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;
+};
+
+export type UniformSet1Param = Omit<
+  UniformMethodMap,
+  | 'uniform2f'
+  | 'uniform2i'
+  | 'uniform3f'
+  | 'uniform3i'
+  | 'uniform4f'
+  | 'uniform4i'
+>;
+export type UniformSet2Params = Pick<
+  UniformMethodMap,
+  'uniform2f' | 'uniform2i'
+>;
+export type UniformSet3Params = Pick<
+  UniformMethodMap,
+  'uniform3f' | 'uniform3i'
+>;
+export type UniformSet4Params = Pick<
+  UniformMethodMap,
+  'uniform4f' | 'uniform4i'
+>;
+
+// 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;
+};
+
+export 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;
+}
+
+export const DefaultVertexSource = `
+  # ifdef GL_FRAGMENT_PRECISION_HIGH
+  precision highp float;
+  # else
+  precision mediump float;
+  # endif
+
+  attribute vec2 a_position;
+  attribute vec2 a_textureCoords;
+  attribute vec4 a_color;
+  attribute vec2 a_nodeCoords;
+
+  uniform vec2 u_resolution;
+  uniform float u_pixelRatio;
+  uniform vec2 u_dimensions;
+  uniform vec4 u_shadow;
+
+  varying vec4 v_color;
+  varying vec2 v_textureCoords;
+
+  void main() {
+    vec2 normalized = a_position * u_pixelRatio;
+    vec2 screenSpace = vec2(2.0 / u_resolution.x, -2.0 / u_resolution.y);
+
+    vec2 outerEdge = clamp(a_textureCoords * 2.0 - vec2(1.0), -1.0, 1.0);
+    vec2 shadowEdge = outerEdge;
+    vec2 vertexPos = normalized + outerEdge + shadowEdge;
+    v_color = a_color;
+    v_textureCoords = a_textureCoords;
+
+    gl_Position = vec4(vertexPos.x * screenSpace.x - 1.0, -sign(screenSpace.y) * (vertexPos.y * -abs(screenSpace.y)) + 1.0, 0.0, 1.0);
+  }
+`;
+
+/**
+ * generate fragment source for
+ * @param stops
+ * @returns
+ */
+export function genGradientColors(stops: number): string {
+  let result = `
+    float stopCalc = (dist - u_stops[0]) / (u_stops[1] - u_stops[0]);
+    vec4 colorOut = mix(u_colors[0], u_colors[1], stopCalc);
+  `;
+  if (stops > 2) {
+    for (let i = 2; i < stops; i++) {
+      result += `colorOut = mix(colorOut, u_colors[${i}], clamp((dist - u_stops[${
+        i - 1
+      }]) / (u_stops[${i}] - u_stops[${i - 1}]), 0.0, 1.0));`;
+    }
+  }
+  return result;
+}

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

@@ -0,0 +1,16 @@
+/**
+ * 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/shaders/canvas/Border.ts

@@ -0,0 +1,119 @@
+import { formatRgba, parseColorRgba } from '../../lib/colorParser.js';
+import { valuesAreEqual } from '../../lib/utils.js';
+import type { CanvasShaderType } from '../../renderers/canvas/CanvasShaderNode.js';
+import type { Vec4 } from '../../renderers/webgl/internal/ShaderUtils.js';
+import {
+  BorderTemplate,
+  type BorderProps,
+} from '../templates/BorderTemplate.js';
+
+export interface ComputedBorderValues {
+  borderColor: string;
+  borderAsym: boolean;
+  innerX: number;
+  innerY: number;
+  innerW: number;
+  innerH: number;
+  outerX: number;
+  outerY: number;
+  outerW: number;
+  outerH: number;
+}
+
+export const Border: CanvasShaderType<BorderProps, ComputedBorderValues> = {
+  props: BorderTemplate.props,
+  update() {
+    this.computed.borderColor = formatRgba(parseColorRgba(this.props!.color));
+    this.computed.borderAsym = !valuesAreEqual(this.props!.w as number[]);
+    const borderAlign = this.props!.align as number;
+    const borderGap = this.props!.gap as number;
+
+    const borderW = this.props!.w as Vec4;
+
+    if (this.computed.borderAsym === false) {
+      const bWidth = borderW[0] * 0.5;
+      //inside
+      const baseline = bWidth - borderW[0] * borderAlign - borderGap;
+      this.computed.outerX = baseline;
+      this.computed.outerY = baseline;
+
+      this.computed.outerW = -baseline * 2;
+      this.computed.outerH = -baseline * 2;
+      return;
+    }
+
+    // Calculate outer and inner rectangle dimensions
+    const [t, r, b, l] = this.props!.w as Vec4;
+
+    const outerX = (this.computed.outerX = -l * borderAlign - borderGap);
+    const outerY = (this.computed.outerY = -t * borderAlign - borderGap);
+    let outerW = 0;
+    let outerH = 0;
+
+    if (r > 0) {
+      outerW += r * borderAlign + borderGap;
+    }
+    if (l > 0) {
+      outerW += l * borderAlign + borderGap;
+    }
+
+    if (b > 0) {
+      outerH += b * borderAlign + borderGap;
+    }
+    if (t > 0) {
+      outerH += t * borderAlign + borderGap;
+    }
+
+    this.computed.outerW = outerW;
+    this.computed.outerH = outerH;
+
+    this.computed.innerX = outerX + l;
+    this.computed.innerY = outerY + t;
+    this.computed.innerW = outerW - l - r;
+    this.computed.innerH = outerH - t - b;
+  },
+  render(ctx, quad, renderContext) {
+    renderContext();
+    const computed = this.computed as ComputedBorderValues;
+    ctx.strokeStyle = computed.borderColor!;
+    if (computed.borderAsym === false && this.props!.w[0] > 0) {
+      ctx.lineWidth = this.props!.w[0];
+      ctx.beginPath();
+      ctx.strokeRect(
+        quad.tx + computed.outerX,
+        quad.ty + computed.outerY,
+        quad.width + computed.outerW,
+        quad.height + computed.outerH,
+      );
+      return;
+    }
+
+    // Pre-calculate common values
+    const tx = quad.tx;
+    const ty = quad.ty;
+    const width = quad.width;
+    const height = quad.height;
+
+    // Calculate outer rectangle (including border)
+    const outerX = tx + computed.outerX;
+    const outerY = ty + computed.outerY;
+    const outerW = width + computed.outerW;
+    const outerH = height + computed.outerH;
+
+    // Calculate inner rectangle (excluding border)
+    const innerX = tx + computed.innerX;
+    const innerY = ty + computed.innerY;
+    const innerW = width + computed.innerW;
+    const innerH = height + computed.innerH;
+
+    // Use clip to subtract inner from outer
+    ctx.save();
+    ctx.beginPath();
+    ctx.rect(outerX, outerY, outerW, outerH);
+    ctx.rect(innerX, innerY, innerW, innerH);
+    ctx.clip('evenodd');
+    ctx.fillStyle = this.computed.borderColor!;
+    ctx.fillRect(outerX, outerY, outerW, outerH);
+    ctx.restore();
+  },
+};

package/src/core/shaders/canvas/HolePunch.ts

@@ -0,0 +1,38 @@
+import { calcFactoredRadiusArray } from '../../lib/utils.js';
+import type { CanvasShaderType } from '../../renderers/canvas/CanvasShaderNode.js';
+import type { Vec4 } from '../../renderers/webgl/internal/ShaderUtils.js';
+import {
+  HolePunchTemplate,
+  type HolePunchProps,
+} from '../templates/HolePunchTemplate.js';
+import { roundRect } from './utils/render.js';
+
+export interface ComputedHolePunchValues {
+  radius: Vec4;
+}
+
+export const HolePunch: CanvasShaderType<
+  HolePunchProps,
+  ComputedHolePunchValues
+> = {
+  props: HolePunchTemplate.props,
+  update() {
+    this.computed.radius = calcFactoredRadiusArray(
+      this.props!.radius as Vec4,
+      this.props!.w,
+      this.props!.h,
+    );
+  },
+  render(ctx, quad, renderContext) {
+    ctx.save();
+    renderContext();
+    const { x, y, w, h } = this.props!;
+    ctx.beginPath();
+    roundRect(ctx, quad.tx + x, quad.ty + y, w, h, this.computed.radius!);
+    ctx.closePath();
+    ctx.fillStyle = 'black';
+    ctx.globalCompositeOperation = 'destination-out';
+    ctx.fill();
+    ctx.restore();
+  },
+};

package/src/core/shaders/canvas/LinearGradient.ts

@@ -0,0 +1,54 @@
+import type { CanvasShaderType } from '../../renderers/canvas/CanvasShaderNode.js';
+import {
+  LinearGradientTemplate,
+  type LinearGradientProps,
+} from '../templates/LinearGradientTemplate.js';
+
+export interface ComputedLinearGradientValues {
+  x0: number;
+  y0: number;
+  x1: number;
+  y1: number;
+  colors: string[];
+}
+
+export const LinearGradient: CanvasShaderType<
+  LinearGradientProps,
+  ComputedLinearGradientValues
+> = {
+  props: LinearGradientTemplate.props,
+  update(node) {
+    const angle = this.props!.angle - (Math.PI / 180) * 90;
+    const nWidth = node.w;
+    const nHeight = node.h;
+    const line =
+      (Math.abs(nWidth * Math.sin(angle)) +
+        Math.abs(nHeight * Math.cos(angle))) *
+      0.5;
+
+    this.computed = {
+      x0: line * Math.cos(angle) + nWidth * 0.5,
+      y0: line * Math.sin(angle) + nHeight * 0.5,
+      x1: line * Math.cos(angle + Math.PI) + nWidth * 0.5,
+      y1: line * Math.sin(angle + Math.PI) + nHeight * 0.5,
+      colors: this.props!.colors.map((value) => this.toColorString(value)),
+    };
+  },
+  render(ctx, quad, renderContext) {
+    renderContext();
+    const computed = this.computed as ComputedLinearGradientValues;
+    const gradient = ctx.createLinearGradient(
+      quad.tx + computed.x0,
+      quad.ty + computed.y0,
+      quad.tx + computed.x1,
+      quad.ty + computed.y1,
+    );
+    const colors = computed.colors;
+    const stops = this.props!.stops;
+    for (let i = 0; i < colors.length; i++) {
+      gradient.addColorStop(stops[i]!, colors[i]!);
+    }
+    ctx.fillStyle = gradient;
+    ctx.fillRect(quad.tx, quad.ty, quad.width, quad.height);
+  },
+};

package/src/core/shaders/canvas/RadialGradient.ts

@@ -0,0 +1,82 @@
+import type { CanvasShaderType } from '../../renderers/canvas/CanvasShaderNode.js';
+import {
+  RadialGradientTemplate,
+  type RadialGradientProps,
+} from '../templates/RadialGradientTemplate.js';
+
+export interface ComputedRadialGradientValues {
+  pivotX: number;
+  pivotY: number;
+  scaleX: number;
+  scaleY: number;
+  size: number;
+  colors: string[];
+}
+
+export const RadialGradient: CanvasShaderType<
+  RadialGradientProps,
+  ComputedRadialGradientValues
+> = {
+  props: RadialGradientTemplate.props,
+  update(node) {
+    let scaleX = 1;
+    let scaleY = 1;
+    const props = this.props as RadialGradientProps;
+    const pWidth = props.w;
+    const pHeight = props.h;
+    if (pWidth > pHeight) {
+      scaleX = pWidth / pHeight;
+    } else if (pHeight > pWidth) {
+      scaleY = pHeight / pWidth;
+    }
+
+    this.computed = {
+      pivotX: props.pivot[0] * node.w,
+      pivotY: props.pivot[1] * node.h,
+      scaleX,
+      scaleY,
+      size: Math.min(pWidth, pHeight),
+      colors: props.colors.map((value) => this.toColorString(value)),
+    };
+  },
+  render(ctx, quad, renderContext) {
+    renderContext();
+    const { scaleX, scaleY, pivotX, pivotY, colors, size } = this
+      .computed as ComputedRadialGradientValues;
+    let x = quad.tx + pivotX;
+    let y = quad.ty + pivotY;
+    const stops = this.props!.stops;
+
+    if (scaleX === scaleY) {
+      const gradient = ctx.createRadialGradient(x, y, 0, x, y, size);
+
+      for (let i = 0; i < colors.length; i++) {
+        gradient.addColorStop(stops[i]!, colors[i]!);
+      }
+
+      ctx.fillStyle = gradient;
+      ctx.fillRect(quad.tx, quad.ty, quad.width, quad.height);
+      return;
+    }
+
+    ctx.save();
+    ctx.scale(scaleX, scaleY);
+    x = x / scaleX;
+    y = y / scaleY;
+    const gradient = ctx.createRadialGradient(x, y, 0, x, y, size);
+
+    for (let i = 0; i < colors.length; i++) {
+      gradient.addColorStop(stops[i]!, colors[i]!);
+    }
+
+    ctx.fillStyle = gradient;
+    ctx.fillRect(
+      quad.tx / scaleX,
+      quad.ty / scaleY,
+      quad.width / scaleX,
+      quad.height / scaleY,
+    );
+
+    ctx.restore();
+  },
+};

package/src/core/shaders/canvas/Rounded.ts

@@ -0,0 +1,38 @@
+import { calcFactoredRadiusArray } from '../../lib/utils.js';
+import type { CanvasShaderType } from '../../renderers/canvas/CanvasShaderNode.js';
+import type { Vec4 } from '../../renderers/webgl/internal/ShaderUtils.js';
+import {
+  RoundedTemplate,
+  type RoundedProps,
+} from '../templates/RoundedTemplate.js';
+import { roundRect } from './utils/render.js';
+
+export interface ComputedRoundedValues {
+  radius: Vec4;
+}
+
+export const Rounded: CanvasShaderType<RoundedProps, ComputedRoundedValues> = {
+  props: RoundedTemplate.props,
+  saveAndRestore: true,
+  update(node) {
+    this.computed.radius = calcFactoredRadiusArray(
+      this.props!.radius as Vec4,
+      node.w,
+      node.h,
+    );
+  },
+  render(ctx, quad, renderContext) {
+    const path = new Path2D();
+    roundRect(
+      path,
+      quad.tx,
+      quad.ty,
+      quad.width,
+      quad.height,
+      this.computed.radius!,
+    );
+    ctx.clip(path);
+
+    renderContext();
+  },
+};