8252301685

Committed 12 Mar 2024 04:23PM UTC coverage: 76.904% (-0.1%) from 77.024%

Build # 8252301685

Build Type

Pull #2018

github

Committed by

web-flow

Commit Message

Merge d998aa11a into 9f0aa118c

Pull Request Pull Request #2018: chore(shadertools): strict null checks, satisfies shader module

Run Details

1785 of 2332 branches covered (76.54%)

Branch coverage included in aggregate %.

98 of 117 new or added lines in 36 files covered. (83.76%)

27 existing lines in 4 files now uncovered.

22859 of 29713 relevant lines covered (76.93%)

20.7 hits per line

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

88.76

/modules/shadertools/src/lib/shader-assembler.ts

// luma.gl
// SPDX-License-Identifier: MIT
// Copyright (c) vis.gl contributors

import type {ShaderModule} from './shader-module/shader-module';
import {ShaderModuleInstance} from './shader-module/shader-module-instance';
import {
  AssembleShaderProps,
  GetUniformsFunc,
  assembleWGSLShader,
  assembleGLSLShaderPair
} from './shader-assembly/assemble-shaders';
import {preprocess} from './preprocessor/preprocessor';

/**
 * A stateful version of `assembleShaders` that can be used to assemble shaders.
 * Supports setting of default modules and hooks.
 */
export class ShaderAssembler {
  /** Default ShaderAssembler instance */
  static defaultShaderAssembler: ShaderAssembler;
  /** Hook functions */
  private readonly _hookFunctions: any[] = [];
  /** Shader modules */
  private _defaultModules: ShaderModule[] = [];

  /**
   * A default shader assembler instance - the natural place to register default modules and hooks
   * @returns
   */
  static getDefaultShaderAssembler(): ShaderAssembler {
    ShaderAssembler.defaultShaderAssembler =
      ShaderAssembler.defaultShaderAssembler || new ShaderAssembler();
    return ShaderAssembler.defaultShaderAssembler;
  }

  /**
   * Add a default module that does not have to be provided with every call to assembleShaders()
   */
  addDefaultModule(module: ShaderModule): void {
    if (
      !this._defaultModules.find(
        m => m.name === (typeof module === 'string' ? module : module.name)
      )
    ) {
      this._defaultModules.push(module);
    }
  }

  /**
   * Remove a default module
   */
  removeDefaultModule(module: ShaderModule): void {
    const moduleName = typeof module === 'string' ? module : module.name;
    this._defaultModules = this._defaultModules.filter(m => m.name !== moduleName);
  }

  /**
   * Register a shader hook
   * @param hook
   * @param opts
   */
  addShaderHook(hook: string, opts?: any): void {
    if (opts) {
      hook = Object.assign(opts, {hook});
    }
    this._hookFunctions.push(hook);
  }

  /**
   * Assemble a WGSL unified shader
   * @param platformInfo
   * @param props
   * @returns
   */
  assembleWGSLShader(props: AssembleShaderProps): {
    source: string;
    getUniforms: GetUniformsFunc;
    modules: ShaderModuleInstance[];
  } {
    const modules = this._getModuleList(props.modules); // Combine with default modules
    const hookFunctions = this._hookFunctions; // TODO - combine with default hook functions
    const {source, getUniforms} = assembleWGSLShader({
      ...props,
      // @ts-expect-error
      source: props.source,
      modules,
      hookFunctions
    });
    // WGSL does not have built-in preprocessing support (just compile time constants)
    const preprocessedSource =
      props.platformInfo.shaderLanguage === 'wgsl' ? preprocess(source) : source;
    return {source: preprocessedSource, getUniforms, modules};
  }

