H3DU.RenderPass3D

Back to documentation index.

H3DU.RenderPass3D(batch, [parameters])

Describes a batch (a scene graph of 3D objects) and options for rendering that batch.

Parameters

• batch (Type: H3DU.Batch3D)
  The batch to render using the options described by this object.
• parameters (Type: Object) (optional)
  An object whose keys have the possibilities given in H3DU.RenderParams#setParams, and whose values are those allowed for each key.

Members

• batch
  The batch to render.
• clearColor
  Whether to clear the color buffer before rendering the batch.
• clearDepth
  Whether to clear the depth buffer before rendering the batch.
• clearStencil
  Whether to clear the stencil buffer before rendering the batch.
• frameBuffer
  Framebuffer to render to.
• shader
  Shader to use.
• useFrameBufferSize
  Use the dimensions of the given framebuffer rather than those of the scene rendering it.

Methods

• setParams
  Sets parameters for this render pass object.

H3DU.RenderPass3D#batch

The batch to render.

Type: H3DU.Batch3D

H3DU.RenderPass3D#clearColor

Whether to clear the color buffer before rendering the batch.

Default Value: true

H3DU.RenderPass3D#clearDepth

Whether to clear the depth buffer before rendering the batch.

Default Value: true

H3DU.RenderPass3D#clearStencil

Whether to clear the stencil buffer before rendering the batch.

Default Value: true

H3DU.RenderPass3D#frameBuffer

Framebuffer to render to.

Type: H3DU.FrameBufferInfo

Default Value: null

H3DU.RenderPass3D#shader

Shader to use.

Type: H3DU.ShaderInfo

Default Value: null

H3DU.RenderPass3D#useFrameBufferSize

Use the dimensions of the given framebuffer rather than those of the scene rendering it.

Type: boolean

Default Value: false

H3DU.RenderPass3D#setParams(parameters)

Sets parameters for this render pass object.

Parameters

• parameters (Type: Object)
  An object whose keys have the possibilities given below, and whose values are those allowed for each key.
  • subScene - The batch to render. An H3DU.Batch3D object.
  • clearColor - Whether to clear the color buffer before rendering the batch. Either true or false.
  • clearDepth - Whether to clear the depth buffer before rendering the batch. Either true or false.
  • clearStencil - Whether to clear the stencil buffer before rendering the batch. Either true or false.
  • frameBuffer - Framebuffer to render to. An H3DU.FrameBufferInfo object.
  • shader - Shader to use. An H3DU.ShaderInfo object.
  • useFrameBufferSize - Use the dimensions of the given framebuffer rather than those of the scene rendering it.
  Any or all of these keys can exist in the parameters object. If a value is undefined, it is ignored.

Return Value

This object. (Type: H3DU.RenderPass3D)

Back to documentation index.