Class CoreTextureManager

EventEmitter base class

Hierarchy (view full)

EventEmitter
- CoreTextureManager

Constructors

constructor

new CoreTextureManager(numImageWorkers): CoreTextureManager
Parameters
- numImageWorkers: number
Returns CoreTextureManager
Overrides EventEmitter.constructor
- Defined in src/core/CoreTextureManager.ts:184

Properties

frameTime

frameTime: number = 0

The current frame time in milliseconds

Remarks

This is used to populate the lastRenderableChangeTime property of Texture instances when their renderable state changes.

Set by stage via updateFrameTime method.

hasCreateImageBitmap

hasCreateImageBitmap: boolean = !!self.createImageBitmap

hasWorker

hasWorker: boolean = !!self.Worker

imageBitmapSupported

imageBitmapSupported: {
    basic: boolean;
    full: boolean;
    options: boolean;
} = ...

imageWorkerManager

imageWorkerManager: null | ImageWorkerManager = null

inverseKeyCache

inverseKeyCache: WeakMap<Texture, string> = ...

Map of cache keys by texture

keyCache

keyCache: Map<string, Texture> = ...

Map of textures by cache key

renderer

renderer: CoreRenderer

Renderer that this texture manager is associated with

Remarks

This MUST be set before the texture manager is used. Otherwise errors will occur when using the texture manager.

txConstructors

txConstructors: Partial<TextureMap> = {}

Map of texture constructors by their type name

Methods

createTexture

createTexture<Type>(textureType, props): InstanceType<TextureMap[Type]>
Create a texture
Type Parameters
- Type extends keyof TextureMap
Parameters
- textureType: Type
  The type of texture to create
- props: ExtractProps<TextureMap[Type]>
  The properties to use for the texture
Returns InstanceType<TextureMap[Type]>
- Defined in src/core/CoreTextureManager.ts:337

emit

emit(event, data?): void
Parameters
- event: string
- Optionaldata: any
Returns void
Inherited from EventEmitter.emit
- Defined in src/common/EventEmitter.ts:64

enqueueDownloadTextureSource

enqueueDownloadTextureSource(texture): void
Enqueue a texture for downloading its source image.
Parameters
- texture: Texture
Returns void
- Defined in src/core/CoreTextureManager.ts:314

enqueueUploadTexture

enqueueUploadTexture(texture): void
Enqueue a texture for uploading to the GPU.
Parameters
- texture: Texture
  The texture to upload
Returns void
- Defined in src/core/CoreTextureManager.ts:325

getTextureFromCache

getTextureFromCache(cacheKey): undefined | Texture
Get a texture from the cache
Parameters
- cacheKey: string
Returns undefined | Texture
- Defined in src/core/CoreTextureManager.ts:485

hasUpdates

hasUpdates(): boolean
Returns boolean
- Defined in src/core/CoreTextureManager.ts:461

initTextureToCache

initTextureToCache(texture, cacheKey): void
Initialize a texture to the cache
Parameters
- texture: Texture
  Texture to cache
- cacheKey: string
  Cache key for the texture
Returns void
- Defined in src/core/CoreTextureManager.ts:474

loadTexture

loadTexture(texture, priority?): void
Override loadTexture to use the batched approach.
Parameters
- texture: Texture
  The texture to load
- Optionalpriority: boolean
Returns void
- Defined in src/core/CoreTextureManager.ts:369

off

off(event, listener?): void
Parameters
- event: string
- Optionallistener: ((target: any, data: any) => void)
  - - (target, data): void
    - Parameters
      target: any
      data: any
      Returns void
Returns void
Inherited from EventEmitter.off
- Defined in src/common/EventEmitter.ts:41

on

on(event, listener): void
Parameters
- event: string
- listener: ((target: any, data: any) => void)
  - - (target, data): void
    - Parameters
      target: any
      data: any
      Returns void
Returns void
Inherited from EventEmitter.on
- Defined in src/common/EventEmitter.ts:32

once

once(event, listener): void
Parameters
- event: string
- listener: ((target: any, data: any) => void)
  - - (target, data): void
    - Parameters
      target: any
      data: any
      Returns void
Returns void
Inherited from EventEmitter.once
- Defined in src/common/EventEmitter.ts:56

processSome

processSome(maxItems?): void
Process a limited number of downloads and uploads.
Parameters
- maxItems: number = 0
  The maximum number of items to process
Returns void
- Defined in src/core/CoreTextureManager.ts:414

registerTextureType

registerTextureType<Type>(textureType, textureClass): void
Type Parameters
- Type extends keyof TextureMap
Parameters
- textureType: Type
- textureClass: TextureMap[Type]
Returns void
- Defined in src/core/CoreTextureManager.ts:304

removeAllListeners

removeAllListeners(): void
Returns void
Inherited from EventEmitter.removeAllListeners
- Defined in src/common/EventEmitter.ts:74

removeTextureFromCache

removeTextureFromCache(texture): void
Remove a texture from the cache
Parameters
- texture: Texture
Returns void
Remarks
Called by Texture Cleanup when a texture is freed.
- Defined in src/core/CoreTextureManager.ts:497

resolveParentTexture

resolveParentTexture(texture): Texture
Resolve a parent texture from the cache or fallback to the provided texture.
Parameters
- texture: ImageTexture
  The provided texture to resolve.
Returns Texture
The cached or provided texture.
- Defined in src/core/CoreTextureManager.ts:511

uploadTexture

uploadTexture(texture): void
Upload a texture to the GPU
Parameters
- texture: Texture
  Texture to upload
Returns void
- Defined in src/core/CoreTextureManager.ts:404

Class CoreTextureManager

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CoreTextureManager

Properties

frameTime

Remarks

hasCreateImageBitmap

hasWorker

imageBitmapSupported

imageWorkerManager

inverseKeyCache

keyCache

renderer

Remarks

txConstructors

Methods

createTexture

Type Parameters

Parameters

Returns InstanceType<TextureMap[Type]>

emit

Parameters

Returns void

enqueueDownloadTextureSource

Parameters

Returns void

enqueueUploadTexture

Parameters

Returns void

getTextureFromCache

Parameters

Returns undefined | Texture

hasUpdates

Returns boolean

initTextureToCache

Parameters

Returns void

loadTexture

Parameters

Returns void

off

Parameters

Parameters

Returns void

Returns void

on

Parameters

Parameters

Returns void

Returns void

once

Parameters

Parameters

Returns void

Returns void

processSome

Parameters

Returns void

registerTextureType

Type Parameters

Parameters

Returns void

removeAllListeners

Returns void

removeTextureFromCache

Parameters

Returns void

Remarks

resolveParentTexture

Parameters

Returns Texture

uploadTexture

Parameters