Taos API Reference
    Preparing search index...

    Class CloudPass

    Volumetric cloud + procedural sky pass (render-graph version).

    Hierarchy (View Summary)

    • Pass<CloudDeps, CloudOutputs>
      • CloudPass
    Index

    Properties

    name: "CloudPass" = 'CloudPass'

    Human-readable identifier used in graph node labels and error messages.

    Methods

    • Set the godray fog-curve value (mirrors GodrayPass.fogCurve). Must be called every frame the cloud-godray coupling is active so the cloud shader shapes its glow term the same way the sky composite does. Passing 0 (the default) disables the contribution — the host should call this with 0 whenever the CloudDeps.godrayFog dep is omitted.

      The value is written into the existing light uniform on the next updateLight call, so the host typically calls this before updateLight each frame.

      Parameters

      • fogCurve: number

      Returns void

    • Insert the pass into graph for one frame. Implementations call graph.addPass(name, type, b => { ... }) exactly once and use the supplied PassBuilder to declare reads, writes, transient resources, and the execute callback.

      Parameters

      • graph: RenderGraph

        Graph being built this frame.

      • deps: CloudDeps

        Pass-specific dependency record (handles, scene data, etc.).

      Returns CloudOutputs

      Pass-specific output record (typically a set of handles downstream passes will consume).

    • Release every long-lived GPU resource owned by the pass (pipelines, persistent uniform buffers, samplers, BGLs). Called by the factory or application during teardown. Default implementation is a no-op.

      Returns void