Interface Regl

Documentation for interface Regl.

Hierarchy

Regl

Callable

__call(state: State): Command

- Defined in regl.d.ts:65
Creates a new REGL command. The resulting command, when executed, will set a WebGL state machine to a specified state.

Parameters
- state: State
Returns Command

Index

Properties

Methods

Properties

_gl

_gl: WebGLRenderingContext

attributes

attributes: WebGLContextAttributes

contextLost

contextLost: boolean

limits

limits: Limits

stats

stats: Stats

Methods

_refresh

_refresh(): void

- Defined in regl.d.ts:192
Returns void

buffer

buffer(length: number): Buffer
buffer(options: BufferOptions): Buffer

- Defined in regl.d.ts:106
Parameters
- length: number
Returns Buffer
- Defined in regl.d.ts:107
Parameters
- options: BufferOptions
Returns Buffer

clear

clear(options: ClearOptions): void

- Defined in regl.d.ts:74
Clears selected buffers to specified values.

Parameters
- options: ClearOptions
Returns void

context

context(name: string): DynamicVariable

- Defined in regl.d.ts:96
Parameters
- name: string
Returns DynamicVariable

cube

cube(radius?: number): TextureCube
cube(posX: TextureImageData, negX: TextureImageData, posY: TextureImageData, negY: TextureImageData, posZ: TextureImageData, negZ: TextureImageData): TextureCube
cube(options: TextureCubeOptions): TextureCube

- Defined in regl.d.ts:121
Parameters
- Optional radius: number
Returns TextureCube
- Defined in regl.d.ts:122
Parameters
- posX: TextureImageData
- negX: TextureImageData
- posY: TextureImageData
- negY: TextureImageData
- posZ: TextureImageData
- negZ: TextureImageData
Returns TextureCube
- Defined in regl.d.ts:127
Parameters
- options: TextureCubeOptions
Returns TextureCube

destroy

destroy(): void

- Defined in regl.d.ts:188
Destroys the gl context and releases all associated resources.

Returns void

draw

draw(): void

- Defined in regl.d.ts:102
Executes an empty draw command

Returns void

elements

elements(options: ElementsOptions): Elements

- Defined in regl.d.ts:109
Parameters
- options: ElementsOptions
Returns Elements

frame

frame(callback: function): Cancel

- Defined in regl.d.ts:145
Registers a callback to be called on each animation frame.

This method integrates with requestAnimationFrame and context loss events. It also calls gl.flush and drains several internal buffers, so you should try to do all your rendering to the drawing buffer within the frame callback.

Parameters
- callback: function
  - - (): void
    - Returns void
Returns Cancel

framebuffer

framebuffer(options: FramebufferOptions): Framebuffer

- Defined in regl.d.ts:131
Parameters
- options: FramebufferOptions
Returns Framebuffer

framebufferCube

framebufferCube(options: FramebufferCubeOptions): FramebufferCube

- Defined in regl.d.ts:133
Parameters
- options: FramebufferCubeOptions
Returns FramebufferCube

hasExtension

hasExtension(name: string): boolean

- Defined in regl.d.ts:167
Test if an extension is present. Argument is case insensitive.

For more information on WebGL extensions, see the WebGL extension registry.

Relevant WebGL APIs
- WebGL Extension Registry
- gl.getExtension
- gl.getSupportedExtensions
Parameters
- name: string
  
  case-insensitive name of WebGL extension
Returns boolean

now

now(): number

- Defined in regl.d.ts:181
Returns Total time elapsed since regl was initialized in seconds.

Returns number

on

on(type: "frame", handler: function): Cancel
on(type: "lost", handler: function): Cancel
on(type: "restore", handler: function): Cancel
on(type: "destroy", handler: function): Cancel

- Defined in regl.d.ts:147
Parameters
- type: "frame"
- handler: function
  - - (): void
    - Returns void
Returns Cancel
- Defined in regl.d.ts:148
Parameters
- type: "lost"
- handler: function
  - - (): void
    - Returns void
Returns Cancel
- Defined in regl.d.ts:149
Parameters
- type: "restore"
- handler: function
  - - (): void
    - Returns void
Returns Cancel
- Defined in regl.d.ts:150
Parameters
- type: "destroy"
- handler: function
  - - (): void
    - Returns void
Returns Cancel

poll

poll(): void

- Defined in regl.d.ts:174
Updates the values of internal times and recalculates the size of viewports.

Returns void

prop

prop(name: string): DynamicVariable

- Defined in regl.d.ts:95
Parameters
- name: string
Returns DynamicVariable

read

read(): Uint8Array | Float32Array
read<T>(data: T): T
read<T>(options: ReadOptions<T>): T

- Defined in regl.d.ts:81
Read entire screen.

Returns Uint8Array | Float32Array
- Defined in regl.d.ts:86
Read entire screen into an existing ArrayBufferView.

Type parameters
- T: Uint8Array | Float32Array
Parameters
- data: T
Returns T
- Defined in regl.d.ts:91
Read a selected region of screen or framebuffer.

Type parameters
- T: Uint8Array | Float32Array
Parameters
- options: ReadOptions<T>
Returns T

renderbuffer

renderbuffer(options: RenderbufferOptions): Renderbuffer

- Defined in regl.d.ts:129
Parameters
- options: RenderbufferOptions
Returns Renderbuffer

texture

texture(width?: number, height?: number): Texture2D
texture(data: TextureImageData): Texture2D
texture(options: Texture2DOptions): Texture2D

- Defined in regl.d.ts:117
Creates an empty texture with given dimensions.

Parameters
- Optional width: number
  
  width of a texture, in pixels (Default: 1)
- Optional height: number
  
  height of a texture, in pixels (Default: equal to width)
Returns Texture2D
- Defined in regl.d.ts:118
Parameters
- data: TextureImageData
Returns Texture2D
- Defined in regl.d.ts:119
Parameters
- options: Texture2DOptions
Returns Texture2D

this

this(name: string): DynamicVariable

- Defined in regl.d.ts:97
Parameters
- name: string
Returns DynamicVariable

Generated using TypeDoc