Module

WebGL.Raw.WebGL2.WebGL2RenderingContext

Package
purescript-webgl2-raw
Repository
chrismshelton/purescript-webgl2-raw

#vertexAttribDivisor Source

vertexAttribDivisor :: forall c. IsWebGL2RenderingContext c => c -> GLuint -> GLuint -> Effect Unit

Usage: vertexAttribDivisor gl index divisor

void vertexAttribDivisor (GLuint index, GLuint divisor);

Documentation: WebGL 2.0 spec, section 3.7.9

#drawArraysInstanced Source

drawArraysInstanced :: forall c. IsWebGL2RenderingContext c => c -> GLenum -> GLint -> GLsizei -> GLsizei -> Effect Unit

Usage: drawArraysInstanced gl mode first count instanceCount

void
drawArraysInstanced ( GLenum mode
                    , GLint first
                    , GLsizei count
                    , GLsizei instanceCount
                    );

Documentation: WebGL 2.0 spec, section 3.7.9

#drawElementsInstanced Source

drawElementsInstanced :: forall c. IsWebGL2RenderingContext c => c -> GLenum -> GLsizei -> GLenum -> GLintptr -> GLsizei -> Effect Unit

Usage: drawElementsInstanced gl mode count type offset instanceCount

void
drawElementsInstanced ( GLenum mode
                      , GLsizei count
                      , GLenum type
                      , GLintptr offset
                      , GLsizei instanceCount
                      );

Documentation: WebGL 2.0 spec, section 3.7.9

#drawRangeElements Source

drawRangeElements :: forall c. IsWebGL2RenderingContext c => c -> GLenum -> GLuint -> GLuint -> GLsizei -> GLenum -> GLintptr -> Effect Unit

Usage: drawRangeElements gl mode start end count type offset

void
drawRangeElements ( GLenum mode
                  , GLuint start
                  , GLuint end
                  , GLsizei count
                  , GLenum type
                  , GLintptr offset
                  );

Documentation: WebGL 2.0 spec, section 3.7.9

#readPixelsPackBuffer Source

readPixelsPackBuffer :: forall c. IsWebGL2RenderingContext c => c -> GLint -> GLint -> GLsizei -> GLsizei -> GLenum -> GLenum -> GLintptr -> Effect Unit

Usage: readPixelsPackBuffer gl x y width height format type offset

void
readPixels ( GLint x
           , GLint y
           , GLsizei width
           , GLsizei height
           , GLenum format
           , GLenum type
           , GLintptr offset
           );

Documentation: WebGL 2.0 spec, section 3.7.10

#readPixels Source

readPixels :: forall c a. IsWebGL2RenderingContext c => IsArrayBufferView a => c -> GLint -> GLint -> GLsizei -> GLsizei -> GLenum -> GLenum -> a -> GLuint -> Effect Unit

Usage: readPixels gl x y width height format type dstData dstOffset

void
readPixels ( GLint x
           , GLint y
           , GLsizei width
           , GLsizei height
           , GLenum format
           , GLenum type
           , [AllowShared] ArrayBufferView dstData
           , GLuint dstOffset
           );

Documentation: WebGL 2.0 spec, section 3.7.10

#drawBuffers Source

drawBuffers :: forall c. IsWebGL2RenderingContext c => c -> Array GLenum -> Effect Unit

Usage: drawBuffers gl buffers

void drawBuffers (sequence<GLenum> buffers);

Documentation: WebGL 2.0 spec, section 3.7.11

#clearBufferfv Source

clearBufferfv :: forall f c. IsWebGL2RenderingContext c => IsFloat32List f => c -> GLenum -> GLint -> f -> Maybe GLuint -> Effect Unit

Usage: clearBufferfv gl buffer drawbuffer values srcOffset

void
clearBufferfv ( GLenum buffer
              , GLint drawbuffer
              , Float32List values
              , optional GLuint srcOffset = 0
              );

#clearBufferiv Source

clearBufferiv :: forall i c. IsWebGL2RenderingContext c => IsInt32List i => c -> GLenum -> GLint -> i -> Maybe GLuint -> Effect Unit

Usage: clearBufferiv gl buffer drawbuffer values srcOffset

void
clearBufferiv ( GLenum buffer
              , GLint drawbuffer
              , Int32List values
              , optional GLuint srcOffset = 0
              );

#clearBufferuiv Source

clearBufferuiv :: forall u c. IsWebGL2RenderingContext c => IsUint32List u => c -> GLenum -> GLint -> u -> Maybe GLuint -> Effect Unit

Usage: clearBufferuiv gl buffer drawbuffer values srcOffset

void
clearBufferuiv ( GLenum buffer
               , GLint drawbuffer
               , Uint32List values
               , optional GLuint srcOffset = 0
               );

#clearBufferfi Source

clearBufferfi :: forall c. IsWebGL2RenderingContext c => c -> GLenum -> GLint -> GLfloat -> GLint -> Effect Unit

Usage: clearBufferfi gl buffer drawbuffer depth stencil

void
clearBufferfi ( GLenum buffer
              , GLint drawbuffer
              , GLfloat depth
              , GLint stencil
              );

#getIndexedParameterGLintptr Source

getIndexedParameterGLintptr :: forall c. IsWebGL2RenderingContext c => c -> GLenum -> GLuint -> Effect (Maybe GLintptr)

Usage: getIndexedParameterGLintptr gl target index

Use when:

  • target = TRANSFORM_FEEDBACK_BUFFER_START
  • target = UNIFORM_BUFFER_START
