Class CanvasResource

Readonly destroyed

false
Copy

internal

Readonly source

src

height

• get height(): number

• The height of the resource.

  Returns number

valid

• get valid(): boolean

• Has been validated

  Returns boolean

width

• get width(): number

• The width of the resource.

  Returns number

bind

• bind(baseTexture): void

• Bind to a parent BaseTexture

  Parameters

  • baseTexture: BaseTexture<Resource, IAutoDetectOptions>

    Parent texture

  Returns void

destroy

• destroy(): void

• Call when destroying resource, unbind any BaseTexture object before calling this method, as reference counts are maintained internally.

  Returns void

dispose

• dispose(): void

• Destroy this PIXI.BaseImageResource

  Returns void

resize

• resize(width, height): void

• Trigger a resize event

  Parameters

  • width: number

    X dimension
  • height: number

    Y dimension

  Returns void

style

• style(_renderer, _baseTexture, _glTexture): boolean

• Set the style, optional to override

  Parameters

  • _renderer: Renderer

    yeah, renderer!
  • _baseTexture: BaseTexture<Resource, IAutoDetectOptions>

    the texture
  • _glTexture: GLTexture

    texture instance for this webgl context

  Returns boolean

  • true is success

unbind

• unbind(baseTexture): void

• Unbind to a parent BaseTexture

  Parameters

  • baseTexture: BaseTexture<Resource, IAutoDetectOptions>

    Parent texture

  Returns void

update

• update(): void

• Checks if source width/height was changed, resize can cause extra baseTexture update. Triggers one update in any case.

  Returns void

upload

• upload(renderer, baseTexture, glTexture, source?): boolean

• 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

    (optional)

  Returns boolean

  • true is success

Static crossOrigin

• crossOrigin(element, url, crossorigin?): void

• 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

    Cross origin value to use

  Returns void