NgtpVignette

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-vignette',
    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: 'vignette-demo relative block h-full' },
    imports: [NgtCanvas, PostprocessingWrapper, SceneGraph],
})
export default class Vignette {
    static clientProviders = [provideNgtRenderer()];
}

scene-graph.ts

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

@Component({
    selector: 'app-scene-graph',
    template: `
        <ngt-mesh #mesh>
            <ngt-dodecahedron-geometry *args="[1.2, 0]" />
            <ngt-mesh-standard-material color="#e67e22" [flatShading]="true" />
        </ngt-mesh>

        <ngtp-effect-composer>
            <ngtp-vignette [options]="{ darkness: 0.6, offset: 0.3 }" />
        </ngtp-effect-composer>
    `,
    schemas: [CUSTOM_ELEMENTS_SCHEMA],
    changeDetection: ChangeDetectionStrategy.OnPush,
    imports: [NgtArgs, NgtpEffectComposer, NgtpVignette],
})
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 vignette effect darkens the edges of the screen, drawing focus to the center of the scene.

Usage

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

@Component({
  template: `
    <ngtp-effect-composer>
      <ngtp-vignette [options]="{ darkness: 0.5, offset: 0.3 }" />
    </ngtp-effect-composer>
  `,
  imports: [NgtpEffectComposer, NgtpVignette],
})
export class SceneGraph {}

Options

Property	Type	Default	Description
darkness	number	0.5	Darkness intensity of the vignette
offset	number	0.5	Offset from center where vignette starts
eskil	boolean	false	Use Eskil’s vignette technique

Example: Cinematic Look

<ngtp-effect-composer>
  <ngtp-vignette [options]="{
    darkness: 0.7,
    offset: 0.2,
    eskil: false
  }" />
</ngtp-effect-composer>