OpenFairyGUI API
    Preparing search index...

    Interface ResolvedPublishAtlasOptions

    interface ResolvedPublishAtlasOptions {
        allowRotation?: boolean;
        extractAlpha?: boolean;
        fast?: boolean;
        maxSize?: number;
        multiPage?: boolean;
        padding?: number;
        powerOfTwo?: boolean;
        square?: boolean;
        trimImage?: boolean;
    }

    Hierarchy

    • Pick<
          AtlasOptions,
          | "maxSize"
          | "fast"
          | "allowRotation"
          | "padding"
          | "powerOfTwo"
          | "square"
          | "multiPage"
          | "trimImage"
          | "extractAlpha",
      >
      • ResolvedPublishAtlasOptions
    Index
    allowRotation? extractAlpha? fast? maxSize? multiPage? padding? powerOfTwo? square? trimImage?
    allowRotation?: boolean

    Allow rotating sprites 90° for better packing. Default: true.

    extractAlpha?: boolean

    Internal publish detail used by the direct-image-output path. When extractAlpha is enabled, the direct output shortcut must be disabled.

    fast?: boolean

    Whether to use the fast editor-compatible packing heuristics. Default: true.

    maxSize?: number

    Maximum atlas texture size (width and height). Default: 2048.

    multiPage?: boolean

    Allow spilling into multiple atlas pages. Default: true.

    padding?: number

    Pixel padding between sprites. Default: 1.

    powerOfTwo?: boolean

    Constrain atlas dimensions to powers of two. Default: false.

    square?: boolean

    Force square atlas (width === height). Default: false.

    trimImage?: boolean

    Trim transparent pixels from image edges before packing. Requires a raster backend. Stores offset/originalSize in Sprite nodes. Default: false.

    Settings
    Member Visibility

    On This Page
    Properties