Class CanvasTexture

attributes

canvas

context

glTextureUnit

WebGLVersion

height

• get height(): number

  The height of this canvas texture in pixels

  Returns number

• set height(val: number): void

  The height of this render target in pixels.

  Parameters

  • val: number

  Returns void

width

• get width(): number

  The width of this canvas texture in pixels

  Returns number

• set width(val: number): void

  The width of this render target in pixels.

  Parameters

  • val: number

  Returns void

bind

• bind(): void

  Bind this render target as the active draw destination. All subsequent draw calls will render into this target until unbind is called. No-op by default — subclasses override for GPU render targets (e.g. WebGL FBOs).

  Returns void

clear

• clear(): void

  Clears the content of the canvas texture

  Returns void

getImageData

• getImageData(x: number, y: number, width: number, height: number): ImageData

  Returns an ImageData object representing the underlying pixel data for a specified portion of this canvas texture. (Note: when using getImageData(), it is highly recommended to use the willReadFrequently attribute when creatimg the corresponding canvas texture)

  Parameters

  • x: number

    The x-axis coordinate of the top-left corner of the rectangle from which the ImageData will be extracted

  • y: number

    The y-axis coordinate of the top-left corner of the rectangle from which the ImageData will be extracted

  • width: number

    The width of the rectangle from which the ImageData will be extracted. Positive values are to the right, and negative to the left

  • height: number

    The height of the rectangle from which the ImageData will be extracted. Positive values are down, and negative are up

  Returns ImageData

  The ImageData extracted from this CanvasRenderTarget.

invalidate

• invalidate(renderer: CanvasRenderer | WebGLRenderer): void

  invalidate the current CanvasRenderTarget, and force a reupload of the corresponding texture (call this if you modify the canvas content between two draw calls)

  Parameters

  • renderer: CanvasRenderer | WebGLRenderer

    the renderer to which this canvas texture is attached

  Returns void

resize

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

  Resizes the canvas texture to the given width and height.

  Parameters

  • width: number

    the desired width

  • height: number

    the desired height

  Returns void

setAntiAlias

• setAntiAlias(enable?: boolean): void

  enable/disable image smoothing (scaling interpolation)

  Parameters

  • Optionalenable: boolean = false

    whether to enable or not image smoothing (scaling interpolation)

  Returns void

toBlob

• toBlob(type?: string, quality?: number): Promise<Blob>

  Creates a Blob directly from the canvas (avoids the getImageData round-trip).

  Parameters

  • Optionaltype: string = "image/png"

    A string indicating the image format

  • Optionalquality: number

    A number between 0 and 1 for lossy formats (image/jpeg, image/webp)

  Returns Promise<Blob>

  A Promise resolving to a Blob

toDataURL

• toDataURL(type?: string, quality?: number): Promise<string>

  Returns a data URL directly from the canvas (avoids the getImageData/Blob round-trip). Note: not supported by OffscreenCanvas — falls back to the base implementation.

  Parameters

  • Optionaltype: string = "image/png"

    A string indicating the image format

  • Optionalquality: number

    A number between 0 and 1 for lossy formats (image/jpeg, image/webp)

  Returns Promise<string>

  A Promise resolving to a data URL string

toImageBitmap

• toImageBitmap(): Promise<ImageBitmap>

  Creates an ImageBitmap directly from the canvas (avoids the getImageData round-trip).

  Returns Promise<ImageBitmap>

  A Promise resolving to an ImageBitmap

unbind

• unbind(): void

  Unbind this render target, restoring the default (screen) output. No-op by default — subclasses override for GPU render targets.

  Returns void