@remotion/effects 4.0.483 → 4.0.484

package/dist/esm/linear-gradient.mjs

@@ -0,0 +1,372 @@
+// src/linear-gradient.ts
+import { Internals } from "remotion";
+
+// src/validate-effect-param.ts
+var assertEffectParamsObject = (params, effectLabel) => {
+  if (params === null || typeof params !== "object") {
+    throw new TypeError(`${effectLabel} effect requires a parameters object, but got ${JSON.stringify(params)}`);
+  }
+};
+var assertRequiredFiniteNumber = (value, name) => {
+  if (typeof value !== "number" || !Number.isFinite(value)) {
+    throw new TypeError(`"${name}" must be a finite number, but got ${JSON.stringify(value)}`);
+  }
+};
+var assertRequiredColor = (value, name) => {
+  if (typeof value !== "string" || value.length === 0) {
+    throw new TypeError(`"${name}" must be a non-empty string, but got ${JSON.stringify(value)}`);
+  }
+};
+var assertOptionalColor = (value, name) => {
+  if (value === undefined) {
+    return;
+  }
+  assertRequiredColor(value, name);
+};
+var assertOptionalBoolean = (value, name) => {
+  if (value === undefined) {
+    return;
+  }
+  if (typeof value !== "boolean") {
+    throw new TypeError(`"${name}" must be a boolean, but got ${JSON.stringify(value)}`);
+  }
+};
+
+// src/color-utils.ts
+var DEFAULT_AMOUNT = 1;
+var DEFAULT_BRIGHTNESS_AMOUNT = 0;
+var DEFAULT_HUE_DEGREES = 0;
+var colorAmountSchema = {
+  type: "number",
+  min: 0,
+  max: 1,
+  step: 0.01,
+  default: DEFAULT_AMOUNT,
+  description: "Amount",
+  hiddenFromList: false
+};
+var colorMultiplierSchema = {
+  type: "number",
+  min: 0,
+  step: 0.01,
+  default: DEFAULT_AMOUNT,
+  description: "Amount",
+  hiddenFromList: false
+};
+var brightnessAmountSchema = {
+  type: "number",
+  min: -1,
+  max: 1,
+  step: 0.01,
+  default: DEFAULT_BRIGHTNESS_AMOUNT,
+  description: "Amount",
+  hiddenFromList: false
+};
+var hueDegreesSchema = {
+  type: "rotation-degrees",
+  step: 1,
+  default: DEFAULT_HUE_DEGREES,
+  description: "Degrees"
+};
+var assertOptionalFiniteNumber = (value, name) => {
+  if (value === undefined) {
+    return;
+  }
+  assertRequiredFiniteNumber(value, name);
+};
+var validateUnitInterval = (value, name) => {
+  if (value < 0) {
+    throw new TypeError(`"${name}" must be >= 0, but got ${JSON.stringify(value)}`);
+  }
+  if (value > 1) {
+    throw new TypeError(`"${name}" must be <= 1, but got ${JSON.stringify(value)}`);
+  }
+};
+var validateNonNegative = (value, name) => {
+  if (value < 0) {
+    throw new TypeError(`"${name}" must be >= 0, but got ${JSON.stringify(value)}`);
+  }
+};
+var validateSignedUnitInterval = (value, name) => {
+  if (value < -1) {
+    throw new TypeError(`"${name}" must be >= -1, but got ${JSON.stringify(value)}`);
+  }
+  if (value > 1) {
+    throw new TypeError(`"${name}" must be <= 1, but got ${JSON.stringify(value)}`);
+  }
+};
+var clampColorChannel = (value) => {
+  return Math.max(0, Math.min(255, value));
+};
+var parseColorRgba = (ctx, color) => {
+  ctx.clearRect(0, 0, 1, 1);
+  ctx.fillStyle = color;
+  ctx.fillRect(0, 0, 1, 1);
+  const { data } = ctx.getImageData(0, 0, 1, 1);
+  return [data[0], data[1], data[2], data[3]];
+};
+
+// src/linear-gradient.ts
+var { createEffect, createWebGL2ContextError } = Internals;
+var DEFAULT_START = [0, 0.5];
+var DEFAULT_END = [1, 0.5];
+var DEFAULT_START_COLOR = "#000000";
+var DEFAULT_END_COLOR = "#ffffff";
+var linearGradientSchema = {
+  start: {
+    type: "uv-coordinate",
+    min: -1,
+    max: 2,
+    step: 0.01,
+    default: DEFAULT_START,
+    description: "Start",
+    visual: {
+      type: "line",
+      to: "end"
+    }
+  },
+  end: {
+    type: "uv-coordinate",
+    min: -1,
+    max: 2,
+    step: 0.01,
+    default: DEFAULT_END,
+    description: "End"
+  },
+  startColor: {
+    type: "color",
+    default: DEFAULT_START_COLOR,
+    description: "Start color"
+  },
+  endColor: {
+    type: "color",
+    default: DEFAULT_END_COLOR,
+    description: "End color"
+  }
+};
+var resolve = (p) => ({
+  start: [...p.start ?? DEFAULT_START],
+  end: [...p.end ?? DEFAULT_END],
+  startColor: p.startColor ?? DEFAULT_START_COLOR,
+  endColor: p.endColor ?? DEFAULT_END_COLOR
+});
+var assertOptionalUvCoordinate = (value, name) => {
+  if (value === undefined) {
+    return;
+  }
+  if (!Array.isArray(value) || value.length !== 2 || value.some((item) => typeof item !== "number" || !Number.isFinite(item))) {
+    throw new TypeError(`"${name}" must be a [number, number] tuple`);
+  }
+};
+var validateLinearGradientParams = (params) => {
+  assertEffectParamsObject(params, "Linear gradient");
+  assertOptionalUvCoordinate(params.start, "start");
+  assertOptionalUvCoordinate(params.end, "end");
+  assertOptionalColor(params.startColor, "startColor");
+  assertOptionalColor(params.endColor, "endColor");
+};
+var VERTEX_SHADER = `#version 300 es
+in vec2 aPos;
+in vec2 aUv;
+out vec2 vUv;
+
+void main() {
+	vUv = aUv;
+	gl_Position = vec4(aPos, 0.0, 1.0);
+}
+`;
+var FRAGMENT_SHADER = `#version 300 es
+precision highp float;
+
+in vec2 vUv;
+out vec4 fragColor;
+
+uniform vec2 uStart;
+uniform vec2 uEnd;
+uniform vec4 uStartColor;
+uniform vec4 uEndColor;
+
+float gradientProgress(vec2 uv) {
+	vec2 gradient = uEnd - uStart;
+	float gradientLengthSq = dot(gradient, gradient);
+	if (gradientLengthSq <= 0.0000001) {
+		return 0.0;
+	}
+
+	return clamp(dot(uv - uStart, gradient) / gradientLengthSq, 0.0, 1.0);
+}
+
+void main() {
+	vec2 publicUv = vec2(vUv.x, 1.0 - vUv.y);
+	vec4 color = mix(uStartColor, uEndColor, gradientProgress(publicUv));
+	fragColor = vec4(color.rgb * color.a, color.a);
+}
+`;
+var compileShader = (gl, type, source) => {
+  const shader = gl.createShader(type);
+  if (!shader) {
+    throw new Error("Failed to create WebGL shader");
+  }
+  gl.shaderSource(shader, source);
+  gl.compileShader(shader);
+  if (!gl.getShaderParameter(shader, gl.COMPILE_STATUS)) {
+    const log = gl.getShaderInfoLog(shader);
+    gl.deleteShader(shader);
+    throw new Error(`Linear gradient shader compile failed: ${log ?? "(no log)"}`);
+  }
+  return shader;
+};
+var createProgram = (gl) => {
+  const vs = compileShader(gl, gl.VERTEX_SHADER, VERTEX_SHADER);
+  const fs = compileShader(gl, gl.FRAGMENT_SHADER, FRAGMENT_SHADER);
+  const program = gl.createProgram();
+  if (!program) {
+    throw new Error("Failed to create WebGL program");
+  }
+  gl.attachShader(program, vs);
+  gl.attachShader(program, fs);
+  gl.linkProgram(program);
+  gl.deleteShader(vs);
+  gl.deleteShader(fs);
+  if (!gl.getProgramParameter(program, gl.LINK_STATUS)) {
+    const log = gl.getProgramInfoLog(program);
+    gl.deleteProgram(program);
+    throw new Error(`Linear gradient program link failed: ${log ?? "(no log)"}`);
+  }
+  return program;
+};
+var setupLinearGradient = (target) => {
+  const gl = target.getContext("webgl2", {
+    premultipliedAlpha: true,
+    alpha: true,
+    preserveDrawingBuffer: true
+  });
+  if (!gl) {
+    throw createWebGL2ContextError("linear gradient effect");
+  }
+  const program = createProgram(gl);
+  const vao = gl.createVertexArray();
+  if (!vao) {
+    throw new Error("Failed to create WebGL vertex array");
+  }
+  gl.bindVertexArray(vao);
+  const data = new Float32Array([
+    -1,
+    -1,
+    0,
+    0,
+    1,
+    -1,
+    1,
+    0,
+    -1,
+    1,
+    0,
+    1,
+    1,
+    1,
+    1,
+    1
+  ]);
+  const vbo = gl.createBuffer();
+  if (!vbo) {
+    throw new Error("Failed to create WebGL buffer");
+  }
+  gl.bindBuffer(gl.ARRAY_BUFFER, vbo);
+  gl.bufferData(gl.ARRAY_BUFFER, data, gl.STATIC_DRAW);
+  const aPos = gl.getAttribLocation(program, "aPos");
+  const aUv = gl.getAttribLocation(program, "aUv");
+  gl.enableVertexAttribArray(aPos);
+  gl.vertexAttribPointer(aPos, 2, gl.FLOAT, false, 16, 0);
+  gl.enableVertexAttribArray(aUv);
+  gl.vertexAttribPointer(aUv, 2, gl.FLOAT, false, 16, 8);
+  gl.bindVertexArray(null);
+  const colorCanvas = document.createElement("canvas");
+  colorCanvas.width = 1;
+  colorCanvas.height = 1;
+  const colorCtx = colorCanvas.getContext("2d", { willReadFrequently: true });
+  if (!colorCtx) {
+    throw new Error("Failed to acquire 2D context for color parsing");
+  }
+  return {
+    gl,
+    program,
+    vao,
+    vbo,
+    uniforms: {
+      uStart: gl.getUniformLocation(program, "uStart"),
+      uEnd: gl.getUniformLocation(program, "uEnd"),
+      uStartColor: gl.getUniformLocation(program, "uStartColor"),
+      uEndColor: gl.getUniformLocation(program, "uEndColor")
+    },
+    colorCtx,
+    cachedStartColor: "",
+    cachedStartColorRgba: [0, 0, 0, 255],
+    cachedEndColor: "",
+    cachedEndColorRgba: [255, 255, 255, 255]
+  };
+};
+var normalizedRgba = (color) => {
+  return [color[0] / 255, color[1] / 255, color[2] / 255, color[3] / 255];
+};
+var getParsedColors = (state, resolved) => {
+  if (state.cachedStartColor !== resolved.startColor) {
+    state.cachedStartColor = resolved.startColor;
+    state.cachedStartColorRgba = parseColorRgba(state.colorCtx, resolved.startColor);
+  }
+  if (state.cachedEndColor !== resolved.endColor) {
+    state.cachedEndColor = resolved.endColor;
+    state.cachedEndColorRgba = parseColorRgba(state.colorCtx, resolved.endColor);
+  }
+  return {
+    start: state.cachedStartColorRgba,
+    end: state.cachedEndColorRgba
+  };
+};
+var linearGradient = createEffect({
+  type: "dev.remotion.effects.linearGradient",
+  label: "linearGradient()",
+  documentationLink: "https://www.remotion.dev/docs/effects/linear-gradient",
+  backend: "webgl2",
+  calculateKey: (params) => {
+    const r = resolve(params);
+    return `linear-gradient-${r.start.join(":")}-${r.end.join(":")}-${r.startColor}-${r.endColor}`;
+  },
+  setup: (target) => setupLinearGradient(target),
+  apply: ({ width, height, params, state }) => {
+    const r = resolve(params);
+    const { start, end } = getParsedColors(state, r);
+    const [sr, sg, sb, sa] = normalizedRgba(start);
+    const [er, eg, eb, ea] = normalizedRgba(end);
+    const { gl, program, uniforms, vao } = state;
+    gl.viewport(0, 0, width, height);
+    gl.bindFramebuffer(gl.FRAMEBUFFER, null);
+    gl.clearColor(0, 0, 0, 0);
+    gl.clear(gl.COLOR_BUFFER_BIT);
+    gl.useProgram(program);
+    if (uniforms.uStart)
+      gl.uniform2f(uniforms.uStart, r.start[0], r.start[1]);
+    if (uniforms.uEnd)
+      gl.uniform2f(uniforms.uEnd, r.end[0], r.end[1]);
+    if (uniforms.uStartColor) {
+      gl.uniform4f(uniforms.uStartColor, sr, sg, sb, sa);
+    }
+    if (uniforms.uEndColor) {
+      gl.uniform4f(uniforms.uEndColor, er, eg, eb, ea);
+    }
+    gl.bindVertexArray(vao);
+    gl.drawArrays(gl.TRIANGLE_STRIP, 0, 4);
+    gl.bindVertexArray(null);
+    gl.useProgram(null);
+  },
+  cleanup: ({ gl, program, vao, vbo }) => {
+    gl.deleteBuffer(vbo);
+    gl.deleteProgram(program);
+    gl.deleteVertexArray(vao);
+  },
+  schema: linearGradientSchema,
+  validateParams: validateLinearGradientParams
+});
+export {
+  linearGradient
+};

