Skip to content

WebGPURenderer: ReadRenderTargetPixelsAsync (RFC) #26326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Jun 26, 2023
Merged

WebGPURenderer: ReadRenderTargetPixelsAsync (RFC) #26326

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
cade3f6
add support for meshPhongNodeMaterial
Jun 9, 2023
ed14fe4
Merge branch 'dev' of https://github.com/aardgoose/three.js into dev
Jun 9, 2023
abb30d3
Merge branch 'dev' of https://github.com/aardgoose/three.js into dev
Jun 14, 2023
1fab8ca
Merge branch 'dev' of https://github.com/aardgoose/three.js into dev
Jun 16, 2023
9e61a6b
Merge branch 'dev' of https://github.com/aardgoose/three.js into dev
Jun 19, 2023
bbad5d6
Merge branch 'dev' of https://github.com/aardgoose/three.js into dev
Jun 20, 2023
9ca480d
Merge branch 'dev' of https://github.com/aardgoose/three.js into dev
Jun 23, 2023
c0cca73
draft readPixel api
Jun 25, 2023
c5a9f20
Update examples/jsm/renderers/webgpu/utils/WebGPUTextureUtils.js
aardgoose Jun 26, 2023
b489450
Update examples/jsm/renderers/common/Renderer.js
aardgoose Jun 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions examples/jsm/renderers/common/Backend.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ class Backend {

createTexture( texture ) { }

copyTextureToBuffer( texture, x, y, width, height ) {}

// attributes

createAttribute( attribute ) { }
Expand Down
6 changes: 6 additions & 0 deletions examples/jsm/renderers/common/Renderer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -637,6 +637,12 @@ class Renderer {

}

readRenderTargetPixelsAsync ( renderTarget, x, y, width, height ) {

return this.backend.copyTextureToBuffer( renderTarget.texture, x, y, width, height );

}

_projectObject( object, camera, groupOrder, renderList ) {

if ( object.visible === false ) return;
Expand Down
6 changes: 6 additions & 0 deletions examples/jsm/renderers/webgpu/WebGPUBackend.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -572,6 +572,12 @@ class WebGPUBackend extends Backend {

}

copyTextureToBuffer( texture, x, y, width, height ) {

return this.textureUtils.copyTextureToBuffer( texture, x, y, width, height );

}

// node builder

createNodeBuilder( object, renderer ) {
Expand Down
82 changes: 82 additions & 0 deletions examples/jsm/renderers/webgpu/utils/WebGPUTextureUtils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,52 @@ class WebGPUTextureUtils {

}

async copyTextureToBuffer( texture, x, y, width, height ) {

const device = this.backend.device;

const textureData = this.backend.get( texture );
const textureGPU = textureData.texture;
const format = textureData.textureDescriptorGPU.format;
const bytesPerTexel = this._getBytesPerTexel( format );

const readBuffer = device.createBuffer(
{
size: width * height * bytesPerTexel,
usage: GPUBufferUsage.COPY_DST | GPUBufferUsage.MAP_READ
}
);

const encoder = device.createCommandEncoder();

encoder.copyTextureToBuffer(
{
texture: textureGPU,
origin: { x: x, y: y },
},
{
buffer: readBuffer,
bytesPerRow: width * bytesPerTexel
},
{
width: width,
height: height
}

);

const typedArrayType = this._getTypedArrayType( format );

device.queue.submit( [ encoder.finish() ] );

await readBuffer.mapAsync( GPUMapMode.READ );

const buffer = readBuffer.getMappedRange();

return new typedArrayType( buffer );

}

_isEnvironmentTexture( texture ) {

const mapping = texture.mapping;
Expand Down Expand Up @@ -579,6 +625,42 @@ class WebGPUTextureUtils {

}

_getTypedArrayType( format ) {

if ( format === GPUTextureFormat.R8Uint ) return Uint8Array;
if ( format === GPUTextureFormat.R8Sint ) return Int8Array;
if ( format === GPUTextureFormat.R8Unorm ) return Uint8Array;
if ( format === GPUTextureFormat.R8Snorm ) return Int8Array;
if ( format === GPUTextureFormat.RG8Uint ) return Uint8Array;
if ( format === GPUTextureFormat.RG8Sint ) return Int8Array;
if ( format === GPUTextureFormat.RG8Unorm ) return Uint8Array;
if ( format === GPUTextureFormat.RG8Snorm ) return Int8Array;
if ( format === GPUTextureFormat.RGBA8Uint ) return Uint8Array;
if ( format === GPUTextureFormat.RGBA8Sint ) return Int8Array;
if ( format === GPUTextureFormat.RGBA8Unorm ) return Uint8Array;
if ( format === GPUTextureFormat.RGBA8Snorm ) return Int8Array;


if ( format === GPUTextureFormat.R16Uint ) return Uint16Array;
if ( format === GPUTextureFormat.R16Sint ) return Int16Array;
if ( format === GPUTextureFormat.RG16Uint ) return Uint16Array;
if ( format === GPUTextureFormat.RG16Sint ) return Int16Array;
if ( format === GPUTextureFormat.RGBA16Uint ) return Uint16Array;
if ( format === GPUTextureFormat.RGBA16Sint ) return Int16Array;


if ( format === GPUTextureFormat.R32Uint ) return Uint32Array;
if ( format === GPUTextureFormat.R32Sint ) return Int32Array;
if ( format === GPUTextureFormat.R32Float ) return Float32Array;
if ( format === GPUTextureFormat.RG32Uint ) return Uint32Array;
if ( format === GPUTextureFormat.RG32Sint ) return Int32Array;
if ( format === GPUTextureFormat.RG32Float ) return Float32Array;
if ( format === GPUTextureFormat.RGBA32Uint ) return Uint32Array;
if ( format === GPUTextureFormat.RGBA32Sint ) return Int32Array;
if ( format === GPUTextureFormat.RGBA32Float ) return Float32Array;

}

_getDimension( texture ) {

let dimension;
Expand Down