Class ForwardRenderPipeline

Creates a new instance of ForwardRenderPipeline.

Executes a single frame render using the draw function provided to startRenderLoop.

Remarks

This method allows manual control over frame rendering instead of using the automatic render loop. It calls the draw function that was provided to startRenderLoop.

Example

// Manual frame rendering
pipeline.draw();
Copy

Gets the initial expression used for buffer clearing and setup.

Remarks

The initial expression is automatically created during setup and handles clearing of color and depth buffers before main rendering begins.

Gets the tone mapping expression used for HDR to LDR conversion.

Remarks

The tone mapping expression is created during setup when not in simple mode. It handles the conversion from high dynamic range rendering to low dynamic range output suitable for display devices.

Resizes the rendering pipeline to match new canvas dimensions.

Remarks

This method handles canvas resizing by destroying existing resources and recreating them with the new dimensions. It automatically handles WebXR canvas sizing when in VR mode.

The method preserves all current pipeline settings (shadow, bloom, etc.) during resize.

Example

window.addEventListener('resize', () => {
  const result = pipeline.resize(window.innerWidth, window.innerHeight);
  if (result.isErr()) {
    console.error('Resize failed:', result.getErr());
  }
});
Copy

Sets the contribution factor for diffuse IBL lighting.

Remarks

This method controls how much the diffuse IBL texture contributes to the final lighting. A value of 0.0 disables diffuse IBL, while 1.0 provides full contribution. Values greater than 1.0 can be used for artistic over-exposure effects.

Example

// Reduce ambient lighting
pipeline.setDiffuseIBLContribution(0.5);

// Disable diffuse IBL
pipeline.setDiffuseIBLContribution(0.0);

// Over-expose for artistic effect
pipeline.setDiffuseIBLContribution(2.0);
Copy

Sets the expressions to be rendered by the pipeline.

Remarks

This method configures the expressions for both opaque and transparent rendering. When transmission is enabled, transparent objects are rendered in a separate pass to support advanced material effects like glass and water.

The method automatically clones expressions for transparent rendering and configures shadow expressions if shadow mapping is enabled.

Example

const expressions = [sceneExpression, uiExpression];
pipeline.setExpressions(expressions, { isTransmission: true });
Copy

Sets the rotation of the IBL environment in radians.

Remarks

This method allows rotating the IBL environment to match the desired lighting direction. This is useful when the IBL doesn't align with the scene's lighting requirements or for artistic control over the environment lighting.

Example

// Rotate IBL by 90 degrees
pipeline.setIBLRotation(Math.PI / 2);

// Rotate IBL by 180 degrees
pipeline.setIBLRotation(Math.PI);

// Animate IBL rotation
let rotation = 0;
setInterval(() => {
  rotation += 0.01;
  pipeline.setIBLRotation(rotation);
}, 16);
Copy

Sets the IBL (Image-Based Lighting) cube textures for realistic lighting.

Remarks

IBL textures provide realistic lighting by using pre-computed environment maps. The diffuse texture provides ambient lighting, while the specular texture provides reflections and specular highlights.

The sheen texture is optional and used for materials with fabric-like properties.

Example

const diffuseCube = new Rn.CubeTexture();
diffuseCube.baseUriToLoad = './assets/ibl/diffuse/diffuse';
diffuseCube.hdriFormat = Rn.HdriFormat.RGBE_PNG;

const specularCube = new Rn.CubeTexture();
specularCube.baseUriToLoad = './assets/ibl/specular/specular';
specularCube.hdriFormat = Rn.HdriFormat.RGBE_PNG;
specularCube.mipmapLevelNumber = 10;

pipeline.setIBLTextures(diffuseCube, specularCube);
Copy

Sets the contribution factor for specular IBL reflections.

Remarks

This method controls how much the specular IBL texture contributes to reflections and specular highlights. A value of 0.0 disables specular IBL, while 1.0 provides full contribution. Values greater than 1.0 can create over-exposed reflections.

Example

// Subtle reflections
pipeline.setSpecularIBLContribution(0.3);

// No reflections
pipeline.setSpecularIBLContribution(0.0);

// Enhanced reflections
pipeline.setSpecularIBLContribution(1.5);
Copy

Sets the tone mapping algorithm used for HDR to LDR conversion.

Remarks

Tone mapping is essential for converting high dynamic range rendering results to low dynamic range output that can be displayed on standard monitors.

Available tone mapping algorithms:

• KhronosPbrNeutral: Khronos PBR neutral tone mapping
• Reinhard: Classic Reinhard tone mapping
• GT_ToneMap: GT tone mapping (default)
• ACES_Narkowicz: ACES tone mapping by Narkowicz
• ACES_Hill: ACES tone mapping by Hill
• ACES_Hill_Exposure_Boost: ACES Hill with exposure boost

Example

// Use ACES tone mapping for cinematic look
pipeline.setToneMappingType(Rn.ToneMappingType.ACES_Hill);

// Use Reinhard for classic look
pipeline.setToneMappingType(Rn.ToneMappingType.Reinhard);

// Use Khronos PBR neutral for accurate colors
pipeline.setToneMappingType(Rn.ToneMappingType.KhronosPbrNeutral);
Copy

Initializes the rendering pipeline with the specified configuration.

Remarks

This method must be called before using any other pipeline methods. It creates all necessary frame buffers, render targets, and expressions based on the provided configuration.

The method automatically detects WebXR capabilities and configures multi-view rendering when appropriate for VR applications.

Example

const result = await pipeline.setup(1920, 1080, {
  isShadow: true,
  isBloom: true,
  shadowMapSize: 2048
});

if (result.isErr()) {
  console.error('Pipeline setup failed:', result.getErr());
}
Copy

Starts the main rendering loop with the provided draw function.

Remarks

This method begins the continuous rendering loop using the system's render loop mechanism. The provided function will be called every frame with the current frame object.

The method automatically handles shadow system updates, expression management, and frame processing.

Example

const result = pipeline.startRenderLoop((frame) => {
  // Update scene
  Rn.System.process(frame);

  // Custom per-frame logic
  updateAnimations();
  handleInput();
});

if (result.isErr()) {
  console.error('Failed to start render loop:', result.getErr());
}
Copy