Class PixiImageManager

PixiImageManager loads and stores textures that can be used by the Pixi.js renderers.

Implements

ResourceManager

Index

Constructors

Methods

dispose getInvalidPIXITexture getOrCreateDiskTexture getOrCreateRectangleTexture getOrCreateScaledTexture getOrLoadPIXITexture getPIXITexture getPIXIVideoTexture getResourceKinds getThreeMaterial getThreeTexture loadResource processResource unloadResourcesList

Constructors

constructor

new PixiImageManager(resourceLoader): PixiImageManager
Parameters
- resourceLoader: ResourceLoader
  The resources loader of the game.
Returns PixiImageManager
- Defined in GDJS/Runtime/pixi-renderers/pixi-image-manager.ts:69

Methods

dispose

dispose(): void
To be called when the game is disposed. Clear caches of loaded textures and materials.

Returns void
Implementation of ResourceManager.dispose
- Defined in GDJS/Runtime/pixi-renderers/pixi-image-manager.ts:478

getInvalidPIXITexture

getInvalidPIXITexture(): Texture<Resource>
Return a PIXI texture which can be used as a placeholder when no suitable texture can be found.

Returns Texture<Resource>
- Defined in GDJS/Runtime/pixi-renderers/pixi-image-manager.ts:297

getOrCreateDiskTexture

getOrCreateDiskTexture(radius, pixiRenderer): Texture<Resource>
Return a texture containing a circle filled with white.
Parameters
- radius: number
  The circle radius
- pixiRenderer: Renderer
  The renderer used to generate the texture
Returns Texture<Resource>
- Defined in GDJS/Runtime/pixi-renderers/pixi-image-manager.ts:400

getOrCreateRectangleTexture

getOrCreateRectangleTexture(width, height, pixiRenderer): Texture<Resource>
Return a texture filled with white.
Parameters
- width: number
  The texture width
- height: number
  The texture height
- pixiRenderer: Renderer
  The renderer used to generate the texture
Returns Texture<Resource>
- Defined in GDJS/Runtime/pixi-renderers/pixi-image-manager.ts:425

getOrCreateScaledTexture

getOrCreateScaledTexture(imageResourceName, width, height, pixiRenderer): Texture<Resource>
Return a texture rescaled according to given dimensions.
Parameters
- imageResourceName: string
- width: number
  The texture width
- height: number
  The texture height
- pixiRenderer: Renderer
  The renderer used to generate the texture
Returns Texture<Resource>
- Defined in GDJS/Runtime/pixi-renderers/pixi-image-manager.ts:452

getOrLoadPIXITexture

getOrLoadPIXITexture(resourceName): Texture<Resource>
Return the PIXI texture associated to the specified resource name. If not found in the loaded textures, this method will try to load it. Warning: this method should only be used in specific cases that cannot rely on the initial resources loading of the game, such as the splashscreen.
Parameters
- resourceName: string
  The name of the resource
Returns Texture<Resource>
The requested texture, or a placeholder if not valid.
- Defined in GDJS/Runtime/pixi-renderers/pixi-image-manager.ts:122

getPIXITexture

getPIXITexture(resourceName): Texture<Resource>
Return the PIXI texture associated to the specified resource name. Returns a placeholder texture if not found.
Parameters
- resourceName: string
  The name of the resource
Returns Texture<Resource>
The requested texture, or a placeholder if not found.
- Defined in GDJS/Runtime/pixi-renderers/pixi-image-manager.ts:89

getPIXIVideoTexture

getPIXIVideoTexture(resourceName): Texture<Resource>
Return the PIXI video texture associated to the specified resource name. Returns a placeholder texture if not found.
Parameters
- resourceName: string
  The name of the resource to get.
Returns Texture<Resource>
- Defined in GDJS/Runtime/pixi-renderers/pixi-image-manager.ts:267

getResourceKinds

getResourceKinds(): ResourceKind[]
Return the kind of resources handled by this manager.

Returns ResourceKind[]
Implementation of ResourceManager.getResourceKinds
- Defined in GDJS/Runtime/pixi-renderers/pixi-image-manager.ts:79

getThreeMaterial

getThreeMaterial(resourceName, options): Material
Return the three.js material associated to the specified resource name.
Parameters
- resourceName: string
  The name of the resource
- options: {
      forceBasicMaterial: boolean;
      useTransparentTexture: boolean;
      vertexColors: boolean;
  }
  - forceBasicMaterial: boolean
  - useTransparentTexture: boolean
  - vertexColors: boolean
Returns Material
The requested material.
- Defined in GDJS/Runtime/pixi-renderers/pixi-image-manager.ts:225

getThreeTexture

getThreeTexture(resourceName): Texture
Return the three.js texture associated to the specified resource name. Returns a placeholder texture if not found.
Parameters
- resourceName: string
  The name of the resource
Returns Texture
The requested texture, or a placeholder if not found.
- Defined in GDJS/Runtime/pixi-renderers/pixi-image-manager.ts:180

loadResource

loadResource(resourceName): Promise<void>
Load the specified resources, so that textures are loaded and can then be used by calling getPIXITexture.
Parameters
- resourceName: string
Returns Promise<void>
Implementation of ResourceManager.loadResource
- Defined in GDJS/Runtime/pixi-renderers/pixi-image-manager.ts:305

processResource

processResource(resourceName): Promise<void>
Process the specified resource.

This method will only be run while loading screen is shown. It can do heavy tasks like parsing data.
Parameters
- resourceName: string
Returns Promise<void>
Implementation of ResourceManager.processResource
- Defined in GDJS/Runtime/pixi-renderers/pixi-image-manager.ts:316

unloadResourcesList

unloadResourcesList(resourcesList): void
Unload the specified list of resources: this clears the cache of loaded textures associated to these resources.

Usually called when scene resoures are unloaded.
Parameters
- resourcesList: ResourceData[]
  The list of specific resources
Returns void
Implementation of ResourceManager.unloadResourcesList
- Defined in GDJS/Runtime/pixi-renderers/pixi-image-manager.ts:531

Class PixiImageManager

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns PixiImageManager

Methods

dispose

Returns void

getInvalidPIXITexture

Returns Texture<Resource>

getOrCreateDiskTexture

Parameters

Returns Texture<Resource>

getOrCreateRectangleTexture

Parameters

Returns Texture<Resource>

getOrCreateScaledTexture

Parameters

Returns Texture<Resource>

getOrLoadPIXITexture

Parameters

Returns Texture<Resource>

getPIXITexture

Parameters

Returns Texture<Resource>

getPIXIVideoTexture

Parameters

Returns Texture<Resource>

getResourceKinds

Returns ResourceKind[]

getThreeMaterial

Parameters

forceBasicMaterial: boolean

useTransparentTexture: boolean

vertexColors: boolean

Returns Material

getThreeTexture

Parameters

Returns Texture

loadResource

Parameters

Returns Promise<void>

processResource

Parameters

Returns Promise<void>

unloadResourcesList

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page