Class Framebuffer

A collection of Textures and/or Renderbuffers that can be rendered to.

Hierarchy

default
- Framebuffer

Index

Properties

Constructors

constructor

Methods

Properties

Protected gl

gl: WebGL2RenderingContext

Protected ready

ready: Promise<void>

Constructors

constructor

new Framebuffer(__namedParameters: FramebufferProps): Framebuffer

Overrides ContextConsumer.constructor
- Defined in webgl/src/lib/buffer/Framebuffer.ts:82
Parameters
- __namedParameters: FramebufferProps
Returns Framebuffer

Methods

verify

verify(): Promise<boolean>

- Defined in webgl/src/lib/buffer/Framebuffer.ts:196
Checks for Framebuffer completeness, i.e. whether all attachements have a valid format and can be rendered to.

Returns Promise<boolean>
true if the Framebuffer is complete, false otherwise.

bind

bind(): boolean

- Defined in webgl/src/lib/buffer/Framebuffer.ts:248
Binds the framebuffer to the gl.FRAMEBUFFER binding point.

Returns boolean
true if the buffer has successfully been bound, false otherwise.

blit

blit(params: BlitParams): Promise<void>

- Defined in webgl/src/lib/buffer/Framebuffer.ts:274
Copies (partial) content from a given Framebuffer to this one, once both are ready.

Parameters
- params: BlitParams
  
  Parameters detailing what to copy. See BlitParams.
Returns Promise<void>

blitSync

blitSync(params: BlitParams): void

- Defined in webgl/src/lib/buffer/Framebuffer.ts:286
Immediately copies (partial) content from a given Framebuffer to this one. This assumes both Framebuffers are ready.

Parameters
- params: BlitParams
  
  Parameters detailing what to copy. See BlitParams.
Returns void

clear

clear(param0: { color?: Record<number, number[]>; stencil?: number; depth?: number }): void

- Defined in webgl/src/lib/buffer/Framebuffer.ts:422
Clears the specified attachments to the provided values.
example
Clearing depth to 1 and color attachements 1 and 3 to red and green respectively:
```
myFbo.clear({
    color: {
        1: [1, 0, 0],
        3: [0, 1, 0],
    },
    depth: 1,
});
```
Parameters
- param0: { color?: Record<number, number[]>; stencil?: number; depth?: number }
  
  Object specifying the attachements to clear.
  - Optional color?: Record<number, number[]>
  - Optional stencil?: number
  - Optional depth?: number
Returns void

delete

delete(): Promise<void>

- Defined in webgl/src/lib/buffer/Framebuffer.ts:469
Flags the underlying WebGLFramebuffer for deletion. The buffer cannot be bound afterwards.

remarks
Note, that only the framebuffer itself is deleted. The attached textures and renderbuffers remain unchanged and must be deleted manually.

Returns Promise<void>

Generated using TypeDoc