Skip to main content

wgpu_core/command/
transfer.rs

1use alloc::{format, string::String, sync::Arc, vec::Vec};
2
3use arrayvec::ArrayVec;
4use thiserror::Error;
5use wgt::{
6    error::{ErrorType, WebGpuError},
7    BufferAddress, BufferTextureCopyInfoError, BufferUsages, Extent3d, TextureSelector,
8    TextureUsages,
9};
10
11use crate::{
12    api_log,
13    command::{
14        clear_texture, encoder::EncodingState, ArcCommand, CommandEncoderError, EncoderStateError,
15    },
16    device::MissingDownlevelFlags,
17    global::Global,
18    id::{BufferId, CommandEncoderId, TextureId},
19    init_tracker::{
20        has_copy_partial_init_tracker_coverage, MemoryInitKind, TextureInitRange,
21        TextureInitTrackerAction,
22    },
23    resource::{
24        Buffer, MissingBufferUsageError, MissingTextureUsageError, ParentDevice, RawResourceAccess,
25        Texture, TextureErrorDimension,
26    },
27};
28
29use super::ClearError;
30
31type TexelCopyBufferInfo = wgt::TexelCopyBufferInfo<BufferId>;
32type TexelCopyTextureInfo = wgt::TexelCopyTextureInfo<Arc<Texture>>;
33
34#[derive(Clone, Copy, Debug, Eq, PartialEq)]
35pub enum CopySide {
36    Source,
37    Destination,
38}
39
40/// Error encountered while attempting a data transfer.
41#[derive(Clone, Debug, Error)]
42#[non_exhaustive]
43pub enum TransferError {
44    #[error("Source and destination cannot be the same buffer")]
45    SameSourceDestinationBuffer,
46    #[error(transparent)]
47    MissingBufferUsage(#[from] MissingBufferUsageError),
48    #[error(transparent)]
49    MissingTextureUsage(#[from] MissingTextureUsageError),
50    #[error(
51        "Copy at offset {start_offset} bytes would end up overrunning the bounds of the {side:?} buffer of size {buffer_size}"
52    )]
53    BufferStartOffsetOverrun {
54        start_offset: BufferAddress,
55        buffer_size: BufferAddress,
56        side: CopySide,
57    },
58    #[error(
59        "Copy at offset {start_offset} for {size} bytes would end up overrunning the bounds of the {side:?} buffer of size {buffer_size}"
60    )]
61    BufferEndOffsetOverrun {
62        start_offset: BufferAddress,
63        size: BufferAddress,
64        buffer_size: BufferAddress,
65        side: CopySide,
66    },
67    #[error("Copy of {dimension:?} {start_offset}..{end_offset} would end up overrunning the bounds of the {side:?} texture of {dimension:?} size {texture_size}")]
68    TextureOverrun {
69        start_offset: u32,
70        end_offset: u32,
71        texture_size: u32,
72        dimension: TextureErrorDimension,
73        side: CopySide,
74    },
75    #[error("Partial copy of {start_offset}..{end_offset} on {dimension:?} dimension with size {texture_size} \
76             is not supported for the {side:?} texture format {format:?} with {sample_count} samples")]
77    UnsupportedPartialTransfer {
78        format: wgt::TextureFormat,
79        sample_count: u32,
80        start_offset: u32,
81        end_offset: u32,
82        texture_size: u32,
83        dimension: TextureErrorDimension,
84        side: CopySide,
85    },
86    #[error(
87        "Copying{} layers {}..{} to{} layers {}..{} of the same texture is not allowed",
88        if *src_aspects == wgt::TextureAspect::All { String::new() } else { format!(" {src_aspects:?}") },
89        src_origin_z,
90        src_origin_z + array_layer_count,
91        if *dst_aspects == wgt::TextureAspect::All { String::new() } else { format!(" {dst_aspects:?}") },
92        dst_origin_z,
93        dst_origin_z + array_layer_count,
94    )]
95    InvalidCopyWithinSameTexture {
96        src_aspects: wgt::TextureAspect,
97        dst_aspects: wgt::TextureAspect,
98        src_origin_z: u32,
99        dst_origin_z: u32,
100        array_layer_count: u32,
101    },
102    #[error("Unable to select texture aspect {aspect:?} from format {format:?}")]
103    InvalidTextureAspect {
104        format: wgt::TextureFormat,
105        aspect: wgt::TextureAspect,
106    },
107    #[error("Unable to select texture mip level {level} out of {total}")]
108    InvalidTextureMipLevel { level: u32, total: u32 },
109    #[error("Texture dimension must be 2D when copying from an external texture")]
110    InvalidDimensionExternal,
111    #[error("Buffer offset {0} is not aligned to block size or `COPY_BUFFER_ALIGNMENT`")]
112    UnalignedBufferOffset(BufferAddress),
113    #[error("Copy size {0} does not respect `COPY_BUFFER_ALIGNMENT`")]
114    UnalignedCopySize(BufferAddress),
115    #[error("Copy width is not a multiple of block width")]
116    UnalignedCopyWidth,
117    #[error("Copy height is not a multiple of block height")]
118    UnalignedCopyHeight,
119    #[error("Copy origin's x component is not a multiple of block width")]
120    UnalignedCopyOriginX,
121    #[error("Copy origin's y component is not a multiple of block height")]
122    UnalignedCopyOriginY,
123    #[error("Bytes per row does not respect `COPY_BYTES_PER_ROW_ALIGNMENT`")]
124    UnalignedBytesPerRow,
125    #[error("Number of bytes per row needs to be specified since more than one row is copied")]
126    UnspecifiedBytesPerRow,
127    #[error("Number of rows per image needs to be specified since more than one image is copied")]
128    UnspecifiedRowsPerImage,
129    #[error("Number of bytes per row is less than the number of bytes in a complete row")]
130    InvalidBytesPerRow,
131    #[error("Number of rows per image is invalid")]
132    InvalidRowsPerImage,
133    #[error("Overflow while computing the size of the copy")]
134    SizeOverflow,
135    #[error("Copy source aspects must refer to all aspects of the source texture format")]
136    CopySrcMissingAspects,
137    #[error(
138        "Copy destination aspects must refer to all aspects of the destination texture format"
139    )]
140    CopyDstMissingAspects,
141    #[error("Copy aspect must refer to a single aspect of texture format")]
142    CopyAspectNotOne,
143    #[error("Copying from textures with format {0:?} is forbidden")]
144    CopyFromForbiddenTextureFormat(wgt::TextureFormat),
145    #[error("Copying from textures with format {format:?} and aspect {aspect:?} is forbidden")]
146    CopyFromForbiddenTextureFormatAspect {
147        format: wgt::TextureFormat,
148        aspect: wgt::TextureAspect,
149    },
150    #[error("Copying to textures with format {0:?} is forbidden")]
151    CopyToForbiddenTextureFormat(wgt::TextureFormat),
152    #[error("Copying to textures with format {format:?} and aspect {aspect:?} is forbidden")]
153    CopyToForbiddenTextureFormatAspect {
154        format: wgt::TextureFormat,
155        aspect: wgt::TextureAspect,
156    },
157    #[error(
158        "Copying to textures with format {0:?} is forbidden when copying from external texture"
159    )]
160    ExternalCopyToForbiddenTextureFormat(wgt::TextureFormat),
161    #[error(
162        "Source format ({src_format:?}) and destination format ({dst_format:?}) are not copy-compatible (they may only differ in srgb-ness)"
163    )]
164    TextureFormatsNotCopyCompatible {
165        src_format: wgt::TextureFormat,
166        dst_format: wgt::TextureFormat,
167    },
168    #[error(transparent)]
169    MemoryInitFailure(#[from] ClearError),
170    #[error("Cannot encode this copy because of a missing downelevel flag")]
171    MissingDownlevelFlags(#[from] MissingDownlevelFlags),
172    #[error("Source texture sample count must be 1, got {sample_count}")]
173    InvalidSampleCount { sample_count: u32 },
174    #[error(
175        "Source sample count ({src_sample_count:?}) and destination sample count ({dst_sample_count:?}) are not equal"
176    )]
177    SampleCountNotEqual {
178        src_sample_count: u32,
179        dst_sample_count: u32,
180    },
181    #[error("Requested mip level {requested} does not exist (count: {count})")]
182    InvalidMipLevel { requested: u32, count: u32 },
183    #[error("Buffer is expected to be unmapped, but was not")]
184    BufferNotAvailable,
185}
186
187impl WebGpuError for TransferError {
188    fn webgpu_error_type(&self) -> ErrorType {
189        match self {
190            Self::MissingBufferUsage(e) => e.webgpu_error_type(),
191            Self::MissingTextureUsage(e) => e.webgpu_error_type(),
192            Self::MemoryInitFailure(e) => e.webgpu_error_type(),
193
194            Self::BufferEndOffsetOverrun { .. }
195            | Self::TextureOverrun { .. }
196            | Self::BufferStartOffsetOverrun { .. }
197            | Self::UnsupportedPartialTransfer { .. }
198            | Self::InvalidCopyWithinSameTexture { .. }
199            | Self::InvalidTextureAspect { .. }
200            | Self::InvalidTextureMipLevel { .. }
201            | Self::InvalidDimensionExternal
202            | Self::UnalignedBufferOffset(..)
203            | Self::UnalignedCopySize(..)
204            | Self::UnalignedCopyWidth
205            | Self::UnalignedCopyHeight
206            | Self::UnalignedCopyOriginX
207            | Self::UnalignedCopyOriginY
208            | Self::UnalignedBytesPerRow
209            | Self::UnspecifiedBytesPerRow
210            | Self::UnspecifiedRowsPerImage
211            | Self::InvalidBytesPerRow
212            | Self::InvalidRowsPerImage
213            | Self::SizeOverflow
214            | Self::CopySrcMissingAspects
215            | Self::CopyDstMissingAspects
216            | Self::CopyAspectNotOne
217            | Self::CopyFromForbiddenTextureFormat(..)
218            | Self::CopyFromForbiddenTextureFormatAspect { .. }
219            | Self::CopyToForbiddenTextureFormat(..)
220            | Self::CopyToForbiddenTextureFormatAspect { .. }
221            | Self::ExternalCopyToForbiddenTextureFormat(..)
222            | Self::TextureFormatsNotCopyCompatible { .. }
223            | Self::MissingDownlevelFlags(..)
224            | Self::InvalidSampleCount { .. }
225            | Self::SampleCountNotEqual { .. }
226            | Self::InvalidMipLevel { .. }
227            | Self::SameSourceDestinationBuffer
228            | Self::BufferNotAvailable => ErrorType::Validation,
229        }
230    }
231}
232
233impl From<BufferTextureCopyInfoError> for TransferError {
234    fn from(value: BufferTextureCopyInfoError) -> Self {
235        match value {
236            BufferTextureCopyInfoError::InvalidBytesPerRow => Self::InvalidBytesPerRow,
237            BufferTextureCopyInfoError::InvalidRowsPerImage => Self::InvalidRowsPerImage,
238            BufferTextureCopyInfoError::ImageStrideOverflow
239            | BufferTextureCopyInfoError::ImageBytesOverflow(_)
240            | BufferTextureCopyInfoError::ArraySizeOverflow(_) => Self::SizeOverflow,
241        }
242    }
243}
244
245pub(crate) fn extract_texture_selector<T>(
246    copy_texture: &wgt::TexelCopyTextureInfo<T>,
247    copy_size: &Extent3d,
248    texture: &Texture,
249) -> Result<(TextureSelector, hal::TextureCopyBase), TransferError> {
250    let format = texture.desc.format;
251    let copy_aspect = hal::FormatAspects::new(format, copy_texture.aspect);
252    if copy_aspect.is_empty() {
253        return Err(TransferError::InvalidTextureAspect {
254            format,
255            aspect: copy_texture.aspect,
256        });
257    }
258
259    let (layers, origin_z) = match texture.desc.dimension {
260        wgt::TextureDimension::D1 => (0..1, 0),
261        wgt::TextureDimension::D2 => (
262            copy_texture.origin.z..copy_texture.origin.z + copy_size.depth_or_array_layers,
263            0,
264        ),
265        wgt::TextureDimension::D3 => (0..1, copy_texture.origin.z),
266    };
267    let base = hal::TextureCopyBase {
268        origin: wgt::Origin3d {
269            x: copy_texture.origin.x,
270            y: copy_texture.origin.y,
271            z: origin_z,
272        },
273        // this value will be incremented per copied layer
274        array_layer: layers.start,
275        mip_level: copy_texture.mip_level,
276        aspect: copy_aspect,
277    };
278    let selector = TextureSelector {
279        mips: copy_texture.mip_level..copy_texture.mip_level + 1,
280        layers,
281    };
282
283    Ok((selector, base))
284}
285
286/// WebGPU's [validating linear texture data][vltd] algorithm.
287///
288/// Copied with some modifications from WebGPU standard.
289///
290/// If successful, returns a tuple `(bytes, stride, is_contiguous)`, where:
291/// - `bytes` is the number of buffer bytes required for this copy, and
292/// - `stride` number of bytes between array layers.
293/// - `is_contiguous` is true if the linear texture data does not have padding
294///   between rows or between images.
295///
296/// [vltd]: https://gpuweb.github.io/gpuweb/#abstract-opdef-validating-linear-texture-data
297pub(crate) fn validate_linear_texture_data(
298    layout: &wgt::TexelCopyBufferLayout,
299    format: wgt::TextureFormat,
300    aspect: wgt::TextureAspect,
301    buffer_size: BufferAddress,
302    buffer_side: CopySide,
303    copy_size: &Extent3d,
304) -> Result<(BufferAddress, BufferAddress, bool), TransferError> {
305    let wgt::BufferTextureCopyInfo {
306        copy_width,
307        copy_height,
308        depth_or_array_layers,
309
310        offset,
311
312        block_size_bytes: _,
313        block_width_texels,
314        block_height_texels,
315
316        width_blocks: _,
317        height_blocks,
318
319        row_bytes_dense,
320        row_stride_bytes,
321
322        image_stride_rows: _,
323        image_stride_bytes,
324
325        image_rows_dense: _,
326        image_bytes_dense,
327
328        bytes_in_copy,
329    } = layout.get_buffer_texture_copy_info(format, aspect, copy_size)?;
330
331    if !copy_width.is_multiple_of(block_width_texels) {
332        return Err(TransferError::UnalignedCopyWidth);
333    }
334    if !copy_height.is_multiple_of(block_height_texels) {
335        return Err(TransferError::UnalignedCopyHeight);
336    }
337
338    let requires_multiple_rows = depth_or_array_layers > 1 || height_blocks > 1;
339    let requires_multiple_images = depth_or_array_layers > 1;
340
341    // `get_buffer_texture_copy_info()` already proceeded with defaults if these
342    // were not specified, and ensured that the values satisfy the minima if
343    // they were, but now we enforce the WebGPU requirement that they be
344    // specified any time they apply.
345    if layout.bytes_per_row.is_none() && requires_multiple_rows {
346        return Err(TransferError::UnspecifiedBytesPerRow);
347    }
348
349    if layout.rows_per_image.is_none() && requires_multiple_images {
350        return Err(TransferError::UnspecifiedRowsPerImage);
351    };
352
353    if offset > buffer_size {
354        return Err(TransferError::BufferStartOffsetOverrun {
355            start_offset: offset,
356            buffer_size,
357            side: buffer_side,
358        });
359    }
360    // NOTE: Should never underflow because of our earlier check.
361    if bytes_in_copy > buffer_size - offset {
362        return Err(TransferError::BufferEndOffsetOverrun {
363            start_offset: offset,
364            size: bytes_in_copy,
365            buffer_size,
366            side: buffer_side,
367        });
368    }
369
370    let is_contiguous = (row_stride_bytes == row_bytes_dense || !requires_multiple_rows)
371        && (image_stride_bytes == image_bytes_dense || !requires_multiple_images);
372
373    Ok((bytes_in_copy, image_stride_bytes, is_contiguous))
374}
375
376/// Validate the source format of a texture copy.
377///
378/// This performs the check from WebGPU's [validating texture buffer copy][vtbc]
379/// algorithm that ensures that the format and aspect form a valid texel copy source
380/// as defined in the [depth-stencil formats][dsf].
381///
382/// [vtbc]: https://gpuweb.github.io/gpuweb/#abstract-opdef-validating-texture-buffer-copy
383/// [dsf]: https://gpuweb.github.io/gpuweb/#depth-formats
384pub(crate) fn validate_texture_copy_src_format(
385    format: wgt::TextureFormat,
386    aspect: wgt::TextureAspect,
387) -> Result<(), TransferError> {
388    use wgt::TextureAspect as Ta;
389    use wgt::TextureFormat as Tf;
390    match (format, aspect) {
391        (Tf::Depth24Plus, _) => Err(TransferError::CopyFromForbiddenTextureFormat(format)),
392        (Tf::Depth24PlusStencil8, Ta::DepthOnly) => {
393            Err(TransferError::CopyFromForbiddenTextureFormatAspect { format, aspect })
394        }
395        _ => Ok(()),
396    }
397}
398
399/// Validate the destination format of a texture copy.
400///
401/// This performs the check from WebGPU's [validating texture buffer copy][vtbc]
402/// algorithm that ensures that the format and aspect form a valid texel copy destination
403/// as defined in the [depth-stencil formats][dsf].
404///
405/// [vtbc]: https://gpuweb.github.io/gpuweb/#abstract-opdef-validating-texture-buffer-copy
406/// [dsf]: https://gpuweb.github.io/gpuweb/#depth-formats
407pub(crate) fn validate_texture_copy_dst_format(
408    format: wgt::TextureFormat,
409    aspect: wgt::TextureAspect,
410) -> Result<(), TransferError> {
411    use wgt::TextureAspect as Ta;
412    use wgt::TextureFormat as Tf;
413    match (format, aspect) {
414        (Tf::Depth24Plus | Tf::Depth32Float, _) => {
415            Err(TransferError::CopyToForbiddenTextureFormat(format))
416        }
417        (Tf::Depth24PlusStencil8 | Tf::Depth32FloatStencil8, Ta::DepthOnly) => {
418            Err(TransferError::CopyToForbiddenTextureFormatAspect { format, aspect })
419        }
420        _ => Ok(()),
421    }
422}
423
424/// Validation for texture/buffer copies.
425///
426/// This implements the following checks from WebGPU's [validating texture buffer copy][vtbc]
427/// algorithm:
428///  * The texture must not be multisampled.
429///  * The copy must be from/to a single aspect of the texture.
430///  * If `aligned` is true, the buffer offset must be aligned appropriately.
431///
432/// And implements the following check from WebGPU's [validating GPUTexelCopyBufferInfo][vtcbi]
433/// algorithm:
434///  * If `aligned` is true, `bytesPerRow` must be a multiple of 256.
435///
436/// Note that the `bytesPerRow` alignment check is enforced whenever
437/// `bytesPerRow` is specified, even if the transfer is not multiple rows and
438/// `bytesPerRow` could have been omitted.
439///
440/// The following steps in [validating texture buffer copy][vtbc] are implemented elsewhere:
441///  * Invocation of other validation algorithms.
442///  * The texture usage (COPY_DST / COPY_SRC) check.
443///  * The check for non-copyable depth/stencil formats. The caller must perform
444///    this check using `validate_texture_copy_src_format` / `validate_texture_copy_dst_format`
445///    before calling this function. This function will panic if
446///    [`wgt::TextureFormat::block_copy_size`] returns `None` due to a
447///    non-copyable format.
448///
449/// [vtbc]: https://gpuweb.github.io/gpuweb/#abstract-opdef-validating-texture-buffer-copy
450/// [vtcbi]: https://www.w3.org/TR/webgpu/#abstract-opdef-validating-gputexelcopybufferinfo
451pub(crate) fn validate_texture_buffer_copy<T>(
452    texture_copy_view: &wgt::TexelCopyTextureInfo<T>,
453    aspect: hal::FormatAspects,
454    desc: &wgt::TextureDescriptor<(), Vec<wgt::TextureFormat>>,
455    layout: &wgt::TexelCopyBufferLayout,
456    aligned: bool,
457) -> Result<(), TransferError> {
458    if desc.sample_count != 1 {
459        return Err(TransferError::InvalidSampleCount {
460            sample_count: desc.sample_count,
461        });
462    }
463
464    if !aspect.is_one() {
465        return Err(TransferError::CopyAspectNotOne);
466    }
467
468    let offset_alignment = if desc.format.is_depth_stencil_format() {
469        4
470    } else {
471        // The case where `block_copy_size` returns `None` is currently
472        // unreachable both for the reason in the expect message, and also
473        // because the currently-defined non-copyable formats are depth/stencil
474        // formats so would take the `if` branch.
475        desc.format
476            .block_copy_size(Some(texture_copy_view.aspect))
477            .expect("non-copyable formats should have been rejected previously")
478    };
479
480    if aligned && !layout.offset.is_multiple_of(u64::from(offset_alignment)) {
481        return Err(TransferError::UnalignedBufferOffset(layout.offset));
482    }
483
484    if let Some(bytes_per_row) = layout.bytes_per_row {
485        if aligned && bytes_per_row % wgt::COPY_BYTES_PER_ROW_ALIGNMENT != 0 {
486            return Err(TransferError::UnalignedBytesPerRow);
487        }
488    }
489
490    Ok(())
491}
492
493/// Validate the extent and alignment of a texture copy.
494///
495/// Copied with minor modifications from WebGPU standard. This mostly follows
496/// the [validating GPUTexelCopyTextureInfo][vtcti] and [validating texture copy
497/// range][vtcr] algorithms.
498///
499/// Returns the HAL copy extent and the layer count.
500///
501/// [vtcti]: https://gpuweb.github.io/gpuweb/#abstract-opdef-validating-gputexelcopytextureinfo
502/// [vtcr]: https://gpuweb.github.io/gpuweb/#abstract-opdef-validating-texture-copy-range
503pub(crate) fn validate_texture_copy_range<T>(
504    texture_copy_view: &wgt::TexelCopyTextureInfo<T>,
505    desc: &wgt::TextureDescriptor<(), Vec<wgt::TextureFormat>>,
506    texture_side: CopySide,
507    copy_size: &Extent3d,
508) -> Result<(hal::CopyExtent, u32), TransferError> {
509    let (block_width, block_height) = desc.format.block_dimensions();
510
511    let extent_virtual = desc.mip_level_size(texture_copy_view.mip_level).ok_or(
512        TransferError::InvalidTextureMipLevel {
513            level: texture_copy_view.mip_level,
514            total: desc.mip_level_count,
515        },
516    )?;
517    // physical size can be larger than the virtual
518    let extent = extent_virtual.physical_size(desc.format);
519
520    // Multisampled and depth-stencil formats do not support partial copies
521    // on x and y dimensions, but do support copying a subset of layers.
522    let requires_exact_size = desc.format.is_depth_stencil_format() || desc.sample_count > 1;
523
524    // Return `Ok` if a run `size` texels long starting at `start_offset` is
525    // valid for `texture_size`. Otherwise, return an appropriate a`Err`.
526    let check_dimension = |dimension: TextureErrorDimension,
527                           start_offset: u32,
528                           size: u32,
529                           texture_size: u32,
530                           requires_exact_size: bool|
531     -> Result<(), TransferError> {
532        if requires_exact_size && (start_offset != 0 || size != texture_size) {
533            Err(TransferError::UnsupportedPartialTransfer {
534                format: desc.format,
535                sample_count: desc.sample_count,
536                start_offset,
537                end_offset: start_offset.wrapping_add(size),
538                texture_size,
539                dimension,
540                side: texture_side,
541            })
542        // Avoid underflow in the subtraction by checking start_offset against
543        // texture_size first.
544        } else if start_offset > texture_size || texture_size - start_offset < size {
545            Err(TransferError::TextureOverrun {
546                start_offset,
547                end_offset: start_offset.wrapping_add(size),
548                texture_size,
549                dimension,
550                side: texture_side,
551            })
552        } else {
553            Ok(())
554        }
555    };
556
557    check_dimension(
558        TextureErrorDimension::X,
559        texture_copy_view.origin.x,
560        copy_size.width,
561        extent.width,
562        requires_exact_size,
563    )?;
564    check_dimension(
565        TextureErrorDimension::Y,
566        texture_copy_view.origin.y,
567        copy_size.height,
568        extent.height,
569        requires_exact_size,
570    )?;
571    check_dimension(
572        TextureErrorDimension::Z,
573        texture_copy_view.origin.z,
574        copy_size.depth_or_array_layers,
575        extent.depth_or_array_layers,
576        false, // partial copy always allowed on Z/layer dimension
577    )?;
578
579    if !texture_copy_view.origin.x.is_multiple_of(block_width) {
580        return Err(TransferError::UnalignedCopyOriginX);
581    }
582    if !texture_copy_view.origin.y.is_multiple_of(block_height) {
583        return Err(TransferError::UnalignedCopyOriginY);
584    }
585    if !copy_size.width.is_multiple_of(block_width) {
586        return Err(TransferError::UnalignedCopyWidth);
587    }
588    if !copy_size.height.is_multiple_of(block_height) {
589        return Err(TransferError::UnalignedCopyHeight);
590    }
591
592    let (depth, array_layer_count) = match desc.dimension {
593        wgt::TextureDimension::D1 => (1, 1),
594        wgt::TextureDimension::D2 => (1, copy_size.depth_or_array_layers),
595        wgt::TextureDimension::D3 => (copy_size.depth_or_array_layers, 1),
596    };
597
598    let copy_extent = hal::CopyExtent {
599        width: copy_size.width,
600        height: copy_size.height,
601        depth,
602    };
603    Ok((copy_extent, array_layer_count))
604}
605
606/// Validate a copy within the same texture.
607///
608/// This implements the WebGPU requirement that the [sets of subresources for
609/// texture copy][srtc] of the source and destination be disjoint, i.e. that the
610/// source and destination do not overlap.
611///
612/// This function assumes that the copy ranges have already been validated with
613/// `validate_texture_copy_range`.
614///
615/// [srtc]: https://gpuweb.github.io/gpuweb/#abstract-opdef-set-of-subresources-for-texture-copy
616pub(crate) fn validate_copy_within_same_texture<T>(
617    src: &wgt::TexelCopyTextureInfo<T>,
618    dst: &wgt::TexelCopyTextureInfo<T>,
619    format: wgt::TextureFormat,
620    array_layer_count: u32,
621) -> Result<(), TransferError> {
622    let src_aspects = hal::FormatAspects::new(format, src.aspect);
623    let dst_aspects = hal::FormatAspects::new(format, dst.aspect);
624    if (src_aspects & dst_aspects).is_empty() {
625        // Copying between different aspects (if it even makes sense), is okay.
626        return Ok(());
627    }
628
629    if src.origin.z >= dst.origin.z + array_layer_count
630        || dst.origin.z >= src.origin.z + array_layer_count
631    {
632        // Copying between non-overlapping layer ranges is okay.
633        return Ok(());
634    }
635
636    if src.mip_level != dst.mip_level {
637        // Copying between different mip levels is okay.
638        return Ok(());
639    }
640
641    Err(TransferError::InvalidCopyWithinSameTexture {
642        src_aspects: src.aspect,
643        dst_aspects: dst.aspect,
644        src_origin_z: src.origin.z,
645        dst_origin_z: dst.origin.z,
646        array_layer_count,
647    })
648}
649
650fn handle_texture_init(
651    state: &mut EncodingState,
652    init_kind: MemoryInitKind,
653    copy_texture: &TexelCopyTextureInfo,
654    copy_size: &Extent3d,
655    texture: &Arc<Texture>,
656) -> Result<(), ClearError> {
657    let init_action = TextureInitTrackerAction {
658        texture: texture.clone(),
659        range: TextureInitRange {
660            mip_range: copy_texture.mip_level..copy_texture.mip_level + 1,
661            layer_range: copy_texture.origin.z
662                ..(copy_texture.origin.z + copy_size.depth_or_array_layers),
663        },
664        kind: init_kind,
665    };
666
667    // Register the init action.
668    let immediate_inits = state
669        .texture_memory_actions
670        .register_init_action(&{ init_action });
671
672    // In rare cases we may need to insert an init operation immediately onto the command buffer.
673    if !immediate_inits.is_empty() {
674        for init in immediate_inits {
675            clear_texture(
676                &init.texture,
677                TextureInitRange {
678                    mip_range: init.mip_level..(init.mip_level + 1),
679                    layer_range: init.layer..(init.layer + 1),
680                },
681                state.raw_encoder,
682                &mut state.tracker.textures,
683                &state.device.alignments,
684                state.device.zero_buffer.as_ref(),
685                state.snatch_guard,
686                state.device.instance_flags,
687            )?;
688        }
689    }
690
691    Ok(())
692}
693
694/// Prepare a transfer's source texture.
695///
696/// Ensure the source texture of a transfer is in the right initialization
697/// state, and record the state for after the transfer operation.
698fn handle_src_texture_init(
699    state: &mut EncodingState,
700    source: &TexelCopyTextureInfo,
701    copy_size: &Extent3d,
702    texture: &Arc<Texture>,
703) -> Result<(), TransferError> {
704    handle_texture_init(
705        state,
706        MemoryInitKind::NeedsInitializedMemory,
707        source,
708        copy_size,
709        texture,
710    )?;
711    Ok(())
712}
713
714/// Prepare a transfer's destination texture.
715///
716/// Ensure the destination texture of a transfer is in the right initialization
717/// state, and record the state for after the transfer operation.
718fn handle_dst_texture_init(
719    state: &mut EncodingState,
720    destination: &wgt::TexelCopyTextureInfo<Arc<Texture>>,
721    copy_size: &Extent3d,
722    texture: &Arc<Texture>,
723) -> Result<(), TransferError> {
724    // Attention: If we don't write full texture subresources, we need to a full
725    // clear first since we don't track subrects. This means that in rare cases
726    // even a *destination* texture of a transfer may need an immediate texture
727    // init.
728    let dst_init_kind = if has_copy_partial_init_tracker_coverage(
729        copy_size,
730        destination.mip_level,
731        &texture.desc,
732    ) {
733        MemoryInitKind::NeedsInitializedMemory
734    } else {
735        MemoryInitKind::ImplicitlyInitialized
736    };
737
738    handle_texture_init(state, dst_init_kind, destination, copy_size, texture)?;
739    Ok(())
740}
741
742/// Handle initialization tracking for a transfer's source or destination buffer.
743///
744/// Ensures that the transfer will not read from uninitialized memory, and updates
745/// the initialization state information to reflect the transfer.
746fn handle_buffer_init(
747    state: &mut EncodingState,
748    info: &wgt::TexelCopyBufferInfo<Arc<Buffer>>,
749    direction: CopySide,
750    required_buffer_bytes_in_copy: BufferAddress,
751    is_contiguous: bool,
752) {
753    const ALIGN_SIZE: BufferAddress = wgt::COPY_BUFFER_ALIGNMENT;
754    const ALIGN_MASK: BufferAddress = wgt::COPY_BUFFER_ALIGNMENT - 1;
755
756    let buffer = &info.buffer;
757    let start = info.layout.offset;
758    let end = info.layout.offset + required_buffer_bytes_in_copy;
759    if !is_contiguous || direction == CopySide::Source {
760        // If the transfer will read the buffer, then the whole region needs to
761        // be initialized.
762        //
763        // If the transfer will not write a contiguous region of the buffer,
764        // then we need to make sure the padding areas are initialized. For now,
765        // initialize the whole region, although this could be improved to
766        // initialize only the necessary parts if doing so is likely to be
767        // faster than initializing the whole thing.
768        //
769        // Adjust the start/end outwards to 4B alignment.
770        let aligned_start = start & !ALIGN_MASK;
771        let aligned_end = (end + ALIGN_MASK) & !ALIGN_MASK;
772        state
773            .buffer_memory_init_actions
774            .extend(buffer.initialization_status.read().create_action(
775                buffer,
776                aligned_start..aligned_end,
777                MemoryInitKind::NeedsInitializedMemory,
778            ));
779    } else {
780        // If the transfer will write a contiguous region of the buffer, then we
781        // don't need to initialize that region.
782        //
783        // However, if the start and end are not 4B aligned, we need to make
784        // sure that we don't end up trying to initialize non-4B-aligned regions
785        // later.
786        //
787        // Adjust the start/end inwards to 4B alignment, we will handle the
788        // first/last pieces differently.
789        let aligned_start = (start + ALIGN_MASK) & !ALIGN_MASK;
790        let aligned_end = end & !ALIGN_MASK;
791        if aligned_start != start {
792            state.buffer_memory_init_actions.extend(
793                buffer.initialization_status.read().create_action(
794                    buffer,
795                    aligned_start - ALIGN_SIZE..aligned_start,
796                    MemoryInitKind::NeedsInitializedMemory,
797                ),
798            );
799        }
800        if aligned_start != aligned_end {
801            state.buffer_memory_init_actions.extend(
802                buffer.initialization_status.read().create_action(
803                    buffer,
804                    aligned_start..aligned_end,
805                    MemoryInitKind::ImplicitlyInitialized,
806                ),
807            );
808        }
809        if aligned_end != end {
810            // It is possible that `aligned_end + ALIGN_SIZE > dst_buffer.size`,
811            // because `dst_buffer.size` is the user-requested size, not the
812            // final size of the buffer. The final size of the buffer is not
813            // readily available, but was rounded up to COPY_BUFFER_ALIGNMENT,
814            // so no overrun is possible.
815            state.buffer_memory_init_actions.extend(
816                buffer.initialization_status.read().create_action(
817                    buffer,
818                    aligned_end..aligned_end + ALIGN_SIZE,
819                    MemoryInitKind::NeedsInitializedMemory,
820                ),
821            );
822        }
823    }
824}
825
826impl Global {
827    pub fn command_encoder_copy_buffer_to_buffer(
828        &self,
829        command_encoder_id: CommandEncoderId,
830        source: BufferId,
831        source_offset: BufferAddress,
832        destination: BufferId,
833        destination_offset: BufferAddress,
834        size: Option<BufferAddress>,
835    ) -> Result<(), EncoderStateError> {
836        profiling::scope!("CommandEncoder::copy_buffer_to_buffer");
837        api_log!(
838            "CommandEncoder::copy_buffer_to_buffer {source:?} -> {destination:?} {size:?}bytes"
839        );
840
841        let hub = &self.hub;
842
843        let cmd_enc = hub.command_encoders.get(command_encoder_id);
844        let mut cmd_buf_data = cmd_enc.data.lock();
845
846        cmd_buf_data.push_with(|| -> Result<_, CommandEncoderError> {
847            Ok(ArcCommand::CopyBufferToBuffer {
848                src: self.resolve_buffer_id(source)?,
849                src_offset: source_offset,
850                dst: self.resolve_buffer_id(destination)?,
851                dst_offset: destination_offset,
852                size,
853            })
854        })
855    }
856
857    pub fn command_encoder_copy_buffer_to_texture(
858        &self,
859        command_encoder_id: CommandEncoderId,
860        source: &TexelCopyBufferInfo,
861        destination: &wgt::TexelCopyTextureInfo<TextureId>,
862        copy_size: &Extent3d,
863    ) -> Result<(), EncoderStateError> {
864        profiling::scope!("CommandEncoder::copy_buffer_to_texture");
865        api_log!(
866            "CommandEncoder::copy_buffer_to_texture {:?} -> {:?} {copy_size:?}",
867            source.buffer,
868            destination.texture
869        );
870
871        let cmd_enc = self.hub.command_encoders.get(command_encoder_id);
872        let mut cmd_buf_data = cmd_enc.data.lock();
873
874        cmd_buf_data.push_with(|| -> Result<_, CommandEncoderError> {
875            Ok(ArcCommand::CopyBufferToTexture {
876                src: wgt::TexelCopyBufferInfo::<Arc<Buffer>> {
877                    buffer: self.resolve_buffer_id(source.buffer)?,
878                    layout: source.layout,
879                },
880                dst: wgt::TexelCopyTextureInfo::<Arc<Texture>> {
881                    texture: self.resolve_texture_id(destination.texture)?,
882                    mip_level: destination.mip_level,
883                    origin: destination.origin,
884                    aspect: destination.aspect,
885                },
886                size: *copy_size,
887            })
888        })
889    }
890
891    pub fn command_encoder_copy_texture_to_buffer(
892        &self,
893        command_encoder_id: CommandEncoderId,
894        source: &wgt::TexelCopyTextureInfo<TextureId>,
895        destination: &TexelCopyBufferInfo,
896        copy_size: &Extent3d,
897    ) -> Result<(), EncoderStateError> {
898        profiling::scope!("CommandEncoder::copy_texture_to_buffer");
899        api_log!(
900            "CommandEncoder::copy_texture_to_buffer {:?} -> {:?} {copy_size:?}",
901            source.texture,
902            destination.buffer
903        );
904
905        let cmd_enc = self.hub.command_encoders.get(command_encoder_id);
906        let mut cmd_buf_data = cmd_enc.data.lock();
907
908        cmd_buf_data.push_with(|| -> Result<_, CommandEncoderError> {
909            Ok(ArcCommand::CopyTextureToBuffer {
910                src: wgt::TexelCopyTextureInfo::<Arc<Texture>> {
911                    texture: self.resolve_texture_id(source.texture)?,
912                    mip_level: source.mip_level,
913                    origin: source.origin,
914                    aspect: source.aspect,
915                },
916                dst: wgt::TexelCopyBufferInfo::<Arc<Buffer>> {
917                    buffer: self.resolve_buffer_id(destination.buffer)?,
918                    layout: destination.layout,
919                },
920                size: *copy_size,
921            })
922        })
923    }
924
925    pub fn command_encoder_copy_texture_to_texture(
926        &self,
927        command_encoder_id: CommandEncoderId,
928        source: &wgt::TexelCopyTextureInfo<TextureId>,
929        destination: &wgt::TexelCopyTextureInfo<TextureId>,
930        copy_size: &Extent3d,
931    ) -> Result<(), EncoderStateError> {
932        profiling::scope!("CommandEncoder::copy_texture_to_texture");
933        api_log!(
934            "CommandEncoder::copy_texture_to_texture {:?} -> {:?} {copy_size:?}",
935            source.texture,
936            destination.texture
937        );
938
939        let cmd_enc = self.hub.command_encoders.get(command_encoder_id);
940        let mut cmd_buf_data = cmd_enc.data.lock();
941
942        cmd_buf_data.push_with(|| -> Result<_, CommandEncoderError> {
943            Ok(ArcCommand::CopyTextureToTexture {
944                src: wgt::TexelCopyTextureInfo {
945                    texture: self.resolve_texture_id(source.texture)?,
946                    mip_level: source.mip_level,
947                    origin: source.origin,
948                    aspect: source.aspect,
949                },
950                dst: wgt::TexelCopyTextureInfo {
951                    texture: self.resolve_texture_id(destination.texture)?,
952                    mip_level: destination.mip_level,
953                    origin: destination.origin,
954                    aspect: destination.aspect,
955                },
956                size: *copy_size,
957            })
958        })
959    }
960}
961
962pub(super) fn copy_buffer_to_buffer(
963    state: &mut EncodingState,
964    src_buffer: &Arc<Buffer>,
965    source_offset: BufferAddress,
966    dst_buffer: &Arc<Buffer>,
967    destination_offset: BufferAddress,
968    size: Option<BufferAddress>,
969) -> Result<(), CommandEncoderError> {
970    if src_buffer.is_equal(dst_buffer) {
971        return Err(TransferError::SameSourceDestinationBuffer.into());
972    }
973
974    src_buffer.same_device(state.device)?;
975
976    let src_pending = state
977        .tracker
978        .buffers
979        .set_single(src_buffer, wgt::BufferUses::COPY_SRC);
980
981    let src_raw = src_buffer.try_raw(state.snatch_guard)?;
982    src_buffer
983        .check_usage(BufferUsages::COPY_SRC)
984        .map_err(TransferError::MissingBufferUsage)?;
985    // expecting only a single barrier
986    let src_barrier = src_pending.map(|pending| pending.into_hal(src_buffer, state.snatch_guard));
987
988    dst_buffer.same_device(state.device)?;
989
990    let dst_pending = state
991        .tracker
992        .buffers
993        .set_single(dst_buffer, wgt::BufferUses::COPY_DST);
994
995    let dst_raw = dst_buffer.try_raw(state.snatch_guard)?;
996    dst_buffer
997        .check_usage(BufferUsages::COPY_DST)
998        .map_err(TransferError::MissingBufferUsage)?;
999    let dst_barrier = dst_pending.map(|pending| pending.into_hal(dst_buffer, state.snatch_guard));
1000
1001    if source_offset > src_buffer.size {
1002        return Err(TransferError::BufferStartOffsetOverrun {
1003            start_offset: source_offset,
1004            buffer_size: src_buffer.size,
1005            side: CopySide::Source,
1006        }
1007        .into());
1008    }
1009    let size = size.unwrap_or_else(|| {
1010        // NOTE: Should never underflow because of our earlier check.
1011        src_buffer.size - source_offset
1012    });
1013
1014    if !size.is_multiple_of(wgt::COPY_BUFFER_ALIGNMENT) {
1015        return Err(TransferError::UnalignedCopySize(size).into());
1016    }
1017    if !source_offset.is_multiple_of(wgt::COPY_BUFFER_ALIGNMENT) {
1018        return Err(TransferError::UnalignedBufferOffset(source_offset).into());
1019    }
1020    if !destination_offset.is_multiple_of(wgt::COPY_BUFFER_ALIGNMENT) {
1021        return Err(TransferError::UnalignedBufferOffset(destination_offset).into());
1022    }
1023    if !state
1024        .device
1025        .downlevel
1026        .flags
1027        .contains(wgt::DownlevelFlags::UNRESTRICTED_INDEX_BUFFER)
1028        && (src_buffer.usage.contains(BufferUsages::INDEX)
1029            || dst_buffer.usage.contains(BufferUsages::INDEX))
1030    {
1031        let forbidden_usages = BufferUsages::VERTEX
1032            | BufferUsages::UNIFORM
1033            | BufferUsages::INDIRECT
1034            | BufferUsages::STORAGE;
1035        if src_buffer.usage.intersects(forbidden_usages)
1036            || dst_buffer.usage.intersects(forbidden_usages)
1037        {
1038            return Err(TransferError::MissingDownlevelFlags(MissingDownlevelFlags(
1039                wgt::DownlevelFlags::UNRESTRICTED_INDEX_BUFFER,
1040            ))
1041            .into());
1042        }
1043    }
1044
1045    if size > src_buffer.size - source_offset {
1046        return Err(TransferError::BufferEndOffsetOverrun {
1047            start_offset: source_offset,
1048            size,
1049            buffer_size: src_buffer.size,
1050            side: CopySide::Source,
1051        }
1052        .into());
1053    }
1054    // NOTE: Should never overflow because of our earlier check.
1055    let source_end_offset = source_offset + size;
1056
1057    if destination_offset > dst_buffer.size {
1058        return Err(TransferError::BufferStartOffsetOverrun {
1059            start_offset: destination_offset,
1060            buffer_size: dst_buffer.size,
1061            side: CopySide::Destination,
1062        }
1063        .into());
1064    }
1065    // NOTE: Should never underflow because of our earlier check.
1066    if size > dst_buffer.size - destination_offset {
1067        return Err(TransferError::BufferEndOffsetOverrun {
1068            start_offset: destination_offset,
1069            size,
1070            buffer_size: dst_buffer.size,
1071            side: CopySide::Destination,
1072        }
1073        .into());
1074    }
1075    // NOTE: Should never overflow because of our earlier check.
1076    let destination_end_offset = destination_offset + size;
1077
1078    // This must happen after parameter validation (so that errors are reported
1079    // as required by the spec), but before any side effects.
1080    if size == 0 {
1081        log::trace!("Ignoring copy_buffer_to_buffer of size 0");
1082        return Ok(());
1083    }
1084
1085    // Make sure source is initialized memory and mark dest as initialized.
1086    state
1087        .buffer_memory_init_actions
1088        .extend(dst_buffer.initialization_status.read().create_action(
1089            dst_buffer,
1090            destination_offset..destination_end_offset,
1091            MemoryInitKind::ImplicitlyInitialized,
1092        ));
1093    state
1094        .buffer_memory_init_actions
1095        .extend(src_buffer.initialization_status.read().create_action(
1096            src_buffer,
1097            source_offset..source_end_offset,
1098            MemoryInitKind::NeedsInitializedMemory,
1099        ));
1100
1101    let region = hal::BufferCopy {
1102        src_offset: source_offset,
1103        dst_offset: destination_offset,
1104        size: wgt::BufferSize::new(size).unwrap(),
1105    };
1106    let barriers = src_barrier
1107        .into_iter()
1108        .chain(dst_barrier)
1109        .collect::<Vec<_>>();
1110    unsafe {
1111        state.raw_encoder.transition_buffers(&barriers);
1112        state
1113            .raw_encoder
1114            .copy_buffer_to_buffer(src_raw, dst_raw, &[region]);
1115    }
1116
1117    Ok(())
1118}
1119
1120pub(super) fn copy_buffer_to_texture(
1121    state: &mut EncodingState,
1122    source: &wgt::TexelCopyBufferInfo<Arc<Buffer>>,
1123    destination: &wgt::TexelCopyTextureInfo<Arc<Texture>>,
1124    copy_size: &Extent3d,
1125) -> Result<(), CommandEncoderError> {
1126    let dst_texture = &destination.texture;
1127    let src_buffer = &source.buffer;
1128
1129    dst_texture.same_device(state.device)?;
1130    src_buffer.same_device(state.device)?;
1131
1132    let (hal_copy_size, array_layer_count) = validate_texture_copy_range(
1133        destination,
1134        &dst_texture.desc,
1135        CopySide::Destination,
1136        copy_size,
1137    )?;
1138
1139    let (dst_range, dst_base) = extract_texture_selector(destination, copy_size, dst_texture)?;
1140
1141    let src_raw = src_buffer.try_raw(state.snatch_guard)?;
1142    src_buffer
1143        .check_usage(BufferUsages::COPY_SRC)
1144        .map_err(TransferError::MissingBufferUsage)?;
1145
1146    let dst_raw = dst_texture.try_raw(state.snatch_guard)?;
1147    dst_texture
1148        .check_usage(TextureUsages::COPY_DST)
1149        .map_err(TransferError::MissingTextureUsage)?;
1150
1151    validate_texture_copy_dst_format(dst_texture.desc.format, destination.aspect)?;
1152
1153    validate_texture_buffer_copy(
1154        destination,
1155        dst_base.aspect,
1156        &dst_texture.desc,
1157        &source.layout,
1158        true, // alignment required for buffer offset
1159    )?;
1160
1161    let (required_buffer_bytes_in_copy, bytes_per_array_layer, is_contiguous) =
1162        validate_linear_texture_data(
1163            &source.layout,
1164            dst_texture.desc.format,
1165            destination.aspect,
1166            src_buffer.size,
1167            CopySide::Source,
1168            copy_size,
1169        )?;
1170
1171    if dst_texture.desc.format.is_depth_stencil_format() {
1172        state
1173            .device
1174            .require_downlevel_flags(wgt::DownlevelFlags::DEPTH_TEXTURE_AND_BUFFER_COPIES)
1175            .map_err(TransferError::from)?;
1176    }
1177
1178    // This must happen after parameter validation (so that errors are reported
1179    // as required by the spec), but before any side effects.
1180    if copy_size.width == 0 || copy_size.height == 0 || copy_size.depth_or_array_layers == 0 {
1181        log::trace!("Ignoring copy_buffer_to_texture of size 0");
1182        return Ok(());
1183    }
1184
1185    // Handle texture init *before* dealing with barrier transitions so we
1186    // have an easier time inserting "immediate-inits" that may be required
1187    // by prior discards in rare cases.
1188    handle_dst_texture_init(state, destination, copy_size, dst_texture)?;
1189
1190    let src_pending = state
1191        .tracker
1192        .buffers
1193        .set_single(src_buffer, wgt::BufferUses::COPY_SRC);
1194    let src_barrier = src_pending.map(|pending| pending.into_hal(src_buffer, state.snatch_guard));
1195
1196    let dst_pending =
1197        state
1198            .tracker
1199            .textures
1200            .set_single(dst_texture, dst_range, wgt::TextureUses::COPY_DST);
1201    let dst_barrier = dst_pending
1202        .map(|pending| pending.into_hal(dst_raw))
1203        .collect::<Vec<_>>();
1204
1205    handle_buffer_init(
1206        state,
1207        source,
1208        CopySide::Source,
1209        required_buffer_bytes_in_copy,
1210        is_contiguous,
1211    );
1212
1213    let regions = (0..array_layer_count)
1214        .map(|rel_array_layer| {
1215            let mut texture_base = dst_base.clone();
1216            texture_base.array_layer += rel_array_layer;
1217            let mut buffer_layout = source.layout;
1218            buffer_layout.offset += rel_array_layer as u64 * bytes_per_array_layer;
1219            hal::BufferTextureCopy {
1220                buffer_layout,
1221                texture_base,
1222                size: hal_copy_size,
1223            }
1224        })
1225        .collect::<Vec<_>>();
1226
1227    unsafe {
1228        state.raw_encoder.transition_textures(&dst_barrier);
1229        state.raw_encoder.transition_buffers(src_barrier.as_slice());
1230        state
1231            .raw_encoder
1232            .copy_buffer_to_texture(src_raw, dst_raw, &regions);
1233    }
1234
1235    Ok(())
1236}
1237
1238pub(super) fn copy_texture_to_buffer(
1239    state: &mut EncodingState,
1240    source: &TexelCopyTextureInfo,
1241    destination: &wgt::TexelCopyBufferInfo<Arc<Buffer>>,
1242    copy_size: &Extent3d,
1243) -> Result<(), CommandEncoderError> {
1244    let src_texture = &source.texture;
1245    let dst_buffer = &destination.buffer;
1246
1247    src_texture.same_device(state.device)?;
1248    dst_buffer.same_device(state.device)?;
1249
1250    let (hal_copy_size, array_layer_count) =
1251        validate_texture_copy_range(source, &src_texture.desc, CopySide::Source, copy_size)?;
1252
1253    let (src_range, src_base) = extract_texture_selector(source, copy_size, src_texture)?;
1254
1255    let src_raw = src_texture.try_raw(state.snatch_guard)?;
1256    src_texture
1257        .check_usage(TextureUsages::COPY_SRC)
1258        .map_err(TransferError::MissingTextureUsage)?;
1259
1260    if source.mip_level >= src_texture.desc.mip_level_count {
1261        return Err(TransferError::InvalidMipLevel {
1262            requested: source.mip_level,
1263            count: src_texture.desc.mip_level_count,
1264        }
1265        .into());
1266    }
1267
1268    validate_texture_copy_src_format(src_texture.desc.format, source.aspect)?;
1269
1270    validate_texture_buffer_copy(
1271        source,
1272        src_base.aspect,
1273        &src_texture.desc,
1274        &destination.layout,
1275        true, // alignment required for buffer offset
1276    )?;
1277
1278    let (required_buffer_bytes_in_copy, bytes_per_array_layer, is_contiguous) =
1279        validate_linear_texture_data(
1280            &destination.layout,
1281            src_texture.desc.format,
1282            source.aspect,
1283            dst_buffer.size,
1284            CopySide::Destination,
1285            copy_size,
1286        )?;
1287
1288    if src_texture.desc.format.is_depth_stencil_format() {
1289        state
1290            .device
1291            .require_downlevel_flags(wgt::DownlevelFlags::DEPTH_TEXTURE_AND_BUFFER_COPIES)
1292            .map_err(TransferError::from)?;
1293    }
1294
1295    let dst_raw = dst_buffer.try_raw(state.snatch_guard)?;
1296    dst_buffer
1297        .check_usage(BufferUsages::COPY_DST)
1298        .map_err(TransferError::MissingBufferUsage)?;
1299
1300    // This must happen after parameter validation (so that errors are reported
1301    // as required by the spec), but before any side effects.
1302    if copy_size.width == 0 || copy_size.height == 0 || copy_size.depth_or_array_layers == 0 {
1303        log::trace!("Ignoring copy_texture_to_buffer of size 0");
1304        return Ok(());
1305    }
1306
1307    // Handle texture init *before* dealing with barrier transitions so we
1308    // have an easier time inserting "immediate-inits" that may be required
1309    // by prior discards in rare cases.
1310    handle_src_texture_init(state, source, copy_size, src_texture)?;
1311
1312    let src_pending =
1313        state
1314            .tracker
1315            .textures
1316            .set_single(src_texture, src_range, wgt::TextureUses::COPY_SRC);
1317    let src_barrier = src_pending
1318        .map(|pending| pending.into_hal(src_raw))
1319        .collect::<Vec<_>>();
1320
1321    let dst_pending = state
1322        .tracker
1323        .buffers
1324        .set_single(dst_buffer, wgt::BufferUses::COPY_DST);
1325
1326    let dst_barrier = dst_pending.map(|pending| pending.into_hal(dst_buffer, state.snatch_guard));
1327
1328    handle_buffer_init(
1329        state,
1330        destination,
1331        CopySide::Destination,
1332        required_buffer_bytes_in_copy,
1333        is_contiguous,
1334    );
1335
1336    let regions = (0..array_layer_count)
1337        .map(|rel_array_layer| {
1338            let mut texture_base = src_base.clone();
1339            texture_base.array_layer += rel_array_layer;
1340            let mut buffer_layout = destination.layout;
1341            buffer_layout.offset += rel_array_layer as u64 * bytes_per_array_layer;
1342            hal::BufferTextureCopy {
1343                buffer_layout,
1344                texture_base,
1345                size: hal_copy_size,
1346            }
1347        })
1348        .collect::<Vec<_>>();
1349    unsafe {
1350        state.raw_encoder.transition_buffers(dst_barrier.as_slice());
1351        state.raw_encoder.transition_textures(&src_barrier);
1352        state.raw_encoder.copy_texture_to_buffer(
1353            src_raw,
1354            wgt::TextureUses::COPY_SRC,
1355            dst_raw,
1356            &regions,
1357        );
1358    }
1359
1360    Ok(())
1361}
1362
1363pub(super) fn copy_texture_to_texture(
1364    state: &mut EncodingState,
1365    source: &TexelCopyTextureInfo,
1366    destination: &TexelCopyTextureInfo,
1367    copy_size: &Extent3d,
1368) -> Result<(), CommandEncoderError> {
1369    let src_texture = &source.texture;
1370    let dst_texture = &destination.texture;
1371
1372    src_texture.same_device(state.device)?;
1373    dst_texture.same_device(state.device)?;
1374
1375    // src and dst texture format must be copy-compatible
1376    // https://gpuweb.github.io/gpuweb/#copy-compatible
1377    if src_texture.desc.format.remove_srgb_suffix() != dst_texture.desc.format.remove_srgb_suffix()
1378    {
1379        return Err(TransferError::TextureFormatsNotCopyCompatible {
1380            src_format: src_texture.desc.format,
1381            dst_format: dst_texture.desc.format,
1382        }
1383        .into());
1384    }
1385
1386    let (src_copy_size, array_layer_count) =
1387        validate_texture_copy_range(source, &src_texture.desc, CopySide::Source, copy_size)?;
1388    let (dst_copy_size, _) = validate_texture_copy_range(
1389        destination,
1390        &dst_texture.desc,
1391        CopySide::Destination,
1392        copy_size,
1393    )?;
1394
1395    if Arc::as_ptr(src_texture) == Arc::as_ptr(dst_texture) {
1396        validate_copy_within_same_texture(
1397            source,
1398            destination,
1399            src_texture.desc.format,
1400            array_layer_count,
1401        )?;
1402    }
1403
1404    let (src_range, src_tex_base) = extract_texture_selector(source, copy_size, src_texture)?;
1405    let (dst_range, dst_tex_base) = extract_texture_selector(destination, copy_size, dst_texture)?;
1406    let src_texture_aspects = hal::FormatAspects::from(src_texture.desc.format);
1407    let dst_texture_aspects = hal::FormatAspects::from(dst_texture.desc.format);
1408    if src_tex_base.aspect != src_texture_aspects {
1409        return Err(TransferError::CopySrcMissingAspects.into());
1410    }
1411    if dst_tex_base.aspect != dst_texture_aspects {
1412        return Err(TransferError::CopyDstMissingAspects.into());
1413    }
1414
1415    if src_texture.desc.sample_count != dst_texture.desc.sample_count {
1416        return Err(TransferError::SampleCountNotEqual {
1417            src_sample_count: src_texture.desc.sample_count,
1418            dst_sample_count: dst_texture.desc.sample_count,
1419        }
1420        .into());
1421    }
1422
1423    let src_raw = src_texture.try_raw(state.snatch_guard)?;
1424    src_texture
1425        .check_usage(TextureUsages::COPY_SRC)
1426        .map_err(TransferError::MissingTextureUsage)?;
1427    let dst_raw = dst_texture.try_raw(state.snatch_guard)?;
1428    dst_texture
1429        .check_usage(TextureUsages::COPY_DST)
1430        .map_err(TransferError::MissingTextureUsage)?;
1431
1432    // This must happen after parameter validation (so that errors are reported
1433    // as required by the spec), but before any side effects.
1434    if copy_size.width == 0 || copy_size.height == 0 || copy_size.depth_or_array_layers == 0 {
1435        log::trace!("Ignoring copy_texture_to_texture of size 0");
1436        return Ok(());
1437    }
1438
1439    // Handle texture init *before* dealing with barrier transitions so we
1440    // have an easier time inserting "immediate-inits" that may be required
1441    // by prior discards in rare cases.
1442    handle_src_texture_init(state, source, copy_size, src_texture)?;
1443    handle_dst_texture_init(state, destination, copy_size, dst_texture)?;
1444
1445    let src_pending =
1446        state
1447            .tracker
1448            .textures
1449            .set_single(src_texture, src_range, wgt::TextureUses::COPY_SRC);
1450
1451    //TODO: try to avoid this the collection. It's needed because both
1452    // `src_pending` and `dst_pending` try to hold `trackers.textures` mutably.
1453    let mut barriers: ArrayVec<_, 2> = src_pending
1454        .map(|pending| pending.into_hal(src_raw))
1455        .collect();
1456
1457    let dst_pending =
1458        state
1459            .tracker
1460            .textures
1461            .set_single(dst_texture, dst_range, wgt::TextureUses::COPY_DST);
1462    barriers.extend(dst_pending.map(|pending| pending.into_hal(dst_raw)));
1463
1464    let hal_copy_size = hal::CopyExtent {
1465        width: src_copy_size.width.min(dst_copy_size.width),
1466        height: src_copy_size.height.min(dst_copy_size.height),
1467        depth: src_copy_size.depth.min(dst_copy_size.depth),
1468    };
1469
1470    let dst_format = dst_texture.desc.format;
1471
1472    let regions = (0..array_layer_count).map(|rel_array_layer| {
1473        let mut src_base = src_tex_base.clone();
1474        let mut dst_base = dst_tex_base.clone();
1475        src_base.array_layer += rel_array_layer;
1476        dst_base.array_layer += rel_array_layer;
1477        hal::TextureCopy {
1478            src_base,
1479            dst_base,
1480            size: hal_copy_size,
1481        }
1482    });
1483
1484    let regions = if dst_tex_base.aspect == hal::FormatAspects::DEPTH_STENCIL {
1485        regions
1486            .flat_map(|region| {
1487                let (mut depth, mut stencil) = (region.clone(), region);
1488                depth.src_base.aspect = hal::FormatAspects::DEPTH;
1489                depth.dst_base.aspect = hal::FormatAspects::DEPTH;
1490                stencil.src_base.aspect = hal::FormatAspects::STENCIL;
1491                stencil.dst_base.aspect = hal::FormatAspects::STENCIL;
1492                [depth, stencil]
1493            })
1494            .collect::<Vec<_>>()
1495    } else if let Some(plane_count) = dst_format.planes() {
1496        regions
1497            .into_iter()
1498            .flat_map(|region| {
1499                (0..plane_count).map(move |plane| {
1500                    let mut plane_region = region.clone();
1501
1502                    let plane_aspect = wgt::TextureAspect::from_plane(plane)
1503                        .expect("expected texture aspect to exist for the plane");
1504                    let plane_aspect = hal::FormatAspects::new(dst_format, plane_aspect);
1505                    plane_region.src_base.aspect = plane_aspect;
1506                    plane_region.dst_base.aspect = plane_aspect;
1507
1508                    let (w_subsampling, h_subsampling) =
1509                        dst_format.subsampling_factors(Some(plane));
1510                    plane_region.src_base.origin.x /= w_subsampling;
1511                    plane_region.src_base.origin.y /= h_subsampling;
1512                    plane_region.dst_base.origin.x /= w_subsampling;
1513                    plane_region.dst_base.origin.y /= h_subsampling;
1514
1515                    plane_region.size.width /= w_subsampling;
1516                    plane_region.size.height /= h_subsampling;
1517
1518                    plane_region
1519                })
1520            })
1521            .collect::<Vec<_>>()
1522    } else {
1523        regions.collect::<Vec<_>>()
1524    };
1525    unsafe {
1526        state.raw_encoder.transition_textures(&barriers);
1527        state.raw_encoder.copy_texture_to_texture(
1528            src_raw,
1529            wgt::TextureUses::COPY_SRC,
1530            dst_raw,
1531            &regions,
1532        );
1533    }
1534
1535    Ok(())
1536}