6955443021

Committed 22 Nov 2023 09:37AM UTC coverage: 76.959% (-0.004%) from 76.963%

Build # 6955443021

Build Type

Pull #1845

github

Committed by

web-flow

Commit Message

Merge 311d58a61 into 99bc61921

Pull Request Pull Request #1845: Warning when passing unsupported value to setUniforms

Run Details

1795 of 2399 branches covered (0.0%)

Branch coverage included in aggregate %.

10 of 16 new or added lines in 4 files covered. (62.5%)

33 existing lines in 2 files now uncovered.

34017 of 44135 relevant lines covered (77.07%)

44.5 hits per line

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

71.76

/modules/engine/src/model/model.ts

// luma.gl, MIT license
// Copyright (c) vis.gl contributors

import type {
  TypedArray,
  RenderPipelineProps,
  RenderPipelineParameters,
  BufferLayout,
  VertexArray,
  AttributeInfo
} from '@luma.gl/core';
import type {Binding, UniformValue, PrimitiveTopology} from '@luma.gl/core';
import {Device, Buffer, RenderPipeline, RenderPass, log, uid, deepEqual, isUniform} from '@luma.gl/core';
import {getAttributeInfosFromLayouts} from '@luma.gl/core';
import type {ShaderModule, PlatformInfo} from '@luma.gl/shadertools';
import {ShaderAssembler} from '@luma.gl/shadertools';
import type {Geometry} from '../geometry/geometry';
import {GPUGeometry, makeGPUGeometry} from '../geometry/gpu-geometry';
import {PipelineFactory} from '../lib/pipeline-factory';

export type ModelProps = Omit<RenderPipelineProps, 'vs' | 'fs'> & {
  // Model also accepts a string shaders
  vs: {glsl?: string; wgsl?: string} | string | null;
  fs: {glsl?: string; wgsl?: string} | string | null;
  /** shadertool shader modules (added to shader code) */
  modules?: ShaderModule[];
  /** Shadertool module defines (configures shader code)*/
  defines?: Record<string, string | number | boolean>;
  // TODO - injections, hooks etc?

  /** pipeline factory to use to create render pipelines. Defaults to default factory for the device */
  pipelineFactory?: PipelineFactory;
  /** Shader assembler. Defaults to the ShaderAssembler.getShaderAssembler() */
  shaderAssembler?: ShaderAssembler;

  /** Parameters that are built into the pipeline */
  parameters?: RenderPipelineParameters;

  /** Geometry */
  geometry?: GPUGeometry | Geometry | null;

  /** Vertex count */
  vertexCount?: number;
  /** instance count */
  instanceCount?: number;

  indexBuffer?: Buffer | null;
  /** @note this is really a map of buffers, not a map of attributes */
  attributes?: Record<string, Buffer>;
  /**   */
  constantAttributes?: Record<string, TypedArray>;

  /** Mapped uniforms for shadertool modules */
  moduleSettings?: Record<string, Record<string, any>>;
};

/**
 * v9 Model API
 * A model
 * - automatically reuses pipelines (programs) when possible
 * - automatically rebuilds pipelines if necessary to accommodate changed settings
 * shadertools integration
 * - accepts modules and performs shader transpilation
 */
export class Model {
  static defaultProps: Required<ModelProps> = {
    ...RenderPipeline.defaultProps,
    vs: null,
    fs: null,
    id: 'unnamed',
    handle: undefined,
    userData: {},
    defines: {},
    modules: [],
    moduleSettings: {},
    geometry: null,
    indexBuffer: null,
    attributes: {},
    constantAttributes: {},

    pipelineFactory: undefined!,
    shaderAssembler: ShaderAssembler.getDefaultShaderAssembler()
  };

  readonly device: Device;
  readonly id: string;
  readonly vs: string;
  readonly fs: string;
  readonly pipelineFactory: PipelineFactory;
  userData: {[key: string]: any} = {};

  // Fixed properties (change can trigger pipeline rebuild)

  /** The render pipeline GPU parameters, depth testing etc */
  parameters: RenderPipelineParameters;

  /** The primitive topology */
  topology: PrimitiveTopology;
  /** Buffer layout */
  bufferLayout: BufferLayout[];

  // Dynamic properties

  /** Vertex count */
  vertexCount: number;
  /** instance count */
  instanceCount: number = 0;

  /** Index buffer */
  indexBuffer: Buffer | null = null;
  /** Buffer-valued attributes */
  bufferAttributes: Record<string, Buffer> = {};
  /** Constant-valued attributes */
  constantAttributes: Record<string, TypedArray> = {};
  /** Bindings (textures, samplers, uniform buffers) */
  bindings: Record<string, Binding> = {};
  /** Sets uniforms @deprecated Use uniform buffers and setBindings() for portability*/
  uniforms: Record<string, UniformValue> = {};

  /** The underlying GPU "program". @note May be recreated if parameters change */
  pipeline: RenderPipeline;