package/dist/index.d.ts

@@ -3,4 +3,6 @@ export { pattern, type PatternOrigin, type PatternParams } from './pattern.js';
 export { rings, type RingsCenter, type RingsParams } from './rings.js';
 export { gridlines, type GridlinesParams } from './gridlines.js';
 export { zigzag, type ZigzagDirection, type ZigzagParams } from './zigzag.js';
+export { linearGradient, type LinearGradientParams, type LinearGradientUvCoordinate, } from './linear-gradient.js';
+export { linearGradientTint, type LinearGradientTintParams, type LinearGradientTintUvCoordinate, } from './linear-gradient-tint.js';
 export { cornerPin, type CornerPinParams, type CornerPinUvCoordinate, } from './corner-pin/index.js';

package/dist/linear-gradient-tint.d.ts

@@ -0,0 +1,26 @@
+export type LinearGradientTintUvCoordinate = readonly [number, number];
+export type LinearGradientTintParams = {
+    /**
+     * UV coordinate where `startColor` is reached. Defaults to `[0, 0.5]`.
+     */
+    readonly start?: LinearGradientTintUvCoordinate;
+    /**
+     * UV coordinate where `endColor` is reached. Defaults to `[1, 0.5]`.
+     */
+    readonly end?: LinearGradientTintUvCoordinate;
+    /**
+     * Tint color at `start`. Defaults to black.
+     */
+    readonly startColor?: string;
+    /**
+     * Tint color at `end`. Defaults to white.
+     */
+    readonly endColor?: string;
+    /**
+     * Tint blend amount from `0` to `1`. Defaults to `0.5`.
+     */
+    readonly amount?: number;
+};
+export declare const linearGradientTint: (params?: (LinearGradientTintParams & {
+    readonly disabled?: boolean | undefined;
+}) | undefined) => import("remotion").EffectDescriptor<unknown>;

