Documentation
    Preparing search index...

    Interface ImageLoaderOptions

    RGBA8 size estimates and an optional enforced decoder heap ceiling (§96).

    interface ImageLoaderOptions {
        maximumDecodedBytes?: number;
        maximumExpansionRatio?: number;
        maximumWorkingBytes?: number;
        name?: string;
        probe?: TexelProbeLike;
        requireProbe?: boolean;
    }

    Hierarchy

    • Pick<
          TextureLoaderOptions,
          "name"
          | "probe"
          | "requireProbe"
          | "maximumWorkingBytes",
      >
      • ImageLoaderOptions
    Index
    maximumDecodedBytes? maximumExpansionRatio? maximumWorkingBytes? name? probe? requireProbe?
    maximumDecodedBytes?: number

    Bound on the width × height × 4 RGBA8 size estimate; default 64 MiB. Native bitmap storage can differ and is not measurable through this seam. Positive infinity disables this estimate check.

    maximumExpansionRatio?: number

    Maximum RGBA8 size estimate divided by encoded bytes; default 1000. Positive infinity disables this estimate check.

    maximumWorkingBytes?: number

    Require an enforced decoder linear-memory ceiling, in bytes. The decoder must come directly from a bounded factory with a ceiling no larger than this safe integer (64 KiB–4 GiB). Native callbacks are refused at construction. Omit for legacy platform decoding without a heap cap. Encoded input, returned RGBA bytes and row-flip copies are separate from the decoder heap; this is not a process-wide memory limit.

    name?: string

    Diagnostics label used in error context.loader. Defaults to "texture".

    probe?: TexelProbeLike

    Optional header reader; see TexelProbeLike and §96, above.

    requireProbe?: boolean

    Require a recognized dimension probe before decoding. Default false.

    Settings
    Member Visibility

    On This Page
    Properties