GPUCommandEncoder: copyTextureToBuffer() 方法
copyTextureToBuffer() 方法是 GPUCommandEncoder 接口的一部分，它会编码一个命令，将数据从 GPUTexture 复制到 GPUBuffer。
语法
copyTextureToBuffer(source, destination, copySize)
参数
source-
一个定义了要从中复制数据的纹理的对象。与
copySize结合使用，定义了源纹理子资源的区域。source可以包含以下属性：aspect可选-
一个枚举值，定义要从中复制数据的纹理的哪个方面。可能的值有：
"all"-
将复制纹理格式的所有可用方面，这可能意味着颜色、深度和模板，具体取决于您处理的格式类型。
"depth-only"-
只会从 深度或模板格式 中复制深度方面。
"stencil-only"-
只会从深度或模板格式中复制模板方面。
如果省略，
aspect的值为"all"。 mipLevel可选-
一个数字，表示要从中复制数据的纹理的 mip-map 级别。如果省略，
mipLevel默认为 0。 origin可选-
一个对象或数组，指定复制的起点——要从中复制数据的纹理区域的最小角。与
size一起，这定义了要从中复制的区域的完整范围。如果省略了origin的任何部分，则x、y和z值将默认为 0。例如，您可以传递一个数组
[0, 0, 0]，或等效的对象{ x: 0, y: 0, z: 0 }。 texture-
一个表示要从中复制数据的纹理的
GPUTexture对象。
destination-
一个定义要写入数据的缓冲区以及写入缓冲区的数据布局的对象。与
copySize结合使用，它定义了目标缓冲区的区域。source可以包含以下属性：buffer-
要写入的
GPUBuffer。 offset可选-
从
data开始到写入复制数据的起始位置的字节偏移量。如果省略，offset默认为 0。 bytesPerRow可选-
一个数字，表示每个块行（即，一个完整的 texel 块行）和后续块行之间的字节步长。如果存在多个块行（即，复制高度或深度大于一个块），则此项是必需的。
rowsPerImage可选-
每张图像的块行数。
bytesPerRow×rowsPerImage将为您提供每张完整图像开始之间的步幅（以字节为单位）。如果需要复制多张图像，则此项是必需的。
copySize-
一个对象或数组，指定复制数据的宽度、高度和深度/数组层数。宽度值必须始终指定，而高度和深度/数组层数是可选的，如果省略则默认为 1。
例如，您可以传递一个数组
[16, 16, 2]，或等效的对象{ width: 16, height: 16, depthOrArrayLayers: 2 }。
返回值
无 (Undefined)。
验证
在调用 copyTextureToBuffer() 时必须满足以下条件，否则将生成 GPUValidationError，并且 GPUCommandEncoder 将失效。
对于 source：
mipLevel小于GPUTexture.mipLevelCount。origin.x是GPUTexture.format的 texel 块宽度的倍数。origin.y是GPUTexture.format的 texel 块高度的倍数。- 如果
GPUTexture.format是 深度或模板格式，或者GPUTexture.sampleCount大于 1，则子资源大小等于size。 source的GPUTexture.usage包含GPUTextureUsage.COPY_SRC标志。source的GPUTexture.sampleCount为 1。source.aspect指的是GPUTexture.format的单个方面。- 该方面根据 深度或模板格式 是有效的图像复制源。
source与copySize兼容。
对于 destination：
destination.bytesPerRow是 256 的倍数。destination.buffer的GPUBuffer.usage包含GPUBufferUsage.COPY_DST标志。
示例
commandEncoder.copyTextureToBuffer(
{
texture: sourceTexture,
},
{
buffer: destinationBuffer,
},
{
width: 16,
height: 16,
depthOrArrayLayers: 2,
},
);
规范
| 规范 |
|---|
| WebGPU # dom-gpucommandencoder-copytexturetobuffer |
浏览器兼容性
加载中…