any getIndexedParameter (GLenum target, GLuint index);

Documentation: WebGL 2.0 spec, section 3.7.2

Warning: the javascript version of this function returns different types depending on the arguments provided. This function will throw an exception if the returned value is not of the expected type.

#getIndexedParameterGLsizeiptr Source

getIndexedParameterGLsizeiptr :: forall c. IsWebGL2RenderingContext c => c -> GLenum -> GLuint -> Effect (Maybe GLsizeiptr)

Usage: getIndexedParameterGLsizeiptr gl target index

Use when:

  • target = TRANSFORM_FEEDBACK_BUFFER_SIZE
  • target = UNIFORM_BUFFER_SIZE
any getIndexedParameter (GLenum target, GLuint index);

Documentation: WebGL 2.0 spec, section 3.7.2

Warning: the javascript version of this function returns different types depending on the arguments provided. This function will throw an exception if the returned value is not of the expected type.

#getIndexedParameterWebGLBuffer Source

getIndexedParameterWebGLBuffer :: forall c. IsWebGL2RenderingContext c => c -> GLenum -> GLuint -> Effect (Maybe WebGLBuffer)

Usage: getIndexedParameterWebGLBuffer gl target index

Use when:

  • target = TRANSFORM_FEEDBACK_BUFFER_BINDING
  • target = UNIFORM_BUFFER_BINDING
any getIndexedParameter (GLenum target, GLuint index);

Documentation: WebGL 2.0 spec, section 3.7.2

Warning: the javascript version of this function returns different types depending on the arguments provided. This function will throw an exception if the returned value is not of the expected type.

#getParameterGLint64 Source

getParameterGLint64 :: forall c. IsWebGL2RenderingContext c => c -> GLenum -> Effect (Maybe GLint64)

Usage: getParameterGLint64 gl pname

Use when:

  • pname = MAX_CLIENT_WAIT_TIMEOUT_WEBGL
  • pname = MAX_COMBINED_FRAGMENT_UNIFORM_COMPONENTS
  • pname = MAX_COMBINED_VERTEX_UNIFORM_COMPONENTS
  • pname = MAX_ELEMENT_INDEX
  • pname = MAX_SERVER_WAIT_TIMEOUT
  • pname = MAX_UNIFORM_BLOCK_SIZE
any getParameter (GLenum pname);

Documentation: WebGL 2.0 spec, section 3.7.2

Warning: the javascript version of this function returns different types depending on the arguments provided. This function will throw an exception if the returned value is not of the expected type.

#getParameterWebGLSampler Source

getParameterWebGLSampler :: forall c. IsWebGL2RenderingContext c => c -> GLenum -> Effect (Maybe WebGLSampler)

Usage: getParameterWebGLSampler gl pname

Use when:

  • pname = SAMPLER_BINDING
any getParameter (GLenum pname);

Documentation: WebGL 2.0 spec, section 3.7.2

Warning: the javascript version of this function returns different types depending on the arguments provided. This function will throw an exception if the returned value is not of the expected type.

#getParameterWebGLTransformFeedback Source

getParameterWebGLTransformFeedback :: forall c. IsWebGL2RenderingContext c => c -> GLenum -> Effect (Maybe WebGLTransformFeedback)

Usage: getParameterWebGLTransformFeedback gl pname

Use when:

  • pname = TRANSFORM_FEEDBACK_BINDING
any getParameter (GLenum pname);

Documentation: WebGL 2.0 spec, section 3.7.2

Warning: the javascript version of this function returns different types depending on the arguments provided. This function will throw an exception if the returned value is not of the expected type.

#getParameterWebGLVertexArrayObject Source

getParameterWebGLVertexArrayObject :: forall c. IsWebGL2RenderingContext c => c -> GLenum -> Effect (Maybe WebGLVertexArrayObject)

Usage: getParameterWebGLVertexArrayObject gl pname

Use when:

  • pname = VERTEX_ARRAY_BINDING
any getParameter (GLenum pname);

Documentation: WebGL 2.0 spec, section 3.7.2

Warning: the javascript version of this function returns different types depending on the arguments provided. This function will throw an exception if the returned value is not of the expected type.

#getWebGL2RenderingContext Source

getWebGL2RenderingContext :: HTMLCanvasElement -> Maybe WebGLContextAttributes -> Effect (Maybe WebGL2RenderingContext)

Usage: getWebGL2RenderingContext canvas attributes

Re-exports from WebGL.Raw.Types

Re-exports from WebGL.Raw.WebGL1.WebGLRenderingContext

#viewport Source

viewport :: forall c. IsWebGLRenderingContext c => c -> GLint -> GLint -> GLsizei -> GLsizei -> Effect Unit

Usage: viewport gl x y width height

void viewport (GLint x, GLint y, GLsizei width, GLsizei height);

Documentation: WebGL 1.0 spec, section 5.14.4

#stencilOpSeparate Source

stencilOpSeparate :: forall c. IsWebGLRenderingContext c => c -> GLenum -> GLenum -> GLenum -> GLenum -> Effect Unit

Usage: stencilOpSeparate gl face fail zfail zpass

void
stencilOpSeparate ( GLenum face
                  , GLenum fail
                  , GLenum zfail
                  , GLenum zpass
                  );

Documentation: WebGL 1.0 spec, section 5.14.3

#stencilOp Source

stencilOp :: forall c. IsWebGLRenderingContext c => c -> GLenum -> GLenum -> GLenum -> Effect Unit