package/dist/linear-gradient.d.ts

@@ -0,0 +1,22 @@
+export type LinearGradientUvCoordinate = readonly [number, number];
+export type LinearGradientParams = {
+    /**
+     * UV coordinate where `startColor` is reached. Defaults to `[0, 0.5]`.
+     */
+    readonly start?: LinearGradientUvCoordinate;
+    /**
+     * UV coordinate where `endColor` is reached. Defaults to `[1, 0.5]`.
+     */
+    readonly end?: LinearGradientUvCoordinate;
+    /**
+     * Color at `start`. Defaults to black.
+     */
+    readonly startColor?: string;
+    /**
+     * Color at `end`. Defaults to white.
+     */
+    readonly endColor?: string;
+};
+export declare const linearGradient: (params?: (LinearGradientParams & {
+    readonly disabled?: boolean | undefined;
+}) | undefined) => import("remotion").EffectDescriptor<unknown>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@remotion/effects",
-	"version": "4.0.483",
+	"version": "4.0.484",
 	"description": "Effects that can be applied to Remotion-based canvas components",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -26,7 +26,7 @@
 		"url": "https://github.com/remotion-dev/remotion/issues"
 	},
 	"dependencies": {
-		"remotion": "4.0.483"
+		"remotion": "4.0.484"
 	},
 	"exports": {
 		".": {
@@ -159,6 +159,16 @@
 			"module": "./dist/esm/lines.mjs",
 			"import": "./dist/esm/lines.mjs"
 		},
+		"./linear-gradient": {
+			"types": "./dist/linear-gradient.d.ts",
+			"module": "./dist/esm/linear-gradient.mjs",
+			"import": "./dist/esm/linear-gradient.mjs"
+		},
+		"./linear-gradient-tint": {
+			"types": "./dist/linear-gradient-tint.d.ts",
+			"module": "./dist/esm/linear-gradient-tint.mjs",
+			"import": "./dist/esm/linear-gradient-tint.mjs"
+		},
 		"./linear-progressive-blur": {
 			"types": "./dist/linear-progressive-blur.d.ts",
 			"module": "./dist/esm/linear-progressive-blur.mjs",
@@ -363,6 +373,12 @@
 			"lines": [
 				"dist/lines.d.ts"
 			],
+			"linear-gradient": [
+				"dist/linear-gradient.d.ts"
+			],
+			"linear-gradient-tint": [
+				"dist/linear-gradient-tint.d.ts"
+			],
 			"linear-progressive-blur": [
 				"dist/linear-progressive-blur.d.ts"
 			],
@@ -442,7 +458,7 @@
 	},
 	"homepage": "https://www.remotion.dev/docs/effects/api",
 	"devDependencies": {
-		"@remotion/eslint-config-internal": "4.0.483",
+		"@remotion/eslint-config-internal": "4.0.484",
 		"@vitest/browser-playwright": "4.0.9",
 		"eslint": "9.19.0",
 		"vitest": "4.0.9",