@motion-core/motion-gpu/dist/vue/motiongpu-context.d.ts

Framework-agnostic WebGPU runtime for fullscreen WGSL shaders with explicit Svelte, React, and Vue adapter entrypoints.

import { type InjectionKey } from 'vue';
import type { RenderMode } from '../core/types.js';
import type { CurrentReadable, CurrentWritable } from '../core/current-value.js';
import type { FrameProfilingSnapshot, FrameRunTimings, FrameScheduleSnapshot } from '../core/frame-registry.js';
import type { MotionGPUScheduler as CoreMotionGPUScheduler } from '../core/scheduler-helpers.js';
export type MotionGPUScheduler = CoreMotionGPUScheduler;
export type { FrameProfilingSnapshot, FrameRunTimings, FrameScheduleSnapshot };
/**
 * Namespace identifier for user-owned context entries.
 */
export type MotionGPUUserNamespace = string | symbol;
/**
 * Shared user context store exposed by `FragCanvas`.
 */
export type MotionGPUUserContext = CurrentWritable<Record<MotionGPUUserNamespace, unknown>>;
/**
 * Public `FragCanvas` runtime context available to composables and user components.
 */
export interface MotionGPUContext {
    /**
     * Underlying canvas element used by the renderer.
     */
    canvas: HTMLCanvasElement | undefined;
    /**
     * Reactive canvas pixel size.
     */
    size: CurrentReadable<{
        width: number;
        height: number;
    }>;
    /**
     * Device pixel ratio multiplier.
     */
    dpr: CurrentWritable<number>;
    /**
     * Max frame delta clamp passed to scheduled callbacks.
     */
    maxDelta: CurrentWritable<number>;
    /**
     * Scheduler render mode (`always`, `on-demand`, `manual`).
     */
    renderMode: CurrentWritable<RenderMode>;
    /**
     * Global toggle for automatic rendering.
     */
    autoRender: CurrentWritable<boolean>;
    /**
     * Namespaced user context store shared within the canvas subtree.
     */
    user: MotionGPUUserContext;
    /**
     * Marks current frame as invalidated.
     */
    invalidate: () => void;
    /**
     * Requests one manual frame advance.
     */
    advance: () => void;
    /**
     * Public scheduler API.
     */
    scheduler: MotionGPUScheduler;
}
/**
 * Vue injection key used to expose `FragCanvas` runtime state.
 */
export declare const motionGPUContextKey: InjectionKey<MotionGPUContext>;
/**
 * Registers the motiongpu context in the current Vue component tree.
 *
 * @param context - Context payload to provide.
 */
export declare function provideMotionGPUContext(context: MotionGPUContext): void;
/**
 * Returns the active motiongpu context.
 *
 * @returns Active context.
 * @throws {Error} When called outside `<FragCanvas>`.
 */
export declare function useMotionGPU(): MotionGPUContext;
//# sourceMappingURL=motiongpu-context.d.ts.map