Hilo3d API - v2.0.0-alpha.4
    Preparing search index...

    Interface ParticleFlipbookOptions

    Options for packing real render-target captures into one flipbook atlas.

    interface ParticleFlipbookOptions {
        captureFrame: (
            context: Readonly<ParticleFlipbookFrameContext>,
        ) =>
            | RenderTargetColorAttachmentReadback
            | PromiseLike<RenderTargetColorAttachmentReadback>;
        columns?: number;
        duration: number;
        frameRate: number;
        includeEnd?: boolean;
        maxAtlasByteLength?: number;
        maxFrames?: number;
        maxTextureSize?: number;
        startTime?: number;
    }

    Hierarchy (View Summary)

    Index
    captureFrame columns? duration frameRate includeEnd? maxAtlasByteLength? maxFrames? maxTextureSize? startTime?
    captureFrame: (
        context: Readonly<ParticleFlipbookFrameContext>,
    ) =>
        | RenderTargetColorAttachmentReadback
        | PromiseLike<RenderTargetColorAttachmentReadback>

    Render and asynchronously read one tightly packed color attachment.

    columns?: number

    Atlas column count. Defaults to a near-square layout.

    duration: number

    Sampled duration in seconds.

    frameRate: number

    Samples per second.

    includeEnd?: boolean

    Add one exact sample at startTime + duration. Defaults to false.

    maxAtlasByteLength?: number

    Safety limit for the packed atlas payload. Defaults to 256 MiB.

    maxFrames?: number

    Safety limit for generated frames. Defaults to 4096.

    maxTextureSize?: number

    Safety limit for either atlas dimension. Defaults to 16384.

    startTime?: number

    Seconds simulated before the first captured frame. Defaults to zero.

    Settings
    Member Visibility

    On This Page
    Properties