Class Renderbuffer

A buffer that can contain an image or be the source or target of a rendering operation.

See

Hierarchy

Renderbuffer

Index

Constructors

Properties

context format height internal width

Methods

bind delete with bind getBoundRenderbuffer unbind

Constructors

constructor

new Renderbuffer(context, format, width, height): Renderbuffer
Creates a renderbuffer.
Parameters
- context: Context
  
  The rendering context of the renderbuffer.
- format: RenderbufferFormat
  
  The format of the renderbuffer.
- width: number
  
  The width of the renderbuffer.
- height: number
  
  The height of the renderbuffer.
Returns Renderbuffer
- Defined in src/core/Renderbuffer.ts:53

Properties

`Readonly` context

context: Context

The rendering context of this renderbuffer.

`Readonly` format

format: RenderbufferFormat

The format of this renderbuffer.

`Readonly` height

height: number

The height of this renderbuffer.

`Readonly` internal

internal: WebGLRenderbuffer

The WebGL API interface of this renderbuffer.

`Readonly` width

width: number

The width of this renderbuffer.

Methods

bind

bind(): void
Binds this renderbuffer.

Returns void
- Defined in src/core/Renderbuffer.ts:97

delete

delete(): void
Deletes this renderbuffer.

Returns void
- Defined in src/core/Renderbuffer.ts:119

with

with<T>(f): T
Executes the given function with this renderbuffer bound, then re-binds the previously-bound renderbuffer.
Type Parameters
- T
Parameters
- f: ((renderbuffer) => T)
  
  The function to execute.
  - - (renderbuffer): T
    - Parameters
      
      renderbuffer: Renderbuffer
      
      Returns T
Returns T
The return value of the executed function.
- Defined in src/core/Renderbuffer.ts:108

`Static` `Private` bind

bind(context, renderbuffer): void
Binds the given renderbuffer.
Parameters
- context: Context
  
  The rendering context.
- renderbuffer: null | WebGLRenderbuffer
  
  The renderbuffer.
Returns void
- Defined in src/core/Renderbuffer.ts:26

`Static` `Private` getBoundRenderbuffer

getBoundRenderbuffer(context): null | WebGLRenderbuffer
Gets the currently-bound renderbuffer.
Parameters
- context: Context
  
  The rendering context.
Returns null | WebGLRenderbuffer
The renderbuffer.
- Defined in src/core/Renderbuffer.ts:39

`Static` unbind

unbind(context): void
Unbinds all renderbuffers from the given rendering context.
Parameters
- context: Context
  
  The rendering context.
Returns void
- Defined in src/core/Renderbuffer.ts:16

Generated using TypeDoc