PIXI.Resolver

new PIXI.Resolver() → {}

basePath Resolver.ts:85

basePath: string

 resolver.basePath = 'https://home.com/';
 resolver.add('foo', 'bar.ong');
 resolver.resolveUrl('foo', 'bar.png'); // => 'https://home.com/bar.png'

parsers Resolver.ts:124

parsers: PIXI.ResolveURLParser[]

 resolver.add('foo', [
    {
      resolution:2,
      format:'png'
      src: 'image@2x.png'
    },
    {
      resolution:1,
      format:'png'
      src: 'image.png'
    }
 ]);

 // with a url parser the information such as resolution and file format could extracted from the url itself:
 extensions.add({
     extension: ExtensionType.ResolveParser,
     test: loadTextures.test, // test if url ends in an image
     parse: (value: string) =>
     ({
         resolution: parseFloat(settings.RETINA_PREFIX.exec(value)?.[1] ?? '1'),
         format: value.split('.').pop(),
         src: value,
     }),
 });

 // now resolution and format can be extracted from the url
 resolver.add('foo', [
    'image@2x.png'
    'image.png'
 ]);

rootPath Resolver.ts:103

rootPath: string

 // Application hosted on https://home.com/some-path/index.html
 resolver.basePath = 'https://home.com/some-path/';
 resolver.rootPath = 'https://home.com/';
 resolver.add('foo', '/bar.png');
 resolver.resolveUrl('foo', '/bar.png'); // => 'https://home.com/bar.png'

add Resolver.ts:247

add(keysIn: string | string[], assetsIn: string | PIXI.ResolveAsset | (PIXI.ResolveAsset | string)[], data: unknown) → {void}

 // single key, single asset:
 resolver.add('foo', 'bar.png');
 resolver.resolveUrl('foo') // => 'bar.png'

 // multiple keys, single asset:
 resolver.add(['foo', 'boo'], 'bar.png');
 resolver.resolveUrl('foo') // => 'bar.png'
 resolver.resolveUrl('boo') // => 'bar.png'

 // multiple keys, multiple assets:
 resolver.add(['foo', 'boo'], ['bar.png', 'bar.webp']);
 resolver.resolveUrl('foo') // => 'bar.png'

 // add custom data attached to the resolver
 Resolver.add(
     'bunnyBooBooSmooth',
     'bunny{png,webp}',
     {scaleMode:SCALE_MODES.NEAREST} // base texture options
 );

 resolver.resolve('bunnyBooBooSmooth') // => {src: 'bunny.png', data: {scaleMode: SCALE_MODES.NEAREST}}

addBundle Resolver.ts:201

addBundle(bundleId: string, assets: PIXI.ResolverBundle["assets"]) → {void}

  resolver.addBundle('animals', {
    bunny: 'bunny.png',
    chicken: 'chicken.png',
    thumper: 'thumper.png',
  });

 const resolvedAssets = await resolver.resolveBundle('animals');

addManifest Resolver.ts:179

addManifest(manifest: ResolverManifest) → {void}

prefer Resolver.ts:53

prefer(preferOrders: PIXI.PreferOrder[]) → {void}

 resolver.prefer({
     // first look for something with the correct format, and then then correct resolution
     priority: ['format', 'resolution'],
     params:{
         format:'webp', // prefer webp images
         resolution: 2, // prefer a resolution of 2
     }
 })
 resolver.add('foo', ['bar@2x.webp', 'bar@2x.png', 'bar.webp', 'bar.png']);
 resolver.resolveUrl('foo') // => 'bar@2x.webp'

reset Resolver.ts:167

reset() → {void}

resolve Resolver.ts:443

resolve(keys: string | string[]) → {PIXI.ResolveAsset | PIXI.ResolveAsset<string, Record>}

 resolver.add('boo', 'bunny.png');

 resolver.resolve('boo') // => {src:'bunny.png'}

 // will return the same string as no key was added for this value..
 resolver.resolve('another-thing.png') // => {src:'another-thing.png'}

resolveBundle Resolver.ts:359

resolveBundle(bundleIds: string | string[]) → {Record<string, PIXI.ResolveAsset> | PIXI.ResolveAsset<string, Record<string, Record>>}

 // manifest example
 const manifest = {
   bundles:[{
      name:'load-screen',
      assets:[
          {
             name: 'background',
             srcs: 'sunset.png',
          },
          {
             name: 'bar',
             srcs: 'load-bar.{png,webp}',
          }
      ]
   },
   {
      name:'game-screen',
      assets:[
          {
             name: 'character',
             srcs: 'robot.png',
          },
          {
             name: 'enemy',
             srcs: 'bad-guy.png',
          }
      ]
   }]
 }}
 resolver.setManifest(manifest);
 const resolved = resolver.resolveBundle('load-screen');

resolveUrl Resolver.ts:419

resolveUrl(key: string | string[]) → {string | Record<string, string>}