@rosalana/sandbox 0.0.4 → 0.1.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import type { AnyUniformValue, HookCallback, SandboxOptions, UniformSchema, WebGLVersion } from "./types";
+import type { AnyUniformValue, HookCallback, ModuleDefinition, SandboxOptions, UniformSchema, WebGLVersion } from "./types";
 export * from "./types";
 export * from "./errors";
 /**
@@ -23,11 +23,13 @@ export declare class Sandbox {
     /** Active event listeners */
     private listeners;
     /** HTML canvas element */
-    private canvas;
+    private canvasEl;
     /** Resolved options */
     private options;
     /** WebGL engine */
     private engine;
+    /** User sets custom vertex shader */
+    private usingCustomVertex;
     constructor(canvas: HTMLCanvasElement, options?: SandboxOptions);
     /**
      * Sandbox - A lightweight WebGL wrapper for shader effects.
@@ -48,6 +50,34 @@ export declare class Sandbox {
      * });
      */
     static create(canvas: HTMLCanvasElement, options?: SandboxOptions): Sandbox;
+    /**
+     * Define a shader module that can be imported in shader source with `#import <function> from "module_name"`.
+     * @example
+     * Sandbox.defineModule("my_module", source, { options });
+     * // Then in shader:
+     * // #import myFunc from "my_module"
+     * // void main() {
+     * //   myFunc();
+     * // }
+     */
+    static defineModule(name: ModuleDefinition["name"], source: ModuleDefinition["source"], options?: ModuleDefinition["options"]): void;
+    /**
+     * Get the list of available shader modules that can be used with `#import` in shader source.
+     */
+    static availableModules(): {
+        name: string;
+        methods: string[];
+        uniforms: {
+            name: string;
+            type: import("./types").GLSLType;
+        }[];
+        options: Record<string, Record<string, import("./types").ModuleMethodOption>> | undefined;
+    }[];
+    /**
+     * Compile a shader source with Sandbox's shader preprocessor and return the final GLSL code.
+     * This is useful for debugging shader code or precompiling shaders for production use.
+     */
+    static compile(shaderSource: string): string;
     private resolveOptions;
     private setupListeners;
     private destroyListeners;
@@ -93,10 +123,32 @@ export declare class Sandbox {
      * sandbox.setFragment(fragmentSource);
      */
     setFragment(fragment: string): this;
+    /**
+     * Get current fragment shader source.
+     */
+    getFragment(): string;
+    /**
+     * Get current vertex shader source.
+     */
+    getVertex(): string;
+    /**
+     * Set the max frame rate runtime
+     *
+     * @example
+     * sandbox.setFps(30); // Limit to 30 FPS
+     * sandbox.setFps(0);  // Unlimited FPS
+     */
+    setFps(fps: number): this;
     /**
      * Add a runtime render hook.
      */
     hook(callback: HookCallback, when?: "before" | "after"): () => void;
+    /**
+     * Runtime configure the module behavior
+     * @example
+     * sandbox.module("my_module", { intensity: 0.5 });
+     */
+    module<T extends Record<string, AnyUniformValue>>(name: string, config: T): this;
     /**
      * Start animation loop.
      */
@@ -140,11 +192,11 @@ export declare class Sandbox {
     /**
      * Get WebGL version using (1 or 2).
      */
-    webglVersion(): WebGLVersion;
+    get version(): WebGLVersion;
     /**
      * Get canvas element.
      */
-    canvasElement(): HTMLCanvasElement;
+    get canvas(): HTMLCanvasElement;
     /**
      * Destroy sandbox and release all resources.
      * @example