Class CanvasResource

Resource type for HTMLCanvasElement.

memberof: PIXI

Hierarchy

BaseImageResource
- CanvasResource

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new CanvasResource(source: HTMLCanvasElement): CanvasResource

Overrides BaseImageResource.constructor
- Defined in source/node_modules/@pixi/core/index.d.ts:1159
Parameters
- source: HTMLCanvasElement
  
  Canvas element to use
Returns CanvasResource

Properties

Protected _height

_height: number

Protected _width

_width: number

destroyed

destroyed: boolean

internal

internal: boolean

noSubImage

noSubImage: boolean

Protected onError

onError: Runner

Protected onResize

onResize: Runner

Protected onUpdate

onUpdate: Runner

source

source: ImageSource

Accessors

height

get height(): number

- Defined in source/node_modules/@pixi/core/index.d.ts:3403
The height of the resource.

member

{number}

readonly

Returns number

valid

get valid(): boolean

- Defined in source/node_modules/@pixi/core/index.d.ts:3378
Has been validated

readonly

member

{boolean}

Returns boolean

width

get width(): number

- Defined in source/node_modules/@pixi/core/index.d.ts:3396
The width of the resource.

member

{number}

readonly

Returns number

Methods

bind

bind(baseTexture: BaseTexture<Resource, IAutoDetectOptions>): void

Inherited from BaseImageResource.bind
- Defined in source/node_modules/@pixi/core/index.d.ts:3360
Bind to a parent BaseTexture

Parameters
- baseTexture: BaseTexture<Resource, IAutoDetectOptions>
  
  Parent texture
Returns void

destroy

destroy(): void

Inherited from BaseImageResource.destroy
- Defined in source/node_modules/@pixi/core/index.d.ts:3433
Call when destroying resource, unbind any BaseTexture object before calling this method, as reference counts are maintained internally.

Returns void

dispose

dispose(): void

Inherited from BaseImageResource.dispose
- Defined in source/node_modules/@pixi/core/index.d.ts:601
Destroy this BaseImageResource

override

Returns void

Protected load

load(): Promise<Resource>

Inherited from BaseImageResource.load
- Defined in source/node_modules/@pixi/core/index.d.ts:3389
This can be overridden to start preloading a resource or do any other prepare step.

Returns Promise<Resource>

Handle the validate event

resize

resize(width: number, height: number): void

Inherited from BaseImageResource.resize
- Defined in source/node_modules/@pixi/core/index.d.ts:3372
Trigger a resize event

Parameters
- width: number
  
  X dimension
- height: number
  
  Y dimension
Returns void

style

style(_renderer: Renderer, _baseTexture: BaseTexture<Resource, IAutoDetectOptions>, _glTexture: GLTexture): boolean

Inherited from BaseImageResource.style
- Defined in source/node_modules/@pixi/core/index.d.ts:3421
Set the style, optional to override

Parameters
- _renderer: Renderer
- _baseTexture: BaseTexture<Resource, IAutoDetectOptions>
- _glTexture: GLTexture
Returns boolean

true is success

unbind

unbind(baseTexture: BaseTexture<Resource, IAutoDetectOptions>): void

Inherited from BaseImageResource.unbind
- Defined in source/node_modules/@pixi/core/index.d.ts:3366
Unbind to a parent BaseTexture

Parameters
- baseTexture: BaseTexture<Resource, IAutoDetectOptions>
  
  Parent texture
Returns void

update

update(): void

Inherited from BaseImageResource.update
- Defined in source/node_modules/@pixi/core/index.d.ts:596
Checks if source width/height was changed, resize can cause extra baseTexture update. Triggers one update in any case.

Returns void

upload

upload(renderer: Renderer, baseTexture: BaseTexture<Resource, IAutoDetectOptions>, glTexture: GLTexture, source?: ImageSource): boolean

Inherited from BaseImageResource.upload
- Defined in source/node_modules/@pixi/core/index.d.ts:591
Upload the texture to the GPU.

Parameters
- renderer: Renderer
  
  Upload to the renderer
- baseTexture: BaseTexture<Resource, IAutoDetectOptions>
  
  Reference to parent texture
- glTexture: GLTexture
- Optional source: ImageSource
Returns boolean

true is success

Static Protected crossOrigin

crossOrigin(element: HTMLImageElement | HTMLVideoElement, url: string, crossorigin?: string | boolean): void

Inherited from BaseImageResource.crossOrigin
- Defined in source/node_modules/@pixi/core/index.d.ts:582
Set cross origin based detecting the url and the crossorigin

Parameters
- element: HTMLImageElement | HTMLVideoElement
  
  Element to apply crossOrigin
- url: string
  
  URL to check
- Optional crossorigin: string | boolean
Returns void

Static test

test(source: unknown): source is HTMLCanvasElement | OffscreenCanvas

Overrides BaseImageResource.test
- Defined in source/node_modules/@pixi/core/index.d.ts:1171
Used to auto-detect the type of resource.

static

Parameters
- source: unknown
  
  The source object
Returns source is HTMLCanvasElement | OffscreenCanvas

true if source is HTMLCanvasElement or OffscreenCanvas

Generated using TypeDoc