Class CanvasTexture

Hierarchy

CoreContextTexture
- CanvasTexture

Index

Constructors

Properties

image state textureSource tintCache

Accessors

Methods

free getImage hasImage load release setTextureMemUse tintTexture updateMemSize

Constructors

constructor

new CanvasTexture(
memManager: TextureMemoryManager,
textureSource: Texture,
): CanvasTexture
Parameters
- memManager: TextureMemoryManager
- textureSource: Texture
Returns CanvasTexture
Inherited from CoreContextTexture.constructor
- Defined in src/core/renderers/CoreContextTexture.ts:28

Properties

`Protected`image

image: HTMLCanvasElement | ImageBitmap | HTMLImageElement | undefined

state

state: "loading" | "loaded" | "failed" | "freed" = 'freed'

`Readonly`textureSource

textureSource: Texture

`Protected`tintCache

tintCache: { image: HTMLCanvasElement; key: string } | undefined

Accessors

renderable

get renderable(): boolean
Returns boolean
Inherited from CoreContextTexture.renderable
- Defined in src/core/renderers/CoreContextTexture.ts:41

Methods

free

free(): void
Returns void
Overrides CoreContextTexture.free
- Defined in src/core/renderers/canvas/CanvasTexture.ts:72

getImage

getImage(
color: IParsedColor,
): HTMLCanvasElement | ImageBitmap | HTMLImageElement | null
Parameters
- color: IParsedColor
Returns HTMLCanvasElement | ImageBitmap | HTMLImageElement | null
- Defined in src/core/renderers/canvas/CanvasTexture.ts:97

hasImage

hasImage(): boolean
Returns boolean
- Defined in src/core/renderers/canvas/CanvasTexture.ts:93

load

load(): Promise<void>
Returns Promise<void>
Overrides CoreContextTexture.load
- Defined in src/core/renderers/canvas/CanvasTexture.ts:39

release

release(): void
Returns void
Overrides CoreContextTexture.release
- Defined in src/core/renderers/canvas/CanvasTexture.ts:67

`Protected`setTextureMemUse

setTextureMemUse(byteSize: number): void
Parameters
- byteSize: number
Returns void
Inherited from CoreContextTexture.setTextureMemUse
- Defined in src/core/renderers/CoreContextTexture.ts:33

`Protected`tintTexture

tintTexture(
source: HTMLCanvasElement | ImageBitmap | HTMLImageElement,
color: string,
): HTMLCanvasElement
Parameters
- source: HTMLCanvasElement | ImageBitmap | HTMLImageElement
- color: string
Returns HTMLCanvasElement
- Defined in src/core/renderers/canvas/CanvasTexture.ts:126

updateMemSize

updateMemSize(): void
Returns void
- Defined in src/core/renderers/canvas/CanvasTexture.ts:79