NgtpBrightnessContrast

Preview

canvas.ts

import { ChangeDetectionStrategy, Component } from '@angular/core';
import { PostprocessingWrapper } from '@postprocessing/wrapper.ts';
import { NgtCanvas, provideNgtRenderer } from 'angular-three/dom';
import { SceneGraph } from './scene-graph';

@Component({
    selector: 'app-brightness-contrast',
    template: `
        <ngt-canvas [camera]="{ position: [0, 0, 5], fov: 50 }">
            <app-postprocessing-wrapper *canvasContent [lights]="true">
                <app-scene-graph />
            </app-postprocessing-wrapper>
        </ngt-canvas>
    `,
    changeDetection: ChangeDetectionStrategy.OnPush,
    host: { class: 'brightness-contrast-demo relative block h-full' },
    imports: [NgtCanvas, PostprocessingWrapper, SceneGraph],
})
export default class BrightnessContrast {
    static clientProviders = [provideNgtRenderer()];
}

scene-graph.ts

import { ChangeDetectionStrategy, Component, CUSTOM_ELEMENTS_SCHEMA, ElementRef, viewChild } from '@angular/core';
import { beforeRender, NgtArgs } from 'angular-three';
import { NgtpBrightnessContrast, NgtpEffectComposer } from 'angular-three-postprocessing';
import * as THREE from 'three';

@Component({
    selector: 'app-scene-graph',
    template: `
        <ngt-mesh #mesh>
            <ngt-torus-geometry *args="[1, 0.4, 32, 64]" />
            <ngt-mesh-standard-material color="#e67e22" />
        </ngt-mesh>

        <ngtp-effect-composer>
            <ngtp-brightness-contrast
                [options]="{
                    brightness: 0.1,
                    contrast: 0.35,
                }"
            />
        </ngtp-effect-composer>
    `,
    schemas: [CUSTOM_ELEMENTS_SCHEMA],
    changeDetection: ChangeDetectionStrategy.OnPush,
    imports: [NgtArgs, NgtpEffectComposer, NgtpBrightnessContrast],
})
export class SceneGraph {
    private meshRef = viewChild.required<ElementRef<THREE.Mesh>>('mesh');

    constructor() {
        beforeRender(({ delta }) => {
            const mesh = this.meshRef().nativeElement;
            mesh.rotation.x += delta * 0.3;
            mesh.rotation.y += delta * 0.4;
        });
    }
}

The brightness/contrast effect allows you to adjust the overall brightness and contrast of your scene, useful for color correction and stylization.

Usage

import { NgtpEffectComposer, NgtpBrightnessContrast } from 'angular-three-postprocessing';

@Component({
  template: `
    <ngtp-effect-composer>
      <ngtp-brightness-contrast [options]="{
        brightness: 0.1,
        contrast: 0.2
      }" />
    </ngtp-effect-composer>
  `,
  imports: [NgtpEffectComposer, NgtpBrightnessContrast],
})
export class SceneGraph {}

Options

Property	Type	Default	Description
brightness	number	0	Brightness adjustment (-1 to 1)
contrast	number	0	Contrast adjustment (-1 to 1)

Example: High Contrast Scene

@Component({
  template: `
    <ngt-mesh>
      <ngt-box-geometry />
      <ngt-mesh-standard-material color="coral" />
    </ngt-mesh>

    <ngtp-effect-composer>
      <ngtp-brightness-contrast [options]="{
        brightness: 0.05,
        contrast: 0.3
      }" />
    </ngtp-effect-composer>
  `,
  imports: [NgtpEffectComposer, NgtpBrightnessContrast],
  schemas: [CUSTOM_ELEMENTS_SCHEMA],
})
export class SceneGraph {}

Tips

• Values of 0 mean no change
• Positive brightness values lighten the image, negative values darken it
• Positive contrast values increase contrast, negative values decrease it
• Combine with other color effects like NgtpHueSaturation for complete color grading