Usage: stencilOp gl fail zfail zpass

void stencilOp (GLenum fail, GLenum zfail, GLenum zpass);

Documentation: WebGL 1.0 spec, section 5.14.3

#stencilMaskSeparate Source

stencilMaskSeparate :: forall c. IsWebGLRenderingContext c => c -> GLenum -> GLuint -> Effect Unit

Usage: stencilMaskSeparate gl face mask

void stencilMaskSeparate (GLenum face, GLuint mask);

Documentation: WebGL 1.0 spec, section 5.14.3

#stencilMask Source

stencilMask :: forall c. IsWebGLRenderingContext c => c -> GLuint -> Effect Unit

Usage: stencilMask gl mask

void stencilMask (GLuint mask);

Documentation: WebGL 1.0 spec, section 5.14.3

#stencilFuncSeparate Source

stencilFuncSeparate :: forall c. IsWebGLRenderingContext c => c -> GLenum -> GLenum -> GLint -> GLuint -> Effect Unit

Usage: stencilFuncSeparate gl face func ref mask

void
stencilFuncSeparate ( GLenum face
                    , GLenum func
                    , GLint ref
                    , GLuint mask
                    );

Documentation: WebGL 1.0 spec, section 5.14.3

#stencilFunc Source

stencilFunc :: forall c. IsWebGLRenderingContext c => c -> GLenum -> GLint -> GLuint -> Effect Unit

Usage: stencilFunc gl func ref mask

void stencilFunc (GLenum func, GLint ref, GLuint mask);

Documentation: WebGL 1.0 spec, section 5.14.3

#scissor Source

scissor :: forall c. IsWebGLRenderingContext c => c -> GLint -> GLint -> GLsizei -> GLsizei -> Effect Unit

Usage: scissor gl x y width height

void scissor (GLint x, GLint y, GLsizei width, GLsizei height);

Documentation: WebGL 1.0 spec, section 5.14.4

#sampleCoverage Source

sampleCoverage :: forall c. IsWebGLRenderingContext c => c -> GLclampf -> GLboolean -> Effect Unit

Usage: sampleCoverage gl value invert

void sampleCoverage (GLclampf value, GLboolean invert);

Documentation: WebGL 1.0 spec, section 5.14.3

#polygonOffset Source

polygonOffset :: forall c. IsWebGLRenderingContext c => c -> GLfloat -> GLfloat -> Effect Unit

Usage: polygonOffset gl factor units

void polygonOffset (GLfloat factor, GLfloat units);

Documentation: WebGL 1.0 spec, section 5.14.3

#pixelStorei Source

pixelStorei :: forall c. IsWebGLRenderingContext c => c -> GLenum -> GLint -> Effect Unit

Usage: pixelStorei gl pname param

void pixelStorei (GLenum pname, GLint param);

Documentation: WebGL 1.0 spec, section 5.14.3

#lineWidth Source

lineWidth :: forall c. IsWebGLRenderingContext c => c -> GLfloat -> Effect Unit

Usage: lineWidth gl width

void lineWidth (GLfloat width);

Documentation: WebGL 1.0 spec, section 5.14.3

#isEnabled Source

isEnabled :: forall c. IsWebGLRenderingContext c => c -> GLenum -> Effect GLboolean

Usage: isEnabled gl cap

[WebGLHandlesContextLoss] GLboolean isEnabled (GLenum cap);

Documentation: WebGL 1.0 spec, section 5.14.3

#isContextLost Source

isContextLost :: forall c. IsWebGLRenderingContext c => c -> Effect Boolean

Usage: isContextLost gl

[WebGLHandlesContextLoss] boolean isContextLost();

Documentation: WebGL 1.0 spec, section 5.14.13

#hint Source

hint :: forall c. IsWebGLRenderingContext c => c -> GLenum -> GLenum -> Effect Unit

Usage: hint gl target mode

void hint (GLenum target, GLenum mode);

Documentation: WebGL 1.0 spec, section 5.14.3

#getSupportedExtensions Source

getSupportedExtensions :: forall c. IsWebGLRenderingContext c => c -> Effect (Maybe (Array String))

Usage: getSupportedExtensions gl

sequence<DOMString>? getSupportedExtensions();

Documentation: WebGL 1.0 spec, section 5.14.14

#getParameterWebGLTexture Source

getParameterWebGLTexture :: forall c. IsWebGLRenderingContext c => c -> GLenum -> Effect (Maybe WebGLTexture)

Usage: getParameterWebGLTexture gl pname

Use when:

  • pname = TEXTURE_BINDING_2D
  • pname = TEXTURE_BINDING_CUBE_MAP
  • pname = TEXTURE_BINDING_2D_ARRAY (WebGL2)
  • pname = TEXTURE_BINDING_3D (WebGL2)
any getParameter (GLenum pname);

Documentation: WebGL 1.0 spec, section 5.14.3

Warning: the javascript version of this function returns different types depending on the arguments provided. This function will throw an exception if the returned value is not of the expected type.

#getParameterWebGLRenderbuffer Source

getParameterWebGLRenderbuffer :: forall c. IsWebGLRenderingContext c => c -> GLenum -> Effect (Maybe WebGLRenderbuffer)

Usage: getParameterWebGLRenderbuffer gl pname

Use when:

  • pname = RENDERBUFFER_BINDING
any getParameter (GLenum pname);

Documentation: WebGL 1.0 spec, section 5.14.3

Warning: the javascript version of this function returns different types depending on the arguments provided. This function will throw an exception if the returned value is not of the expected type.

