WebGPUBackend.js 32 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348
  1. /*// debugger tools
  2. import 'https://greggman.github.io/webgpu-avoid-redundant-state-setting/webgpu-check-redundant-state-setting.js';
  3. //*/
  4. import { WebGPUCoordinateSystem } from 'three';
  5. import { GPUFeatureName, GPUTextureFormat, GPULoadOp, GPUStoreOp, GPUIndexFormat, GPUTextureViewDimension } from './utils/WebGPUConstants.js';
  6. import WGSLNodeBuilder from './nodes/WGSLNodeBuilder.js';
  7. import Backend from '../common/Backend.js';
  8. import WebGPUUtils from './utils/WebGPUUtils.js';
  9. import WebGPUAttributeUtils from './utils/WebGPUAttributeUtils.js';
  10. import WebGPUBindingUtils from './utils/WebGPUBindingUtils.js';
  11. import WebGPUPipelineUtils from './utils/WebGPUPipelineUtils.js';
  12. import WebGPUTextureUtils from './utils/WebGPUTextureUtils.js';
  13. import WebGPU from '../../capabilities/WebGPU.js';
  14. //
  15. class WebGPUBackend extends Backend {
  16. constructor( parameters = {} ) {
  17. super( parameters );
  18. this.isWebGPUBackend = true;
  19. // some parameters require default values other than "undefined"
  20. this.parameters.alpha = ( parameters.alpha === undefined ) ? true : parameters.alpha;
  21. this.parameters.antialias = ( parameters.antialias === true );
  22. if ( this.parameters.antialias === true ) {
  23. this.parameters.sampleCount = ( parameters.sampleCount === undefined ) ? 4 : parameters.sampleCount;
  24. } else {
  25. this.parameters.sampleCount = 1;
  26. }
  27. this.parameters.requiredLimits = ( parameters.requiredLimits === undefined ) ? {} : parameters.requiredLimits;
  28. this.trackTimestamp = ( parameters.trackTimestamp === true );
  29. this.adapter = null;
  30. this.device = null;
  31. this.context = null;
  32. this.colorBuffer = null;
  33. this.defaultRenderPassdescriptor = null;
  34. this.utils = new WebGPUUtils( this );
  35. this.attributeUtils = new WebGPUAttributeUtils( this );
  36. this.bindingUtils = new WebGPUBindingUtils( this );
  37. this.pipelineUtils = new WebGPUPipelineUtils( this );
  38. this.textureUtils = new WebGPUTextureUtils( this );
  39. this.occludedResolveCache = new Map();
  40. }
  41. async init( renderer ) {
  42. await super.init( renderer );
  43. //
  44. const parameters = this.parameters;
  45. const adapterOptions = {
  46. powerPreference: parameters.powerPreference
  47. };
  48. const adapter = await navigator.gpu.requestAdapter( adapterOptions );
  49. if ( adapter === null ) {
  50. throw new Error( 'WebGPUBackend: Unable to create WebGPU adapter.' );
  51. }
  52. // feature support
  53. const features = Object.values( GPUFeatureName );
  54. const supportedFeatures = [];
  55. for ( const name of features ) {
  56. if ( adapter.features.has( name ) ) {
  57. supportedFeatures.push( name );
  58. }
  59. }
  60. const deviceDescriptor = {
  61. requiredFeatures: supportedFeatures,
  62. requiredLimits: parameters.requiredLimits
  63. };
  64. const device = ( parameters.device !== undefined ) ? parameters.device : await adapter.requestDevice( deviceDescriptor );
  65. const context = ( parameters.context !== undefined ) ? parameters.context : renderer.domElement.getContext( 'webgpu' );
  66. this.adapter = adapter;
  67. this.device = device;
  68. this.context = context;
  69. const alphaMode = parameters.alpha ? 'premultiplied' : 'opaque';
  70. this.context.configure( {
  71. device: this.device,
  72. format: GPUTextureFormat.BGRA8Unorm,
  73. usage: GPUTextureUsage.RENDER_ATTACHMENT | GPUTextureUsage.COPY_SRC,
  74. alphaMode: alphaMode
  75. } );
  76. this.updateSize();
  77. }
  78. get coordinateSystem() {
  79. return WebGPUCoordinateSystem;
  80. }
  81. async getArrayBufferAsync( attribute ) {
  82. return await this.attributeUtils.getArrayBufferAsync( attribute );
  83. }
  84. getContext() {
  85. return this.context;
  86. }
  87. _getDefaultRenderPassDescriptor() {
  88. let descriptor = this.defaultRenderPassdescriptor;
  89. const antialias = this.parameters.antialias;
  90. if ( descriptor === null ) {
  91. const renderer = this.renderer;
  92. descriptor = {
  93. colorAttachments: [ {
  94. view: null
  95. } ],
  96. depthStencilAttachment: {
  97. view: this.textureUtils.getDepthBuffer( renderer.depth, renderer.stencil ).createView()
  98. }
  99. };
  100. const colorAttachment = descriptor.colorAttachments[ 0 ];
  101. if ( antialias === true ) {
  102. colorAttachment.view = this.colorBuffer.createView();
  103. } else {
  104. colorAttachment.resolveTarget = undefined;
  105. }
  106. this.defaultRenderPassdescriptor = descriptor;
  107. }
  108. const colorAttachment = descriptor.colorAttachments[ 0 ];
  109. if ( antialias === true ) {
  110. colorAttachment.resolveTarget = this.context.getCurrentTexture().createView();
  111. } else {
  112. colorAttachment.view = this.context.getCurrentTexture().createView();
  113. }
  114. return descriptor;
  115. }
  116. _getRenderPassDescriptor( renderContext ) {
  117. const renderTarget = renderContext.renderTarget;
  118. const renderTargetData = this.get( renderTarget );
  119. let descriptors = renderTargetData.descriptors;
  120. if ( descriptors === undefined ) {
  121. descriptors = [];
  122. renderTargetData.descriptors = descriptors;
  123. }
  124. if ( renderTargetData.width !== renderTarget.width ||
  125. renderTargetData.height !== renderTarget.height ||
  126. renderTargetData.activeMipmapLevel !== renderTarget.activeMipmapLevel ||
  127. renderTargetData.samples !== renderTarget.samples
  128. ) {
  129. descriptors.length = 0;
  130. }
  131. let descriptor = descriptors[ renderContext.activeCubeFace ];
  132. if ( descriptor === undefined ) {
  133. const textures = renderContext.textures;
  134. const colorAttachments = [];
  135. for ( let i = 0; i < textures.length; i ++ ) {
  136. const textureData = this.get( textures[ i ] );
  137. const textureView = textureData.texture.createView( {
  138. baseMipLevel: renderContext.activeMipmapLevel,
  139. mipLevelCount: 1,
  140. baseArrayLayer: renderContext.activeCubeFace,
  141. dimension: GPUTextureViewDimension.TwoD
  142. } );
  143. let view, resolveTarget;
  144. if ( textureData.msaaTexture !== undefined ) {
  145. view = textureData.msaaTexture.createView();
  146. resolveTarget = textureView;
  147. } else {
  148. view = textureView;
  149. resolveTarget = undefined;
  150. }
  151. colorAttachments.push( {
  152. view,
  153. resolveTarget,
  154. loadOp: GPULoadOp.Load,
  155. storeOp: GPUStoreOp.Store
  156. } );
  157. }
  158. const depthTextureData = this.get( renderContext.depthTexture );
  159. const depthStencilAttachment = {
  160. view: depthTextureData.texture.createView(),
  161. };
  162. descriptor = {
  163. colorAttachments,
  164. depthStencilAttachment
  165. };
  166. descriptors[ renderContext.activeCubeFace ] = descriptor;
  167. renderTargetData.width = renderTarget.width;
  168. renderTargetData.height = renderTarget.height;
  169. renderTargetData.samples = renderTarget.samples;
  170. renderTargetData.activeMipmapLevel = renderTarget.activeMipmapLevel;
  171. }
  172. return descriptor;
  173. }
  174. beginRender( renderContext ) {
  175. const renderContextData = this.get( renderContext );
  176. const device = this.device;
  177. const occlusionQueryCount = renderContext.occlusionQueryCount;
  178. let occlusionQuerySet;
  179. if ( occlusionQueryCount > 0 ) {
  180. if ( renderContextData.currentOcclusionQuerySet ) renderContextData.currentOcclusionQuerySet.destroy();
  181. if ( renderContextData.currentOcclusionQueryBuffer ) renderContextData.currentOcclusionQueryBuffer.destroy();
  182. // Get a reference to the array of objects with queries. The renderContextData property
  183. // can be changed by another render pass before the buffer.mapAsyc() completes.
  184. renderContextData.currentOcclusionQuerySet = renderContextData.occlusionQuerySet;
  185. renderContextData.currentOcclusionQueryBuffer = renderContextData.occlusionQueryBuffer;
  186. renderContextData.currentOcclusionQueryObjects = renderContextData.occlusionQueryObjects;
  187. //
  188. occlusionQuerySet = device.createQuerySet( { type: 'occlusion', count: occlusionQueryCount } );
  189. renderContextData.occlusionQuerySet = occlusionQuerySet;
  190. renderContextData.occlusionQueryIndex = 0;
  191. renderContextData.occlusionQueryObjects = new Array( occlusionQueryCount );
  192. renderContextData.lastOcclusionObject = null;
  193. }
  194. let descriptor;
  195. if ( renderContext.textures === null ) {
  196. descriptor = this._getDefaultRenderPassDescriptor();
  197. } else {
  198. descriptor = this._getRenderPassDescriptor( renderContext );
  199. }
  200. this.initTimestampQuery( renderContext, descriptor );
  201. descriptor.occlusionQuerySet = occlusionQuerySet;
  202. const depthStencilAttachment = descriptor.depthStencilAttachment;
  203. if ( renderContext.textures !== null ) {
  204. const colorAttachments = descriptor.colorAttachments;
  205. for ( let i = 0; i < colorAttachments.length; i ++ ) {
  206. const colorAttachment = colorAttachments[ i ];
  207. if ( renderContext.clearColor ) {
  208. colorAttachment.clearValue = renderContext.clearColorValue;
  209. colorAttachment.loadOp = GPULoadOp.Clear;
  210. colorAttachment.storeOp = GPUStoreOp.Store;
  211. } else {
  212. colorAttachment.loadOp = GPULoadOp.Load;
  213. colorAttachment.storeOp = GPUStoreOp.Store;
  214. }
  215. }
  216. } else {
  217. const colorAttachment = descriptor.colorAttachments[ 0 ];
  218. if ( renderContext.clearColor ) {
  219. colorAttachment.clearValue = renderContext.clearColorValue;
  220. colorAttachment.loadOp = GPULoadOp.Clear;
  221. colorAttachment.storeOp = GPUStoreOp.Store;
  222. } else {
  223. colorAttachment.loadOp = GPULoadOp.Load;
  224. colorAttachment.storeOp = GPUStoreOp.Store;
  225. }
  226. }
  227. //
  228. if ( renderContext.depth ) {
  229. if ( renderContext.clearDepth ) {
  230. depthStencilAttachment.depthClearValue = renderContext.clearDepthValue;
  231. depthStencilAttachment.depthLoadOp = GPULoadOp.Clear;
  232. depthStencilAttachment.depthStoreOp = GPUStoreOp.Store;
  233. } else {
  234. depthStencilAttachment.depthLoadOp = GPULoadOp.Load;
  235. depthStencilAttachment.depthStoreOp = GPUStoreOp.Store;
  236. }
  237. }
  238. if ( renderContext.stencil ) {
  239. if ( renderContext.clearStencil ) {
  240. depthStencilAttachment.stencilClearValue = renderContext.clearStencilValue;
  241. depthStencilAttachment.stencilLoadOp = GPULoadOp.Clear;
  242. depthStencilAttachment.stencilStoreOp = GPUStoreOp.Store;
  243. } else {
  244. depthStencilAttachment.stencilLoadOp = GPULoadOp.Load;
  245. depthStencilAttachment.stencilStoreOp = GPUStoreOp.Store;
  246. }
  247. }
  248. //
  249. const encoder = device.createCommandEncoder( { label: 'renderContext_' + renderContext.id } );
  250. const currentPass = encoder.beginRenderPass( descriptor );
  251. //
  252. renderContextData.descriptor = descriptor;
  253. renderContextData.encoder = encoder;
  254. renderContextData.currentPass = currentPass;
  255. renderContextData.currentSets = { attributes: {} };
  256. //
  257. if ( renderContext.viewport ) {
  258. this.updateViewport( renderContext );
  259. }
  260. if ( renderContext.scissor ) {
  261. const { x, y, width, height } = renderContext.scissorValue;
  262. currentPass.setScissorRect( x, renderContext.height - height - y, width, height );
  263. }
  264. }
  265. finishRender( renderContext ) {
  266. const renderContextData = this.get( renderContext );
  267. const occlusionQueryCount = renderContext.occlusionQueryCount;
  268. if ( occlusionQueryCount > renderContextData.occlusionQueryIndex ) {
  269. renderContextData.currentPass.endOcclusionQuery();
  270. }
  271. renderContextData.currentPass.end();
  272. if ( occlusionQueryCount > 0 ) {
  273. const bufferSize = occlusionQueryCount * 8; // 8 byte entries for query results
  274. //
  275. let queryResolveBuffer = this.occludedResolveCache.get( bufferSize );
  276. if ( queryResolveBuffer === undefined ) {
  277. queryResolveBuffer = this.device.createBuffer(
  278. {
  279. size: bufferSize,
  280. usage: GPUBufferUsage.QUERY_RESOLVE | GPUBufferUsage.COPY_SRC
  281. }
  282. );
  283. this.occludedResolveCache.set( bufferSize, queryResolveBuffer );
  284. }
  285. //
  286. const readBuffer = this.device.createBuffer(
  287. {
  288. size: bufferSize,
  289. usage: GPUBufferUsage.COPY_DST | GPUBufferUsage.MAP_READ
  290. }
  291. );
  292. // two buffers required here - WebGPU doesn't allow usage of QUERY_RESOLVE & MAP_READ to be combined
  293. renderContextData.encoder.resolveQuerySet( renderContextData.occlusionQuerySet, 0, occlusionQueryCount, queryResolveBuffer, 0 );
  294. renderContextData.encoder.copyBufferToBuffer( queryResolveBuffer, 0, readBuffer, 0, bufferSize );
  295. renderContextData.occlusionQueryBuffer = readBuffer;
  296. //
  297. this.resolveOccludedAsync( renderContext );
  298. }
  299. this.prepareTimestampBuffer( renderContext, renderContextData.encoder );
  300. this.device.queue.submit( [ renderContextData.encoder.finish() ] );
  301. //
  302. if ( renderContext.textures !== null ) {
  303. const textures = renderContext.textures;
  304. for ( let i = 0; i < textures.length; i ++ ) {
  305. const texture = textures[ i ];
  306. if ( texture.generateMipmaps === true ) {
  307. this.textureUtils.generateMipmaps( texture );
  308. }
  309. }
  310. }
  311. }
  312. isOccluded( renderContext, object ) {
  313. const renderContextData = this.get( renderContext );
  314. return renderContextData.occluded && renderContextData.occluded.has( object );
  315. }
  316. async resolveOccludedAsync( renderContext ) {
  317. const renderContextData = this.get( renderContext );
  318. // handle occlusion query results
  319. const { currentOcclusionQueryBuffer, currentOcclusionQueryObjects } = renderContextData;
  320. if ( currentOcclusionQueryBuffer && currentOcclusionQueryObjects ) {
  321. const occluded = new WeakSet();
  322. renderContextData.currentOcclusionQueryObjects = null;
  323. renderContextData.currentOcclusionQueryBuffer = null;
  324. await currentOcclusionQueryBuffer.mapAsync( GPUMapMode.READ );
  325. const buffer = currentOcclusionQueryBuffer.getMappedRange();
  326. const results = new BigUint64Array( buffer );
  327. for ( let i = 0; i < currentOcclusionQueryObjects.length; i ++ ) {
  328. if ( results[ i ] !== 0n ) {
  329. occluded.add( currentOcclusionQueryObjects[ i ] );
  330. }
  331. }
  332. currentOcclusionQueryBuffer.destroy();
  333. renderContextData.occluded = occluded;
  334. }
  335. }
  336. updateViewport( renderContext ) {
  337. const { currentPass } = this.get( renderContext );
  338. const { x, y, width, height, minDepth, maxDepth } = renderContext.viewportValue;
  339. currentPass.setViewport( x, renderContext.height - height - y, width, height, minDepth, maxDepth );
  340. }
  341. clear( color, depth, stencil, renderTargetData = null ) {
  342. const device = this.device;
  343. const renderer = this.renderer;
  344. let colorAttachments = [];
  345. let depthStencilAttachment;
  346. let clearValue;
  347. let supportsDepth;
  348. let supportsStencil;
  349. if ( color ) {
  350. const clearColor = this.getClearColor();
  351. clearValue = { r: clearColor.r, g: clearColor.g, b: clearColor.b, a: clearColor.a };
  352. }
  353. if ( renderTargetData === null ) {
  354. supportsDepth = renderer.depth;
  355. supportsStencil = renderer.stencil;
  356. const descriptor = this._getDefaultRenderPassDescriptor();
  357. if ( color ) {
  358. colorAttachments = descriptor.colorAttachments;
  359. const colorAttachment = colorAttachments[ 0 ];
  360. colorAttachment.clearValue = clearValue;
  361. colorAttachment.loadOp = GPULoadOp.Clear;
  362. colorAttachment.storeOp = GPUStoreOp.Store;
  363. }
  364. if ( supportsDepth || supportsStencil ) {
  365. depthStencilAttachment = descriptor.depthStencilAttachment;
  366. }
  367. } else {
  368. supportsDepth = renderTargetData.depth;
  369. supportsStencil = renderTargetData.stencil;
  370. if ( color ) {
  371. for ( const texture of renderTargetData.textures ) {
  372. const textureData = this.get( texture );
  373. const textureView = textureData.texture.createView();
  374. let view, resolveTarget;
  375. if ( textureData.msaaTexture !== undefined ) {
  376. view = textureData.msaaTexture.createView();
  377. resolveTarget = textureView;
  378. } else {
  379. view = textureView;
  380. resolveTarget = undefined;
  381. }
  382. colorAttachments.push( {
  383. view,
  384. resolveTarget,
  385. clearValue,
  386. loadOp: GPULoadOp.Clear,
  387. storeOp: GPUStoreOp.Store
  388. } );
  389. }
  390. }
  391. if ( supportsDepth || supportsStencil ) {
  392. const depthTextureData = this.get( renderTargetData.depthTexture );
  393. depthStencilAttachment = {
  394. view: depthTextureData.texture.createView()
  395. };
  396. }
  397. }
  398. //
  399. if ( supportsDepth ) {
  400. if ( depth ) {
  401. depthStencilAttachment.depthLoadOp = GPULoadOp.Clear;
  402. depthStencilAttachment.depthClearValue = renderer.getClearDepth();
  403. depthStencilAttachment.depthStoreOp = GPUStoreOp.Store;
  404. } else {
  405. depthStencilAttachment.depthLoadOp = GPULoadOp.Load;
  406. depthStencilAttachment.depthStoreOp = GPUStoreOp.Store;
  407. }
  408. }
  409. //
  410. if ( supportsStencil ) {
  411. if ( stencil ) {
  412. depthStencilAttachment.stencilLoadOp = GPULoadOp.Clear;
  413. depthStencilAttachment.stencilClearValue = renderer.getClearStencil();
  414. depthStencilAttachment.stencilStoreOp = GPUStoreOp.Store;
  415. } else {
  416. depthStencilAttachment.stencilLoadOp = GPULoadOp.Load;
  417. depthStencilAttachment.stencilStoreOp = GPUStoreOp.Store;
  418. }
  419. }
  420. //
  421. const encoder = device.createCommandEncoder( {} );
  422. const currentPass = encoder.beginRenderPass( {
  423. colorAttachments,
  424. depthStencilAttachment
  425. } );
  426. currentPass.end();
  427. device.queue.submit( [ encoder.finish() ] );
  428. }
  429. // compute
  430. beginCompute( computeGroup ) {
  431. const groupGPU = this.get( computeGroup );
  432. const descriptor = {};
  433. this.initTimestampQuery( computeGroup, descriptor );
  434. groupGPU.cmdEncoderGPU = this.device.createCommandEncoder();
  435. groupGPU.passEncoderGPU = groupGPU.cmdEncoderGPU.beginComputePass( descriptor );
  436. }
  437. compute( computeGroup, computeNode, bindings, pipeline ) {
  438. const { passEncoderGPU } = this.get( computeGroup );
  439. // pipeline
  440. const pipelineGPU = this.get( pipeline ).pipeline;
  441. passEncoderGPU.setPipeline( pipelineGPU );
  442. // bind group
  443. const bindGroupGPU = this.get( bindings ).group;
  444. passEncoderGPU.setBindGroup( 0, bindGroupGPU );
  445. passEncoderGPU.dispatchWorkgroups( computeNode.dispatchCount );
  446. }
  447. finishCompute( computeGroup ) {
  448. const groupData = this.get( computeGroup );
  449. groupData.passEncoderGPU.end();
  450. this.prepareTimestampBuffer( computeGroup, groupData.cmdEncoderGPU );
  451. this.device.queue.submit( [ groupData.cmdEncoderGPU.finish() ] );
  452. }
  453. // render object
  454. draw( renderObject, info ) {
  455. const { object, geometry, context, pipeline } = renderObject;
  456. const bindingsData = this.get( renderObject.getBindings() );
  457. const contextData = this.get( context );
  458. const pipelineGPU = this.get( pipeline ).pipeline;
  459. const currentSets = contextData.currentSets;
  460. // pipeline
  461. const passEncoderGPU = contextData.currentPass;
  462. if ( currentSets.pipeline !== pipelineGPU ) {
  463. passEncoderGPU.setPipeline( pipelineGPU );
  464. currentSets.pipeline = pipelineGPU;
  465. }
  466. // bind group
  467. const bindGroupGPU = bindingsData.group;
  468. passEncoderGPU.setBindGroup( 0, bindGroupGPU );
  469. // attributes
  470. const index = renderObject.getIndex();
  471. const hasIndex = ( index !== null );
  472. // index
  473. if ( hasIndex === true ) {
  474. if ( currentSets.index !== index ) {
  475. const buffer = this.get( index ).buffer;
  476. const indexFormat = ( index.array instanceof Uint16Array ) ? GPUIndexFormat.Uint16 : GPUIndexFormat.Uint32;
  477. passEncoderGPU.setIndexBuffer( buffer, indexFormat );
  478. currentSets.index = index;
  479. }
  480. }
  481. // vertex buffers
  482. const vertexBuffers = renderObject.getVertexBuffers();
  483. for ( let i = 0, l = vertexBuffers.length; i < l; i ++ ) {
  484. const vertexBuffer = vertexBuffers[ i ];
  485. if ( currentSets.attributes[ i ] !== vertexBuffer ) {
  486. const buffer = this.get( vertexBuffer ).buffer;
  487. passEncoderGPU.setVertexBuffer( i, buffer );
  488. currentSets.attributes[ i ] = vertexBuffer;
  489. }
  490. }
  491. // occlusion queries - handle multiple consecutive draw calls for an object
  492. if ( contextData.occlusionQuerySet !== undefined ) {
  493. const lastObject = contextData.lastOcclusionObject;
  494. if ( lastObject !== object ) {
  495. if ( lastObject !== null && lastObject.occlusionTest === true ) {
  496. passEncoderGPU.endOcclusionQuery();
  497. contextData.occlusionQueryIndex ++;
  498. }
  499. if ( object.occlusionTest === true ) {
  500. passEncoderGPU.beginOcclusionQuery( contextData.occlusionQueryIndex );
  501. contextData.occlusionQueryObjects[ contextData.occlusionQueryIndex ] = object;
  502. }
  503. contextData.lastOcclusionObject = object;
  504. }
  505. }
  506. // draw
  507. const drawRange = renderObject.drawRange;
  508. const firstVertex = drawRange.start;
  509. const instanceCount = this.getInstanceCount( renderObject );
  510. if ( instanceCount === 0 ) return;
  511. if ( hasIndex === true ) {
  512. const indexCount = ( drawRange.count !== Infinity ) ? drawRange.count : index.count;
  513. passEncoderGPU.drawIndexed( indexCount, instanceCount, firstVertex, 0, 0 );
  514. info.update( object, indexCount, instanceCount );
  515. } else {
  516. const positionAttribute = geometry.attributes.position;
  517. const vertexCount = ( drawRange.count !== Infinity ) ? drawRange.count : positionAttribute.count;
  518. passEncoderGPU.draw( vertexCount, instanceCount, firstVertex, 0 );
  519. info.update( object, vertexCount, instanceCount );
  520. }
  521. }
  522. // cache key
  523. needsRenderUpdate( renderObject ) {
  524. const data = this.get( renderObject );
  525. const { object, material } = renderObject;
  526. const utils = this.utils;
  527. const sampleCount = utils.getSampleCount( renderObject.context );
  528. const colorSpace = utils.getCurrentColorSpace( renderObject.context );
  529. const colorFormat = utils.getCurrentColorFormat( renderObject.context );
  530. const depthStencilFormat = utils.getCurrentDepthStencilFormat( renderObject.context );
  531. const primitiveTopology = utils.getPrimitiveTopology( object, material );
  532. let needsUpdate = false;
  533. if ( data.material !== material || data.materialVersion !== material.version ||
  534. data.transparent !== material.transparent || data.blending !== material.blending || data.premultipliedAlpha !== material.premultipliedAlpha ||
  535. data.blendSrc !== material.blendSrc || data.blendDst !== material.blendDst || data.blendEquation !== material.blendEquation ||
  536. data.blendSrcAlpha !== material.blendSrcAlpha || data.blendDstAlpha !== material.blendDstAlpha || data.blendEquationAlpha !== material.blendEquationAlpha ||
  537. data.colorWrite !== material.colorWrite || data.depthWrite !== material.depthWrite || data.depthTest !== material.depthTest || data.depthFunc !== material.depthFunc ||
  538. data.stencilWrite !== material.stencilWrite || data.stencilFunc !== material.stencilFunc ||
  539. data.stencilFail !== material.stencilFail || data.stencilZFail !== material.stencilZFail || data.stencilZPass !== material.stencilZPass ||
  540. data.stencilFuncMask !== material.stencilFuncMask || data.stencilWriteMask !== material.stencilWriteMask ||
  541. data.side !== material.side || data.alphaToCoverage !== material.alphaToCoverage ||
  542. data.sampleCount !== sampleCount || data.colorSpace !== colorSpace ||
  543. data.colorFormat !== colorFormat || data.depthStencilFormat !== depthStencilFormat ||
  544. data.primitiveTopology !== primitiveTopology ||
  545. data.clippingContextVersion !== renderObject.clippingContextVersion
  546. ) {
  547. data.material = material; data.materialVersion = material.version;
  548. data.transparent = material.transparent; data.blending = material.blending; data.premultipliedAlpha = material.premultipliedAlpha;
  549. data.blendSrc = material.blendSrc; data.blendDst = material.blendDst; data.blendEquation = material.blendEquation;
  550. data.blendSrcAlpha = material.blendSrcAlpha; data.blendDstAlpha = material.blendDstAlpha; data.blendEquationAlpha = material.blendEquationAlpha;
  551. data.colorWrite = material.colorWrite;
  552. data.depthWrite = material.depthWrite; data.depthTest = material.depthTest; data.depthFunc = material.depthFunc;
  553. data.stencilWrite = material.stencilWrite; data.stencilFunc = material.stencilFunc;
  554. data.stencilFail = material.stencilFail; data.stencilZFail = material.stencilZFail; data.stencilZPass = material.stencilZPass;
  555. data.stencilFuncMask = material.stencilFuncMask; data.stencilWriteMask = material.stencilWriteMask;
  556. data.side = material.side; data.alphaToCoverage = material.alphaToCoverage;
  557. data.sampleCount = sampleCount;
  558. data.colorSpace = colorSpace;
  559. data.colorFormat = colorFormat;
  560. data.depthStencilFormat = depthStencilFormat;
  561. data.primitiveTopology = primitiveTopology;
  562. data.clippingContextVersion = renderObject.clippingContextVersion;
  563. needsUpdate = true;
  564. }
  565. return needsUpdate;
  566. }
  567. getRenderCacheKey( renderObject ) {
  568. const { object, material } = renderObject;
  569. const utils = this.utils;
  570. const renderContext = renderObject.context;
  571. return [
  572. material.transparent, material.blending, material.premultipliedAlpha,
  573. material.blendSrc, material.blendDst, material.blendEquation,
  574. material.blendSrcAlpha, material.blendDstAlpha, material.blendEquationAlpha,
  575. material.colorWrite,
  576. material.depthWrite, material.depthTest, material.depthFunc,
  577. material.stencilWrite, material.stencilFunc,
  578. material.stencilFail, material.stencilZFail, material.stencilZPass,
  579. material.stencilFuncMask, material.stencilWriteMask,
  580. material.side,
  581. utils.getSampleCount( renderContext ),
  582. utils.getCurrentColorSpace( renderContext ), utils.getCurrentColorFormat( renderContext ), utils.getCurrentDepthStencilFormat( renderContext ),
  583. utils.getPrimitiveTopology( object, material ),
  584. renderObject.clippingContextVersion
  585. ].join();
  586. }
  587. // textures
  588. createSampler( texture ) {
  589. this.textureUtils.createSampler( texture );
  590. }
  591. destroySampler( texture ) {
  592. this.textureUtils.destroySampler( texture );
  593. }
  594. createDefaultTexture( texture ) {
  595. this.textureUtils.createDefaultTexture( texture );
  596. }
  597. createTexture( texture, options ) {
  598. this.textureUtils.createTexture( texture, options );
  599. }
  600. updateTexture( texture, options ) {
  601. this.textureUtils.updateTexture( texture, options );
  602. }
  603. generateMipmaps( texture ) {
  604. this.textureUtils.generateMipmaps( texture );
  605. }
  606. destroyTexture( texture ) {
  607. this.textureUtils.destroyTexture( texture );
  608. }
  609. copyTextureToBuffer( texture, x, y, width, height ) {
  610. return this.textureUtils.copyTextureToBuffer( texture, x, y, width, height );
  611. }
  612. initTimestampQuery( renderContext, descriptor ) {
  613. if ( ! this.hasFeature( GPUFeatureName.TimestampQuery ) || ! this.trackTimestamp ) return;
  614. const renderContextData = this.get( renderContext );
  615. if ( ! renderContextData.timeStampQuerySet ) {
  616. // Create a GPUQuerySet which holds 2 timestamp query results: one for the
  617. // beginning and one for the end of compute pass execution.
  618. const timeStampQuerySet = this.device.createQuerySet( { type: 'timestamp', count: 2 } );
  619. const timestampWrites = {
  620. querySet: timeStampQuerySet,
  621. beginningOfPassWriteIndex: 0, // Write timestamp in index 0 when pass begins.
  622. endOfPassWriteIndex: 1, // Write timestamp in index 1 when pass ends.
  623. };
  624. Object.assign( descriptor, {
  625. timestampWrites,
  626. } );
  627. renderContextData.timeStampQuerySet = timeStampQuerySet;
  628. }
  629. }
  630. // timestamp utils
  631. prepareTimestampBuffer( renderContext, encoder ) {
  632. if ( ! this.hasFeature( GPUFeatureName.TimestampQuery ) || ! this.trackTimestamp ) return;
  633. const renderContextData = this.get( renderContext );
  634. const size = 2 * BigInt64Array.BYTES_PER_ELEMENT;
  635. const resolveBuffer = this.device.createBuffer( {
  636. size,
  637. usage: GPUBufferUsage.QUERY_RESOLVE | GPUBufferUsage.COPY_SRC,
  638. } );
  639. const resultBuffer = this.device.createBuffer( {
  640. size,
  641. usage: GPUBufferUsage.COPY_DST | GPUBufferUsage.MAP_READ,
  642. } );
  643. encoder.resolveQuerySet( renderContextData.timeStampQuerySet, 0, 2, resolveBuffer, 0 );
  644. encoder.copyBufferToBuffer( resolveBuffer, 0, resultBuffer, 0, size );
  645. renderContextData.currentTimestampQueryBuffer = resultBuffer;
  646. }
  647. async resolveTimestampAsync(renderContext, type = 'render') {
  648. if (!this.hasFeature(GPUFeatureName.TimestampQuery) || !this.trackTimestamp) return;
  649. const renderContextData = this.get(renderContext);
  650. const { currentTimestampQueryBuffer } = renderContextData;
  651. if (currentTimestampQueryBuffer === undefined) return;
  652. const buffer = currentTimestampQueryBuffer;
  653. try {
  654. await buffer.mapAsync(GPUMapMode.READ);
  655. const times = new BigUint64Array(buffer.getMappedRange());
  656. const duration = Number(times[1] - times[0]) / 1000000;
  657. this.renderer.info.updateTimestamp(type, duration);
  658. } catch (error) {
  659. console.error(`Error mapping buffer: ${error}`);
  660. // Optionally handle the error, e.g., re-queue the buffer or skip it
  661. } finally {
  662. buffer.unmap();
  663. }
  664. }
  665. // node builder
  666. createNodeBuilder( object, renderer, scene = null ) {
  667. return new WGSLNodeBuilder( object, renderer, scene );
  668. }
  669. // program
  670. createProgram( program ) {
  671. const programGPU = this.get( program );
  672. programGPU.module = {
  673. module: this.device.createShaderModule( { code: program.code, label: program.stage } ),
  674. entryPoint: 'main'
  675. };
  676. }
  677. destroyProgram( program ) {
  678. this.delete( program );
  679. }
  680. // pipelines
  681. createRenderPipeline( renderObject, promises ) {
  682. this.pipelineUtils.createRenderPipeline( renderObject, promises );
  683. }
  684. createComputePipeline( computePipeline, bindings ) {
  685. this.pipelineUtils.createComputePipeline( computePipeline, bindings );
  686. }
  687. // bindings
  688. createBindings( bindings ) {
  689. this.bindingUtils.createBindings( bindings );
  690. }
  691. updateBindings( bindings ) {
  692. this.bindingUtils.createBindings( bindings );
  693. }
  694. updateBinding( binding ) {
  695. this.bindingUtils.updateBinding( binding );
  696. }
  697. // attributes
  698. createIndexAttribute( attribute ) {
  699. this.attributeUtils.createAttribute( attribute, GPUBufferUsage.INDEX | GPUBufferUsage.COPY_SRC | GPUBufferUsage.COPY_DST );
  700. }
  701. createAttribute( attribute ) {
  702. this.attributeUtils.createAttribute( attribute, GPUBufferUsage.VERTEX | GPUBufferUsage.COPY_SRC | GPUBufferUsage.COPY_DST );
  703. }
  704. createStorageAttribute( attribute ) {
  705. this.attributeUtils.createAttribute( attribute, GPUBufferUsage.STORAGE | GPUBufferUsage.VERTEX | GPUBufferUsage.COPY_SRC | GPUBufferUsage.COPY_DST );
  706. }
  707. updateAttribute( attribute ) {
  708. this.attributeUtils.updateAttribute( attribute );
  709. }
  710. destroyAttribute( attribute ) {
  711. this.attributeUtils.destroyAttribute( attribute );
  712. }
  713. // canvas
  714. updateSize() {
  715. this.colorBuffer = this.textureUtils.getColorBuffer();
  716. this.defaultRenderPassdescriptor = null;
  717. }
  718. // utils public
  719. getMaxAnisotropy() {
  720. return 16;
  721. }
  722. async hasFeatureAsync( name ) {
  723. const adapter = this.adapter || await WebGPU.getStaticAdapter();
  724. //
  725. return adapter.features.has( name );
  726. }
  727. hasFeature( name ) {
  728. if ( ! this.adapter ) {
  729. console.warn( 'WebGPUBackend: WebGPU adapter has not been initialized yet. Please use hasFeatureAsync instead' );
  730. return false;
  731. }
  732. return this.adapter.features.has( name );
  733. }
  734. copyTextureToTexture( position, srcTexture, dstTexture, level = 0 ) {
  735. const encoder = this.device.createCommandEncoder( { label: 'copyTextureToTexture_' + srcTexture.id + '_' + dstTexture.id } );
  736. const sourceGPU = this.get( srcTexture ).texture;
  737. const destinationGPU = this.get( dstTexture ).texture;
  738. encoder.copyTextureToTexture(
  739. {
  740. texture: sourceGPU,
  741. mipLevel: level,
  742. origin: { x: 0, y: 0, z: 0 }
  743. },
  744. {
  745. texture: destinationGPU,
  746. mipLevel: level,
  747. origin: { x: position.x, y: position.y, z: position.z }
  748. },
  749. [
  750. srcTexture.image.width,
  751. srcTexture.image.height
  752. ]
  753. );
  754. this.device.queue.submit( [ encoder.finish() ] );
  755. }
  756. copyFramebufferToTexture( texture, renderContext ) {
  757. const renderContextData = this.get( renderContext );
  758. const { encoder, descriptor } = renderContextData;
  759. let sourceGPU = null;
  760. if ( renderContext.renderTarget ) {
  761. if ( texture.isDepthTexture ) {
  762. sourceGPU = this.get( renderContext.depthTexture ).texture;
  763. } else {
  764. sourceGPU = this.get( renderContext.textures[ 0 ] ).texture;
  765. }
  766. } else {
  767. if ( texture.isDepthTexture ) {
  768. sourceGPU = this.textureUtils.getDepthBuffer( renderContext.depth, renderContext.stencil );
  769. } else {
  770. sourceGPU = this.context.getCurrentTexture();
  771. }
  772. }
  773. const destinationGPU = this.get( texture ).texture;
  774. if ( sourceGPU.format !== destinationGPU.format ) {
  775. console.error( 'WebGPUBackend: copyFramebufferToTexture: Source and destination formats do not match.', sourceGPU.format, destinationGPU.format );
  776. return;
  777. }
  778. renderContextData.currentPass.end();
  779. encoder.copyTextureToTexture(
  780. {
  781. texture: sourceGPU,
  782. origin: { x: 0, y: 0, z: 0 }
  783. },
  784. {
  785. texture: destinationGPU
  786. },
  787. [
  788. texture.image.width,
  789. texture.image.height
  790. ]
  791. );
  792. if ( texture.generateMipmaps ) this.textureUtils.generateMipmaps( texture );
  793. descriptor.colorAttachments[ 0 ].loadOp = GPULoadOp.Load;
  794. if ( renderContext.depth ) descriptor.depthStencilAttachment.depthLoadOp = GPULoadOp.Load;
  795. if ( renderContext.stencil ) descriptor.depthStencilAttachment.stencilLoadOp = GPULoadOp.Load;
  796. renderContextData.currentPass = encoder.beginRenderPass( descriptor );
  797. renderContextData.currentSets = { attributes: {} };
  798. }
  799. }
  800. export default WebGPUBackend;