Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DrawConfig<Uniforms, Attributes, Props, OwnContext, ParentContext>

Type Parameters

  • Uniforms extends {} = {}

  • Attributes extends {} = {}

  • Props extends {} = {}

  • OwnContext extends {} = {}

  • ParentContext extends DefaultContext = DefaultContext

Hierarchy

  • DrawConfig

Index

Properties

Properties

Optional attributes

attributes?: MaybeDynamicAttributes<Attributes, ParentContext & OwnContext, Props>

Object mapping names of attribute variables to their values.

Related WebGL APIs

  • gl.vertexAttribPointer
  • gl.vertexAttrib
  • gl.getAttribLocation
  • gl.vertexAttibDivisor
  • gl.enableVertexAttribArray, gl.disableVertexAttribArray

Optional blend

blend?: MaybeDynamic<BlendingOptions, ParentContext & OwnContext, Props>

Related WebGL APIs

  • gl.blendEquationSeparate
  • gl.blendFuncSeparate
  • gl.blendColor

Optional colorMask

colorMask?: MaybeDynamic<BVec4, ParentContext & OwnContext, Props>

Optional context

context?: UserContext<ParentContext, OwnContext, Props>

Object mapping user-defined keys to user-defined values to be accessed via DynamicVariables or DynamicVariableFns elsewhere in the DrawConfig or in scoped DrawCommands. Context variables in regl are computed before any other parameters and can also be passed from a scoped command to any sub-commands. Both DynamicVariables and DynamicVariableFns can be used as values in the context object, making it possible to define new context properties derived from existing context properties or from props.

Optional count

count?: MaybeDynamic<number, ParentContext & OwnContext, Props>

Number of vertices to draw. (Default: 0, or inferred from elements)

Optional cull

cull?: MaybeDynamic<CullingOptions, ParentContext & OwnContext, Props>

Optional depth

depth?: MaybeDynamic<DepthTestOptions, ParentContext & OwnContext, Props>

Related WebGL APIs

  • gl.depthFunc
  • gl.depthMask
  • gl.depthRange

Optional dither

dither?: MaybeDynamic<boolean, ParentContext & OwnContext, Props>

Optional elements

elements?: MaybeDynamic<null | ElementsData | Elements | ElementsOptions, ParentContext & OwnContext, Props>

Element array buffer. (Default: null)

Elements must be either an instance of REGL.Elements or else the arguments to REGL.Elements. If elements is specified while primitive, count and offset are not, then these values may be inferred from the state of the element array buffer.

Optional frag

frag?: MaybeDynamic<string, ParentContext & OwnContext, Props>

Source code of fragment shader

Optional framebuffer

framebuffer?: MaybeDynamic<null | Framebuffer, ParentContext & OwnContext, Props>

A framebuffer to be used as a target for drawing. (Default: null) Passing null sets the framebuffer to the drawing buffer. Updating the render target will modify the viewport.

Related WebGL APIs

Optional frontFace

frontFace?: MaybeDynamic<FaceWindingType, ParentContext & OwnContext, Props>

Optional instances

instances?: MaybeDynamic<number, ParentContext & OwnContext, Props>

Number of instances to draw. (Default: 0)

Only applicable if the ANGLE_instanced_arrays extension is present.

Optional lineWidth

lineWidth?: MaybeDynamic<number, ParentContext & OwnContext, Props>

Optional offset

offset?: MaybeDynamic<number, ParentContext & OwnContext, Props>

Offset of primitives to draw. (Default: 0, or inferred from elements)

Optional polygonOffset

polygonOffset?: MaybeDynamic<PolygonOffsetOptions, ParentContext & OwnContext, Props>

Related WebGL APIs

  • gl.polygonOffset

Optional primitive

primitive?: MaybeDynamic<PrimitiveType, ParentContext & OwnContext, Props>

Sets the primitive type. (Default: 'triangles', or inferred from elements)

Optional profile

profile?: MaybeDynamic<boolean, ParentContext & OwnContext, Props>

If set, turns on profiling for this command. (Default: false) Profiling stats can be accessed via the stats property of the DrawCommand.

Optional sample

sample?: MaybeDynamic<SamplingOptions, ParentContext & OwnContext, Props>

Optional scissor

scissor?: MaybeNestedDynamic<ScissorOptions, ParentContext & OwnContext, Props>

Optional stencil

stencil?: MaybeDynamic<StencilOptions, ParentContext & OwnContext, Props>

Related WebGL APIs

  • gl.stencilFunc
  • gl.stencilMask
  • gl.stencilOpSeparate

Optional uniforms

uniforms?: MaybeDynamicUniforms<Uniforms, ParentContext & OwnContext, Props>

Object mapping names of uniform variables to their values. To specify uniforms in GLSL structs use the fully qualified path with dot notation. example: 'nested.value': 5.3 To specify uniforms in GLSL arrays use the fully qualified path with bracket notation. example: 'colors[0]': [0, 1, 0, 1]

Related WebGL APIs

  • gl.getUniformLocation
  • gl.uniform

Optional vao

vao?: MaybeDynamic<AttributeState[] | VertexArrayObject, ParentContext & OwnContext, Props>

Configuration of vertex array object

Optional vert

vert?: MaybeDynamic<string, ParentContext & OwnContext, Props>

Source code of vertex shader

Optional viewport

viewport?: MaybeDynamic<BoundingBox, ParentContext & OwnContext, Props>

Sets gl.viewport. Default: {} Updating viewport will modify the context variables viewportWidth and viewportHeight.

Generated using TypeDoc