📄 WebGPUUtils.js¶
📊 Analysis Summary¶
| Metric | Count |
|---|---|
| 🔧 Functions | 9 |
| 🧱 Classes | 1 |
| 📦 Imports | 4 |
| 📊 Variables & Constants | 7 |
📚 Table of Contents¶
🛠️ File Location:¶
📂 src/renderers/webgpu/utils/WebGPUUtils.js
📦 Imports¶
| Name | Source |
|---|---|
HalfFloatType |
../../../constants.js |
UnsignedByteType |
../../../constants.js |
GPUPrimitiveTopology |
./WebGPUConstants.js |
GPUTextureFormat |
./WebGPUConstants.js |
Variables & Constants¶
| Name | Type | Kind | Value | Exported |
|---|---|---|---|---|
format |
any |
let/var | *not shown* |
✗ |
samples |
any |
let/var | *not shown* |
✗ |
renderer |
any |
let/var | this.backend.renderer |
✗ |
isMSAA |
boolean |
let/var | samples > 1 && texture.renderTarget !== null && ( texture.isDepthTexture !== ... |
✗ |
primarySamples |
any |
let/var | isMSAA ? 1 : samples |
✗ |
format |
any |
let/var | *not shown* |
✗ |
outputType |
any |
let/var | this.backend.parameters.outputType |
✗ |
Functions¶
WebGPUUtils.getCurrentDepthStencilFormat(renderContext: RenderContext): string¶
JSDoc:
/**
* Returns the depth/stencil GPU format for the given render context.
*
* @param {RenderContext} renderContext - The render context.
* @return {string} The depth/stencil GPU texture format.
*/
Parameters:
renderContextRenderContext
Returns: string
Calls:
this.getTextureFormatGPU
Code
getCurrentDepthStencilFormat( renderContext ) {
let format;
if ( renderContext.depthTexture !== null ) {
format = this.getTextureFormatGPU( renderContext.depthTexture );
} else if ( renderContext.depth && renderContext.stencil ) {
format = GPUTextureFormat.Depth24PlusStencil8;
} else if ( renderContext.depth ) {
format = GPUTextureFormat.Depth24Plus;
}
return format;
}
WebGPUUtils.getTextureFormatGPU(texture: Texture): string¶
JSDoc:
/**
* Returns the GPU format for the given texture.
*
* @param {Texture} texture - The texture.
* @return {string} The GPU texture format.
*/
Parameters:
textureTexture
Returns: string
Calls:
this.backend.get
WebGPUUtils.getTextureSampleData(texture: Texture): any¶
JSDoc:
/**
* Returns an object that defines the multi-sampling state of the given texture.
*
* @param {Texture} texture - The texture.
* @return {Object} The multi-sampling state.
*/
Parameters:
textureTexture
Returns: any
Calls:
renderer.getRenderTarget
Code
getTextureSampleData( texture ) {
let samples;
if ( texture.isFramebufferTexture ) {
samples = 1;
} else if ( texture.isDepthTexture && ! texture.renderTarget ) {
const renderer = this.backend.renderer;
const renderTarget = renderer.getRenderTarget();
samples = renderTarget ? renderTarget.samples : renderer.samples;
} else if ( texture.renderTarget ) {
samples = texture.renderTarget.samples;
}
samples = samples || 1;
const isMSAA = samples > 1 && texture.renderTarget !== null && ( texture.isDepthTexture !== true && texture.isFramebufferTexture !== true );
const primarySamples = isMSAA ? 1 : samples;
return { samples, primarySamples, isMSAA };
}
WebGPUUtils.getCurrentColorFormat(renderContext: RenderContext): string¶
JSDoc:
/**
* Returns the default color attachment's GPU format of the current render context.
*
* @param {RenderContext} renderContext - The render context.
* @return {string} The GPU texture format of the default color attachment.
*/
Parameters:
renderContextRenderContext
Returns: string
Calls:
this.getTextureFormatGPUthis.getPreferredCanvasFormat
Code
WebGPUUtils.getCurrentColorSpace(renderContext: RenderContext): string¶
JSDoc:
/**
* Returns the output color space of the current render context.
*
* @param {RenderContext} renderContext - The render context.
* @return {string} The output color space.
*/
Parameters:
renderContextRenderContext
Returns: string
Code
WebGPUUtils.getPrimitiveTopology(object: Object3D, material: Material): string¶
JSDoc:
/**
* Returns GPU primitive topology for the given object and material.
*
* @param {Object3D} object - The 3D object.
* @param {Material} material - The material.
* @return {string} The GPU primitive topology.
*/
Parameters:
objectObject3DmaterialMaterial
Returns: string
Code
getPrimitiveTopology( object, material ) {
if ( object.isPoints ) return GPUPrimitiveTopology.PointList;
else if ( object.isLineSegments || ( object.isMesh && material.wireframe === true ) ) return GPUPrimitiveTopology.LineList;
else if ( object.isLine ) return GPUPrimitiveTopology.LineStrip;
else if ( object.isMesh ) return GPUPrimitiveTopology.TriangleList;
}
WebGPUUtils.getSampleCount(sampleCount: number): number¶
JSDoc:
/**
* Returns a modified sample count from the given sample count value.
*
* That is required since WebGPU only supports either 1 or 4.
*
* @param {number} sampleCount - The input sample count.
* @return {number} The (potentially updated) output sample count.
*/
Parameters:
sampleCountnumber
Returns: number
WebGPUUtils.getSampleCountRenderContext(renderContext: RenderContext): number¶
JSDoc:
/**
* Returns the sample count of the given render context.
*
* @param {RenderContext} renderContext - The render context.
* @return {number} The sample count.
*/
Parameters:
renderContextRenderContext
Returns: number
Calls:
this.getSampleCount
Code
WebGPUUtils.getPreferredCanvasFormat(): string¶
JSDoc:
/**
* Returns the preferred canvas format.
*
* There is a separate method for this so it's possible to
* honor edge cases for specific devices.
*
* @return {string} The GPU texture format of the canvas.
*/
Returns: string
Calls:
navigator.gpu.getPreferredCanvasFormat
Code
getPreferredCanvasFormat() {
const outputType = this.backend.parameters.outputType;
if ( outputType === undefined ) {
return navigator.gpu.getPreferredCanvasFormat();
} else if ( outputType === UnsignedByteType ) {
return GPUTextureFormat.BGRA8Unorm;
} else if ( outputType === HalfFloatType ) {
return GPUTextureFormat.RGBA16Float;
} else {
throw new Error( 'Unsupported outputType' );
}
}
Classes¶
WebGPUUtils¶
Class Code
class WebGPUUtils {
/**
* Constructs a new utility object.
*
* @param {WebGPUBackend} backend - The WebGPU backend.
*/
constructor( backend ) {
/**
* A reference to the WebGPU backend.
*
* @type {WebGPUBackend}
*/
this.backend = backend;
}
/**
* Returns the depth/stencil GPU format for the given render context.
*
* @param {RenderContext} renderContext - The render context.
* @return {string} The depth/stencil GPU texture format.
*/
getCurrentDepthStencilFormat( renderContext ) {
let format;
if ( renderContext.depthTexture !== null ) {
format = this.getTextureFormatGPU( renderContext.depthTexture );
} else if ( renderContext.depth && renderContext.stencil ) {
format = GPUTextureFormat.Depth24PlusStencil8;
} else if ( renderContext.depth ) {
format = GPUTextureFormat.Depth24Plus;
}
return format;
}
/**
* Returns the GPU format for the given texture.
*
* @param {Texture} texture - The texture.
* @return {string} The GPU texture format.
*/
getTextureFormatGPU( texture ) {
return this.backend.get( texture ).format;
}
/**
* Returns an object that defines the multi-sampling state of the given texture.
*
* @param {Texture} texture - The texture.
* @return {Object} The multi-sampling state.
*/
getTextureSampleData( texture ) {
let samples;
if ( texture.isFramebufferTexture ) {
samples = 1;
} else if ( texture.isDepthTexture && ! texture.renderTarget ) {
const renderer = this.backend.renderer;
const renderTarget = renderer.getRenderTarget();
samples = renderTarget ? renderTarget.samples : renderer.samples;
} else if ( texture.renderTarget ) {
samples = texture.renderTarget.samples;
}
samples = samples || 1;
const isMSAA = samples > 1 && texture.renderTarget !== null && ( texture.isDepthTexture !== true && texture.isFramebufferTexture !== true );
const primarySamples = isMSAA ? 1 : samples;
return { samples, primarySamples, isMSAA };
}
/**
* Returns the default color attachment's GPU format of the current render context.
*
* @param {RenderContext} renderContext - The render context.
* @return {string} The GPU texture format of the default color attachment.
*/
getCurrentColorFormat( renderContext ) {
let format;
if ( renderContext.textures !== null ) {
format = this.getTextureFormatGPU( renderContext.textures[ 0 ] );
} else {
format = this.getPreferredCanvasFormat(); // default context format
}
return format;
}
/**
* Returns the output color space of the current render context.
*
* @param {RenderContext} renderContext - The render context.
* @return {string} The output color space.
*/
getCurrentColorSpace( renderContext ) {
if ( renderContext.textures !== null ) {
return renderContext.textures[ 0 ].colorSpace;
}
return this.backend.renderer.outputColorSpace;
}
/**
* Returns GPU primitive topology for the given object and material.
*
* @param {Object3D} object - The 3D object.
* @param {Material} material - The material.
* @return {string} The GPU primitive topology.
*/
getPrimitiveTopology( object, material ) {
if ( object.isPoints ) return GPUPrimitiveTopology.PointList;
else if ( object.isLineSegments || ( object.isMesh && material.wireframe === true ) ) return GPUPrimitiveTopology.LineList;
else if ( object.isLine ) return GPUPrimitiveTopology.LineStrip;
else if ( object.isMesh ) return GPUPrimitiveTopology.TriangleList;
}
/**
* Returns a modified sample count from the given sample count value.
*
* That is required since WebGPU only supports either 1 or 4.
*
* @param {number} sampleCount - The input sample count.
* @return {number} The (potentially updated) output sample count.
*/
getSampleCount( sampleCount ) {
return sampleCount >= 4 ? 4 : 1;
}
/**
* Returns the sample count of the given render context.
*
* @param {RenderContext} renderContext - The render context.
* @return {number} The sample count.
*/
getSampleCountRenderContext( renderContext ) {
if ( renderContext.textures !== null ) {
return this.getSampleCount( renderContext.sampleCount );
}
return this.getSampleCount( this.backend.renderer.samples );
}
/**
* Returns the preferred canvas format.
*
* There is a separate method for this so it's possible to
* honor edge cases for specific devices.
*
* @return {string} The GPU texture format of the canvas.
*/
getPreferredCanvasFormat() {
const outputType = this.backend.parameters.outputType;
if ( outputType === undefined ) {
return navigator.gpu.getPreferredCanvasFormat();
} else if ( outputType === UnsignedByteType ) {
return GPUTextureFormat.BGRA8Unorm;
} else if ( outputType === HalfFloatType ) {
return GPUTextureFormat.RGBA16Float;
} else {
throw new Error( 'Unsupported outputType' );
}
}
}
Methods¶
getCurrentDepthStencilFormat(renderContext: RenderContext): string¶
Code
getCurrentDepthStencilFormat( renderContext ) {
let format;
if ( renderContext.depthTexture !== null ) {
format = this.getTextureFormatGPU( renderContext.depthTexture );
} else if ( renderContext.depth && renderContext.stencil ) {
format = GPUTextureFormat.Depth24PlusStencil8;
} else if ( renderContext.depth ) {
format = GPUTextureFormat.Depth24Plus;
}
return format;
}
getTextureFormatGPU(texture: Texture): string¶
getTextureSampleData(texture: Texture): any¶
Code
getTextureSampleData( texture ) {
let samples;
if ( texture.isFramebufferTexture ) {
samples = 1;
} else if ( texture.isDepthTexture && ! texture.renderTarget ) {
const renderer = this.backend.renderer;
const renderTarget = renderer.getRenderTarget();
samples = renderTarget ? renderTarget.samples : renderer.samples;
} else if ( texture.renderTarget ) {
samples = texture.renderTarget.samples;
}
samples = samples || 1;
const isMSAA = samples > 1 && texture.renderTarget !== null && ( texture.isDepthTexture !== true && texture.isFramebufferTexture !== true );
const primarySamples = isMSAA ? 1 : samples;
return { samples, primarySamples, isMSAA };
}
getCurrentColorFormat(renderContext: RenderContext): string¶
Code
getCurrentColorSpace(renderContext: RenderContext): string¶
Code
getPrimitiveTopology(object: Object3D, material: Material): string¶
Code
getPrimitiveTopology( object, material ) {
if ( object.isPoints ) return GPUPrimitiveTopology.PointList;
else if ( object.isLineSegments || ( object.isMesh && material.wireframe === true ) ) return GPUPrimitiveTopology.LineList;
else if ( object.isLine ) return GPUPrimitiveTopology.LineStrip;
else if ( object.isMesh ) return GPUPrimitiveTopology.TriangleList;
}
getSampleCount(sampleCount: number): number¶
getSampleCountRenderContext(renderContext: RenderContext): number¶
Code
getPreferredCanvasFormat(): string¶
Code
getPreferredCanvasFormat() {
const outputType = this.backend.parameters.outputType;
if ( outputType === undefined ) {
return navigator.gpu.getPreferredCanvasFormat();
} else if ( outputType === UnsignedByteType ) {
return GPUTextureFormat.BGRA8Unorm;
} else if ( outputType === HalfFloatType ) {
return GPUTextureFormat.RGBA16Float;
} else {
throw new Error( 'Unsupported outputType' );
}
}