MultisampleFramebuffer

A Framebuffer backed by a multisampled renderbuffer.

Drawing goes into the MSAA renderbuffer (Framebuffer.glFramebuffer); reading Framebuffer.texture (or blitting/copying) resolves the samples into the backing color texture first, so consumers never need to sequence the resolve themselves.

Hierarchy

• Framebuffer
  • MultisampleFramebuffer

Index

Constructors

• constructor

Properties

• bufferFormat
• filtering
• samples
• transparency
• wrapping

Accessors

• glFramebuffer
• height
• texelSize
• texture
• width

Methods

• blitToScreen
• clear
• copyToTexture
• dispose
• resize

Constructors

constructor

• MultisampleFramebuffer(options: MultisampleFramebufferOptions): MultisampleFramebuffer

• Overrides Framebuffer.constructor

  Parameters

  • options: MultisampleFramebufferOptions

  Returns MultisampleFramebuffer

Properties

publicreadonlyinheritedbufferFormat

bufferFormat: number

Inherited from Framebuffer.bufferFormat

Format compatible with the canvas drawing buffer, needed for Framebuffer.blitToScreen

publicreadonlyinheritedfiltering

filtering: ImageFiltering

Inherited from Framebuffer.filtering

publicreadonlysamples

samples: number

publicreadonlyinheritedtransparency

transparency: boolean

Inherited from Framebuffer.transparency

publicreadonlyinheritedwrapping

wrapping: ImageWrapConfiguration

Inherited from Framebuffer.wrapping

Accessors

publicglFramebuffer

• get glFramebuffer(): WebGLFramebuffer

• Overrides Framebuffer.glFramebuffer

  The framebuffer to bind when drawing into this framebuffer.

  On a MultisampleFramebuffer this is the multisampled renderbuffer framebuffer.

  ---

  Returns WebGLFramebuffer

publicinheritedheight

• get height(): number

• Inherited from Framebuffer.height

  Returns number

publicinheritedtexelSize

• get texelSize(): [texelWidth: number, texelHeight: number]

• Inherited from Framebuffer.texelSize

  [1 / width, 1 / height], useful for passing to shaders that sample neighboring texels (blurs etc.)

  ---

  Returns [texelWidth: number, texelHeight: number]

publictexture

• get texture(): WebGLTexture

• Overrides Framebuffer.texture

  The color texture backing this framebuffer, for sampling as a source.

  On a MultisampleFramebuffer reading this resolves the MSAA renderbuffer first.

  ---

  Returns WebGLTexture

publicinheritedwidth

• get width(): number

• Inherited from Framebuffer.width

  Returns number

Methods

publicblitToScreen

• blitToScreen(): void

• Overrides Framebuffer.blitToScreen

  Blits the (resolved) contents 1:1 to the canvas drawing buffer

  ---

  Returns void

publicinheritedclear

• clear(color?: Color): void

• Inherited from Framebuffer.clear

  Clears the framebuffer to the provided color (transparent black by default)

  Leaves this framebuffer bound

  ---

  Parameters

  • optionalcolor: Color

  Returns void

publicinheritedcopyToTexture

• copyToTexture(texture: WebGLTexture): void

• Inherited from Framebuffer.copyToTexture

  Copies the current (resolved) contents into the provided texture, which is reallocated at this framebuffer's dimensions

  ---

  Parameters

  • texture: WebGLTexture

  Returns void

publicdispose

• dispose(): void

• Overrides Framebuffer.dispose

  Deletes the GL resources owned by this framebuffer, it cannot be used afterwards

  ---

  Returns void

publicresize

• resize(width: number, height: number): void

• Overrides Framebuffer.resize

  Resize the framebuffer, contents are discarded

  ---

  Parameters

  • width: number

  • height: number

  Returns void