  /**
   * VertexArray
   * @note not implemented: if bufferLayout is updated, vertex array has to be rebuilt!
   * @todo - allow application to define multiple vertex arrays?
   * */
  vertexArray: VertexArray;

  _pipelineNeedsUpdate: string | false = 'newly created';
  _attributeInfos: Record<string, AttributeInfo> = {};
  _gpuGeometry: GPUGeometry | null = null;
  private _getModuleUniforms: (props?: Record<string, Record<string, any>>) => Record<string, any>;
  private props: Required<ModelProps>;

  constructor(device: Device, props: ModelProps) {
    this.props = {...Model.defaultProps, ...props};
    props = this.props;
    this.id = props.id || uid('model');
    this.device = device;

    Object.assign(this.userData, props.userData);

    /** Create a shadertools platform info from the Device */
    const platformInfo: PlatformInfo = {
      type: device.info.type,
      shaderLanguage: device.info.shadingLanguages[0],
      gpu: device.info.gpu,
      features: device.features
    };

    const {vs, fs, getUniforms} = this.props.shaderAssembler.assembleShaders(
      platformInfo,
      this.props
    );
    this.vs = vs;
    this.fs = fs;
    this._getModuleUniforms = getUniforms;

    this.vertexCount = this.props.vertexCount;
    this.instanceCount = this.props.instanceCount;

    this.topology = this.props.topology;
    this.bufferLayout = this.props.bufferLayout;
    this.parameters = this.props.parameters;

    // Geometry, if provided, sets topology and vertex cound
    if (props.geometry) {
      this._gpuGeometry = this.setGeometry(props.geometry);
    }

    this.pipelineFactory =
      props.pipelineFactory || PipelineFactory.getDefaultPipelineFactory(this.device);

    // Create the pipeline
    // @note order is important
    this.pipeline = this._updatePipeline();

    this.vertexArray = device.createVertexArray({
      renderPipeline: this.pipeline
    });

    // Now we can apply geometry attributes
    if (this._gpuGeometry) {
      this._setGeometryAttributes(this._gpuGeometry);
    }

    // Apply any dynamic settings that will not trigger pipeline change
    if (props.vertexCount) {
      this.setVertexCount(props.vertexCount);
    }
    if (props.instanceCount) {
      this.setInstanceCount(props.instanceCount);
    }
    // @ts-expect-error
    if (props.indices) {
      throw new Error('Model.props.indices removed. Use props.indexBuffer')
    }
    if (props.indexBuffer) {
      this.setIndexBuffer(props.indexBuffer);
    }
    if (props.attributes) {
      this.setAttributes(props.attributes);
    }
    if (props.constantAttributes) {
      this.setConstantAttributes(props.constantAttributes);
    }
    if (props.bindings) {
      this.setBindings(props.bindings);
    }
    if (props.uniforms) {
      this.setUniforms(props.uniforms);
    }
    if (props.moduleSettings) {
      this.updateModuleSettings(props.moduleSettings);
    }

    this.setUniforms(this._getModuleUniforms()); // Get all default module uniforms

    // Catch any access to non-standard props
    Object.seal(this);
  }

  destroy(): void {
    this.pipelineFactory.release(this.pipeline);
  }

  // Draw call

  draw(renderPass: RenderPass): void {
    // Check if the pipeline is invalidated
    // TODO - this is likely the worst place to do this from performance perspective. Perhaps add a predraw()?
    this.pipeline = this._updatePipeline();

    // Set pipeline state, we may be sharing a pipeline so we need to set all state on every draw
    // Any caching needs to be done inside the pipeline functions
    this.pipeline.setBindings(this.bindings);
    this.pipeline.setUniforms(this.uniforms);

    this.pipeline.draw({
      renderPass,
      vertexArray: this.vertexArray,
      vertexCount: this.vertexCount,
      instanceCount: this.instanceCount
    });
  }

  // Update fixed fields (can trigger pipeline rebuild)

  /**
   * Updates the optional geometry
   * Geometry, set topology and bufferLayout
   * @note Can trigger a pipeline rebuild / pipeline cache fetch on WebGPU
   */
  setGeometry(geometry: GPUGeometry | Geometry): GPUGeometry {
    const gpuGeometry = geometry && makeGPUGeometry(this.device, geometry);
    this.setTopology(gpuGeometry.topology || 'triangle-list');
    this.bufferLayout = mergeBufferLayouts(this.bufferLayout, gpuGeometry.bufferLayout);
    if (this.vertexArray) {
      this._setGeometryAttributes(gpuGeometry);
    }
    return gpuGeometry;
  }

  /**
   * Updates the optional geometry attributes
   * Geometry, sets several attributes, indexBuffer, and also vertex count
   * @note Can trigger a pipeline rebuild / pipeline cache fetch on WebGPU
   */
  _setGeometryAttributes(gpuGeometry: GPUGeometry): void {
    // TODO - delete previous geometry?
    this.vertexCount = gpuGeometry.vertexCount;
    this.setAttributes(gpuGeometry.attributes);
    this.setIndexBuffer(gpuGeometry.indices);
  }

