Class Framebuffer

A portion of contiguous memory that contains a collection of buffers that store color, alpha, depth, and stencil information that is used to render an image.

See

WebGLFramebuffer

Hierarchy (View Summary)

Constructors

constructor

Properties

context

Accessors

drawBuffers height readBuffer status width

Methods

attach delete

Constructors

constructor

Properties

Readonlycontext

context: Context

The rendering context.

Accessors

drawBuffers

  • get drawBuffers(): (number | boolean)[]

  • The current draw buffers. false represents no buffer, true represents the back buffer, and an integer represents the corresponding color buffer.

    Returns (number | boolean)[]

    See

    drawBuffers

    Throws

    BadValueError if too many draw buffers are specified for the current environment.

  • set drawBuffers(value: (number | boolean)[]): void

  • Parameters

    • value: (number | boolean)[]

    Returns void

height

readBuffer

  • get readBuffer(): number | boolean

  • The current read buffer. false represents no buffer, true represents the back buffer, and an integer represents the corresponding color buffer.

    Returns number | boolean

    See

    readBuffer

  • set readBuffer(value: number | boolean): void

  • Parameters

    • value: number | boolean

    Returns void

status

width

Methods

attach

  • attach(
        attachment: number,
        texture: Texture2d,
        _?: undefined,
        level?: number,
        layer?: number,
    ): void

  • Attach a 2D texture to this framebuffer.

    Parameters

    • attachment: number

      Specify the depth attachment, the stencil attachment, the depth stencil attachment, or the index of a color attachment.

    • texture: Texture2d

      The texture to attach.

    • Optional_: undefined

      An unused value.

    • Optionallevel: number

      The level of the texture to attach. Defaults to the top level.

    • Optionallayer: number

      The layer of the texture to attach, or undefined for the entire texture.

    Returns void

    Throws

    BadValueError if the size of the texture does not match the size of any existing attachment to the framebuffer.

    See

  • attach(
        attachment: number,
        texture: TextureCubemap,
        face: CubeFace,
        level?: number,
        layer?: number,
    ): void

  • Attach a face of a cubemapped texture to this framebuffer.

    Parameters

    • attachment: number

      Specify the depth attachment, the stencil attachment, the depth stencil attachment, or the index of a color attachment.

    • texture: TextureCubemap

      The texture to attach.

    • face: CubeFace

      The face of the cubemapped texture to attach.

    • Optionallevel: number

      The level of the texture to attach. Defaults to the top level.

    • Optionallayer: number

      The layer of the texture to attach, or undefined for the entire texture.

    Returns void

    Throws

    BadValueError if the size of the texture does not match the size of any existing attachment to the framebuffer.

    See

  • attach(attachment: number, renderbuffer: Renderbuffer): void

  • Attach a renderbuffer to this framebuffer.

    Parameters

    • attachment: number

      Specify the depth attachment, the stencil attachment, the depth stencil attachment, or the index of a color attachment.

    • renderbuffer: Renderbuffer

      The renderbuffer to attach.

    Returns void

    Throws

    BadValueError if the size of the renderbuffer does not match the size of any existing attachment to the framebuffer.

    See

    framebufferRenderbuffer

delete

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods