Class Framebuffer

constructor

• new Framebuffer(width: number, height: number): Framebuffer

• Parameters

  • width: number

    Width of the frame buffer
  • height: number

    Height of the frame buffer

  Returns Framebuffer

colorTextures

depth

depthTexture

dirtyFormat

dirtyId

dirtySize

disposeRunner

glFramebuffers

height

multisample

import { MSAA_QUALITY } from 'pixi.js';

renderTexture.framebuffer.multisample = MSAA_QUALITY.HIGH;
// ...
renderer.render(myContainer, { renderTexture });
renderer.framebuffer.blit(); // Copies data from MSAA framebuffer to texture
Copy

PIXI.MSAA_QUALITY.NONE
Copy

stencil

width

colorTexture

• get colorTexture(): BaseTexture<Resource, IAutoDetectOptions>

• Reference to the colorTexture.

  Returns BaseTexture<Resource, IAutoDetectOptions>

addColorTexture

• addColorTexture(
      index?: number,
      texture?: BaseTexture<Resource, IAutoDetectOptions>,
  ): this

• Add texture to the colorTexture array.

  Parameters

  • Optionalindex: number

    Index of the array to add the texture to
  • Optionaltexture: BaseTexture<Resource, IAutoDetectOptions>

    Texture to add to the array

  Returns this

addDepthTexture

• addDepthTexture(texture?: BaseTexture<Resource, IAutoDetectOptions>): this

• Add a depth texture to the frame buffer.

  Parameters

  • Optionaltexture: BaseTexture<Resource, IAutoDetectOptions>

    Texture to add.

  Returns this

destroyDepthTexture

• destroyDepthTexture(): void

• Destroys and removes the depth texture added to this framebuffer.

  Returns void

dispose

• dispose(): void

• Disposes WebGL resources that are connected to this geometry.

  Returns void

enableDepth

• enableDepth(): this

• Enable depth on the frame buffer.

  Returns this

enableStencil

• enableStencil(): this

• Enable stencil on the frame buffer.

  Returns this

resize

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

• Resize the frame buffer

  Parameters

  • width: number

    Width of the frame buffer to resize to
  • height: number

    Height of the frame buffer to resize to

  Returns void