pixi.js
    Preparing search index...

    Variable spritesheetAssetConst Advanced

    spritesheetAsset: {
        cache: {
            getCacheableAssets: (
                keys: string[],
                asset: Spritesheet,
            ) => Record<string, any>;
            test: (asset: Spritesheet) => boolean;
        };
        extension: Asset;
        loader: {
            extension: {
                name: string;
                priority: LoaderParserPriority;
                type: LoadParser;
            };
            name: string;
            parse<T>(
                asset: SpriteSheetJson,
                options: ResolvedAsset<
                    {
                        cachePrefix?: string;
                        ignoreMultiPack?: boolean;
                        imageFilename?: string;
                        texture?: Texture;
                        textureOptions?: TextureSourceOptions;
                    },
                >,
                loader?: Loader,
            ): Promise<Spritesheet<SpritesheetData>>;
            testParse(
                asset: SpriteSheetJson,
                options: ResolvedAsset,
            ): Promise<boolean>;
            unload(
                spritesheet: Spritesheet,
                _resolvedAsset: ResolvedAsset<any>,
                loader: Loader,
            ): Promise<void>;
        };
        resolver: {
            extension: { name: string; type: ResolveParser };
            parse: (
                value: string,
            ) => { format: string; resolution: number; src: string };
            test: (value: string) => boolean;
        };
    } = ...

    Asset extension for loading spritesheets

    Type declaration

    • cache: {
          getCacheableAssets: (
              keys: string[],
              asset: Spritesheet,
          ) => Record<string, any>;
          test: (asset: Spritesheet) => boolean;
      }

      Handle the caching of the related Spritesheet Textures

    • extension: Asset
    • loader: {
          extension: {
              name: string;
              priority: LoaderParserPriority;
              type: LoadParser;
          };
          name: string;
          parse<T>(
              asset: SpriteSheetJson,
              options: ResolvedAsset<
                  {
                      cachePrefix?: string;
                      ignoreMultiPack?: boolean;
                      imageFilename?: string;
                      texture?: Texture;
                      textureOptions?: TextureSourceOptions;
                  },
              >,
              loader?: Loader,
          ): Promise<Spritesheet<SpritesheetData>>;
          testParse(asset: SpriteSheetJson, options: ResolvedAsset): Promise<boolean>;
          unload(
              spritesheet: Spritesheet,
              _resolvedAsset: ResolvedAsset<any>,
              loader: Loader,
          ): Promise<void>;
      }

      Loader plugin that parses sprite sheets! once the JSON has been loaded this checks to see if the JSON is spritesheet data. If it is, we load the spritesheets image and parse the data into Spritesheet All textures in the sprite sheet are then added to the cache

    • resolver: {
          extension: { name: string; type: ResolveParser };
          parse: (
              value: string,
          ) => { format: string; resolution: number; src: string };
          test: (value: string) => boolean;
      }

      Resolve the resolution of the asset.

    import { Assets } from 'pixi.js';

    Assets.load({
        alias: 'spritesheet',
        src: 'path/to/spritesheet.json',
        data: {
            ignoreMultiPack: true,
            textureOptions: {
                scaleMode: "nearest"
            }
        }
    })

    Settings

    Member Visibility