Taos API Reference
    Preparing search index...

    Class SdfVolume

    A baked signed-distance field stored as a 3D r32float texture plus an AABB transform. Sampled by particle modifiers (sdf_attractor, sdf_collision) and the sdf_surface spawn shape.

    Owns its GPU texture; call destroy when done.

    Index

    Properties

    texture: GPUTexture
    sampler: GPUSampler
    resolution: [number, number, number]
    worldMin: [number, number, number]
    worldMax: [number, number, number]

    Accessors

    • get extent(): [number, number, number]

      World-space extent along each axis (worldMax - worldMin).

      Returns [number, number, number]

    Methods

    • Bakes an SDF from a Mesh created with keepData: true. Extracts positions from the retained interleaved vertex data (stride = VERTEX_STRIDE) and forwards to bakeFromMesh.

      worldOffset translates the mesh positions before baking so the SDF's AABB aligns with where the mesh is rendered in world space (the particle pass samples the SDF in world coordinates). For a mesh drawn at Mat4.translation(x,y,z), pass worldOffset: [x, y, z]. Defaults to [0,0,0] — mesh local == world.

      Throws if the Mesh wasn't built with keepData: true.

      Parameters

      • ctx: RenderContext
      • mesh: Mesh
      • Optionalopts: {
            resolution?: number | [number, number, number];
            padding?: number;
            worldOffset?: [number, number, number];
        }

      Returns SdfVolume