  /**
   * Updates the primitive topology ('triangle-list', 'triangle-strip' etc).
   * @note Triggers a pipeline rebuild / pipeline cache fetch on WebGPU
   */
  setTopology(topology: PrimitiveTopology): void {
    if (topology !== this.topology) {
      this.topology = topology;
      this._setPipelineNeedsUpdate('topology');
    }
  }

  /**
   * Updates the buffer layout.
   * @note Triggers a pipeline rebuild / pipeline cache fetch on WebGPU
   */
  setBufferLayout(bufferLayout: BufferLayout[]): void {
    this.bufferLayout = this._gpuGeometry
      ? mergeBufferLayouts(bufferLayout, this._gpuGeometry.bufferLayout)
      : bufferLayout;
    this._setPipelineNeedsUpdate('bufferLayout');

    // Recreate the pipeline
    this.pipeline = this._updatePipeline();
    
    // vertex array needs to be updated if we update buffer layout,
    // but not if we update parameters
    this.vertexArray = this.device.createVertexArray({
      renderPipeline: this.pipeline
    });

    // Reapply geometry attributes to the new vertex array
    if (this._gpuGeometry) {
      this._setGeometryAttributes(this._gpuGeometry);
    }
  }

  /**
   * Set GPU parameters.
   * @note Can trigger a pipeline rebuild / pipeline cache fetch.
   * @param parameters
   */
  setParameters(parameters: RenderPipelineParameters) {
    if (!deepEqual(parameters, this.parameters, 2)) {
      this.parameters = parameters;
      this._setPipelineNeedsUpdate('parameters');
    }
  }

  // Update dynamic fields

  /**
   * Updates the vertex count (used in draw calls)
   * @note Any attributes with stepMode=vertex need to be at least this big
   */
  setVertexCount(vertexCount: number): void {
    this.vertexCount = vertexCount;
  }

  /**
   * Updates the instance count (used in draw calls)
   * @note Any attributes with stepMode=instance need to be at least this big
   */
  setInstanceCount(instanceCount: number): void {
    this.instanceCount = instanceCount;
  }

  /**
   * Updates shader module settings (which results in uniforms being set)
   */
  setShaderModuleProps(props: Record<string, any>): void {
    const uniforms = this._getModuleUniforms(props);

    // Extract textures & framebuffers set by the modules
    // TODO better way to extract bindings
    const keys = Object.keys(uniforms).filter(k => !isUniform(uniforms[k]));
    const bindings: Record<string, Binding> = {};
    for (const k of keys) {
      bindings[k] = uniforms[k];
      delete uniforms[k];
    }

    Object.assign(this.uniforms, uniforms);
    Object.assign(this.bindings, bindings);
  }

  /**
   * @deprecated Updates shader module settings (which results in uniforms being set)
   */
  updateModuleSettings(props: Record<string, any>): void {
    this.setShaderModuleProps(props);
  }

  /**
   * Sets bindings (textures, samplers, uniform buffers)
   */
  setBindings(bindings: Record<string, Binding>): void {
    Object.assign(this.bindings, bindings);
  }

  /**
   * Sets individual uniforms
   * @deprecated WebGL only, use uniform buffers for portability
   * @param uniforms
   * @returns self for chaining
   */
  setUniforms(uniforms: Record<string, UniformValue>): void {
    this.pipeline.setUniforms(uniforms);
    Object.assign(this.uniforms, uniforms);
  }

  /**
   * Sets the index buffer
   * @todo - how to unset it if we change geometry?
   */
  setIndexBuffer(indexBuffer: Buffer | null): void {
    this.vertexArray.setIndexBuffer(indexBuffer);
  }

  /**
   * Sets attributes (buffers)
   * @note Overrides any attributes previously set with the same name
   */
  setAttributes(buffers: Record<string, Buffer>): void {
    if (buffers.indices) {
      log.warn(
        `Model:${this.id} setAttributes() - indexBuffer should be set using setIndexBuffer()`
      );
    }
    for (const [bufferName, buffer] of Object.entries(buffers)) {
      const bufferLayout = this.bufferLayout.find(layout => layout.name === bufferName);
      if (!bufferLayout) {
        continue; // eslint-disable-line no-continue
      }

      // For an interleaved attribute we may need to set multiple attributes
      const attributeNames = bufferLayout.attributes
        ? bufferLayout.attributes?.map(layout => layout.attribute)
        : [bufferLayout.name];
      let set = false;
      for (const attributeName of attributeNames) {
        const attributeInfo = this._attributeInfos[attributeName];
        if (attributeInfo) {
          this.vertexArray.setBuffer(attributeInfo.location, buffer);
          set = true;
        }
      }
      if (!set) {
        log.warn(
          `Model(${this.id}): Ignoring buffer "${buffer.id}" for unknown attribute "${bufferName}"`
        )();
      }
    }
  }

