8422163501

Committed 25 Mar 2024 02:57PM UTC coverage: 89.976% (+0.002%) from 89.974%

Build # 8422163501

Build Type

Pull #8705

github

Committed by

web-flow

Commit Message

Merge 8537b8983 into 8eed30839

Pull Request Pull Request #8705: Support `clearTarget` option in PostProcessEffect

Run Details

6281 of 6923 branches covered (90.73%)

Branch coverage included in aggregate %.

7 of 8 new or added lines in 3 files covered. (87.5%)

5 existing lines in 1 file now uncovered.

51567 of 57370 relevant lines covered (89.88%)

6706.49 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

93.92

/modules/core/src/effects/post-process-effect.ts

import type {Device, Framebuffer} from '@luma.gl/core';
import {normalizeShaderModule, ShaderPass} from '@luma.gl/shadertools';

import ScreenPass from '../passes/screen-pass';

import type {Effect, EffectContext, PostRenderOptions} from '../lib/effect';

type PostProcessEffectOptions = {
  clearTarget: boolean;
};

const defaultOptions: PostProcessEffectOptions = {
  clearTarget: true
};

export default class PostProcessEffect<ShaderPassT extends ShaderPass> implements Effect {
  id: string;
  options: PostProcessEffectOptions;
  props: ShaderPassT['props'];
  module: ShaderPassT;
  passes?: ScreenPass[];

  constructor(
    module: ShaderPassT,
    props: ShaderPassT['props'],
    options?: PostProcessEffectOptions
  ) {
    this.id = `${module.name}-pass`;
    this.options = {...defaultOptions, ...options};
    this.props = props;
    normalizeShaderModule(module);
    this.module = module;
  }

  setup({device}: EffectContext) {
    this.passes = createPasses(device, this.module, this.id);
  }

  setProps(props: ShaderPassT['props']) {
    this.props = props;
  }

  // eslint-disable-next-line @typescript-eslint/no-empty-function
  preRender(): void {}

  postRender(params: PostRenderOptions): Framebuffer {
    const passes = this.passes!;

    const {target} = params;
    let inputBuffer = params.inputBuffer;
    let outputBuffer: Framebuffer | null = params.swapBuffer;

    for (let index = 0; index < passes.length; index++) {
      const isLastPass = index === passes.length - 1;
      const renderToTarget = target !== undefined && isLastPass;
      if (renderToTarget) {
        outputBuffer = target;
      }
      const clear = !renderToTarget || this.options.clearTarget;
      const moduleSettings = {};
      moduleSettings[this.module.name] = this.props;
      passes[index].render({inputBuffer, outputBuffer, moduleSettings, clear});

      const switchBuffer = outputBuffer as Framebuffer;
      outputBuffer = inputBuffer;
      inputBuffer = switchBuffer;
    }
    return inputBuffer;
  }

  cleanup(): void {
    if (this.passes) {
      for (const pass of this.passes) {
        pass.delete();
      }
      this.passes = undefined;
    }
  }
}

function createPasses(device: Device, module: ShaderPass, id: string): ScreenPass[] {
  return module.passes.map((pass, index) => {
    const fs = getFragmentShaderForRenderPass(module, pass);
    const idn = `${id}-${index}`;
    return new ScreenPass(device, {id: idn, module, fs});
  });
}

const FS_TEMPLATE_INPUTS = `\
#version 300 es
uniform sampler2D texSrc;
uniform vec2 texSize;

in vec2 position;
in vec2 coordinate;
in vec2 uv;

out vec4 fragColor;
`;

const FILTER_FS_TEMPLATE = (func: string) => `\
${FS_TEMPLATE_INPUTS}
void main() {
  fragColor = texture(texSrc, coordinate);
  fragColor = ${func}(fragColor, texSize, coordinate);
}
`;

const SAMPLER_FS_TEMPLATE = (func: string) => `\
${FS_TEMPLATE_INPUTS}
void main() {
  fragColor = ${func}(texSrc, texSize, coordinate);
}
`;

function getFragmentShaderForRenderPass(module: ShaderPass, pass: ShaderPass['passes'][0]): string {
  if (pass.filter) {
    const func = typeof pass.filter === 'string' ? pass.filter : `${module.name}_filterColor`;
    return FILTER_FS_TEMPLATE(func);
  }

  if (pass.sampler) {
    const func = typeof pass.sampler === 'string' ? pass.sampler : `${module.name}_sampleColor`;
    return SAMPLER_FS_TEMPLATE(func);
  }

  // console.error(`${module.name} no fragment shader generated`);
  return '';
}