#getParameterWebGLProgram Source

getParameterWebGLProgram :: forall c. IsWebGLRenderingContext c => c -> GLenum -> Effect (Maybe WebGLProgram)

Usage: getParameterWebGLProgram gl pname

Use when:

  • pname = CURRENT_PROGRAM
any getParameter (GLenum pname);

Documentation: WebGL 1.0 spec, section 5.14.3

Warning: the javascript version of this function returns different types depending on the arguments provided. This function will throw an exception if the returned value is not of the expected type.

#getParameterWebGLFramebuffer Source

getParameterWebGLFramebuffer :: forall c. IsWebGLRenderingContext c => c -> GLenum -> Effect (Maybe WebGLFramebuffer)

Usage: getParameterWebGLFramebuffer gl pname

Use when:

  • pname = FRAMEBUFFER_BINDING
  • pname = DRAW_FRAMEBUFFER_BINDING (WebGL2)
  • pname = READ_FRAMEBUFFER_BINDING (WebGL2)
any getParameter (GLenum pname);

Documentation: WebGL 1.0 spec, section 5.14.3

Warning: the javascript version of this function returns different types depending on the arguments provided. This function will throw an exception if the returned value is not of the expected type.

#getParameterWebGLBuffer Source

getParameterWebGLBuffer :: forall c. IsWebGLRenderingContext c => c -> GLenum -> Effect (Maybe WebGLBuffer)

Usage: getParameterWebGLBuffer gl pname

Use when:

  • pname = ARRAY_BUFFER_BINDING
  • pname = ELEMENT_ARRAY_BUFFER_BINDING
  • pname = COPY_READ_BUFFER_BINDING (WebGL2)
  • pname = COPY_WRITE_BUFFER_BINDING (WebGL2)
  • pname = PIXEL_PACK_BUFFER_BINDING (WebGL2)
  • pname = PIXEL_UNPACK_BUFFER_BINDING (WebGL2)
  • pname = TRANSFORM_FEEDBACK_BUFFER_BINDING (WebGL2)
  • pname = UNIFORM_BUFFER_BINDING (WebGL2)
any getParameter (GLenum pname);

Documentation: WebGL 1.0 spec, section 5.14.3

Warning: the javascript version of this function returns different types depending on the arguments provided. This function will throw an exception if the returned value is not of the expected type.

#getParameterUint32Array Source

getParameterUint32Array :: forall c. IsWebGLRenderingContext c => c -> GLenum -> Effect (Maybe (ArrayView Uint32))

Usage: getParameterUint32Array gl pname

Use when:

  • pname = COMPRESSED_TEXTURE_FORMATS
any getParameter (GLenum pname);

Documentation: WebGL 1.0 spec, section 5.14.3

Warning: the javascript version of this function returns different types depending on the arguments provided. This function will throw an exception if the returned value is not of the expected type.

#getParameterString Source

getParameterString :: forall c. IsWebGLRenderingContext c => c -> GLenum -> Effect (Maybe String)

Usage: getParameterString gl pname

Use when:

  • pname = RENDERER
  • pname = SHADING_LANGUAGE_VERSION
  • pname = VENDOR
  • pname = VERSION
  • pname = UNMASKED_RENDERER_WEBGL (WEBGL_debug_renderer_info)
  • pname = UNMASKED_VENDOR_WEBGL (WEBGL_debug_renderer_info)
any getParameter (GLenum pname);

Documentation: WebGL 1.0 spec, section 5.14.3

Warning: the javascript version of this function returns different types depending on the arguments provided. This function will throw an exception if the returned value is not of the expected type.

#getParameterInt32Array Source

getParameterInt32Array :: forall c. IsWebGLRenderingContext c => c -> GLenum -> Effect (Maybe (ArrayView Int32))

Usage: getParameterInt32Array gl pname

Use when:

  • pname = MAX_VIEWPORT_DIMS
  • pname = SCISSOR_BOX
  • pname = VIEWPORT
any getParameter (GLenum pname);

Documentation: WebGL 1.0 spec, section 5.14.3

Warning: the javascript version of this function returns different types depending on the arguments provided. This function will throw an exception if the returned value is not of the expected type.

#getParameterGLuint64EXT Source

getParameterGLuint64EXT :: forall c. IsWebGLRenderingContext c => c -> GLenum -> Effect (Maybe GLuint64EXT)

Usage: getParameterGLuint64EXT gl pname

Use when:

  • pname = TIMESTAMP_EXT (EXT_disjoint_timer_query, EXT_disjoint_timer_query_webgl2)
any getParameter (GLenum pname);

Documentation: WebGL 1.0 spec, section 5.14.3

Warning: the javascript version of this function returns different types depending on the arguments provided. This function will throw an exception if the returned value is not of the expected type.

#getParameterGLuint Source

getParameterGLuint :: forall c. IsWebGLRenderingContext c => c -> GLenum -> Effect (Maybe GLuint)

Usage: getParameterGLuint gl pname

Use when:

  • pname = STENCIL_BACK_VALUE_MASK
  • pname = STENCIL_BACK_WRITEMASK
  • pname = STENCIL_VALUE_MASK
  • pname = STENCIL_WRITEMASK
any getParameter (GLenum pname);

Documentation: WebGL 1.0 spec, section 5.14.3

Warning: the javascript version of this function returns different types depending on the arguments provided. This function will throw an exception if the returned value is not of the expected type.

#getParameterGLint Source