  /**
   * Sets constant attributes
   * @note Overrides any attributes previously set with the same name
   * Constant attributes are only supported in WebGL, not in WebGPU
   * Any attribute that is disabled in the current vertex array object
   * is read from the context's global constant value for that attribute location.
   * @param constantAttributes
   */
  setConstantAttributes(attributes: Record<string, TypedArray>): void {
    for (const [attributeName, value] of Object.entries(attributes)) {
      const attributeInfo = this._attributeInfos[attributeName];
      if (attributeInfo) {
        this.vertexArray.setConstant(attributeInfo.location, value);
      } else {
        log.warn(`Model "${this.id}: Ignoring constant supplied for unknown attribute "${attributeName}"`)();
      }
    }
  }

  _setPipelineNeedsUpdate(reason: string): void {
    this._pipelineNeedsUpdate = this._pipelineNeedsUpdate || reason;
  }

  _updatePipeline(): RenderPipeline {
    if (this._pipelineNeedsUpdate) {
      if (this.pipeline) {
        log.log(1, `Model ${this.id}: Recreating pipeline because "${this._pipelineNeedsUpdate}".`)();
      }
      this._pipelineNeedsUpdate = false;
      this.pipeline = this.device.createRenderPipeline({
        ...this.props,
        bufferLayout: this.bufferLayout,
        topology: this.topology,
        parameters: this.parameters,
        vs: this.device.createShader({id: '{$this.id}-vertex', stage: 'vertex', source: this.vs}),
        fs: this.fs ? this.device.createShader({id: '{$this.id}-fragment', stage: 'fragment', source: this.fs}) : null
      });
      this._attributeInfos = getAttributeInfosFromLayouts(
        this.pipeline.shaderLayout,
        this.bufferLayout
      );
    }
    return this.pipeline;
  }
}

/** TODO - move to core, document add tests */
function mergeBufferLayouts(layouts1: BufferLayout[], layouts2: BufferLayout[]): BufferLayout[] {
  const layouts = [...layouts1];
  for (const attribute of layouts2) {
    const index = layouts.findIndex(attribute2 => attribute2.name === attribute.name);
    if (index < 0) {
      layouts.push(attribute);
    } else {
      layouts[index] = attribute;
    }
  }
  return layouts;
}

1	// luma.gl, MIT license	1✔
2	// Copyright (c) vis.gl contributors	1✔
3		1✔
4	import type {	1✔
5	TypedArray,	1✔
6	RenderPipelineProps,	1✔
7	RenderPipelineParameters,	1✔
8	BufferLayout,	1✔
9	VertexArray,	1✔
10	AttributeInfo	1✔
11	} from '@luma.gl/core';	1✔
12	import type {Binding, UniformValue, PrimitiveTopology} from '@luma.gl/core';	1✔
13	import {Device, Buffer, RenderPipeline, RenderPass, log, uid, deepEqual, isUniform} from '@luma.gl/core';	1✔
14	import {getAttributeInfosFromLayouts} from '@luma.gl/core';	1✔
15	import type {ShaderModule, PlatformInfo} from '@luma.gl/shadertools';	1✔
16	import {ShaderAssembler} from '@luma.gl/shadertools';	1✔
17	import type {Geometry} from '../geometry/geometry';	1✔
18	import {GPUGeometry, makeGPUGeometry} from '../geometry/gpu-geometry';	1✔
19	import {PipelineFactory} from '../lib/pipeline-factory';	1✔
20		1✔
21	export type ModelProps = Omit<RenderPipelineProps, 'vs' \| 'fs'> & {	1✔
22	// Model also accepts a string shaders	1✔
23	vs: {glsl?: string; wgsl?: string} \| string \| null;	1✔
24	fs: {glsl?: string; wgsl?: string} \| string \| null;	1✔
25	/** shadertool shader modules (added to shader code) */	1✔
26	modules?: ShaderModule[];	1✔
27	/** Shadertool module defines (configures shader code)*/	1✔
28	defines?: Record<string, string \| number \| boolean>;	1✔
29	// TODO - injections, hooks etc?	1✔
30		1✔
31	/** pipeline factory to use to create render pipelines. Defaults to default factory for the device */	1✔
32	pipelineFactory?: PipelineFactory;	1✔
33	/** Shader assembler. Defaults to the ShaderAssembler.getShaderAssembler() */	1✔
34	shaderAssembler?: ShaderAssembler;	1✔
35		1✔
36	/** Parameters that are built into the pipeline */	1✔
37	parameters?: RenderPipelineParameters;	1✔
38		1✔
39	/** Geometry */	1✔
40	geometry?: GPUGeometry \| Geometry \| null;	1✔
41		1✔
42	/** Vertex count */	1✔
43	vertexCount?: number;	1✔
44	/** instance count */	1✔
45	instanceCount?: number;	1✔
46		1✔
47	indexBuffer?: Buffer \| null;	1✔
48	/** @note this is really a map of buffers, not a map of attributes */	1✔
49	attributes?: Record<string, Buffer>;	1✔
50	/** */	1✔
51	constantAttributes?: Record<string, TypedArray>;	1✔
52		1✔
53	/** Mapped uniforms for shadertool modules */	1✔
54	moduleSettings?: Record<string, Record<string, any>>;	1✔
55	};	1✔
56		1✔
57	/**	1✔
58	* v9 Model API	1✔
59	* A model	1✔
60	* - automatically reuses pipelines (programs) when possible	1✔
61	* - automatically rebuilds pipelines if necessary to accommodate changed settings	1✔
62	* shadertools integration	1✔
63	* - accepts modules and performs shader transpilation	1✔
64	*/	1✔
65	export class Model {	1✔
66	static defaultProps: Required<ModelProps> = {	1✔
67	...RenderPipeline.defaultProps,	1✔
68	vs: null,	1✔
69	fs: null,	1✔
70	id: 'unnamed',	1✔
71	handle: undefined,	1✔
72	userData: {},	1✔
73	defines: {},	1✔
74	modules: [],	1✔
75	moduleSettings: {},	1✔
76	geometry: null,	1✔
77	indexBuffer: null,	1✔
78	attributes: {},	1✔
79	constantAttributes: {},	1✔
80		1✔
81	pipelineFactory: undefined!,	1✔
82	shaderAssembler: ShaderAssembler.getDefaultShaderAssembler()	1✔
83	};	1✔
84		1✔
85	readonly device: Device;	1✔
86	readonly id: string;	1✔
87	readonly vs: string;	1✔
88	readonly fs: string;	1✔
89	readonly pipelineFactory: PipelineFactory;	1✔
90	userData: {[key: string]: any} = {};	1✔
91		1✔
92	// Fixed properties (change can trigger pipeline rebuild)	1✔
93		1✔
94	/** The render pipeline GPU parameters, depth testing etc */	1✔
95	parameters: RenderPipelineParameters;	1✔
96		1✔
97	/** The primitive topology */	1✔
98	topology: PrimitiveTopology;	1✔
99	/** Buffer layout */	1✔
100	bufferLayout: BufferLayout[];	1✔
101		1✔
102	// Dynamic properties	1✔
103		1✔
104	/** Vertex count */	1✔
105	vertexCount: number;	1✔
106	/** instance count */	1✔
107	instanceCount: number = 0;	1✔
108		1✔
109	/** Index buffer */	1✔
110	indexBuffer: Buffer \| null = null;	1✔
111	/** Buffer-valued attributes */	1✔
112	bufferAttributes: Record<string, Buffer> = {};	1✔
113	/** Constant-valued attributes */	1✔
114	constantAttributes: Record<string, TypedArray> = {};	1✔
115	/** Bindings (textures, samplers, uniform buffers) */	1✔
116	bindings: Record<string, Binding> = {};	1✔
117	/** Sets uniforms @deprecated Use uniform buffers and setBindings() for portability*/	1✔
118	uniforms: Record<string, UniformValue> = {};	1✔
119		1✔
120	/** The underlying GPU "program". @note May be recreated if parameters change */	1✔
121	pipeline: RenderPipeline;	1✔
122		1✔
123	/**	1✔
124	* VertexArray	1✔
125	* @note not implemented: if bufferLayout is updated, vertex array has to be rebuilt!	1✔
126	* @todo - allow application to define multiple vertex arrays?	1✔
127	* */	1✔
128	vertexArray: VertexArray;	1✔
129		1✔
130	_pipelineNeedsUpdate: string \| false = 'newly created';	1✔
131	_attributeInfos: Record<string, AttributeInfo> = {};	1✔
132	_gpuGeometry: GPUGeometry \| null = null;	1✔
133	private _getModuleUniforms: (props?: Record<string, Record<string, any>>) => Record<string, any>;	1✔
134	private props: Required<ModelProps>;	1✔
135		1✔
136	constructor(device: Device, props: ModelProps) {	1✔
137	this.props = {...Model.defaultProps, ...props};	3✔
138	props = this.props;	3✔
139	this.id = props.id \|\| uid('model');	3!
140	this.device = device;	3✔
141		3✔
142	Object.assign(this.userData, props.userData);	3✔
143		3✔
144	/** Create a shadertools platform info from the Device */	3✔
145	const platformInfo: PlatformInfo = {	3✔
146	type: device.info.type,	3✔
147	shaderLanguage: device.info.shadingLanguages[0],	3✔
148	gpu: device.info.gpu,	3✔
149	features: device.features	3✔
150	};	3✔
151		3✔
152	const {vs, fs, getUniforms} = this.props.shaderAssembler.assembleShaders(	3✔
153	platformInfo,	3✔
154	this.props	3✔
155	);	3✔
156	this.vs = vs;	3✔
157	this.fs = fs;	3✔
158	this._getModuleUniforms = getUniforms;	3✔
159		3✔
160	this.vertexCount = this.props.vertexCount;	3✔
161	this.instanceCount = this.props.instanceCount;	3✔
162		3✔
163	this.topology = this.props.topology;	3✔
164	this.bufferLayout = this.props.bufferLayout;	3✔
165	this.parameters = this.props.parameters;	3✔
166		3✔
167	// Geometry, if provided, sets topology and vertex cound	3✔
168	if (props.geometry) {	3!
169	this._gpuGeometry = this.setGeometry(props.geometry);	×
170	}	×
171		3✔
172	this.pipelineFactory =	3✔
173	props.pipelineFactory \|\| PipelineFactory.getDefaultPipelineFactory(this.device);	3✔
174		3✔
175	// Create the pipeline	3✔
176	// @note order is important	3✔
177	this.pipeline = this._updatePipeline();	3✔
178		3✔
179	this.vertexArray = device.createVertexArray({	3✔
180	renderPipeline: this.pipeline	3✔
181	});	3✔
182		3✔
183	// Now we can apply geometry attributes	3✔
184	if (this._gpuGeometry) {	3!
185	this._setGeometryAttributes(this._gpuGeometry);	×
186	}	×
187		3✔
188	// Apply any dynamic settings that will not trigger pipeline change	3✔
189	if (props.vertexCount) {	3!
190	this.setVertexCount(props.vertexCount);	×
191	}	×
192	if (props.instanceCount) {	3!
193	this.setInstanceCount(props.instanceCount);	×
194	}	×
195	// @ts-expect-error	3✔
196	if (props.indices) {	3!
197	throw new Error('Model.props.indices removed. Use props.indexBuffer')	×
198	}	×
199	if (props.indexBuffer) {	3!
200	this.setIndexBuffer(props.indexBuffer);	×
201	}	×
202	if (props.attributes) {	3✔
203	this.setAttributes(props.attributes);	3✔
204	}	3✔
205	if (props.constantAttributes) {	3✔
206	this.setConstantAttributes(props.constantAttributes);	3✔
207	}	3✔
208	if (props.bindings) {	3✔
209	this.setBindings(props.bindings);	3✔
210	}	3✔
211	if (props.uniforms) {	3✔
212	this.setUniforms(props.uniforms);	3✔
213	}	3✔
214	if (props.moduleSettings) {	3✔
215	this.updateModuleSettings(props.moduleSettings);	3✔
216	}	3✔
217		3✔
218	this.setUniforms(this._getModuleUniforms()); // Get all default module uniforms	3✔
219		3✔
220	// Catch any access to non-standard props	3✔
221	Object.seal(this);	3✔
222	}	3✔
223		1✔
224	destroy(): void {	1✔
225	this.pipelineFactory.release(this.pipeline);	×
226	}	×
227		1✔
228	// Draw call	1✔
229		1✔
230	draw(renderPass: RenderPass): void {	1✔
231	// Check if the pipeline is invalidated	×
232	// TODO - this is likely the worst place to do this from performance perspective. Perhaps add a predraw()?	×
233	this.pipeline = this._updatePipeline();	×
234		×
235	// Set pipeline state, we may be sharing a pipeline so we need to set all state on every draw	×
236	// Any caching needs to be done inside the pipeline functions	×
237	this.pipeline.setBindings(this.bindings);	×
238	this.pipeline.setUniforms(this.uniforms);	×
239		×
240	this.pipeline.draw({	×
241	renderPass,	×
242	vertexArray: this.vertexArray,	×
243	vertexCount: this.vertexCount,	×
244	instanceCount: this.instanceCount	×
245	});	×
246	}	×
247		1✔
248	// Update fixed fields (can trigger pipeline rebuild)	1✔
249		1✔
250	/**	1✔
251	* Updates the optional geometry	1✔
252	* Geometry, set topology and bufferLayout	1✔
253	* @note Can trigger a pipeline rebuild / pipeline cache fetch on WebGPU	1✔
254	*/	1✔
255	setGeometry(geometry: GPUGeometry \| Geometry): GPUGeometry {	1✔
256	const gpuGeometry = geometry && makeGPUGeometry(this.device, geometry);	×
257	this.setTopology(gpuGeometry.topology \|\| 'triangle-list');	×
258	this.bufferLayout = mergeBufferLayouts(this.bufferLayout, gpuGeometry.bufferLayout);	×
259	if (this.vertexArray) {	×
260	this._setGeometryAttributes(gpuGeometry);	×
261	}	×
262	return gpuGeometry;	×
263	}	×
264		1✔
265	/**	1✔
266	* Updates the optional geometry attributes	1✔
267	* Geometry, sets several attributes, indexBuffer, and also vertex count	1✔
268	* @note Can trigger a pipeline rebuild / pipeline cache fetch on WebGPU	1✔
269	*/	1✔
270	_setGeometryAttributes(gpuGeometry: GPUGeometry): void {	1✔
271	// TODO - delete previous geometry?	×
272	this.vertexCount = gpuGeometry.vertexCount;	×
273	this.setAttributes(gpuGeometry.attributes);	×
274	this.setIndexBuffer(gpuGeometry.indices);	×
275	}	×
276		1✔
277	/**	1✔
278	* Updates the primitive topology ('triangle-list', 'triangle-strip' etc).	1✔
279	* @note Triggers a pipeline rebuild / pipeline cache fetch on WebGPU	1✔
280	*/	1✔
281	setTopology(topology: PrimitiveTopology): void {	1✔
282	if (topology !== this.topology) {	×
283	this.topology = topology;	×
284	this._setPipelineNeedsUpdate('topology');	×
285	}	×
286	}	×
287		1✔
288	/**	1✔
289	* Updates the buffer layout.	1✔
290	* @note Triggers a pipeline rebuild / pipeline cache fetch on WebGPU	1✔
291	*/	1✔
292	setBufferLayout(bufferLayout: BufferLayout[]): void {	1✔
293	this.bufferLayout = this._gpuGeometry	×
294	? mergeBufferLayouts(bufferLayout, this._gpuGeometry.bufferLayout)	×
295	: bufferLayout;	×
296	this._setPipelineNeedsUpdate('bufferLayout');	×
297		×
298	// Recreate the pipeline	×
299	this.pipeline = this._updatePipeline();	×
300		×
301	// vertex array needs to be updated if we update buffer layout,	×
302	// but not if we update parameters	×
303	this.vertexArray = this.device.createVertexArray({	×
304	renderPipeline: this.pipeline	×
305	});	×
306		×
307	// Reapply geometry attributes to the new vertex array	×
308	if (this._gpuGeometry) {	×
309	this._setGeometryAttributes(this._gpuGeometry);	×
310	}	×
311	}	×
312		1✔
313	/**	1✔
314	* Set GPU parameters.	1✔
315	* @note Can trigger a pipeline rebuild / pipeline cache fetch.	1✔
316	* @param parameters	1✔
317	*/	1✔
318	setParameters(parameters: RenderPipelineParameters) {	1✔
319	if (!deepEqual(parameters, this.parameters, 2)) {	×
320	this.parameters = parameters;	×
321	this._setPipelineNeedsUpdate('parameters');	×
322	}	×
323	}	×
324		1✔
325	// Update dynamic fields	1✔
326		1✔
327	/**	1✔
328	* Updates the vertex count (used in draw calls)	1✔
329	* @note Any attributes with stepMode=vertex need to be at least this big	1✔
330	*/	1✔
331	setVertexCount(vertexCount: number): void {	1✔
332	this.vertexCount = vertexCount;	×
333	}	×
334		1✔
335	/**	1✔
336	* Updates the instance count (used in draw calls)	1✔
337	* @note Any attributes with stepMode=instance need to be at least this big	1✔
338	*/	1✔
339	setInstanceCount(instanceCount: number): void {	1✔
340	this.instanceCount = instanceCount;	×
341	}	×
342		1✔
343	/**	1✔
344	* Updates shader module settings (which results in uniforms being set)	1✔
345	*/	1✔
346	setShaderModuleProps(props: Record<string, any>): void {	1✔
347	const uniforms = this._getModuleUniforms(props);	3✔
348		3✔
349	// Extract textures & framebuffers set by the modules	3✔
350	// TODO better way to extract bindings	3✔
351	const keys = Object.keys(uniforms).filter(k => !isUniform(uniforms[k]));	3✔
352	const bindings: Record<string, Binding> = {};	3✔
353	for (const k of keys) {	3!
UNCOV 354	bindings[k] = uniforms[k];	×
UNCOV 355	delete uniforms[k];	×
UNCOV 356	}	×
357		3✔
358	Object.assign(this.uniforms, uniforms);	3✔
359	Object.assign(this.bindings, bindings);	3✔
360	}	3✔
361		1✔
362	/**	1✔
363	* @deprecated Updates shader module settings (which results in uniforms being set)	1✔
364	*/	1✔
365	updateModuleSettings(props: Record<string, any>): void {	1✔
366	this.setShaderModuleProps(props);	3✔
367	}	3✔
368		1✔
369	/**	1✔
370	* Sets bindings (textures, samplers, uniform buffers)	1✔
371	*/	1✔
372	setBindings(bindings: Record<string, Binding>): void {	1✔
373	Object.assign(this.bindings, bindings);	3✔
374	}	3✔
375		1✔
376	/**	1✔
377	* Sets individual uniforms	1✔
378	* @deprecated WebGL only, use uniform buffers for portability	1✔
379	* @param uniforms	1✔
380	* @returns self for chaining	1✔
381	*/	1✔
382	setUniforms(uniforms: Record<string, UniformValue>): void {	1✔
383	this.pipeline.setUniforms(uniforms);	6✔
384	Object.assign(this.uniforms, uniforms);	6✔
385	}	6✔
386		1✔
387	/**	1✔
388	* Sets the index buffer	1✔
389	* @todo - how to unset it if we change geometry?	1✔
390	*/	1✔
391	setIndexBuffer(indexBuffer: Buffer \| null): void {	1✔
392	this.vertexArray.setIndexBuffer(indexBuffer);	×
393	}	×
394		1✔
395	/**	1✔
396	* Sets attributes (buffers)	1✔
397	* @note Overrides any attributes previously set with the same name	1✔
398	*/	1✔
399	setAttributes(buffers: Record<string, Buffer>): void {	1✔
400	if (buffers.indices) {	3!
401	log.warn(	×
402	`Model:${this.id} setAttributes() - indexBuffer should be set using setIndexBuffer()`	×
403	);	×
404	}	×
405	for (const [bufferName, buffer] of Object.entries(buffers)) {	3!
406	const bufferLayout = this.bufferLayout.find(layout => layout.name === bufferName);	×
407	if (!bufferLayout) {	×
408	continue; // eslint-disable-line no-continue	×
409	}	×
410		×
411	// For an interleaved attribute we may need to set multiple attributes	×
412	const attributeNames = bufferLayout.attributes	×
413	? bufferLayout.attributes?.map(layout => layout.attribute)	×
414	: [bufferLayout.name];	×
415	let set = false;	×
416	for (const attributeName of attributeNames) {	×
417	const attributeInfo = this._attributeInfos[attributeName];	×
418	if (attributeInfo) {	×
UNCOV 419	this.vertexArray.setBuffer(attributeInfo.location, buffer);	×
UNCOV 420	set = true;	×
UNCOV 421	}	×
UNCOV 422	}	×
UNCOV 423	if (!set) {	×
UNCOV 424	log.warn(	×
UNCOV 425	`Model(${this.id}): Ignoring buffer "${buffer.id}" for unknown attribute "${bufferName}"`	×
UNCOV 426	)();	×
UNCOV 427	}	×
UNCOV 428	}	×
429	}	3✔
430		1✔
431	/**	1✔
432	* Sets constant attributes	1✔
433	* @note Overrides any attributes previously set with the same name	1✔
434	* Constant attributes are only supported in WebGL, not in WebGPU	1✔
435	* Any attribute that is disabled in the current vertex array object	1✔
436	* is read from the context's global constant value for that attribute location.	1✔
437	* @param constantAttributes	1✔
438	*/	1✔
439	setConstantAttributes(attributes: Record<string, TypedArray>): void {	1✔
440	for (const [attributeName, value] of Object.entries(attributes)) {	3!
441	const attributeInfo = this._attributeInfos[attributeName];	×
442	if (attributeInfo) {	×
UNCOV 443	this.vertexArray.setConstant(attributeInfo.location, value);	×
UNCOV 444	} else {	×
UNCOV 445	log.warn(`Model "${this.id}: Ignoring constant supplied for unknown attribute "${attributeName}"`)();	×
UNCOV 446	}	×
447	}	×
448	}	3✔
449		1✔
450	_setPipelineNeedsUpdate(reason: string): void {	1✔
UNCOV 451	this._pipelineNeedsUpdate = this._pipelineNeedsUpdate \|\| reason;	×
UNCOV 452	}	×
453		1✔
454	_updatePipeline(): RenderPipeline {	1✔
455	if (this._pipelineNeedsUpdate) {	3✔
456	if (this.pipeline) {	3!
UNCOV 457	log.log(1, `Model ${this.id}: Recreating pipeline because "${this._pipelineNeedsUpdate}".`)();	×
UNCOV 458	}	×
459	this._pipelineNeedsUpdate = false;	3✔
460	this.pipeline = this.device.createRenderPipeline({	3✔
461	...this.props,	3✔
462	bufferLayout: this.bufferLayout,	3✔
463	topology: this.topology,	3✔
464	parameters: this.parameters,	3✔
465	vs: this.device.createShader({id: '{$this.id}-vertex', stage: 'vertex', source: this.vs}),	3✔
466	fs: this.fs ? this.device.createShader({id: '{$this.id}-fragment', stage: 'fragment', source: this.fs}) : null	3!
467	});	3✔
468	this._attributeInfos = getAttributeInfosFromLayouts(	3✔
469	this.pipeline.shaderLayout,	3✔
470	this.bufferLayout	3✔
471	);	3✔
472	}	3✔
473	return this.pipeline;	3✔
474	}	3✔
475	}	1✔
476		1✔
477	/** TODO - move to core, document add tests */	1✔
478	function mergeBufferLayouts(layouts1: BufferLayout[], layouts2: BufferLayout[]): BufferLayout[] {	×
479	const layouts = [...layouts1];	×
UNCOV 480	for (const attribute of layouts2) {	×
UNCOV 481	const index = layouts.findIndex(attribute2 => attribute2.name === attribute.name);	×
UNCOV 482	if (index < 0) {	×
UNCOV 483	layouts.push(attribute);	×
UNCOV 484	} else {	×
UNCOV 485	layouts[index] = attribute;	×
UNCOV 486	}	×
UNCOV 487	}	×
UNCOV 488	return layouts;	×
UNCOV 489	}	×

visgl / luma.gl / 6955443021

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