Class RenderPassUpsample

Hierarchy

  • RenderPassShaderQuad
    • RenderPassUpsample

Properties

_name _options afterPasses beforePasses blendState colorArrayOps cullMode depthState depthStencilOps device executeEnabled fullSizeClearRect renderTarget requiresCubemaps samples stencilBack stencilFront quadVertexShader

Accessors

colorOps enabled name options

Methods

createQuadShader init render setClearColor setClearDepth setClearStencil

Properties

_name

_name: string

_options

_options: any

The options specified when the render target was initialized.

afterPasses

afterPasses: RenderPass[] = []

Render passes which need to be executed after this pass.

beforePasses

beforePasses: RenderPass[] = []

Render passes which need to be executed before this pass.

blendState

blendState: BlendState = BlendState.NOBLEND

A blend state to use when rendering the quad. Defaults to BlendState.NOBLEND.

colorArrayOps

colorArrayOps: ColorAttachmentOps[] = []

Array of color attachment operations. The first element corresponds to the color attachment 0, and so on.

cullMode

cullMode: number = CULLFACE_NONE

The cull mode to use when rendering the quad. Defaults to CULLFACE_NONE.

depthState

depthState: DepthState = DepthState.NODEPTH

A depth state to use when rendering the quad. Defaults to DepthState.NODEPTH.

depthStencilOps

depthStencilOps: DepthStencilAttachmentOps

device

device: GraphicsDevice

The graphics device.

executeEnabled

executeEnabled: boolean = true

True if the render pass is enabled and execute function will be called. Note that before and after functions are called regardless of this flag.

fullSizeClearRect

fullSizeClearRect: boolean = true

True if the render pass uses the full viewport / scissor for rendering into the render target.

renderTarget

renderTarget: RenderTarget

The render target for this render pass:

  • undefined: render pass does not render to any render target
  • null: render pass renders to the backbuffer
  • Otherwise, renders to the provided RT.

requiresCubemaps

requiresCubemaps: boolean = true

If true, this pass might use dynamically rendered cubemaps. Use for a case where rendering to cubemap faces is interleaved with rendering to shadows, to avoid generating cubemap mipmaps. This will likely be retired when render target dependency tracking gets implemented.

samples

samples: number = 0

Number of samples. 0 if no render target, otherwise number of samples from the render target, or the main framebuffer if render target is null.

stencilBack

stencilBack: StencilParameters = null

Stencil parameters for back faces to use when rendering the quad. Defaults to null.

stencilFront

stencilFront: StencilParameters = null

Stencil parameters for front faces to use when rendering the quad. Defaults to null.

Static quadVertexShader

quadVertexShader: string = ...

A simple vertex shader used to render a quad, which requires 'vec2 aPosition' in the vertex buffer, and generates uv coordinates uv0 for use in the fragment shader.

Accessors

colorOps

enabled

name

options

Methods

createQuadShader

  • createQuadShader(name, fs, shaderDefinitionOptions?): object

  • Creates a quad shader from the supplied fragment shader code.

    Parameters

    • name: string

      A name of the shader.

    • fs: string

      Fragment shader source code.

    • Optional shaderDefinitionOptions: {
          fragmentOutputTypes: string | string[];
          useTransformFeedback: boolean;
      } = {}

      Additional options that will be added to the shader definition.

      • fragmentOutputTypes: string | string[]

        Fragment shader output types, which default to vec4. Passing a string will set the output type for all color attachments. Passing an array will set the output type for each color attachment.

      • useTransformFeedback: boolean

        Whether to use transform feedback. Defaults to false.

    Returns object

    Returns the created shader.

init

  • init(renderTarget?, options?): void

  • Parameters

    • Optional renderTarget: RenderTarget = null

      The render target to render into (output). This function should be called only for render passes which use render target, or passes which render directly into the default framebuffer, in which case a null or undefined render target is expected.

    • options: any = null

    Returns void

render

setClearColor

  • setClearColor(color): void

  • Mark render pass as clearing the full color buffer.

    Parameters

    • color: Color

      The color to clear to, or undefined to preserve the existing content.

    Returns void

setClearDepth

  • setClearDepth(depthValue): void

  • Mark render pass as clearing the full depth buffer.

    Parameters

    • depthValue: number

      The depth value to clear to, or undefined to preserve the existing content.

    Returns void

setClearStencil

  • setClearStencil(stencilValue): void

  • Mark render pass as clearing the full stencil buffer.

    Parameters

    • stencilValue: number

      The stencil value to clear to, or undefined to preserve the existing content.

    Returns void

Settings

Member Visibility

Theme

On This Page

_name_optionsafterPassesbeforePassesblendStatecolorArrayOpscullModedepthStatedepthStencilOpsdeviceexecuteEnabledfullSizeClearRectrenderTargetrequiresCubemapssamplesstencilBackstencilFrontquadVertexShadercolorOpsenablednameoptionscreateQuadShaderinitrendersetClearColorsetClearDepthsetClearStencil