@lightningtv/renderer 2.16.1 → 3.2.3

package/src/core/shaders/canvas/utils/render.ts

@@ -0,0 +1,143 @@
+import type { Vec4 } from '../../../renderers/webgl/internal/ShaderUtils.js';
+
+export function roundRect(
+  ctx: CanvasRenderingContext2D | Path2D,
+  x: number,
+  y: number,
+  width: number,
+  height: number,
+  radius: Vec4,
+) {
+  if (ctx.roundRect !== undefined) {
+    ctx.roundRect(x, y, width, height, radius);
+    return;
+  }
+  const { 0: tl, 1: tr, 2: br, 3: bl } = radius;
+  ctx.moveTo(x + tl, y);
+  ctx.lineTo(x + width - tr, y);
+  ctx.ellipse(x + width - tr, y + tr, tr, tr, 0, 1.5 * Math.PI, 2 * Math.PI);
+  ctx.lineTo(x + width, y - height - br);
+  ctx.ellipse(x + width - br, y + height - br, br, br, 0, 0, 0.5 * Math.PI);
+  ctx.lineTo(x + bl, y + height);
+  ctx.ellipse(x + bl, y + height - bl, bl, bl, 0, 0.5 * Math.PI, Math.PI);
+  ctx.lineTo(x, y + tl);
+  ctx.ellipse(x + tl, y + tl, tl, tl, 0, Math.PI, 1.5 * Math.PI);
+}
+
+export function roundedRectWithBorder(
+  ctx: CanvasRenderingContext2D,
+  x: number,
+  y: number,
+  width: number,
+  height: number,
+  radius: Vec4,
+  borderGap: number,
+  outerX: number,
+  outerY: number,
+  outerW: number,
+  outerH: number,
+  outerBorderRadius: Vec4,
+  innerX: number,
+  innerY: number,
+  innerW: number,
+  innerH: number,
+  innerBorderRadius: Vec4,
+  borderColor: string,
+  renderContext: () => void,
+) {
+  outerX += x;
+  outerY += y;
+  outerW += width;
+  outerH += height;
+
+  innerX += x;
+  innerY += y;
+  innerW += width;
+  innerH += height;
+
+  // no gap render strategy - to avoid artifacts between border and node
+  if (borderGap === 0) {
+    //draw outer border rounded rect
+    ctx.beginPath();
+    roundRect(ctx, outerX, outerY, outerW, outerH, outerBorderRadius);
+    ctx.fillStyle = borderColor;
+    ctx.fill();
+    ctx.closePath();
+
+    const path = new Path2D();
+    roundRect(path, innerX, innerY, innerW, innerH, innerBorderRadius as Vec4);
+    ctx.clip(path);
+    renderContext();
+    return;
+  }
+
+  // with gap render strategy
+
+  //draw node content first
+  ctx.save();
+  const path = new Path2D();
+  roundRect(path, x, y, width, height, radius);
+  ctx.clip(path);
+  renderContext();
+  ctx.restore();
+
+  //draw border by clipping inner area from outer area
+  ctx.save();
+  const borderPath = new Path2D();
+  roundRect(borderPath, outerX, outerY, outerW, outerH, outerBorderRadius);
+  roundRect(borderPath, innerX, innerY, innerW, innerH, innerBorderRadius);
+  ctx.fillStyle = borderColor;
+  ctx.fill(borderPath, 'evenodd');
+  ctx.restore();
+}
+
+export function shadow(
+  ctx: CanvasRenderingContext2D,
+  x: number,
+  y: number,
+  width: number,
+  height: number,
+  color: string,
+  projection: Vec4,
+  radius: Vec4,
+  pixelRatio: number,
+) {
+  ctx.save();
+  const cw = ctx.canvas.width;
+  const ch = ctx.canvas.height;
+  const scaleFactor = (2 * projection[3] + width) / width;
+  ctx.scale(scaleFactor, scaleFactor);
+  ctx.shadowColor = color;
+  ctx.shadowBlur = projection[2] * pixelRatio;
+  ctx.shadowOffsetX = projection[0] + cw * pixelRatio - projection[3] * 0.5;
+  ctx.shadowOffsetY = projection[1] + ch * pixelRatio - projection[3] * 0.5;
+
+  const spreadFactor = projection[3];
+  ctx.beginPath();
+  roundRect(
+    ctx,
+    (x - spreadFactor - cw) / scaleFactor,
+    (y - spreadFactor - ch) / scaleFactor,
+    width + spreadFactor,
+    height + spreadFactor,
+    radius,
+  );
+  ctx.fillStyle = color;
+  ctx.fill();
+  ctx.restore();
+}
+
+export function strokeLine(
+  ctx: CanvasRenderingContext2D,
+  x: number,
+  y: number,
+  x2: number,
+  y2: number,
+  lineWidth: number,
+) {
+  ctx.beginPath();
+  ctx.lineWidth = lineWidth;
+  ctx.moveTo(x, y);
+  ctx.lineTo(x2, y2);
+  ctx.stroke();
+}

