@hyperframes/shader-transitions 0.6.6 → 0.6.8

package/dist/index.d.cts

@@ -40,4 +40,59 @@ declare function init(config: HyperShaderConfig): GsapTimeline;
 
 declare function isHtmlInCanvasCaptureSupported(): boolean;
 
-export { type HyperShaderConfig, SHADER_NAMES, type ShaderName, type TransitionConfig, init, isHtmlInCanvasCaptureSupported };
+interface AccentColors {
+    accent: [number, number, number];
+    dark: [number, number, number];
+    bright: [number, number, number];
+}
+
+/**
+ * engineModePageComposite — page-side WebGL compositor for engine render mode.
+ *
+ * Opt-in via `window.__HF_PAGE_SIDE_COMPOSITING__ = true` (set by the producer
+ * when `EngineConfig.enablePageSideCompositing` is true). When the flag is
+ * off, hyper-shader's engine-mode path stays on the opacity-flip-only timeline
+ * and the producer's hf#677 Node-side layered pipeline runs the shader blend.
+ *
+ * Two-phase capture protocol:
+ *
+ *  Phase 1 (seek wrapper, runs inside page.evaluate):
+ *    - Runs original GSAP seek to position the timeline
+ *    - If inside a transition window, clones FROM/TO scene elements into
+ *      layoutsubtree staging canvases
+ *    - Sets window.__hf_page_composite_pending with transition metadata
+ *    - Returns immediately (seek resolves)
+ *
+ *  Paint force (engine-side, frameCapture.ts):
+ *    - Engine detects the pending flag and fires a micro Page.captureScreenshot
+ *      to force the browser compositor to paint the staging canvas clones
+ *
+ *  Phase 2 (engine calls window.__hf_page_composite_resolve):
+ *    - drawElementImage reads the now-valid paint records from the clones
+ *    - Uploads textures to WebGL, runs the shader, shows the GL overlay
+ *    - Cleans up staging canvases
+ *
+ * This gives native-fidelity capture (identical to preview-path
+ * drawElementImage) without depending on requestAnimationFrame for paint.
+ */
+
+interface PageCompositeTransitionConfig {
+    time: number;
+    shader: ShaderName;
+    duration?: number;
+}
+interface PageCompositorInstallOptions {
+    scenes: string[];
+    transitions: PageCompositeTransitionConfig[];
+    bgColor: string;
+    accentColors: AccentColors;
+    width: number;
+    height: number;
+    defaultDuration: number;
+}
+declare const PAGE_COMPOSITOR_CANVAS_ID = "__hf-page-side-compositor";
+declare const PAGE_COMPOSITOR_BUILD_CANARY = "__hf_page_compositor_v1__";
+declare function isPageSideCompositingSupported(): boolean;
+declare function installPageSideCompositor(options: PageCompositorInstallOptions): boolean;
+
+export { type HyperShaderConfig, PAGE_COMPOSITOR_BUILD_CANARY, PAGE_COMPOSITOR_CANVAS_ID, SHADER_NAMES, type ShaderName, type TransitionConfig, init, installPageSideCompositor, isHtmlInCanvasCaptureSupported, isPageSideCompositingSupported };

package/dist/index.d.ts

@@ -40,4 +40,59 @@ declare function init(config: HyperShaderConfig): GsapTimeline;
 
 declare function isHtmlInCanvasCaptureSupported(): boolean;
 
-export { type HyperShaderConfig, SHADER_NAMES, type ShaderName, type TransitionConfig, init, isHtmlInCanvasCaptureSupported };
+interface AccentColors {
+    accent: [number, number, number];
+    dark: [number, number, number];
+    bright: [number, number, number];
+}
+
+/**
+ * engineModePageComposite — page-side WebGL compositor for engine render mode.
+ *
+ * Opt-in via `window.__HF_PAGE_SIDE_COMPOSITING__ = true` (set by the producer
+ * when `EngineConfig.enablePageSideCompositing` is true). When the flag is
+ * off, hyper-shader's engine-mode path stays on the opacity-flip-only timeline
+ * and the producer's hf#677 Node-side layered pipeline runs the shader blend.
+ *
+ * Two-phase capture protocol:
+ *
+ *  Phase 1 (seek wrapper, runs inside page.evaluate):
+ *    - Runs original GSAP seek to position the timeline
+ *    - If inside a transition window, clones FROM/TO scene elements into
+ *      layoutsubtree staging canvases
+ *    - Sets window.__hf_page_composite_pending with transition metadata
+ *    - Returns immediately (seek resolves)
+ *
+ *  Paint force (engine-side, frameCapture.ts):
+ *    - Engine detects the pending flag and fires a micro Page.captureScreenshot
+ *      to force the browser compositor to paint the staging canvas clones
+ *
+ *  Phase 2 (engine calls window.__hf_page_composite_resolve):
+ *    - drawElementImage reads the now-valid paint records from the clones
+ *    - Uploads textures to WebGL, runs the shader, shows the GL overlay
+ *    - Cleans up staging canvases
+ *
+ * This gives native-fidelity capture (identical to preview-path
+ * drawElementImage) without depending on requestAnimationFrame for paint.
+ */
+
+interface PageCompositeTransitionConfig {
+    time: number;
+    shader: ShaderName;
+    duration?: number;
+}
+interface PageCompositorInstallOptions {
+    scenes: string[];
+    transitions: PageCompositeTransitionConfig[];
+    bgColor: string;
+    accentColors: AccentColors;
+    width: number;
+    height: number;
+    defaultDuration: number;
+}
+declare const PAGE_COMPOSITOR_CANVAS_ID = "__hf-page-side-compositor";
+declare const PAGE_COMPOSITOR_BUILD_CANARY = "__hf_page_compositor_v1__";
+declare function isPageSideCompositingSupported(): boolean;
+declare function installPageSideCompositor(options: PageCompositorInstallOptions): boolean;
+
+export { type HyperShaderConfig, PAGE_COMPOSITOR_BUILD_CANARY, PAGE_COMPOSITOR_CANVAS_ID, SHADER_NAMES, type ShaderName, type TransitionConfig, init, installPageSideCompositor, isHtmlInCanvasCaptureSupported, isPageSideCompositingSupported };