getParameterGLint :: forall c. IsWebGLRenderingContext c => c -> GLenum -> Effect (Maybe GLint)

Usage: getParameterGLint gl pname

Use when:

  • pname = ALPHA_BITS
  • pname = BLUE_BITS
  • pname = DEPTH_BITS
  • pname = GREEN_BITS
  • pname = MAX_COMBINED_TEXTURE_IMAGE_UNITS
  • pname = MAX_CUBE_MAP_TEXTURE_SIZE
  • pname = MAX_FRAGMENT_UNIFORM_VECTORS
  • pname = MAX_RENDERBUFFER_SIZE
  • pname = MAX_TEXTURE_IMAGE_UNITS
  • pname = MAX_TEXTURE_SIZE
  • pname = MAX_VARYING_VECTORS
  • pname = MAX_VERTEX_ATTRIBS
  • pname = MAX_VERTEX_TEXTURE_IMAGE_UNITS
  • pname = MAX_VERTEX_UNIFORM_VECTORS
  • pname = PACK_ALIGNMENT
  • pname = RED_BITS
  • pname = SAMPLES
  • pname = SAMPLE_BUFFERS
  • pname = STENCIL_BACK_REF
  • pname = STENCIL_BITS
  • pname = STENCIL_CLEAR_VALUE
  • pname = STENCIL_REF
  • pname = SUBPIXEL_BITS
  • pname = UNPACK_ALIGNMENT
  • pname = MAX_3D_TEXTURE_SIZE (WebGL2)
  • pname = MAX_ARRAY_TEXTURE_LAYERS (WebGL2)
  • pname = MAX_COLOR_ATTACHMENTS (WebGL2)
  • pname = MAX_COMBINED_UNIFORM_BLOCKS (WebGL2)
  • pname = MAX_DRAW_BUFFERS (WebGL2)
  • pname = MAX_ELEMENTS_INDICES (WebGL2)
  • pname = MAX_ELEMENTS_VERTICES (WebGL2)
  • pname = MAX_FRAGMENT_INPUT_COMPONENTS (WebGL2)
  • pname = MAX_FRAGMENT_UNIFORM_BLOCKS (WebGL2)
  • pname = MAX_FRAGMENT_UNIFORM_COMPONENTS (WebGL2)
  • pname = MAX_PROGRAM_TEXEL_OFFSET (WebGL2)
  • pname = MAX_SAMPLES (WebGL2)
  • pname = MAX_TRANSFORM_FEEDBACK_INTERLEAVED_COMPONENTS (WebGL2)
  • pname = MAX_TRANSFORM_FEEDBACK_SEPARATE_ATTRIBS (WebGL2)
  • pname = MAX_TRANSFORM_FEEDBACK_SEPARATE_COMPONENTS (WebGL2)
  • pname = MAX_UNIFORM_BUFFER_BINDINGS (WebGL2)
  • pname = MAX_VARYING_COMPONENTS (WebGL2)
  • pname = MAX_VERTEX_OUTPUT_COMPONENTS (WebGL2)
  • pname = MAX_VERTEX_UNIFORM_BLOCKS (WebGL2)
  • pname = MAX_VERTEX_UNIFORM_COMPONENTS (WebGL2)
  • pname = MIN_PROGRAM_TEXEL_OFFSET (WebGL2)
  • pname = PACK_ROW_LENGTH (WebGL2)
  • pname = PACK_SKIP_PIXELS (WebGL2)
  • pname = PACK_SKIP_ROWS (WebGL2)
  • pname = UNIFORM_BUFFER_OFFSET_ALIGNMENT (WebGL2)
  • pname = UNPACK_IMAGE_HEIGHT (WebGL2)
  • pname = UNPACK_ROW_LENGTH (WebGL2)
  • pname = UNPACK_SKIP_IMAGES (WebGL2)
  • pname = UNPACK_SKIP_PIXELS (WebGL2)
  • pname = UNPACK_SKIP_ROWS (WebGL2)
any getParameter (GLenum pname);

Documentation: WebGL 1.0 spec, section 5.14.3

Warning: the javascript version of this function returns different types depending on the arguments provided. This function will throw an exception if the returned value is not of the expected type.

#getParameterGLfloat Source

getParameterGLfloat :: forall c. IsWebGLRenderingContext c => c -> GLenum -> Effect (Maybe GLfloat)

Usage: getParameterGLfloat gl pname

Use when:

  • pname = DEPTH_CLEAR_VALUE
  • pname = LINE_WIDTH
  • pname = POLYGON_OFFSET_FACTOR
  • pname = POLYGON_OFFSET_UNITS
  • pname = SAMPLE_COVERAGE_VALUE
  • pname = MAX_TEXTURE_LOD_BIAS (WebGL2)
any getParameter (GLenum pname);

Documentation: WebGL 1.0 spec, section 5.14.3

Warning: the javascript version of this function returns different types depending on the arguments provided. This function will throw an exception if the returned value is not of the expected type.

#getParameterGLenum Source

getParameterGLenum :: forall c. IsWebGLRenderingContext c => c -> GLenum -> Effect (Maybe GLenum)

Usage: getParameterGLenum gl pname

