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)

ContextDependent
- Framebuffer

Index

Constructors

constructor

new Framebuffer(context: Context): Framebuffer
Create a framebuffer.
Parameters
- context: Context
  The rendering context.
Returns Framebuffer
See
createFramebuffer
Overrides ContextDependent.constructor
- Defined in src/core/Framebuffer.ts:166

Properties

`Readonly`context

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.
- Defined in src/core/Framebuffer.ts:525
set drawBuffers(value: (number | boolean)[]): void
Parameters
- value: (number | boolean)[]
Returns void
- Defined in src/core/Framebuffer.ts:555

height

get height(): number
The height of this framebuffer.

Returns number
- Defined in src/core/Framebuffer.ts:269

readAttachment

get readAttachment(): undefined | Renderbuffer | Texture
The attachment that is currently bound to the current read buffer.

Returns undefined | Renderbuffer | Texture
- Defined in src/core/Framebuffer.ts:460

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
- Defined in src/core/Framebuffer.ts:426
set readBuffer(value: number | boolean): void
Parameters
- value: number | boolean
Returns void
- Defined in src/core/Framebuffer.ts:443

status

get status(): FramebufferStatus
The status of this framebuffer.

Returns FramebufferStatus
See
checkFramebufferStatus
- Defined in src/core/Framebuffer.ts:208

width

get width(): number
The width of this framebuffer.

Returns number
- Defined in src/core/Framebuffer.ts:263

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
- framebufferTexture2D
- framebufferTextureLayer
- Defined in src/core/Framebuffer.ts:285
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
- framebufferTexture2D
- framebufferTextureLayer
- Defined in src/core/Framebuffer.ts:304
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
- Defined in src/core/Framebuffer.ts:319

delete

delete(): void
Delete this framebuffer.

Returns void
See
deleteFramebuffer
- Defined in src/core/Framebuffer.ts:217

Class Framebuffer

See

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Framebuffer

See

Properties

Readonlycontext

Accessors

drawBuffers

Returns (number | boolean)[]

See

Throws

Parameters

Returns void

height

Returns number

readAttachment

Returns undefined | Renderbuffer | Texture

readBuffer

Returns number | boolean

See

Parameters

Returns void

status

Returns FramebufferStatus

See

width

Returns number

Methods

attach

Parameters

Returns void

Throws

See

Parameters

Returns void

Throws

See

Parameters

Returns void

Throws

See

delete

Returns void

See

Settings

On This Page

`Readonly`context