Class CoreTextureManager

EventEmitter base class

Hierarchy (View Summary)

EventEmitter
- CoreTextureManager

Constructors

constructor

new CoreTextureManager(
stage: Stage,
settings: TextureManagerSettings,
): CoreTextureManager
Parameters
- stage: Stage
- settings: TextureManagerSettings
Returns CoreTextureManager
Overrides EventEmitter.constructor
- Defined in src/core/CoreTextureManager.ts:218

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.

inverseKeyCache

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

Map of cache keys by texture

keyCache

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

Map of textures by cache key

maxRetryCount

maxRetryCount: number

platform

platform: Platform

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 extends keyof TextureMap>(
textureType: Type,
props: ExtractProps<TextureMap[Type]>,
): 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:256

emit

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

enqueueUploadTexture

enqueueUploadTexture(texture: 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:244

getTextureFromCache

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

hasUpdates

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

initTextureToCache

initTextureToCache(texture: Texture, cacheKey: string): 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:424

isProcessingTexture

isProcessingTexture(texture: Texture): boolean
Check if a texture is being processed
Parameters
- texture: Texture
Returns boolean
- Defined in src/core/CoreTextureManager.ts:385

loadTexture

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

off

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

on

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

once

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

processSome

processSome(maxProcessingTime: number): Promise<void>
Process a limited number of uploads.
Parameters
- maxProcessingTime: number
  The maximum processing time in milliseconds
Returns Promise<void>
- Defined in src/core/CoreTextureManager.ts:394

registerTextureType

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

removeAllListeners

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

removeTextureFromCache

removeTextureFromCache(texture: 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:447

removeTextureFromQueue

removeTextureFromQueue(texture: Texture): void
Remove texture from the upload queue
Parameters
- texture: Texture
  The texture to remove
Returns void
- Defined in src/core/CoreTextureManager.ts:460

resolveParentTexture

resolveParentTexture(texture: ImageTexture): 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:473

uploadTexture

uploadTexture(texture: Texture): Promise<void>
Upload a texture to the GPU
Parameters
- texture: Texture
  Texture to upload
Returns Promise<void>
Promise that resolves when the texture is fully loaded
- Defined in src/core/CoreTextureManager.ts:339

Class CoreTextureManager

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CoreTextureManager

Properties

frameTime

Remarks

inverseKeyCache

keyCache

maxRetryCount

platform

renderer

Remarks

txConstructors

Methods

createTexture

Type Parameters

Parameters

Returns InstanceType<TextureMap[Type]>

emit

Parameters

Returns void

enqueueUploadTexture

Parameters

Returns void

getTextureFromCache

Parameters

Returns undefined | Texture

hasUpdates

Returns boolean

initTextureToCache

Parameters

Returns void

isProcessingTexture

Parameters

Returns boolean

loadTexture

Parameters

Returns Promise<void>

off

Parameters

Returns void

on

Parameters

Returns void

once

Parameters

Returns void

processSome

Parameters

Returns Promise<void>

registerTextureType

Type Parameters

Parameters

Returns void

removeAllListeners

Returns void

removeTextureFromCache

Parameters

Returns void

Remarks

removeTextureFromQueue

Parameters

Returns void

resolveParentTexture

Parameters

Returns Texture

uploadTexture

Parameters

Returns Promise<void>

Settings

On This Page