VFX-JS
    Preparing search index...

    Type Alias EffectRenderTargetOpts

    type EffectRenderTargetOpts = {
        size?: readonly [number, number];
        float?: boolean;
        persistent?: boolean;
        wrap?: EffectTextureWrap | readonly [EffectTextureWrap, EffectTextureWrap];
        filter?: EffectTextureFilter;
        mipmap?: boolean | "manual";
    }
    Index

    Properties

    size? float? persistent? wrap? filter? mipmap?

    Properties

    size?: readonly [number, number]

    Size in physical pixels.
    If omitted, the target size will follow the source element size
    (element size * pixelRatio, auto-resized)

    float?: boolean

    Use 16F/32F render target. (Default: false)

    persistent?: boolean

    Whether the target content should persist across frames (Default: false).
    Useful for feedback effects like trails or motion blur.

    wrap?: EffectTextureWrap | readonly [EffectTextureWrap, EffectTextureWrap]

    Default: "clamp". Tuple form specifies [wrapS, wrapT].

    filter?: EffectTextureFilter

    Default: "linear".

    mipmap?: boolean | "manual"

    Allocate a full mip chain (Default: false).

    • false: no mip storage, single level. Identical to the
      pre-mipmap behaviour.
    • true: full mip chain allocated, auto-regenerated after every
      draw whose target is this RT.
    • "manual": full mip chain allocated, regenerated only when
      rt.generateMipmaps() is called.

    When mipmap is enabled, filter is auto-promoted on the MIN side:
    "linear" → trilinear, "nearest" → nearest-mip-nearest. MAG
    stays bilinear / nearest.

    Settings

    Member Visibility

    On This Page

    Properties