Module

WebGL.Raw.WebGL2.WebGLFramebuffer

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

#blitFramebuffer Source

blitFramebuffer :: forall c. IsWebGL2RenderingContext c => c -> GLint -> GLint -> GLint -> GLint -> GLint -> GLint -> GLint -> GLint -> GLbitfield -> GLenum -> Effect Unit

Usage: blitFramebuffer gl srcX0 srcY0 srcX1 srcY1 dstX0 dstY0 dstX1 dstY1 mask filter

void
blitFramebuffer ( GLint srcX0
                , GLint srcY0
                , GLint srcX1
                , GLint srcY1
                , GLint dstX0
                , GLint dstY0
                , GLint dstX1
                , GLint dstY1
                , GLbitfield mask
                , GLenum filter
                );

Documentation: WebGL 2.0 spec, section 3.7.4

#framebufferTextureLayer Source

framebufferTextureLayer :: forall c. IsWebGL2RenderingContext c => c -> GLenum -> GLenum -> Maybe WebGLTexture -> GLint -> GLint -> Effect Unit

Usage: framebufferTextureLayer gl target attachment texture level layer

void
framebufferTextureLayer ( GLenum target
                        , GLenum attachment
                        , WebGLTexture? texture
                        , GLint level
                        , GLint layer
                        );

Documentation: WebGL 2.0 spec, section 3.7.4

#invalidateFramebuffer Source

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

Usage: invalidateFramebuffer gl target attachments

void
invalidateFramebuffer (GLenum target, sequence<GLenum> attachments);

Documentation: WebGL 2.0 spec, section 3.7.4

#invalidateSubFramebuffer Source

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

Usage: invalidateSubFramebuffer gl target attachments x y width height

void
invalidateSubFramebuffer ( GLenum target
                         , sequence<GLenum> attachments
                         , GLint x
                         , GLint y
                         , GLsizei width
                         , GLsizei height
                         );

Documentation: WebGL 2.0 spec, section 3.7.4

#readBuffer Source

readBuffer :: forall c. IsWebGL2RenderingContext c => c -> GLenum -> Effect Unit

Usage: readBuffer gl src

void readBuffer (GLenum src);

Documentation: WebGL 2.0 spec, section 3.7.4

Re-exports from WebGL.Raw.Types

#WebGLFramebuffer Source

Re-exports from WebGL.Raw.WebGL1.WebGLFramebuffer

#isFramebuffer Source

isFramebuffer :: forall c. IsWebGLRenderingContext c => c -> Maybe WebGLFramebuffer -> Effect GLboolean

Usage: isFramebuffer gl framebuffer

[WebGLHandlesContextLoss] GLboolean
isFramebuffer (WebGLFramebuffer? framebuffer);

Documentation: WebGL 1.0 spec, section 5.14.6

#getFramebufferAttachmentParameterWebGLTexture Source

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

Usage: getFramebufferAttachmentParameterWebGLTexture gl target attachment pname

Use when:

  • pname = FRAMEBUFFER_ATTACHMENT_OBJECT_NAME
any
getFramebufferAttachmentParameter ( GLenum target
                                  , GLenum attachment
                                  , GLenum pname
                                  );

Documentation: WebGL 1.0 spec, section 5.14.6

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.

#getFramebufferAttachmentParameterWebGLRenderbuffer Source

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

Usage: getFramebufferAttachmentParameterWebGLRenderbuffer gl target attachment pname

Use when:

  • pname = FRAMEBUFFER_ATTACHMENT_OBJECT_NAME
any
getFramebufferAttachmentParameter ( GLenum target
                                  , GLenum attachment
                                  , GLenum pname
                                  );

Documentation: WebGL 1.0 spec, section 5.14.6

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.

#getFramebufferAttachmentParameterGLint Source

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

Usage: getFramebufferAttachmentParameterGLint gl target attachment pname