Use when:

  • pname = ACTIVE_TEXTURE
  • pname = BLEND_DST_ALPHA
  • pname = BLEND_DST_RGB
  • pname = BLEND_EQUATION_ALPHA
  • pname = BLEND_EQUATION_RGB
  • pname = BLEND_SRC_ALPHA
  • pname = BLEND_SRC_RGB
  • pname = CULL_FACE_MODE
  • pname = DEPTH_FUNC
  • pname = FRONT_FACE
  • pname = GENERATE_MIPMAP_HINT
  • pname = IMPLEMENTATION_COLOR_READ_FORMAT
  • pname = IMPLEMENTATION_COLOR_READ_TYPE
  • pname = STENCIL_BACK_FAIL
  • pname = STENCIL_BACK_FUNC
  • pname = STENCIL_BACK_PASS_DEPTH_FAIL
  • pname = STENCIL_BACK_PASS_DEPTH_PASS
  • pname = STENCIL_FAIL
  • pname = STENCIL_FUNC
  • pname = STENCIL_PASS_DEPTH_FAIL
  • pname = STENCIL_PASS_DEPTH_PASS
  • pname = UNPACK_COLORSPACE_CONVERSION_WEBGL
  • pname = DRAW_BUFFERi (WebGL2)
  • pname = FRAGMENT_SHADER_DERIVATIVE_HINT (WebGL2)
  • pname = READ_BUFFER (WebGL2)
any getParameter (GLenum pname);

Documentation: WebGL 1.0 spec, section 5.14.3

Warning: the javascript version of this function returns different types depending on the arguments provided. This function will throw an exception if the returned value is not of the expected type.

#getParameterGLbooleanArray Source

getParameterGLbooleanArray :: forall c. IsWebGLRenderingContext c => c -> GLenum -> Effect (Maybe (Array GLboolean))

Usage: getParameterGLbooleanArray gl pname

Use when:

  • pname = COLOR_WRITEMASK
any getParameter (GLenum pname);

Documentation: WebGL 1.0 spec, section 5.14.3

Warning: the javascript version of this function returns different types depending on the arguments provided. This function will throw an exception if the returned value is not of the expected type.

#getParameterGLboolean Source

getParameterGLboolean :: forall c. IsWebGLRenderingContext c => c -> GLenum -> Effect (Maybe GLboolean)

Usage: getParameterGLboolean gl pname

Use when:

  • pname = BLEND
  • pname = CULL_FACE
  • pname = DEPTH_TEST
  • pname = DEPTH_WRITEMASK
  • pname = DITHER
  • pname = POLYGON_OFFSET_FILL
  • pname = SAMPLE_ALPHA_TO_COVERAGE
  • pname = SAMPLE_COVERAGE
  • pname = SAMPLE_COVERAGE_INVERT
  • pname = SCISSOR_TEST
  • pname = STENCIL_TEST
  • pname = UNPACK_FLIP_Y_WEBGL
  • pname = UNPACK_PREMULTIPLY_ALPHA_WEBGL
  • pname = RASTERIZER_DISCARD (WebGL2)
  • pname = TRANSFORM_FEEDBACK_ACTIVE (WebGL2)
  • pname = TRANSFORM_FEEDBACK_PAUSED (WebGL2)
any getParameter (GLenum pname);

Documentation: WebGL 1.0 spec, section 5.14.3

Warning: the javascript version of this function returns different types depending on the arguments provided. This function will throw an exception if the returned value is not of the expected type.

#getParameterFloat32Array Source

getParameterFloat32Array :: forall c. IsWebGLRenderingContext c => c -> GLenum -> Effect (Maybe (ArrayView Float32))

Usage: getParameterFloat32Array gl pname

Use when:

  • pname = ALIASED_LINE_WIDTH_RANGE
  • pname = ALIASED_POINT_SIZE_RANGE
  • pname = BLEND_COLOR
  • pname = COLOR_CLEAR_VALUE
  • pname = DEPTH_RANGE
any getParameter (GLenum pname);

Documentation: WebGL 1.0 spec, section 5.14.3

Warning: the javascript version of this function returns different types depending on the arguments provided. This function will throw an exception if the returned value is not of the expected type.

#getParameterBoolean Source

getParameterBoolean :: forall c. IsWebGLRenderingContext c => c -> GLenum -> Effect (Maybe Boolean)

Usage: getParameterBoolean gl pname

Use when:

  • pname = GPU_DISJOINT_EXT (EXT_disjoint_timer_query, EXT_disjoint_timer_query_webgl2)
any getParameter (GLenum pname);

Documentation: WebGL 1.0 spec, section 5.14.3

Warning: the javascript version of this function returns different types depending on the arguments provided. This function will throw an exception if the returned value is not of the expected type.

#getError Source

getError :: forall c. IsWebGLRenderingContext c => c -> Effect GLenum

Usage: getError gl

[WebGLHandlesContextLoss] GLenum getError();

Documentation: WebGL 1.0 spec, section 5.14.3

#getDrawingBufferWidth Source

getDrawingBufferWidth :: forall c. IsWebGLRenderingContext c => c -> Effect GLsizei

Usage: getDrawingBufferWidth gl

Documentation: WebGL 1.0 spec, section 5.14.1

#getDrawingBufferHeight Source

getDrawingBufferHeight :: forall c. IsWebGLRenderingContext c => c -> Effect GLsizei

Usage: getDrawingBufferHeight gl

Documentation: WebGL 1.0 spec, section 5.14.1

#getContextAttributes Source

getContextAttributes :: forall c. IsWebGLRenderingContext c => c -> Effect (Maybe WebGLContextAttributes)

Usage: getContextAttributes gl

[WebGLHandlesContextLoss] WebGLContextAttributes?
getContextAttributes();

Documentation: WebGL 1.0 spec, section 5.14.2

