Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type Aliases

Attribute: number | AttributeState
BVec4: [boolean, boolean, boolean, boolean]
BlendingEquation: "add" | "subtract" | "reverse subtract" | "min" | "max"
BlendingFunction: "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"
BufferData: number[] | number[][] | Uint8Array | Int8Array | Uint16Array | Int16Array | Uint32Array | Int32Array | Float32Array
BufferDataType: "uint8" | "int8" | "uint16" | "int16" | "uint32" | "int32" | "float32" | "float"
BufferUsageHint: "static" | "dynamic" | "stream"
CommandBodyFn<Context, Props>: ((context: Context, props: Props, batchId: number) => void)

Type Parameters

Type declaration

    • (context: Context, props: Props, batchId: number): void
    • Commands can be nested using scoping. If a DrawCommand is passed a CommandBodyFn, then the DrawCommand is evaluated and its state variables are saved as the defaults for all DrawCommands invoked within the CommandBodyFn.

      Parameters

      • context: Context

        REGL context

      • props: Props

        additional parameters of a draw call

      • batchId: number

        index of a command in a batch call

      Returns void

ComparisonOperatorType: "never" | "always" | "less" | "<" | "lequal" | "<=" | "greater" | ">" | "gequal" | ">=" | "equal" | "=" | "notequal" | "!="
DynamicVariableFn<Return, Context, Props>: ((context: Context, props: Props, batchId: number) => Return)

Type Parameters

Type declaration

    • (context: Context, props: Props, batchId: number): Return
    • Parameters

      • context: Context
      • props: Props
      • batchId: number

      Returns Return

ElementsData: number[] | number[][] | Uint8Array | Uint16Array | Uint32Array
ElementsDataType: "uint8" | "uint16" | "uint32"
FaceOrientationType: "front" | "back"
FaceWindingType: "cw" | "ccw"
FrameCallback: ((context: DefaultContext) => void)

Type declaration

    • A handler function invoked when regl fires the "frame" event. It is passed the default Context.

      Parameters

      Returns void

Framebuffer2DAttachment: Texture2D | Renderbuffer
FramebufferColorDataType: "uint8" | "half float" | "float"
MaybeDynamic<Type, Context, Props>: Type | DynamicVariable<Type> | DynamicVariableFn<Type, Context, Props>

Type Parameters

MaybeDynamicAttributes<Attributes, Context, Props>: { [ Key in keyof Attributes]: MaybeDynamic<Attributes[Key], Context, Props> }

Type Parameters

MaybeDynamicUniforms<Uniforms, Context, Props>: { [ Key in keyof Uniforms]: MaybeDynamic<Uniforms[Key], Context, Props> | MaybeDynamic<Uniforms[Key], Context, Props>[] }

Type Parameters

MaybeNestedDynamic<Type, Context, Props>: { [ K in keyof Type]: MaybeDynamic<Type[K], Context, Props> }

Type Parameters

PrimitiveType: "points" | "lines" | "line strip" | "line loop" | "triangles" | "triangle strip" | "triangle fan"
RenderbufferColorFormat: "rgba4" | "rgb565" | "rgb5 a1" | "rgb16f" | "rgba16f" | "rgba32f" | "srgba"
RenderbufferFormat: RenderbufferColorFormat | "depth" | "stencil" | "depth stencil"
StencilOperationType: "zero" | "keep" | "replace" | "invert" | "increment" | "decrement" | "increment wrap" | "decrement wrap"
TextureChannelsType: 1 | 2 | 3 | 4
TextureColorSpaceType: "none" | "browser"
TextureCubeFaceIndex: 0 | 1 | 2 | 3 | 4 | 5
TextureDataType: "uint8" | "uint16" | "uint32" | "float" | "float32" | "half float" | "float16"
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: number[] | number[][] | number[][][] | ArrayBufferView | NDArrayLike | HTMLImageElement | HTMLVideoElement | HTMLCanvasElement | CanvasRenderingContext2D
TextureMagFilterType: "nearest" | "linear"
TextureMinFilterType: "nearest" | "linear" | "linear mipmap linear" | "mipmap" | "nearest mipmap linear" | "linear mipmap nearest" | "nearest mipmap nearest"
TextureMipmapHintType: "don't care" | "dont care" | "nice" | "fast"
TextureUnpackAlignmentType: 1 | 2 | 4 | 8
TextureWrapModeType: "repeat" | "clamp" | "mirror"
Uniform: boolean | number | boolean[] | number[] | Float32Array | Int32Array
UserContext<ParentContext, OwnContext, Props>: { [ Key in keyof OwnContext]: MaybeDynamic<OwnContext[Key], ParentContext, Props> }

Type Parameters

  • ParentContext extends DefaultContext

  • OwnContext extends {}

  • Props extends {}

Vec4: [number, number, number, number]

Generated using TypeDoc