Options
All
  • Public
  • Public/Protected
  • All
Menu

Module REGL

Callable

  • Creates a full screen canvas element and a WebGL rendering context.

    Returns Regl

  • Creates a WebGL rendering context using an element selected by selector.

    Parameters

    • selector: string

      an argument to document.querySelector

    Returns Regl

  • Creates a WebGL rendering context using a <canvas> element.

    Parameters

    • canvas: HTMLCanvasElement

      HTML canvas element

    Returns Regl

  • Creates a canvas element and a WebGL rendering context in a given container element.

    Parameters

    • container: HTMLElement

      an HTML element

    Returns Regl

  • Wraps an existing WebGL rendering context.

    Parameters

    • gl: WebGLRenderingContext

      WebGL rendering context

    Returns Regl

  • Creates a WebGL according to specified options

    Parameters

    Returns Regl

Index

Interfaces

Type aliases

Type aliases

BlendingEquationType

BlendingEquationType: "add" | "subtract" | "reverse subtract" | "min" | "max"

BlendingFunctionType

BlendingFunctionType: "zero" | 0 | "one" | 1 | "src color" | "one minus src color" | "src alpha" | "one minus src alpha" | "dst color" | "one minus dst color" | "dst alpha" | "one minus dst alpha" | "constant color" | "one minus constant color" | "constant alpha" | "one minus constant alpha" | "src alpha saturate"

BufferDataType

BufferDataType: number | Array<number> | Uint8Array | Int8Array | Uint16Array | Int16Array | Uint32Array | Int32Array | Float32Array

BufferDataTypeType

BufferDataTypeType: "uint8" | "int8" | "uint16" | "int16" | "uint32" | "int32" | "float32" | "float"

BufferUsageHintType

BufferUsageHintType: "static" | "dynamic" | "stream"

ComparisonOperatorType

ComparisonOperatorType: "never" | "always" | "less" | "<" | "lequal" | "<=" | "greater" | ">" | "gequal" | ">=" | "equal" | "=" | "notequal" | "!="

DynamicVariable

DynamicVariable: object

Type declaration

  • Dynamic Variable: void

DynamicVariableFn

DynamicVariableFn: function

Type declaration

ElementsDataTypeType

ElementsDataTypeType: "uint8" | "uint16" | "uint32"

FaceOrientationType

FaceOrientationType: "front" | "back"

FaceWindingType

FaceWindingType: "cw" | "ccw"

FramebufferColorDataTypeType

FramebufferColorDataTypeType: "uint8" | "half float" | "float"

FramebufferColorFormatType

FramebufferColorFormatType: "rgba" | "rgba4" | "rgb565" | "rgb5 a1" | "rgb16f" | "rgba16f" | "rgba32f" | "srgba"

PrimitiveType

PrimitiveType: "points" | "lines" | "line strip" | "line loop" | "triangles" | "triangle strip" | "triangle fan"

PropType

PropType: boolean | number | DynamicVariable | DynamicVariableFn | PropArray | Props

Props

Props: object

Type declaration

RenderbufferFormatType

RenderbufferFormatType: "rgba4" | "rgb565" | "rgb5 a1" | "depth" | "stencil" | "depth stencil" | "srgba" | "rgba16f" | "rgb16f" | "rgba32f"

StencilOperationType

StencilOperationType: "zero" | "keep" | "replace" | "invert" | "increment" | "decrement" | "increment wrap" | "decrement wrap"

TextureChannelsType

TextureChannelsType: 1 | 2 | 3 | 4

TextureColorSpaceType

TextureColorSpaceType: "none" | "browser"

TextureCubeFaceIndexType

TextureCubeFaceIndexType: 0 | 1 | 2 | 3 | 4 | 5

TextureDataTypeType

TextureDataTypeType: "uint8" | "uint16" | "uint32" | "float" | "half float"

TextureFormatType

TextureFormatType: "alpha" | "luminance" | "luminance alpha" | "rgb" | "rgba" | "rgba4" | "rgb5 a1" | "rgb565" | "srgb" | "srgba" | "depth" | "depth stencil" | "rgb s3tc dxt1" | "rgba s3tc dxt1" | "rgba s3tc dxt3" | "rgba s3tc dxt5" | "rgb atc" | "rgba atc explicit alpha" | "rgba atc interpolated alpha" | "rgb pvrtc 4bppv1" | "rgb pvrtc 2bppv1" | "rgba pvrtc 4bppv1" | "rgba pvrtc 2bppv1" | "rgb etc1"

TextureImageData

TextureImageData: number[] | number[] | ArrayBufferView | HTMLImageElement | HTMLCanvasElement | CanvasRenderingContext2D | HTMLVideoElement | NDArray

TextureMagFilterType

TextureMagFilterType: "nearest" | "linear"

TextureMinFilterType

TextureMinFilterType: "nearest" | "linear" | "linear mipmap linear" | "mipmap" | "nearest mipmap linear" | "linear mipmap nearest" | "nearest mipmap nearest"

TextureMipmapHintType

TextureMipmapHintType: "don't care" | "dont care" | "nice" | "fast"

TextureUnpackAlignmentType

TextureUnpackAlignmentType: 1 | 2 | 4 | 8

TextureWrapModeType

TextureWrapModeType: "repeat" | "clamp" | "mirror"

Generated using TypeDoc