package/src/core/shaders/templates/BorderTemplate.ts

@@ -0,0 +1,128 @@
+import type { CoreShaderType } from '../../renderers/CoreShaderNode.js';
+import type { Vec4 } from '../../renderers/webgl/internal/ShaderUtils.js';
+import { validateArrayLength4, type PrefixedType } from '../utils.js';
+
+/**
+ * Properties of the {@link Border} shader
+ */
+export interface BorderProps {
+  /**
+   * Width of the border in pixels
+   *
+   * @default 0
+   */
+  w: number | [number, number, number, number];
+  /**
+   * Color of the border in 0xRRGGBBAA
+   *
+   * @default 0xffffffff
+   */
+  color: number;
+  /**
+   * Alignment of the border
+   *
+   * @default 'inside'
+   */
+  align: number | 'inside' | 'center' | 'outside';
+  /**
+   * Gap between node and border baseline. Default is 0. and generally edge of node)
+   */
+  gap: number;
+  /**
+   * Top width
+   */
+  top: number;
+  /**
+   * Right width
+   */
+  right: number;
+  /**
+   * Bottom width
+   */
+  bottom: number;
+  /**
+   * Left width
+   */
+  left: number;
+}
+
+export function getBorderProps<P extends string>(
+  prefix?: P,
+): PrefixedType<BorderProps, P> {
+  const pf = prefix && prefix.length > 0 ? `${prefix}-` : '';
+  const w = pf + 'w';
+  return {
+    [w]: {
+      default: [0, 0, 0, 0],
+      resolve(value) {
+        if (value !== undefined) {
+          return validateArrayLength4(value);
+        }
+        return ([] as number[]).concat(this.default);
+      },
+    },
+    [pf + 'color']: 0xffffffff,
+    [pf + 'align']: {
+      default: 0, //inside,
+      resolve(value) {
+        if (!isNaN(value)) {
+          return value as number;
+        }
+        if (typeof value === 'string') {
+          switch (value) {
+            case 'inside':
+              return 0;
+            case 'center':
+              return 0.5;
+            case 'outside':
+              return 1;
+          }
+        }
+        return this.default;
+      },
+    },
+    [pf + 'gap']: 0,
+    [pf + 'top']: {
+      default: 0,
+      set(value, props) {
+        (props[w] as Vec4)[0] = value;
+      },
+      get(props) {
+        return (props[w] as Vec4)[0];
+      },
+    },
+    [pf + 'right']: {
+      default: 0,
+      set(value, props) {
+        (props[w] as Vec4)[1] = value;
+      },
+      get(props) {
+        return (props[w] as Vec4)[1];
+      },
+    },
+    [pf + 'bottom']: {
+      default: 0,
+      set(value, props) {
+        (props[w] as Vec4)[2] = value;
+      },
+      get(props) {
+        return (props[w] as Vec4)[2];
+      },
+    },
+    [pf + 'left']: {
+      default: 0,
+      set(value, props) {
+        (props[w] as Vec4)[3] = value;
+      },
+      get(props) {
+        return (props[w] as Vec4)[3];
+      },
+    },
+  } as PrefixedType<BorderProps, P>;
+}
+
+type PlainBorderProps = PrefixedType<BorderProps>;
+
+export const BorderTemplate: CoreShaderType<BorderProps> = {
+  props: getBorderProps() as PlainBorderProps,
+};

package/src/core/shaders/templates/HolePunchTemplate.ts

@@ -0,0 +1,65 @@
+import type { CoreShaderType } from '../../renderers/CoreShaderNode.js';
+import { validateArrayLength4 } from '../utils.js';
+
+/**
+ * Properties of the {@link HolePunch} shader
+ */
+export interface HolePunchProps {
+  /**
+   * X position where the hole punch starts
+   */
+  x: number;
+  /**
+   * Y position where the hole punch starts
+   */
+  y: number;
+  /**
+   * Width of the hole punch
+   */
+  w: number;
+  /**
+   * height of the hole punch
+   *
+   * @remarks if not defined uses the width value
+   */
+  h: number;
+  /**
+   * Corner radius in pixels, to cut out of the corners of the hole punch
+   *
+   * @remarks
+   * You can input an array with a length of up to four or a number.
+   *
+   * array length 4:
+   * [topLeft, topRight, bottomRight, bottomLeft]
+   *
+   * array length 2:
+   * [20, 40] -> [20(topLeft), 40(topRight), 20(bottomRight), 40(bottomLeft)]
+   *
+   * array length 3:
+   * [20, 40, 60] -> [20(topLeft), 40(topRight), 60(bottomRight), 20(bottomLeft)]
+   *
+   * number:
+   * 30 -> [30, 30, 30, 30]
+   *
+   * @default -1
+   */
+  radius: number | number[];
+}
+
+export const HolePunchTemplate: CoreShaderType<HolePunchProps> = {
+  props: {
+    x: 0,
+    y: 0,
+    w: 50,
+    h: 50,
+    radius: {
+      default: [0, 0, 0, 0],
+      resolve(value) {
+        if (value !== undefined) {
+          return validateArrayLength4(value);
+        }
+        return ([] as number[]).concat(this.default);
+      },
+    },
+  },
+};

package/src/core/shaders/templates/LinearGradientTemplate.ts

@@ -0,0 +1,54 @@
+import type { CoreShaderType } from '../../renderers/CoreShaderNode.js';
+
+/**
+ * Properties of the {@link LinearGradient} shader
+ */
+export interface LinearGradientProps {
+  /**
+   * Array of colors to be used in the LinearGradient shader
+   *
+   * @default [0xff000000, 0xffffffff]
+   */
+  colors: number[];
+  /**
+   * Angle of the LinearGradient shader, Angle in Radians
+   *
+   * @default 0
+   */
+  angle: number;
+  /**
+   * Array of color stops
+   */
+  stops: number[];
+}
+
+export const LinearGradientTemplate: CoreShaderType<LinearGradientProps> = {
+  props: {
+    colors: {
+      default: [0x000000ff, 0xffffffff],
+      resolve(value) {
+        if (value !== undefined && value.length > 0) {
+          return value;
+        }
+        return ([] as number[]).concat(this.default);
+      },
+    },
+    stops: {
+      default: [0, 1],
+      resolve(value, props) {
+        if (value !== undefined && value.length === props.colors.length) {
+          return value;
+        }
+        if (value === undefined) {
+          value = [];
+        }
+        const len = props.colors.length;
+        for (let i = 0; i < len; i++) {
+          value[i] = i * (1 / (len - 1));
+        }
+        return value;
+      },
+    },
+    angle: 0,
+  },
+};

package/src/core/shaders/templates/RadialGradientTemplate.ts