1	import type {Device, Framebuffer} from '@luma.gl/core';	1✔
2	import {normalizeShaderModule, ShaderPass} from '@luma.gl/shadertools';	1✔
3		1✔
4	import ScreenPass from '../passes/screen-pass';	1✔
5		1✔
6	import type {Effect, EffectContext, PostRenderOptions} from '../lib/effect';	1✔
7		1✔
8	type PostProcessEffectOptions = {	1✔
9	clearTarget: boolean;	1✔
10	};	1✔
11		1✔
12	const defaultOptions: PostProcessEffectOptions = {	1✔
13	clearTarget: true	1✔
14	};	1✔
15		1✔
16	export default class PostProcessEffect<ShaderPassT extends ShaderPass> implements Effect {	1✔
17	id: string;	1✔
18	options: PostProcessEffectOptions;	1✔
19	props: ShaderPassT['props'];	1✔
20	module: ShaderPassT;	1✔
21	passes?: ScreenPass[];	1✔
22		1✔
23	constructor(	1✔
24	module: ShaderPassT,	4✔
25	props: ShaderPassT['props'],	4✔
26	options?: PostProcessEffectOptions	4✔
27	) {	4✔
28	this.id = `${module.name}-pass`;	4✔
29	this.options = {...defaultOptions, ...options};	4✔
30	this.props = props;	4✔
31	normalizeShaderModule(module);	4✔
32	this.module = module;	4✔
33	}	4✔
34		1✔
35	setup({device}: EffectContext) {	1✔
36	this.passes = createPasses(device, this.module, this.id);	3✔
37	}	3✔
38		1✔
39	setProps(props: ShaderPassT['props']) {	1✔
UNCOV 40	this.props = props;	×
NEW 41	}	×
42		1✔
43	// eslint-disable-next-line @typescript-eslint/no-empty-function	1✔
44	preRender(): void {}	1✔
45		1✔
46	postRender(params: PostRenderOptions): Framebuffer {	1✔
47	const passes = this.passes!;	4✔
48		4✔
49	const {target} = params;	4✔
50	let inputBuffer = params.inputBuffer;	4✔
51	let outputBuffer: Framebuffer \| null = params.swapBuffer;	4✔
52		4✔
53	for (let index = 0; index < passes.length; index++) {	4✔
54	const isLastPass = index === passes.length - 1;	4✔
55	const renderToTarget = target !== undefined && isLastPass;	4✔
56	if (renderToTarget) {	4✔
57	outputBuffer = target;	2✔
58	}	2✔
59	const clear = !renderToTarget \|\| this.options.clearTarget;	4✔
60	const moduleSettings = {};	4✔
61	moduleSettings[this.module.name] = this.props;	4✔
62	passes[index].render({inputBuffer, outputBuffer, moduleSettings, clear});	4✔
63		4✔
64	const switchBuffer = outputBuffer as Framebuffer;	4✔
65	outputBuffer = inputBuffer;	4✔
66	inputBuffer = switchBuffer;	4✔
67	}	4✔
68	return inputBuffer;	4✔
69	}	4✔
70		1✔
71	cleanup(): void {	1✔
72	if (this.passes) {	3✔
73	for (const pass of this.passes) {	3✔
74	pass.delete();	3✔
75	}	3✔
76	this.passes = undefined;	3✔
77	}	3✔
78	}	3✔
79	}	1✔
80		1✔
81	function createPasses(device: Device, module: ShaderPass, id: string): ScreenPass[] {	3✔
82	return module.passes.map((pass, index) => {	3✔
83	const fs = getFragmentShaderForRenderPass(module, pass);	3✔
84	const idn = `${id}-${index}`;	3✔
85	return new ScreenPass(device, {id: idn, module, fs});	3✔
86	});	3✔
87	}	3✔
88		1✔
89	const FS_TEMPLATE_INPUTS = `\	1✔
90	#version 300 es	1✔
91	uniform sampler2D texSrc;	1✔
92	uniform vec2 texSize;	1✔
93		1✔
94	in vec2 position;	1✔
95	in vec2 coordinate;	1✔
96	in vec2 uv;	1✔
97		1✔
98	out vec4 fragColor;	1✔
99	`;	1✔
100		1✔
101	const FILTER_FS_TEMPLATE = (func: string) => `\	1✔
102	${FS_TEMPLATE_INPUTS}	1✔
103	void main() {	1✔
104	fragColor = texture(texSrc, coordinate);	1✔
105	fragColor = ${func}(fragColor, texSize, coordinate);	1✔
106	}	1✔
107	`;	1✔
108		1✔
109	const SAMPLER_FS_TEMPLATE = (func: string) => `\	1✔
110	${FS_TEMPLATE_INPUTS}	2✔
111	void main() {	2✔
112	fragColor = ${func}(texSrc, texSize, coordinate);	2✔
113	}	1✔
114	`;	1✔
115		1✔
116	function getFragmentShaderForRenderPass(module: ShaderPass, pass: ShaderPass['passes'][0]): string {	3✔
117	if (pass.filter) {	3✔
118	const func = typeof pass.filter === 'string' ? pass.filter : `${module.name}_filterColor`;	1!
119	return FILTER_FS_TEMPLATE(func);	1✔
120	}	1✔
121		2✔
122	if (pass.sampler) {	2✔
123	const func = typeof pass.sampler === 'string' ? pass.sampler : `${module.name}_sampleColor`;	2!
124	return SAMPLER_FS_TEMPLATE(func);	2✔
125	}	2!
UNCOV 126		×
UNCOV 127	// console.error(`${module.name} no fragment shader generated`);	×
UNCOV 128	return '';	×
UNCOV 129	}	×

visgl / deck.gl / 8422163501

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous