@lightningjs/renderer 2.12.1 → 3.0.0-beta1

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

@@ -0,0 +1,115 @@
+/*
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import type { CoreShaderType } from '../../renderers/CoreShaderNode.js';
+import type { Vec4 } from '../../renderers/webgl/internal/ShaderUtils.js';
+import { validateArrayLength4, type PrefixedType } from './shaderUtils.js';
+
+/**
+ * Properties of the {@link Border} shader
+ */
+export interface BorderProps {
+  /**
+   * Width of the border in pixels
+   *
+   * @default 0
+   */
+  width: number | [number, number, number, number];
+  /**
+   * Color of the border in 0xRRGGBBAA
+   *
+   * @default 0xffffffff
+   */
+  color: 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 width = pf + 'width';
+  return {
+    [width]: {
+      default: [0, 0, 0, 0],
+      resolve(value) {
+        if (value !== undefined) {
+          return validateArrayLength4(value);
+        }
+        return ([] as number[]).concat(this.default);
+      },
+    },
+    [pf + 'color']: 0xffffffff,
+    [pf + 'top']: {
+      default: 0,
+      set(value, props) {
+        (props[width] as Vec4)[0] = value;
+      },
+      get(props) {
+        return (props[width] as Vec4)[0];
+      },
+    },
+    [pf + 'right']: {
+      default: 0,
+      set(value, props) {
+        (props[width] as Vec4)[1] = value;
+      },
+      get(props) {
+        return (props[width] as Vec4)[1];
+      },
+    },
+    [pf + 'bottom']: {
+      default: 0,
+      set(value, props) {
+        (props[width] as Vec4)[2] = value;
+      },
+      get(props) {
+        return (props[width] as Vec4)[2];
+      },
+    },
+    [pf + 'left']: {
+      default: 0,
+      set(value, props) {
+        (props[width] as Vec4)[3] = value;
+      },
+      get(props) {
+        return (props[width] 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,82 @@
+/*
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import type { CoreShaderType } from '../../renderers/CoreShaderNode.js';
+import { validateArrayLength4 } from './shaderUtils.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
+   */
+  width: number;
+  /**
+   * height of the hole punch
+   *
+   * @remarks if not defined uses the width value
+   */
+  height: 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,
+    width: 50,
+    height: 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,71 @@
+/*
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+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,81 @@
+/*
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+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[];
+  /**
+   * Width of the RadialGradientEffect
+   */
+  width: number;
+  /**
+   * height of the RadialGradientEffect
+   *
+   * @remarks if not defined uses the width value
+   */
+  height: 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;
+      },
+    },
+    width: 50,
+    height: 50,
+    pivot: [0.5, 0.5],
+  },
+};

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

@@ -0,0 +1,98 @@
+/*
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import type { CoreShaderType } from '../../renderers/CoreShaderNode.js';
+import type { Vec4 } from '../../renderers/webgl/internal/ShaderUtils.js';
+import { validateArrayLength4 } from './shaderUtils.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,38 @@
+/*
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+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 './shaderUtils.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,35 @@
+/*
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+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 './shaderUtils.js';
+
+export type RoundedWithBorderProps = RoundedProps &
+  PrefixedType<BorderProps, 'border'>;
+
+const props = Object.assign(
+  {},
+  RoundedTemplate.props,
+  getBorderProps('border'),
+) as RoundedWithBorderProps;
+
+export const RoundedWithBorderTemplate: CoreShaderType<RoundedWithBorderProps> =
+  {
+    props,
+  };

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

@@ -0,0 +1,35 @@
+/*
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import type { CoreShaderType } from '../../renderers/CoreShaderNode.js';
+import { RoundedTemplate, type RoundedProps } from './RoundedTemplate.js';
+import type { PrefixedType } from './shaderUtils.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,106 @@
+/*
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import type { CoreShaderType } from '../../renderers/CoreShaderNode.js';
+import type { PrefixedType } from './shaderUtils.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,
+};