@@ -0,0 +1,66 @@
+import type { CoreShaderType } from '../../renderers/CoreShaderNode.js';
+
+/**
+ * Properties of the {@link RadialGradient} shader
+ */
+export interface RadialGradientProps {
+  /**
+   * Array of colors to be used in the RadialGradient shader
+   *
+   * @default [0xff000000, 0xffffffff]
+   */
+  colors: number[];
+  /**
+   * Array of color stops
+   */
+  stops: number[];
+  /**
+   * radial width of the RadialGradientEffect
+   *
+   * @remarks from the center to the outer edge of the gradient
+   */
+  w: number;
+  /**
+   * radial height of the RadialGradientEffect
+   * if not defined uses the width value
+   * @remarks from the center to the outer edge of the gradient
+   */
+  h: number;
+  /**
+   * center point of where the RadialGradientEffect is drawn
+   */
+  pivot: [number, number];
+}
+
+export const RadialGradientTemplate: CoreShaderType<RadialGradientProps> = {
+  props: {
+    colors: {
+      default: [0x000000ff, 0xffffffff],
+      resolve(value) {
+        if (value !== undefined && value.length > 0) {
+          return value;
+        }
+        return ([] as number[]).concat(this.default);
+      },
+    },
+    stops: {
+      default: [0, 1],
+      resolve(value, props) {
+        if (value !== undefined && value.length === props.colors.length) {
+          return value;
+        }
+        if (value === undefined) {
+          value = [];
+        }
+        const len = props.colors.length;
+        for (let i = 0; i < len; i++) {
+          value[i] = i * (1 / (len - 1));
+        }
+        return value;
+      },
+    },
+    w: 50,
+    h: 50,
+    pivot: [0.5, 0.5],
+  },
+};

package/src/core/shaders/templates/RoundedTemplate.ts

@@ -0,0 +1,81 @@
+import type { CoreShaderType } from '../../renderers/CoreShaderNode.js';
+import type { Vec4 } from '../../renderers/webgl/internal/ShaderUtils.js';
+import { validateArrayLength4 } from '../utils.js';
+
+/**
+ * Properties of the {@link RoundedRectangle} shader
+ */
+export interface RoundedProps {
+  /**
+   * Corner radius, in pixels, to cut out of the corners
+   *
+   * @defaultValue 0
+   */
+  radius: number | number[];
+  /**
+   * sets top-left corner
+   */
+  'top-left': number;
+  /**
+   * sets top-right corner
+   */
+  'top-right': number;
+  /**
+   * sets bottom-right corner
+   */
+  'bottom-right': number;
+  /**
+   * sets bottom-left corner
+   */
+  'bottom-left': number;
+}
+
+export const RoundedTemplate: CoreShaderType<RoundedProps> = {
+  props: {
+    radius: {
+      default: [0, 0, 0, 0],
+      resolve(value) {
+        if (value !== undefined) {
+          return validateArrayLength4(value);
+        }
+        return ([] as number[]).concat(this.default);
+      },
+    },
+    'top-left': {
+      default: 0,
+      set(value, props) {
+        (props.radius as Vec4)[0] = value;
+      },
+      get(props) {
+        return (props.radius as Vec4)[0];
+      },
+    },
+    'top-right': {
+      default: 0,
+      set(value, props) {
+        (props.radius as Vec4)[1] = value;
+      },
+      get(props) {
+        return (props.radius as Vec4)[1];
+      },
+    },
+    'bottom-right': {
+      default: 0,
+      set(value, props) {
+        (props.radius as Vec4)[2] = value;
+      },
+      get(props) {
+        return (props.radius as Vec4)[2];
+      },
+    },
+    'bottom-left': {
+      default: 0,
+      set(value, props) {
+        (props.radius as Vec4)[3] = value;
+      },
+      get(props) {
+        return (props.radius as Vec4)[3];
+      },
+    },
+  },
+};

package/src/core/shaders/templates/RoundedWithBorderAndShadowTemplate.ts

@@ -0,0 +1,21 @@
+import type { CoreShaderType } from '../../renderers/CoreShaderNode.js';
+import { getBorderProps, type BorderProps } from './BorderTemplate.js';
+import { RoundedTemplate, type RoundedProps } from './RoundedTemplate.js';
+import type { PrefixedType } from '../utils.js';
+import { getShadowProps, type ShadowProps } from './ShadowTemplate.js';
+
+export type RoundedWithBorderAndShadowProps = RoundedProps &
+  PrefixedType<BorderProps, 'border'> &
+  PrefixedType<ShadowProps, 'shadow'>;
+
+const props = Object.assign(
+  {},
+  RoundedTemplate.props,
+  getBorderProps('border'),
+  getShadowProps('shadow'),
+) as RoundedWithBorderAndShadowProps;
+
+export const RoundedWithBorderAndShadowTemplate: CoreShaderType<RoundedWithBorderAndShadowProps> =
+  {
+    props,
+  };