  /**
   * Assemble a pair of shaders into a single shader program
   * @param platformInfo
   * @param props
   * @returns
   */
  assembleGLSLShaderPair(props: AssembleShaderProps): {
    vs: string;
    fs: string;
    getUniforms: GetUniformsFunc;
    modules: ShaderModuleInstance[];
  } {
    const modules = this._getModuleList(props.modules); // Combine with default modules
    const hookFunctions = this._hookFunctions; // TODO - combine with default hook functions
    const assembled = assembleGLSLShaderPair({
      ...props,
      // @ts-expect-error
      vs: props.vs,
      // @ts-expect-error
      fs: props.fs,
      modules,
      hookFunctions
    });

    return {...assembled, modules};
  }

  /**
   * Dedupe and combine with default modules
   */
  _getModuleList(appModules: (ShaderModule | ShaderModuleInstance)[] = []): ShaderModuleInstance[] {
    const modules = new Array<ShaderModule | ShaderModuleInstance>(
      this._defaultModules.length + appModules.length
    );
    const seen: Record<string, boolean> = {};
    let count = 0;

    for (let i = 0, len = this._defaultModules.length; i < len; ++i) {
      const module = this._defaultModules[i];
      const name = module.name;
      modules[count++] = module;
      seen[name] = true;
    }

    for (let i = 0, len = appModules.length; i < len; ++i) {
      const module = appModules[i];
      const name = module.name;
      if (!seen[name]) {
        modules[count++] = module;
        seen[name] = true;
      }
    }

    modules.length = count;

    return ShaderModuleInstance.instantiateModules(modules);
  }
}

