@woosh/meep-engine 3.64.0 → 3.65.0

package/src/shade/renderer/grass/blade/GPUGrassBlades.d.ts

@@ -0,0 +1,135 @@
+/**
+ * Grass blades on the device: the species list, and the passes that make a view's blades each frame and
+ * draw them (`GRASS_BLADE.js`).
+ *
+ * Blades stand on the surfels {@link GPUGrassSurfaces} keeps; nothing of a blade outlives its frame.
+ *
+ * Each frame: {@link update} once; then for every view that draws grass {@link graph_generate}, after the
+ * surfaces' own passes for the view, after whatever publishes the scene's wind for the frame (the blades
+ * are bent by it), and before anything reads the scene's depth for the frame's image; and
+ * {@link graph_draw} at the frame phase where the G-buffer is written into.
+ *
+ * The blades are pushed over by the scene's fluid obstacles through {@link press}, a field this owns and
+ * stamps as part of making a view's blades.
+ */
+export class GPUGrassBlades {
+    /**
+     * Offer the pipelines the blades' passes run — see {@link PipelineEnquiry}.
+     *
+     * @param {PipelineEnquiry} enquiry
+     */
+    static enquirePipelines(enquiry: PipelineEnquiry): void;
+    /**
+     * @param {GraphicsContext} graphics
+     * @param {GPUGrassSurfaces} surfaces whose surfels the blades stand on
+     */
+    constructor(graphics: GraphicsContext, surfaces: GPUGrassSurfaces);
+    /**
+     * Where obstacles have pressed the grass down, and its settings.
+     *
+     * @readonly
+     * @type {GPUGrassPress}
+     */
+    readonly press: GPUGrassPress;
+    /**
+     * @returns {number} blades a frame's list has room for
+     */
+    get blade_capacity(): number;
+    /**
+     * @returns {number} the most blades a view's list was asked to hold, as last read off the device
+     */
+    get blades_asked(): number;
+    /**
+     * The species list on the device. Null before the first {@link update}, and replaced when it grows.
+     *
+     * @returns {GPUBuffer|null}
+     */
+    get species_buffer(): any;
+    /**
+     * The blades' clock on the device (`GRASS_BLADE_CLOCK_STRUCT`). Null before the first {@link update}.
+     *
+     * @returns {GPUBuffer|null}
+     */
+    get clock_buffer(): any;
+    /**
+     * Set a species' record.
+     *
+     * @param {number} index the species' place in the list, as `mesh_ground_covers` rows name it
+     * @param {object} species
+     * @param {number} species.blade_length metres
+     * @param {number} species.blade_width metres
+     * @param {number} species.density blades a square metre
+     * @param {number} species.roughness
+     * @param {number[]} species.color_root linear rgb
+     * @param {number[]} species.color_tip linear rgb
+     * @param {number} species.length_variation how much of its length a blade can lack, 0 to 1
+     * @param {number} species.lean the most a blade leans from upright at its root, radians
+     * @param {number} species.curl the most a blade's tip turns further than its root leans, radians
+     * @param {number} species.tint how far a blade's colour strays from its species', as a share of it
+     * @param {number} species.roundness how far a blade's normal turns towards its edges
+     * @param {number} species.elastic_modulus of the blade's tissue in bending, Pa
+     * @param {number} species.blade_depth depth of the blade's section in bending, metres
+     * @param {number} species.turbulence how unsteady the wind a blade feels is, as a share of its speed
+     */
+    set_species(index: number, species: {
+        blade_length: number;
+        blade_width: number;
+        density: number;
+        roughness: number;
+        color_root: number[];
+        color_tip: number[];
+        length_variation: number;
+        lean: number;
+        curl: number;
+        tint: number;
+        roundness: number;
+        elastic_modulus: number;
+        blade_depth: number;
+        turbulence: number;
+    }): void;
+    /**
+     * Begin a frame: move the blades' clock and the press's on, bring the device's species list up to
+     * date, and make room for the blades the last frames' lists were asked to hold. Call once a frame,
+     * before any view's {@link graph_generate}.
+     *
+     * @param {number} time_delta_seconds how far the scene's clock has moved since the last call
+     */
+    update(time_delta_seconds: number): void;
+    /**
+     * Record the passes that make a view's blades: stamp the press field, count the cells, sum, and make
+     * the blades the counts allow. Records nothing while nothing grows.
+     *
+     * @param {object} options
+     * @param {FrameGraph} options.graph
+     * @param {GPUViewContext} options.view the view; its scene is the surfaces' scene
+     * @param {GPUFluidForcing|null} [options.forcing] the scene's GPU fluid forcing, whose obstacles press
+     *        the blades; none press without it
+     */
+    graph_generate({ graph, view, forcing }: {
+        graph: FrameGraph;
+        view: GPUViewContext;
+        forcing?: GPUFluidForcing | null;
+    }): void;
+    /**
+     * Record a view's blade draw: its blades into the blade id target under the scene's depth, then the
+     * G-buffer's surface, the visibility word and the velocity under every pixel a blade covers. Publishes
+     * the depth, the G-buffer targets, the visibility buffer and the velocity buffer it wrote. Records nothing for a view {@link graph_generate} made no blades for this frame.
+     *
+     * @param {FrameContext} frame at the phase where the G-buffer is written into
+     */
+    graph_draw(frame: FrameContext): void;
+    /**
+     * Let go of everything on the device. The species stay listed.
+     */
+    destroy(): void;
+    #private;
+}
+export type FrameGraph = import("../../../../engine/graphics/render/frame_graph/FrameGraph.js").FrameGraph;
+export type PipelineEnquiry = import("../../../device/pipeline/PipelineEnquiry.js").PipelineEnquiry;
+export type FrameContext = import("../../extension/FrameContext.js").FrameContext;
+export type GPUFluidForcing = import("../../fluid/forcing/GPUFluidForcing.js").GPUFluidForcing;
+export type GraphicsContext = import("../../GraphicsContext.js").GraphicsContext;
+export type GPUViewContext = import("../../view/GPUViewContext.js").GPUViewContext;
+export type GPUGrassSurfaces = import("../surface/GPUGrassSurfaces.js").GPUGrassSurfaces;
+import { GPUGrassPress } from "../press/GPUGrassPress.js";
+//# sourceMappingURL=GPUGrassBlades.d.ts.map

