ShaderPass

A single shader pass: draws a full-destination quad with a fragment shader, reading explicit sources and writing to an explicit destination.

const tint = new ex.ShaderPass({ graphicsContext, fragmentSource: myGlsl });
tint.draw(sourceFramebuffer, destinationFramebuffer);

// multiple named sources + per-draw uniforms
merge.draw({
  sources: { u_smaller: quarterRes, u_larger: halfRes },
  destination: halfResOut,
  uniforms: { u_strength: 2 }
});

There is no hidden bind state to sequence, each draw states its inputs and output.

Index

Constructors

• constructor

Properties

• filtering
• name
• scale

Accessors

• uniforms

Methods

• dispose
• draw
• getShader

Constructors

constructor

• ShaderPass(options: ShaderPassOptions): ShaderPass

• Parameters

  • options: ShaderPassOptions

  Returns ShaderPass

Properties

publicreadonlyfiltering

filtering: ImageFiltering

Filtering used by ShaderPipeline for this pass's intermediate framebuffer

publicreadonlyname

name: string

publicreadonlyscale

scale: number

Relative resolution used by ShaderPipeline for this pass's intermediate framebuffer

Accessors

publicuniforms

• get uniforms(): UniformDictionary

• Declarative uniforms for this pass, changes are uploaded on the next draw

  ---

  Returns UniformDictionary

Methods

publicdispose

• dispose(): void

• Deletes the compiled shader program, the pass cannot be used afterwards

  ---

  Returns void

publicdraw

• draw(source: ShaderPassSource, destination: ShaderPassDestination): void
• draw(options: ShaderPassDrawOptions): void

• Draws the pass, source binds as u_image

  ---

  Parameters

  • source: ShaderPassSource

  • destination: ShaderPassDestination

  Returns void

publicgetShader

• getShader(): Shader

• The compiled Shader backing this pass, compiling it if necessary

  ---

  Returns Shader