1	// luma.gl	1✔
2	// SPDX-License-Identifier: MIT	1✔
3	// Copyright (c) vis.gl contributors	1✔
4		1✔
5	import type {ShaderModule} from './shader-module/shader-module';	1✔
6	import {ShaderModuleInstance} from './shader-module/shader-module-instance';	1✔
7	import {	1✔
8	AssembleShaderProps,	1✔
9	GetUniformsFunc,	1✔
10	assembleWGSLShader,	1✔
11	assembleGLSLShaderPair	1✔
12	} from './shader-assembly/assemble-shaders';	1✔
13	import {preprocess} from './preprocessor/preprocessor';	1✔
14		1✔
15	/**	1✔
16	* A stateful version of `assembleShaders` that can be used to assemble shaders.	1✔
17	* Supports setting of default modules and hooks.	1✔
18	*/	1✔
19	export class ShaderAssembler {	1✔
20	/** Default ShaderAssembler instance */	1✔
21	static defaultShaderAssembler: ShaderAssembler;	1✔
22	/** Hook functions */	1✔
23	private readonly _hookFunctions: any[] = [];	1✔
24	/** Shader modules */	1✔
25	private _defaultModules: ShaderModule[] = [];	1✔
26		1✔
27	/**	1✔
28	* A default shader assembler instance - the natural place to register default modules and hooks	1✔
29	* @returns	1✔
30	*/	1✔
31	static getDefaultShaderAssembler(): ShaderAssembler {	1✔
32	ShaderAssembler.defaultShaderAssembler =	2✔
33	ShaderAssembler.defaultShaderAssembler \|\| new ShaderAssembler();	2✔
34	return ShaderAssembler.defaultShaderAssembler;	2✔
35	}	2✔
36		1✔
37	/**	1✔
38	* Add a default module that does not have to be provided with every call to assembleShaders()	1✔
39	*/	1✔
40	addDefaultModule(module: ShaderModule): void {	1✔
41	if (	2✔
42	!this._defaultModules.find(	2✔
43	m => m.name === (typeof module === 'string' ? module : module.name)	2✔
44	)	2✔
45	) {	2✔
46	this._defaultModules.push(module);	2✔
47	}	2✔
48	}	2✔
49		1✔
50	/**	1✔
51	* Remove a default module	1✔
52	*/	1✔
53	removeDefaultModule(module: ShaderModule): void {	1✔
54	const moduleName = typeof module === 'string' ? module : module.name;	1!
55	this._defaultModules = this._defaultModules.filter(m => m.name !== moduleName);	1✔
56	}	1✔
57		1✔
58	/**	1✔
59	* Register a shader hook	1✔
60	* @param hook	1✔
61	* @param opts	1✔
62	*/	1✔
63	addShaderHook(hook: string, opts?: any): void {	1✔
64	if (opts) {	2✔
65	hook = Object.assign(opts, {hook});	1✔
66	}	1✔
67	this._hookFunctions.push(hook);	2✔
68	}	2✔
69		1✔
70	/**	1✔
71	* Assemble a WGSL unified shader	1✔
72	* @param platformInfo	1✔
73	* @param props	1✔
74	* @returns	1✔
75	*/	1✔
76	assembleWGSLShader(props: AssembleShaderProps): {	1✔
77	source: string;	×
78	getUniforms: GetUniformsFunc;	×
79	modules: ShaderModuleInstance[];	×
80	} {	×
81	const modules = this._getModuleList(props.modules); // Combine with default modules	×
82	const hookFunctions = this._hookFunctions; // TODO - combine with default hook functions	×
83	const {source, getUniforms} = assembleWGSLShader({	×
84	...props,	×
NEW 85	// @ts-expect-error	×
NEW 86	source: props.source,	×
87	modules,	×
88	hookFunctions	×
89	});	×
90	// WGSL does not have built-in preprocessing support (just compile time constants)	×
91	const preprocessedSource =	×
92	props.platformInfo.shaderLanguage === 'wgsl' ? preprocess(source) : source;	×
93	return {source: preprocessedSource, getUniforms, modules};	×
94	}	×
95		1✔
96	/**	1✔
97	* Assemble a pair of shaders into a single shader program	1✔
98	* @param platformInfo	1✔
99	* @param props	1✔
100	* @returns	1✔
101	*/	1✔
102	assembleGLSLShaderPair(props: AssembleShaderProps): {	1✔
103	vs: string;	45✔
104	fs: string;	45✔
105	getUniforms: GetUniformsFunc;	45✔
106	modules: ShaderModuleInstance[];	45✔
107	} {	45✔
108	const modules = this._getModuleList(props.modules); // Combine with default modules	45✔
109	const hookFunctions = this._hookFunctions; // TODO - combine with default hook functions	45✔
110	const assembled = assembleGLSLShaderPair({	45✔
111	...props,	45✔
112	// @ts-expect-error	45✔
113	vs: props.vs,	45✔
114	// @ts-expect-error	45✔
115	fs: props.fs,	45✔
116	modules,	45✔
117	hookFunctions	45✔
118	});	45✔
119		45✔
120	return {...assembled, modules};	45✔
121	}	45✔
122		1✔
123	/**	1✔
124	* Dedupe and combine with default modules	1✔
125	*/	1✔
126	_getModuleList(appModules: (ShaderModule \| ShaderModuleInstance)[] = []): ShaderModuleInstance[] {	1✔
127	const modules = new Array<ShaderModule \| ShaderModuleInstance>(	45✔
128	this._defaultModules.length + appModules.length	45✔
129	);	45✔
130	const seen: Record<string, boolean> = {};	45✔
131	let count = 0;	45✔
132		45✔
133	for (let i = 0, len = this._defaultModules.length; i < len; ++i) {	45✔
134	const module = this._defaultModules[i];	3✔
135	const name = module.name;	3✔
136	modules[count++] = module;	3✔
137	seen[name] = true;	3✔
138	}	3✔
139		45✔
140	for (let i = 0, len = appModules.length; i < len; ++i) {	45✔
141	const module = appModules[i];	12✔
142	const name = module.name;	12✔
143	if (!seen[name]) {	12✔
144	modules[count++] = module;	11✔
145	seen[name] = true;	11✔
146	}	11✔
147	}	12✔
148		45✔
149	modules.length = count;	45✔
150		45✔
151	return ShaderModuleInstance.instantiateModules(modules);	45✔
152	}	45✔
153	}	1✔

visgl / luma.gl / 8252301685

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