package/src/shade/renderer/grass/blade/GPUGrassBlades.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GPUGrassBlades.d.ts","sourceRoot":"","sources":["../../../../../../src/shade/renderer/grass/blade/GPUGrassBlades.js"],"names":[],"mappings":"AAsFA;;;;;;;;;;;;;GAaG;AACH;IAEI;;;;OAIG;IACH,iCAFW,eAAe,QAWzB;IAmED;;;OAGG;IACH,sBAHW,eAAe,YACf,gBAAgB,EAW1B;IA9ED;;;;;OAKG;IACH,gBAFU,aAAa,CAEjB;IA0EN;;OAEG;IACH,6BAEC;IAED;;OAEG;IACH,2BAEC;IAED;;;;OAIG;IACH,0BAEC;IAED;;;;OAIG;IACH,wBAEC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,mBAjBW,MAAM;QAEU,YAAY,EAA5B,MAAM;QACU,WAAW,EAA3B,MAAM;QACU,OAAO,EAAvB,MAAM;QACU,SAAS,EAAzB,MAAM;QACY,UAAU,EAA5B,MAAM,EAAE;QACU,SAAS,EAA3B,MAAM,EAAE;QACQ,gBAAgB,EAAhC,MAAM;QACU,IAAI,EAApB,MAAM;QACU,IAAI,EAApB,MAAM;QACU,IAAI,EAApB,MAAM;QACU,SAAS,EAAzB,MAAM;QACU,eAAe,EAA/B,MAAM;QACU,WAAW,EAA3B,MAAM;QACU,UAAU,EAA1B,MAAM;aA0ChB;IAED;;;;;;OAMG;IACH,2BAFW,MAAM,QAyDhB;IAED;;;;;;;;;OASG;IACH;QAL+B,KAAK,EAAzB,UAAU;QACc,IAAI,EAA5B,cAAc;QACiB,OAAO,GAAtC,eAAe,GAAC,IAAI;aA8J9B;IAED;;;;;;OAMG;IACH,kBAFW,YAAY,QAqItB;IAED;;OAEG;IACH,gBAQC;;CACJ;yBA/nBY,OAAO,8DAA8D,EAAE,UAAU;8BACjF,OAAO,6CAA6C,EAAE,eAAe;2BACrE,OAAO,iCAAiC,EAAE,YAAY;8BACtD,OAAO,wCAAwC,EAAE,eAAe;8BAChE,OAAO,0BAA0B,EAAE,eAAe;6BAClD,OAAO,8BAA8B,EAAE,cAAc;+BACrD,OAAO,gCAAgC,EAAE,gBAAgB;8BA1BxC,2BAA2B"}