Class CanvasResource

Readonlydestroyed

false
Copy

internal

Readonlysource

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: BaseTexture): void

  Bind to a parent BaseTexture

  Parameters

  • baseTexture: BaseTexture

    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: number, height: number): void

  Trigger a resize event

  Parameters

  • width: number

    X dimension

  • height: number

    Y dimension

  Returns void

style

• style(
      _renderer: Renderer,
      _baseTexture: BaseTexture,
      _glTexture: GLTexture,
  ): boolean

  Set the style, optional to override

  Parameters

  • _renderer: Renderer

    yeah, renderer!

  • _baseTexture: BaseTexture

    the texture

  • _glTexture: GLTexture

    texture instance for this webgl context

  Returns boolean

  • true is success

unbind

• unbind(baseTexture: BaseTexture): void

  Unbind to a parent BaseTexture

  Parameters

  • baseTexture: BaseTexture

    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: Renderer,
      baseTexture: BaseTexture,
      glTexture: GLTexture,
      source?: ImageSource,
  ): boolean

  Upload the texture to the GPU.

  Parameters

  • renderer: Renderer

    Upload to the renderer

  • baseTexture: BaseTexture

    Reference to parent texture

  • glTexture: GLTexture
  • Optionalsource: ImageSource

    (optional)

  Returns boolean

  • true is success

StaticcrossOrigin

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

  Set cross origin based detecting the url and the crossorigin

  Parameters

  • element: HTMLImageElement | HTMLVideoElement

    Element to apply crossOrigin

  • url: string

    URL to check

  • Optionalcrossorigin: string | boolean

    Cross origin value to use

  Returns void