#getCanvas Source

getCanvas :: forall c. IsWebGLRenderingContext c => c -> Effect HTMLCanvasElement

Usage: getCanvas gl

Documentation: WebGL 1.0 spec, section 5.14.1

#frontFace Source

frontFace :: forall c. IsWebGLRenderingContext c => c -> GLenum -> Effect Unit

Usage: frontFace gl mode

void frontFace (GLenum mode);

Documentation: WebGL 1.0 spec, section 5.14.3

#flush Source

flush :: forall c. IsWebGLRenderingContext c => c -> Effect Unit

Usage: flush gl

void flush();

Documentation: WebGL 1.0 spec, section 5.14.11

#finish Source

finish :: forall c. IsWebGLRenderingContext c => c -> Effect Unit

Usage: finish gl

void finish();

Documentation: WebGL 1.0 spec, section 5.14.11

#enable Source

enable :: forall c. IsWebGLRenderingContext c => c -> GLenum -> Effect Unit

Usage: enable gl cap

void enable (GLenum cap);

Documentation: WebGL 1.0 spec, section 5.14.3

#drawElements Source

drawElements :: forall c. IsWebGLRenderingContext c => c -> GLenum -> GLsizei -> GLenum -> GLintptr -> Effect Unit

Usage: drawElements gl mode count type offset

void
drawElements ( GLenum mode
             , GLsizei count
             , GLenum type
             , GLintptr offset
             );

Documentation: WebGL 1.0 spec, section 5.14.11

#drawArrays Source

drawArrays :: forall c. IsWebGLRenderingContext c => c -> GLenum -> GLint -> GLsizei -> Effect Unit

Usage: drawArrays gl mode first count

void drawArrays (GLenum mode, GLint first, GLsizei count);

Documentation: WebGL 1.0 spec, section 5.14.11

#disable Source

disable :: forall c. IsWebGLRenderingContext c => c -> GLenum -> Effect Unit

Usage: disable gl cap

void disable (GLenum cap);

Documentation: WebGL 1.0 spec, section 5.14.3

#depthRange Source

depthRange :: forall c. IsWebGLRenderingContext c => c -> GLclampf -> GLclampf -> Effect Unit

Usage: depthRange gl zNear zFar

void depthRange (GLclampf zNear, GLclampf zFar);

Documentation: WebGL 1.0 spec, section 5.14.3

#depthMask Source

depthMask :: forall c. IsWebGLRenderingContext c => c -> GLboolean -> Effect Unit

Usage: depthMask gl flag

void depthMask (GLboolean flag);

Documentation: WebGL 1.0 spec, section 5.14.3

#depthFunc Source

depthFunc :: forall c. IsWebGLRenderingContext c => c -> GLenum -> Effect Unit

Usage: depthFunc gl func

void depthFunc (GLenum func);

Documentation: WebGL 1.0 spec, section 5.14.3

#cullFace Source

cullFace :: forall c. IsWebGLRenderingContext c => c -> GLenum -> Effect Unit

Usage: cullFace gl mode

void cullFace (GLenum mode);

Documentation: WebGL 1.0 spec, section 5.14.3

#colorMask Source

colorMask :: forall c. IsWebGLRenderingContext c => c -> GLboolean -> GLboolean -> GLboolean -> GLboolean -> Effect Unit

Usage: colorMask gl red green blue alpha

void
colorMask ( GLboolean red
          , GLboolean green
          , GLboolean blue
          , GLboolean alpha
          );

Documentation: WebGL 1.0 spec, section 5.14.3

#clearStencil Source

clearStencil :: forall c. IsWebGLRenderingContext c => c -> GLint -> Effect Unit

Usage: clearStencil gl s

void clearStencil (GLint s);

Documentation: WebGL 1.0 spec, section 5.14.3

#clearDepth Source

clearDepth :: forall c. IsWebGLRenderingContext c => c -> GLclampf -> Effect Unit

Usage: clearDepth gl depth

void clearDepth (GLclampf depth);

Documentation: WebGL 1.0 spec, section 5.14.3

#clearColor Source

clearColor :: forall c. IsWebGLRenderingContext c => c -> GLclampf -> GLclampf -> GLclampf -> GLclampf -> Effect Unit

Usage: clearColor gl red green blue alpha

void
clearColor ( GLclampf red
           , GLclampf green
           , GLclampf blue
           , GLclampf alpha
           );

Documentation: WebGL 1.0 spec, section 5.14.3

#clear Source

clear :: forall c. IsWebGLRenderingContext c => c -> GLbitfield -> Effect Unit

Usage: clear gl mask

void clear (GLbitfield mask);

Documentation: WebGL 1.0 spec, section 5.14.11

#blendFuncSeparate Source

blendFuncSeparate :: forall c. IsWebGLRenderingContext c => c -> GLenum -> GLenum -> GLenum -> GLenum -> Effect Unit

Usage: blendFuncSeparate gl srcRGB dstRGB srcAlpha dstAlpha

void
blendFuncSeparate ( GLenum srcRGB
                  , GLenum dstRGB
                  , GLenum srcAlpha
                  , GLenum dstAlpha
                  );

Documentation: WebGL 1.0 spec, section 5.14.3

#blendFunc Source

blendFunc :: forall c. IsWebGLRenderingContext c => c -> GLenum -> GLenum -> Effect Unit

Usage: blendFunc gl sfactor dfactor

void blendFunc (GLenum sfactor, GLenum dfactor);

Documentation: WebGL 1.0 spec, section 5.14.3