package/src/core/shaders/templates/RoundedWithBorderTemplate.ts

@@ -0,0 +1,23 @@
+import type { CoreShaderType } from '../../renderers/CoreShaderNode.js';
+import { getBorderProps, type BorderProps } from './BorderTemplate.js';
+import { RoundedTemplate, type RoundedProps } from './RoundedTemplate.js';
+import type { PrefixedType } from '../utils.js';
+
+export type RoundedWithBorderProps = RoundedProps &
+  PrefixedType<BorderProps, 'border'> & {
+    'border-fill': number;
+  };
+
+const props = Object.assign(
+  {},
+  RoundedTemplate.props,
+  getBorderProps('border'),
+  {
+    'border-fill': 0x00000000,
+  },
+) as RoundedWithBorderProps;
+
+export const RoundedWithBorderTemplate: CoreShaderType<RoundedWithBorderProps> =
+  {
+    props,
+  };

package/src/core/shaders/templates/RoundedWithShadowTemplate.ts

@@ -0,0 +1,18 @@
+import type { CoreShaderType } from '../../renderers/CoreShaderNode.js';
+import { RoundedTemplate, type RoundedProps } from './RoundedTemplate.js';
+import type { PrefixedType } from '../utils.js';
+import { getShadowProps, type ShadowProps } from './ShadowTemplate.js';
+
+export type RoundedWithShadowProps = RoundedProps &
+  PrefixedType<ShadowProps, 'shadow'>;
+
+const props = Object.assign(
+  {},
+  RoundedTemplate.props,
+  getShadowProps('shadow'),
+) as RoundedWithShadowProps;
+
+export const RoundedWithShadowTemplate: CoreShaderType<RoundedWithShadowProps> =
+  {
+    props,
+  };

package/src/core/shaders/templates/ShadowTemplate.ts

@@ -0,0 +1,89 @@
+import type { CoreShaderType } from '../../renderers/CoreShaderNode.js';
+import type { PrefixedType } from '../utils.js';
+
+export interface ShadowProps {
+  /**
+   * Shadow Color
+   *
+   * @default 0x000000ff
+   */
+  color: number;
+  /**
+   * Shadow Projection [offsetX, offsetY, blur, spread]
+   *
+   * @default [0, 0, 5, 5]
+   */
+  projection: [number, number, number, number];
+  /**
+   * OffsetX of Shadow (center)
+   */
+  x: number;
+  /**
+   * OffsetY of Shadow (center)
+   */
+  y: number;
+  /**
+   * Blur along the edges of the Shadow
+   */
+  blur: number;
+  /**
+   * Spread of the shadow compared to node
+   */
+  spread: number;
+}
+
+export function getShadowProps<P extends string>(
+  prefix?: P,
+): PrefixedType<ShadowProps, P> {
+  const pf = prefix && prefix.length > 0 ? `${prefix}-` : '';
+  const projection = pf + 'projection';
+
+  return {
+    [pf + 'color']: 0x000000ff,
+    [projection]: {
+      default: [0, 0, 5, 5],
+    },
+    [pf + 'x']: {
+      default: 0,
+      set(value, props) {
+        props[projection][0] = value;
+      },
+      get(props) {
+        return props[projection][0];
+      },
+    },
+    [pf + 'y']: {
+      default: 0,
+      set(value, props) {
+        props[projection][1] = value;
+      },
+      get(props) {
+        return props[projection][1];
+      },
+    },
+    [pf + 'blur']: {
+      default: 10,
+      set(value, props) {
+        props[projection][2] = value;
+      },
+      get(props) {
+        return props[projection][2];
+      },
+    },
+    [pf + 'spread']: {
+      default: 10,
+      set(value, props) {
+        props[projection][3] = value;
+      },
+      get(props) {
+        return props[projection][3];
+      },
+    },
+  } as PrefixedType<ShadowProps, P>;
+}
+
+type PlainShadowProps = PrefixedType<ShadowProps>;
+
+export const ShadowTemplate: CoreShaderType<ShadowProps> = {
+  props: getShadowProps() as PlainShadowProps,
+};