Class Framebuffer

Hierarchy

Framebuffer

Index

Methods

bind delete get2DCanvas getDepth getDepths getId getIds getImageDataArray getImageDataBlob getImageDataUrl getPixel getXYZ getXYZArray getXYZRange

Constructors

Properties

depthTexture framebuffer height isReady renderbuffer texture width

Methods

bind

bind(): void
Returns void
- Defined in src/framebuffer.ts:93

delete

delete(): void
Deletes all WebGL objects it holds

Returns void
- Defined in src/framebuffer.ts:307

get2DCanvas

get2DCanvas(): HTMLCanvasElement
Returns HTMLCanvasElement
- Defined in src/framebuffer.ts:260

getDepth

getDepth(x: number, y: number): number
Parameters
- x: number
- y: number
Returns number
- Defined in src/framebuffer.ts:112

getDepths

getDepths(points: {
x: number;
y: number;
}[]): number[]
Parameters
- points: {
  x: number;
  y: number;
  }[]
Returns number[]
- Defined in src/framebuffer.ts:122

getId

getId(x: number, y: number): number
Parameters
- x: number
- y: number
Returns number
- Defined in src/framebuffer.ts:202

getIds

getIds(points: {
x: number;
y: number;
}[]): number[]
Parameters
- points: {
  x: number;
  y: number;
  }[]
Returns number[]
- Defined in src/framebuffer.ts:218

getImageDataArray

getImageDataArray(): Uint8ClampedArray
Returns Uint8ClampedArray
- Defined in src/framebuffer.ts:236

getImageDataBlob

getImageDataBlob(callback: ((blob: Blob) => void), type?: "png" | "jpeg"): void
Gets current image data as a BLOB. Use callback to handle data.
Parameters
- callback: ((blob: Blob) => void)
  
  Use callback to handle Blob
  - - (blob: Blob): void
    - Parameters
      
      blob: Blob
      
      Returns void
- type: "png" | "jpeg" = 'png'
Returns void
- Defined in src/framebuffer.ts:296

getImageDataUrl

getImageDataUrl(type?: "png" | "jpeg"): string
Gets current image data from the framebuffer as Base64 string
Parameters
- type: "png" | "jpeg" = 'png'
Returns string
- Defined in src/framebuffer.ts:284

getPixel

getPixel(x: number, y: number): Uint8Array
Returns one pixel at defined position
Parameters
- x: number
- y: number
Returns Uint8Array
- Defined in src/framebuffer.ts:104

getXYZ

getXYZ(x: number, y: number): vec3
Computes normalised X, Y, Z of event in the clip space
Parameters
- x: number
  
  X coordinate of the event
- y: number
  
  Y coordinate of the event
Returns vec3
- Defined in src/framebuffer.ts:158

getXYZArray

getXYZArray(points: {
x: number;
y: number;
}[]): vec3[]
Parameters
- points: {
  x: number;
  y: number;
  }[]
Returns vec3[]
- Defined in src/framebuffer.ts:130

getXYZRange

getXYZRange(x: number, y: number): {
    far: vec3;
    middle: vec3;
    near: vec3;
}
Computes normalised X, Y, Z of event in the clip space with near and far bounds, This can be used to refine near and far clipping planes for more precise evaluation in the second pass.
Parameters
- x: number
  
  X coordinate of the event
- y: number
  
  Y coordinate of the event
Returns {
    far: vec3;
    middle: vec3;
    near: vec3;
}
- far: vec3
- middle: vec3
- near: vec3
- Defined in src/framebuffer.ts:174

Constructors

constructor

new Framebuffer(gl: WebGLRenderingContext, width: number, height: number, withDepth: boolean, glVersion: number): Framebuffer
Parameters
- gl: WebGLRenderingContext
- width: number
- height: number
- withDepth: boolean
- glVersion: number
Returns Framebuffer
- Defined in src/framebuffer.ts:26

Properties

depthTexture

depthTexture: WebGLTexture

framebuffer

framebuffer: WebGLFramebuffer

height

height: number

isReady

isReady: boolean = true

renderbuffer

renderbuffer: WebGLRenderbuffer

texture

texture: WebGLTexture

width

width: number

Generated using TypeDoc