#blendEquationSeparate Source

blendEquationSeparate :: forall c. IsWebGLRenderingContext c => c -> GLenum -> GLenum -> Effect Unit

Usage: blendEquationSeparate gl modeRGB modeAlpha

void blendEquationSeparate (GLenum modeRGB, GLenum modeAlpha);

Documentation: WebGL 1.0 spec, section 5.14.3

#blendEquation Source

blendEquation :: forall c. IsWebGLRenderingContext c => c -> GLenum -> Effect Unit

Usage: blendEquation gl mode

void blendEquation (GLenum mode);

Documentation: WebGL 1.0 spec, section 5.14.3

#blendColor Source

blendColor :: forall c. IsWebGLRenderingContext c => c -> GLclampf -> GLclampf -> GLclampf -> GLclampf -> Effect Unit

Usage: blendColor gl red green blue alpha

void
blendColor ( GLclampf red
           , GLclampf green
           , GLclampf blue
           , GLclampf alpha
           );

Documentation: WebGL 1.0 spec, section 5.14.3

#activeTexture Source

activeTexture :: forall c. IsWebGLRenderingContext c => c -> GLenum -> Effect Unit

Usage: activeTexture gl texture

void activeTexture (GLenum texture);

Documentation: WebGL 1.0 spec, section 5.14.3

Modules
WebGL.Raw.Extensions.ANGLE.InstancedArrays
WebGL.Raw.Extensions.EXT.BlendMinmax
WebGL.Raw.Extensions.EXT.ColorBufferFloat
WebGL.Raw.Extensions.EXT.ColorBufferHalfFloat
WebGL.Raw.Extensions.EXT.DisjointTimerQuery
WebGL.Raw.Extensions.EXT.DisjointTimerQueryWebgl2
WebGL.Raw.Extensions.EXT.FragDepth
WebGL.Raw.Extensions.EXT.SRGB
WebGL.Raw.Extensions.EXT.ShaderTextureLod
WebGL.Raw.Extensions.EXT.TextureFilterAnisotropic
WebGL.Raw.Extensions.OES.ElementIndexUint
WebGL.Raw.Extensions.OES.StandardDerivatives
WebGL.Raw.Extensions.OES.TextureFloat
WebGL.Raw.Extensions.OES.TextureFloatLinear
WebGL.Raw.Extensions.OES.TextureHalfFloat
WebGL.Raw.Extensions.OES.TextureHalfFloatLinear
WebGL.Raw.Extensions.OES.VertexArrayObject
WebGL.Raw.Extensions.WEBGL.ColorBufferFloat
WebGL.Raw.Extensions.WEBGL.CompressedTextureAstc
WebGL.Raw.Extensions.WEBGL.CompressedTextureEtc
WebGL.Raw.Extensions.WEBGL.CompressedTextureEtc1
WebGL.Raw.Extensions.WEBGL.CompressedTexturePvrtc
WebGL.Raw.Extensions.WEBGL.CompressedTextureS3tc
WebGL.Raw.Extensions.WEBGL.CompressedTextureS3tcSrgb
WebGL.Raw.Extensions.WEBGL.DebugRendererInfo
WebGL.Raw.Extensions.WEBGL.DebugShaders
WebGL.Raw.Extensions.WEBGL.DepthTexture
WebGL.Raw.Extensions.WEBGL.DrawBuffers
WebGL.Raw.Extensions.WEBGL.LoseContext
WebGL.Raw.Types
WebGL.Raw.WebGL1
WebGL.Raw.WebGL1.Enums
WebGL.Raw.WebGL1.Uniforms
WebGL.Raw.WebGL1.VertexAttributes
WebGL.Raw.WebGL1.WebGLActiveInfo
WebGL.Raw.WebGL1.WebGLBuffer
WebGL.Raw.WebGL1.WebGLContextEvent
WebGL.Raw.WebGL1.WebGLFramebuffer
WebGL.Raw.WebGL1.WebGLProgram
WebGL.Raw.WebGL1.WebGLRenderbuffer
WebGL.Raw.WebGL1.WebGLRenderingContext
WebGL.Raw.WebGL1.WebGLShader
WebGL.Raw.WebGL1.WebGLShaderPrecisionFormat
WebGL.Raw.WebGL1.WebGLTexture
WebGL.Raw.WebGL2
WebGL.Raw.WebGL2.Enums
WebGL.Raw.WebGL2.UniformBufferObjects
WebGL.Raw.WebGL2.Uniforms
WebGL.Raw.WebGL2.VertexAttributes
WebGL.Raw.WebGL2.WebGL2RenderingContext
WebGL.Raw.WebGL2.WebGLActiveInfo
WebGL.Raw.WebGL2.WebGLBuffer
WebGL.Raw.WebGL2.WebGLContextEvent
WebGL.Raw.WebGL2.WebGLFramebuffer
WebGL.Raw.WebGL2.WebGLProgram
WebGL.Raw.WebGL2.WebGLQuery
WebGL.Raw.WebGL2.WebGLRenderbuffer
WebGL.Raw.WebGL2.WebGLSampler
WebGL.Raw.WebGL2.WebGLShader
WebGL.Raw.WebGL2.WebGLShaderPrecisionFormat
WebGL.Raw.WebGL2.WebGLSync
WebGL.Raw.WebGL2.WebGLTexture
WebGL.Raw.WebGL2.WebGLTransformFeedback
WebGL.Raw.WebGL2.WebGLVertexArrayObject