Use when:

  • pname = FRAMEBUFFER_ATTACHMENT_TEXTURE_CUBE_MAP_FACE
  • pname = FRAMEBUFFER_ATTACHMENT_TEXTURE_LEVEL
  • pname = FRAMEBUFFER_ATTACHMENT_ALPHA_SIZE (WebGL2)
  • pname = FRAMEBUFFER_ATTACHMENT_BLUE_SIZE (WebGL2)
  • pname = FRAMEBUFFER_ATTACHMENT_DEPTH_SIZE (WebGL2)
  • pname = FRAMEBUFFER_ATTACHMENT_GREEN_SIZE (WebGL2)
  • pname = FRAMEBUFFER_ATTACHMENT_RED_SIZE (WebGL2)
  • pname = FRAMEBUFFER_ATTACHMENT_STENCIL_SIZE (WebGL2)
  • pname = FRAMEBUFFER_ATTACHMENT_TEXTURE_LAYER (WebGL2)
any
getFramebufferAttachmentParameter ( GLenum target
                                  , GLenum attachment
                                  , GLenum pname
                                  );

Documentation: WebGL 1.0 spec, section 5.14.6

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.

#getFramebufferAttachmentParameterGLenum Source

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

Usage: getFramebufferAttachmentParameterGLenum gl target attachment pname

Use when:

  • pname = FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE
  • pname = FRAMEBUFFER_ATTACHMENT_COLOR_ENCODING (WebGL2)
  • pname = FRAMEBUFFER_ATTACHMENT_COMPONENT_TYPE (WebGL2)
any
getFramebufferAttachmentParameter ( GLenum target
                                  , GLenum attachment
                                  , GLenum pname
                                  );

Documentation: WebGL 1.0 spec, section 5.14.6

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.

#framebufferTexture2D Source

framebufferTexture2D :: forall c. IsWebGLRenderingContext c => c -> GLenum -> GLenum -> GLenum -> Maybe WebGLTexture -> GLint -> Effect Unit

Usage: framebufferTexture2D gl target attachment textarget texture level

void
framebufferTexture2D ( GLenum target
                     , GLenum attachment
                     , GLenum textarget
                     , WebGLTexture? texture
                     , GLint level
                     );

Documentation: WebGL 1.0 spec, section 5.14.6

#framebufferRenderbuffer Source

framebufferRenderbuffer :: forall c. IsWebGLRenderingContext c => c -> GLenum -> GLenum -> GLenum -> Maybe WebGLRenderbuffer -> Effect Unit

Usage: framebufferRenderbuffer gl target attachment renderbuffertarget renderbuffer

void
framebufferRenderbuffer ( GLenum target
                        , GLenum attachment
                        , GLenum renderbuffertarget
                        , WebGLRenderbuffer? renderbuffer
                        );

Documentation: WebGL 1.0 spec, section 5.14.6

#deleteFramebuffer Source

deleteFramebuffer :: forall c. IsWebGLRenderingContext c => c -> Maybe WebGLFramebuffer -> Effect Unit

Usage: deleteFramebuffer gl framebuffer

void deleteFramebuffer (WebGLFramebuffer? framebuffer);

Documentation: WebGL 1.0 spec, section 5.14.6

#createFramebuffer Source

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

Usage: createFramebuffer gl

WebGLFramebuffer? createFramebuffer();

Documentation: WebGL 1.0 spec, section 5.14.6

#checkFramebufferStatus Source

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

Usage: checkFramebufferStatus gl target

[WebGLHandlesContextLoss] GLenum
checkFramebufferStatus (GLenum target);

Documentation: WebGL 1.0 spec, section 5.14.6

#bindFramebuffer Source

bindFramebuffer :: forall c. IsWebGLRenderingContext c => c -> GLenum -> Maybe WebGLFramebuffer -> Effect Unit

Usage: bindFramebuffer gl target framebuffer

void bindFramebuffer (GLenum target, WebGLFramebuffer? framebuffer);

Documentation: WebGL 1.0 spec, section 5.14.6

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