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<String, 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<String, 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_layer_range = if texture.desc.dimension == wgt::TextureDimension::D3 {
658        // Init tracking only considers array layers, not depth/volume slices
659        0..1
660    } else {
661        copy_texture.origin.z..copy_texture.origin.z + copy_size.depth_or_array_layers
662    };
663    let init_action = TextureInitTrackerAction {
664        texture: texture.clone(),
665        range: TextureInitRange {
666            mip_range: copy_texture.mip_level..copy_texture.mip_level + 1,
667            layer_range: init_layer_range,
668        },
669        kind: init_kind,
670    };
671
672    // Register the init action.
673    let immediate_inits = state
674        .texture_memory_actions
675        .register_init_action(&{ init_action });
676
677    // In rare cases we may need to insert an init operation immediately onto the command buffer.
678    if !immediate_inits.is_empty() {
679        for init in immediate_inits {
680            clear_texture(
681                &init.texture,
682                TextureInitRange {
683                    mip_range: init.mip_level..(init.mip_level + 1),
684                    layer_range: init.layer..(init.layer + 1),
685                },
686                state.raw_encoder,
687                &mut state.tracker.textures,
688                &state.device.alignments,
689                state.device.zero_buffer.as_ref(),
690                state.snatch_guard,
691                state.device.instance_flags,
692            )?;
693        }
694    }
695
696    Ok(())
697}
698
699/// Prepare a transfer's source texture.
700///
701/// Ensure the source texture of a transfer is in the right initialization
702/// state, and record the state for after the transfer operation.
703fn handle_src_texture_init(
704    state: &mut EncodingState,
705    source: &TexelCopyTextureInfo,
706    copy_size: &Extent3d,
707    texture: &Arc<Texture>,
708) -> Result<(), TransferError> {
709    handle_texture_init(
710        state,
711        MemoryInitKind::NeedsInitializedMemory,
712        source,
713        copy_size,
714        texture,
715    )?;
716    Ok(())
717}
718
719/// Prepare a transfer's destination texture.
720///
721/// Ensure the destination texture of a transfer is in the right initialization
722/// state, and record the state for after the transfer operation.
723fn handle_dst_texture_init(
724    state: &mut EncodingState,
725    destination: &wgt::TexelCopyTextureInfo<Arc<Texture>>,
726    copy_size: &Extent3d,
727    texture: &Arc<Texture>,
728) -> Result<(), TransferError> {
729    // Attention: If we don't write full texture subresources, we need to a full
730    // clear first since we don't track subrects. This means that in rare cases
731    // even a *destination* texture of a transfer may need an immediate texture
732    // init.
733    let dst_init_kind =
734        if has_copy_partial_init_tracker_coverage(copy_size, destination, &texture.desc) {
735            MemoryInitKind::NeedsInitializedMemory
736        } else {
737            MemoryInitKind::ImplicitlyInitialized
738        };
739
740    handle_texture_init(state, dst_init_kind, destination, copy_size, texture)?;
741    Ok(())
742}
743
744/// Handle initialization tracking for a transfer's source or destination buffer.
745///
746/// Ensures that the transfer will not read from uninitialized memory, and updates
747/// the initialization state information to reflect the transfer.
748fn handle_buffer_init(
749    state: &mut EncodingState,
750    info: &wgt::TexelCopyBufferInfo<Arc<Buffer>>,
751    direction: CopySide,
752    required_buffer_bytes_in_copy: BufferAddress,
753    is_contiguous: bool,
754) {
755    const ALIGN_SIZE: BufferAddress = wgt::COPY_BUFFER_ALIGNMENT;
756    const ALIGN_MASK: BufferAddress = wgt::COPY_BUFFER_ALIGNMENT - 1;
757
758    let buffer = &info.buffer;
759    let start = info.layout.offset;
760    let end = info.layout.offset + required_buffer_bytes_in_copy;
761    if !is_contiguous || direction == CopySide::Source {
762        // If the transfer will read the buffer, then the whole region needs to
763        // be initialized.
764        //
765        // If the transfer will not write a contiguous region of the buffer,
766        // then we need to make sure the padding areas are initialized. For now,
767        // initialize the whole region, although this could be improved to
768        // initialize only the necessary parts if doing so is likely to be
769        // faster than initializing the whole thing.
770        //
771        // Adjust the start/end outwards to 4B alignment.
772        let aligned_start = start & !ALIGN_MASK;
773        let aligned_end = (end + ALIGN_MASK) & !ALIGN_MASK;
774        state
775            .buffer_memory_init_actions
776            .extend(buffer.initialization_status.read().create_action(
777                buffer,
778                aligned_start..aligned_end,
779                MemoryInitKind::NeedsInitializedMemory,
780            ));
781    } else {
782        // If the transfer will write a contiguous region of the buffer, then we
783        // don't need to initialize that region.
784        //
785        // However, if the start and end are not 4B aligned, we need to make
786        // sure that we don't end up trying to initialize non-4B-aligned regions
787        // later.
788        //
789        // Adjust the start/end inwards to 4B alignment, we will handle the
790        // first/last pieces differently.
791        let aligned_start = (start + ALIGN_MASK) & !ALIGN_MASK;
792        let aligned_end = end & !ALIGN_MASK;
793        if aligned_start != start {
794            state.buffer_memory_init_actions.extend(
795                buffer.initialization_status.read().create_action(
796                    buffer,
797                    aligned_start - ALIGN_SIZE..aligned_start,
798                    MemoryInitKind::NeedsInitializedMemory,
799                ),
800            );
801        }
802        if aligned_start != aligned_end {
803            state.buffer_memory_init_actions.extend(
804                buffer.initialization_status.read().create_action(
805                    buffer,
806                    aligned_start..aligned_end,
807                    MemoryInitKind::ImplicitlyInitialized,
808                ),
809            );
810        }
811        if aligned_end != end {
812            // It is possible that `aligned_end + ALIGN_SIZE > dst_buffer.size`,
813            // because `dst_buffer.size` is the user-requested size, not the
814            // final size of the buffer. The final size of the buffer is not
815            // readily available, but was rounded up to COPY_BUFFER_ALIGNMENT,
816            // so no overrun is possible.
817            state.buffer_memory_init_actions.extend(
818                buffer.initialization_status.read().create_action(
819                    buffer,
820                    aligned_end..aligned_end + ALIGN_SIZE,
821                    MemoryInitKind::NeedsInitializedMemory,
822                ),
823            );
824        }
825    }
826}
827
828impl Global {
829    pub fn command_encoder_copy_buffer_to_buffer(
830        &self,
831        command_encoder_id: CommandEncoderId,
832        source: BufferId,
833        source_offset: BufferAddress,
834        destination: BufferId,
835        destination_offset: BufferAddress,
836        size: Option<BufferAddress>,
837    ) -> Result<(), EncoderStateError> {
838        profiling::scope!("CommandEncoder::copy_buffer_to_buffer");
839        api_log!(
840            "CommandEncoder::copy_buffer_to_buffer {source:?} -> {destination:?} {size:?}bytes"
841        );
842
843        let hub = &self.hub;
844
845        let cmd_enc = hub.command_encoders.get(command_encoder_id);
846        let mut cmd_buf_data = cmd_enc.data.lock();
847
848        cmd_buf_data.push_with(|| -> Result<_, CommandEncoderError> {
849            Ok(ArcCommand::CopyBufferToBuffer {
850                src: self.resolve_buffer_id(source)?,
851                src_offset: source_offset,
852                dst: self.resolve_buffer_id(destination)?,
853                dst_offset: destination_offset,
854                size,
855            })
856        })
857    }
858
859    pub fn command_encoder_copy_buffer_to_texture(
860        &self,
861        command_encoder_id: CommandEncoderId,
862        source: &TexelCopyBufferInfo,
863        destination: &wgt::TexelCopyTextureInfo<TextureId>,
864        copy_size: &Extent3d,
865    ) -> Result<(), EncoderStateError> {
866        profiling::scope!("CommandEncoder::copy_buffer_to_texture");
867        api_log!(
868            "CommandEncoder::copy_buffer_to_texture {:?} -> {:?} {copy_size:?}",
869            source.buffer,
870            destination.texture
871        );
872
873        let cmd_enc = self.hub.command_encoders.get(command_encoder_id);
874
875        let mut cmd_buf_data = cmd_enc.data.lock();
876
877        cmd_buf_data.push_with(|| -> Result<_, CommandEncoderError> {
878            let texture = self.resolve_texture_id(destination.texture);
879            texture.check_valid()?;
880            Ok(ArcCommand::CopyBufferToTexture {
881                src: wgt::TexelCopyBufferInfo::<Arc<Buffer>> {
882                    buffer: self.resolve_buffer_id(source.buffer)?,
883                    layout: source.layout,
884                },
885                dst: wgt::TexelCopyTextureInfo::<Arc<Texture>> {
886                    texture,
887                    mip_level: destination.mip_level,
888                    origin: destination.origin,
889                    aspect: destination.aspect,
890                },
891                size: *copy_size,
892            })
893        })
894    }
895
896    pub fn command_encoder_copy_texture_to_buffer(
897        &self,
898        command_encoder_id: CommandEncoderId,
899        source: &wgt::TexelCopyTextureInfo<TextureId>,
900        destination: &TexelCopyBufferInfo,
901        copy_size: &Extent3d,
902    ) -> Result<(), EncoderStateError> {
903        profiling::scope!("CommandEncoder::copy_texture_to_buffer");
904        api_log!(
905            "CommandEncoder::copy_texture_to_buffer {:?} -> {:?} {copy_size:?}",
906            source.texture,
907            destination.buffer
908        );
909
910        let cmd_enc = self.hub.command_encoders.get(command_encoder_id);
911
912        let mut cmd_buf_data = cmd_enc.data.lock();
913
914        cmd_buf_data.push_with(|| -> Result<_, CommandEncoderError> {
915            let texture = self.resolve_texture_id(source.texture);
916            texture.check_valid()?;
917            Ok(ArcCommand::CopyTextureToBuffer {
918                src: wgt::TexelCopyTextureInfo::<Arc<Texture>> {
919                    texture,
920                    mip_level: source.mip_level,
921                    origin: source.origin,
922                    aspect: source.aspect,
923                },
924                dst: wgt::TexelCopyBufferInfo::<Arc<Buffer>> {
925                    buffer: self.resolve_buffer_id(destination.buffer)?,
926                    layout: destination.layout,
927                },
928                size: *copy_size,
929            })
930        })
931    }
932
933    pub fn command_encoder_copy_texture_to_texture(
934        &self,
935        command_encoder_id: CommandEncoderId,
936        source: &wgt::TexelCopyTextureInfo<TextureId>,
937        destination: &wgt::TexelCopyTextureInfo<TextureId>,
938        copy_size: &Extent3d,
939    ) -> Result<(), EncoderStateError> {
940        profiling::scope!("CommandEncoder::copy_texture_to_texture");
941        api_log!(
942            "CommandEncoder::copy_texture_to_texture {:?} -> {:?} {copy_size:?}",
943            source.texture,
944            destination.texture
945        );
946
947        let cmd_enc = self.hub.command_encoders.get(command_encoder_id);
948
949        let mut cmd_buf_data = cmd_enc.data.lock();
950
951        cmd_buf_data.push_with(|| -> Result<_, CommandEncoderError> {
952            let src_texture = self.resolve_texture_id(source.texture);
953            let dst_texture = self.resolve_texture_id(destination.texture);
954            src_texture.check_valid()?;
955            dst_texture.check_valid()?;
956            Ok(ArcCommand::CopyTextureToTexture {
957                src: wgt::TexelCopyTextureInfo {
958                    texture: src_texture,
959                    mip_level: source.mip_level,
960                    origin: source.origin,
961                    aspect: source.aspect,
962                },
963                dst: wgt::TexelCopyTextureInfo {
964                    texture: dst_texture,
965                    mip_level: destination.mip_level,
966                    origin: destination.origin,
967                    aspect: destination.aspect,
968                },
969                size: *copy_size,
970            })
971        })
972    }
973}
974
975pub(super) fn copy_buffer_to_buffer(
976    state: &mut EncodingState,
977    src_buffer: &Arc<Buffer>,
978    source_offset: BufferAddress,
979    dst_buffer: &Arc<Buffer>,
980    destination_offset: BufferAddress,
981    size: Option<BufferAddress>,
982) -> Result<(), CommandEncoderError> {
983    if src_buffer.is_equal(dst_buffer) {
984        return Err(TransferError::SameSourceDestinationBuffer.into());
985    }
986
987    src_buffer.same_device(state.device)?;
988
989    let src_pending = state
990        .tracker
991        .buffers
992        .set_single(src_buffer, wgt::BufferUses::COPY_SRC);
993
994    let src_raw = src_buffer.try_raw(state.snatch_guard)?;
995    src_buffer
996        .check_usage(BufferUsages::COPY_SRC)
997        .map_err(TransferError::MissingBufferUsage)?;
998    // expecting only a single barrier
999    let src_barrier = src_pending.map(|pending| pending.into_hal(src_buffer, state.snatch_guard));
1000
1001    dst_buffer.same_device(state.device)?;
1002
1003    let dst_pending = state
1004        .tracker
1005        .buffers
1006        .set_single(dst_buffer, wgt::BufferUses::COPY_DST);
1007
1008    let dst_raw = dst_buffer.try_raw(state.snatch_guard)?;
1009    dst_buffer
1010        .check_usage(BufferUsages::COPY_DST)
1011        .map_err(TransferError::MissingBufferUsage)?;
1012    let dst_barrier = dst_pending.map(|pending| pending.into_hal(dst_buffer, state.snatch_guard));
1013
1014    if source_offset > src_buffer.size {
1015        return Err(TransferError::BufferStartOffsetOverrun {
1016            start_offset: source_offset,
1017            buffer_size: src_buffer.size,
1018            side: CopySide::Source,
1019        }
1020        .into());
1021    }
1022    let size = size.unwrap_or_else(|| {
1023        // NOTE: Should never underflow because of our earlier check.
1024        src_buffer.size - source_offset
1025    });
1026
1027    if !size.is_multiple_of(wgt::COPY_BUFFER_ALIGNMENT) {
1028        return Err(TransferError::UnalignedCopySize(size).into());
1029    }
1030    if !source_offset.is_multiple_of(wgt::COPY_BUFFER_ALIGNMENT) {
1031        return Err(TransferError::UnalignedBufferOffset(source_offset).into());
1032    }
1033    if !destination_offset.is_multiple_of(wgt::COPY_BUFFER_ALIGNMENT) {
1034        return Err(TransferError::UnalignedBufferOffset(destination_offset).into());
1035    }
1036    if !state
1037        .device
1038        .downlevel
1039        .flags
1040        .contains(wgt::DownlevelFlags::UNRESTRICTED_INDEX_BUFFER)
1041        && (src_buffer.usage.contains(BufferUsages::INDEX)
1042            || dst_buffer.usage.contains(BufferUsages::INDEX))
1043    {
1044        let forbidden_usages = BufferUsages::VERTEX
1045            | BufferUsages::UNIFORM
1046            | BufferUsages::INDIRECT
1047            | BufferUsages::STORAGE;
1048        if src_buffer.usage.intersects(forbidden_usages)
1049            || dst_buffer.usage.intersects(forbidden_usages)
1050        {
1051            return Err(TransferError::MissingDownlevelFlags(MissingDownlevelFlags(
1052                wgt::DownlevelFlags::UNRESTRICTED_INDEX_BUFFER,
1053            ))
1054            .into());
1055        }
1056    }
1057
1058    if size > src_buffer.size - source_offset {
1059        return Err(TransferError::BufferEndOffsetOverrun {
1060            start_offset: source_offset,
1061            size,
1062            buffer_size: src_buffer.size,
1063            side: CopySide::Source,
1064        }
1065        .into());
1066    }
1067    // NOTE: Should never overflow because of our earlier check.
1068    let source_end_offset = source_offset + size;
1069
1070    if destination_offset > dst_buffer.size {
1071        return Err(TransferError::BufferStartOffsetOverrun {
1072            start_offset: destination_offset,
1073            buffer_size: dst_buffer.size,
1074            side: CopySide::Destination,
1075        }
1076        .into());
1077    }
1078    // NOTE: Should never underflow because of our earlier check.
1079    if size > dst_buffer.size - destination_offset {
1080        return Err(TransferError::BufferEndOffsetOverrun {
1081            start_offset: destination_offset,
1082            size,
1083            buffer_size: dst_buffer.size,
1084            side: CopySide::Destination,
1085        }
1086        .into());
1087    }
1088    // NOTE: Should never overflow because of our earlier check.
1089    let destination_end_offset = destination_offset + size;
1090
1091    // This must happen after parameter validation (so that errors are reported
1092    // as required by the spec), but before any side effects.
1093    if size == 0 {
1094        log::trace!("Ignoring copy_buffer_to_buffer of size 0");
1095        return Ok(());
1096    }
1097
1098    // Make sure source is initialized memory and mark dest as initialized.
1099    state
1100        .buffer_memory_init_actions
1101        .extend(dst_buffer.initialization_status.read().create_action(
1102            dst_buffer,
1103            destination_offset..destination_end_offset,
1104            MemoryInitKind::ImplicitlyInitialized,
1105        ));
1106    state
1107        .buffer_memory_init_actions
1108        .extend(src_buffer.initialization_status.read().create_action(
1109            src_buffer,
1110            source_offset..source_end_offset,
1111            MemoryInitKind::NeedsInitializedMemory,
1112        ));
1113
1114    let region = hal::BufferCopy {
1115        src_offset: source_offset,
1116        dst_offset: destination_offset,
1117        size: wgt::BufferSize::new(size).unwrap(),
1118    };
1119    let barriers = src_barrier
1120        .into_iter()
1121        .chain(dst_barrier)
1122        .collect::<Vec<_>>();
1123    unsafe {
1124        state.raw_encoder.transition_buffers(&barriers);
1125        state
1126            .raw_encoder
1127            .copy_buffer_to_buffer(src_raw, dst_raw, &[region]);
1128    }
1129
1130    Ok(())
1131}
1132
1133pub(super) fn copy_buffer_to_texture(
1134    state: &mut EncodingState,
1135    source: &wgt::TexelCopyBufferInfo<Arc<Buffer>>,
1136    destination: &wgt::TexelCopyTextureInfo<Arc<Texture>>,
1137    copy_size: &Extent3d,
1138) -> Result<(), CommandEncoderError> {
1139    let dst_texture = &destination.texture;
1140    let src_buffer = &source.buffer;
1141
1142    dst_texture.same_device(state.device)?;
1143    src_buffer.same_device(state.device)?;
1144
1145    let (hal_copy_size, array_layer_count) = validate_texture_copy_range(
1146        destination,
1147        &dst_texture.desc,
1148        CopySide::Destination,
1149        copy_size,
1150    )?;
1151
1152    let (dst_range, dst_base) = extract_texture_selector(destination, copy_size, dst_texture)?;
1153
1154    let src_raw = src_buffer.try_raw(state.snatch_guard)?;
1155    src_buffer
1156        .check_usage(BufferUsages::COPY_SRC)
1157        .map_err(TransferError::MissingBufferUsage)?;
1158
1159    let dst_raw = dst_texture.try_inner(state.snatch_guard)?.raw();
1160    dst_texture
1161        .check_usage(TextureUsages::COPY_DST)
1162        .map_err(TransferError::MissingTextureUsage)?;
1163
1164    validate_texture_copy_dst_format(dst_texture.desc.format, destination.aspect)?;
1165
1166    validate_texture_buffer_copy(
1167        destination,
1168        dst_base.aspect,
1169        &dst_texture.desc,
1170        &source.layout,
1171        true, // alignment required for buffer offset
1172    )?;
1173
1174    let (required_buffer_bytes_in_copy, bytes_per_array_layer, is_contiguous) =
1175        validate_linear_texture_data(
1176            &source.layout,
1177            dst_texture.desc.format,
1178            destination.aspect,
1179            src_buffer.size,
1180            CopySide::Source,
1181            copy_size,
1182        )?;
1183
1184    if dst_texture.desc.format.is_depth_stencil_format() {
1185        state
1186            .device
1187            .require_downlevel_flags(wgt::DownlevelFlags::DEPTH_TEXTURE_AND_BUFFER_COPIES)
1188            .map_err(TransferError::from)?;
1189    }
1190
1191    // This must happen after parameter validation (so that errors are reported
1192    // as required by the spec), but before any side effects.
1193    if copy_size.width == 0 || copy_size.height == 0 || copy_size.depth_or_array_layers == 0 {
1194        log::trace!("Ignoring copy_buffer_to_texture of size 0");
1195        return Ok(());
1196    }
1197
1198    // Handle texture init *before* dealing with barrier transitions so we
1199    // have an easier time inserting "immediate-inits" that may be required
1200    // by prior discards in rare cases.
1201    handle_dst_texture_init(state, destination, copy_size, dst_texture)?;
1202
1203    let src_pending = state
1204        .tracker
1205        .buffers
1206        .set_single(src_buffer, wgt::BufferUses::COPY_SRC);
1207    let src_barrier = src_pending.map(|pending| pending.into_hal(src_buffer, state.snatch_guard));
1208
1209    let dst_pending =
1210        state
1211            .tracker
1212            .textures
1213            .set_single(dst_texture, dst_range, wgt::TextureUses::COPY_DST);
1214    let dst_barrier = dst_pending
1215        .map(|pending| pending.into_hal(dst_raw))
1216        .collect::<Vec<_>>();
1217
1218    handle_buffer_init(
1219        state,
1220        source,
1221        CopySide::Source,
1222        required_buffer_bytes_in_copy,
1223        is_contiguous,
1224    );
1225
1226    let regions = (0..array_layer_count)
1227        .map(|rel_array_layer| {
1228            let mut texture_base = dst_base.clone();
1229            texture_base.array_layer += rel_array_layer;
1230            let mut buffer_layout = source.layout;
1231            buffer_layout.offset += rel_array_layer as u64 * bytes_per_array_layer;
1232            hal::BufferTextureCopy {
1233                buffer_layout,
1234                texture_base,
1235                size: hal_copy_size,
1236            }
1237        })
1238        .collect::<Vec<_>>();
1239
1240    unsafe {
1241        state.raw_encoder.transition_textures(&dst_barrier);
1242        state.raw_encoder.transition_buffers(src_barrier.as_slice());
1243        state
1244            .raw_encoder
1245            .copy_buffer_to_texture(src_raw, dst_raw, &regions);
1246    }
1247
1248    Ok(())
1249}
1250
1251pub(super) fn copy_texture_to_buffer(
1252    state: &mut EncodingState,
1253    source: &TexelCopyTextureInfo,
1254    destination: &wgt::TexelCopyBufferInfo<Arc<Buffer>>,
1255    copy_size: &Extent3d,
1256) -> Result<(), CommandEncoderError> {
1257    let src_texture = &source.texture;
1258    let dst_buffer = &destination.buffer;
1259
1260    src_texture.same_device(state.device)?;
1261    dst_buffer.same_device(state.device)?;
1262
1263    let (hal_copy_size, array_layer_count) =
1264        validate_texture_copy_range(source, &src_texture.desc, CopySide::Source, copy_size)?;
1265
1266    let (src_range, src_base) = extract_texture_selector(source, copy_size, src_texture)?;
1267
1268    let src_raw = src_texture.try_inner(state.snatch_guard)?.raw();
1269    src_texture
1270        .check_usage(TextureUsages::COPY_SRC)
1271        .map_err(TransferError::MissingTextureUsage)?;
1272
1273    if source.mip_level >= src_texture.desc.mip_level_count {
1274        return Err(TransferError::InvalidMipLevel {
1275            requested: source.mip_level,
1276            count: src_texture.desc.mip_level_count,
1277        }
1278        .into());
1279    }
1280
1281    validate_texture_copy_src_format(src_texture.desc.format, source.aspect)?;
1282
1283    validate_texture_buffer_copy(
1284        source,
1285        src_base.aspect,
1286        &src_texture.desc,
1287        &destination.layout,
1288        true, // alignment required for buffer offset
1289    )?;
1290
1291    let (required_buffer_bytes_in_copy, bytes_per_array_layer, is_contiguous) =
1292        validate_linear_texture_data(
1293            &destination.layout,
1294            src_texture.desc.format,
1295            source.aspect,
1296            dst_buffer.size,
1297            CopySide::Destination,
1298            copy_size,
1299        )?;
1300
1301    if src_texture.desc.format.is_depth_stencil_format() {
1302        state
1303            .device
1304            .require_downlevel_flags(wgt::DownlevelFlags::DEPTH_TEXTURE_AND_BUFFER_COPIES)
1305            .map_err(TransferError::from)?;
1306    }
1307
1308    let dst_raw = dst_buffer.try_raw(state.snatch_guard)?;
1309    dst_buffer
1310        .check_usage(BufferUsages::COPY_DST)
1311        .map_err(TransferError::MissingBufferUsage)?;
1312
1313    // This must happen after parameter validation (so that errors are reported
1314    // as required by the spec), but before any side effects.
1315    if copy_size.width == 0 || copy_size.height == 0 || copy_size.depth_or_array_layers == 0 {
1316        log::trace!("Ignoring copy_texture_to_buffer of size 0");
1317        return Ok(());
1318    }
1319
1320    // Handle texture init *before* dealing with barrier transitions so we
1321    // have an easier time inserting "immediate-inits" that may be required
1322    // by prior discards in rare cases.
1323    handle_src_texture_init(state, source, copy_size, src_texture)?;
1324
1325    let src_pending =
1326        state
1327            .tracker
1328            .textures
1329            .set_single(src_texture, src_range, wgt::TextureUses::COPY_SRC);
1330    let src_barrier = src_pending
1331        .map(|pending| pending.into_hal(src_raw))
1332        .collect::<Vec<_>>();
1333
1334    let dst_pending = state
1335        .tracker
1336        .buffers
1337        .set_single(dst_buffer, wgt::BufferUses::COPY_DST);
1338
1339    let dst_barrier = dst_pending.map(|pending| pending.into_hal(dst_buffer, state.snatch_guard));
1340
1341    handle_buffer_init(
1342        state,
1343        destination,
1344        CopySide::Destination,
1345        required_buffer_bytes_in_copy,
1346        is_contiguous,
1347    );
1348
1349    let regions = (0..array_layer_count)
1350        .map(|rel_array_layer| {
1351            let mut texture_base = src_base.clone();
1352            texture_base.array_layer += rel_array_layer;
1353            let mut buffer_layout = destination.layout;
1354            buffer_layout.offset += rel_array_layer as u64 * bytes_per_array_layer;
1355            hal::BufferTextureCopy {
1356                buffer_layout,
1357                texture_base,
1358                size: hal_copy_size,
1359            }
1360        })
1361        .collect::<Vec<_>>();
1362    unsafe {
1363        state.raw_encoder.transition_buffers(dst_barrier.as_slice());
1364        state.raw_encoder.transition_textures(&src_barrier);
1365        state.raw_encoder.copy_texture_to_buffer(
1366            src_raw,
1367            wgt::TextureUses::COPY_SRC,
1368            dst_raw,
1369            &regions,
1370        );
1371    }
1372
1373    Ok(())
1374}
1375
1376pub(super) fn copy_texture_to_texture(
1377    state: &mut EncodingState,
1378    source: &TexelCopyTextureInfo,
1379    destination: &TexelCopyTextureInfo,
1380    copy_size: &Extent3d,
1381) -> Result<(), CommandEncoderError> {
1382    let src_texture = &source.texture;
1383    let dst_texture = &destination.texture;
1384
1385    src_texture.same_device(state.device)?;
1386    dst_texture.same_device(state.device)?;
1387
1388    // src and dst texture format must be copy-compatible
1389    // (https://gpuweb.github.io/gpuweb/#copy-compatible), with an
1390    // extension allowing one plane of a planar source to be copied
1391    // into a single-plane destination of the matching format
1392    // (e.g. NV12 Plane0 -> R8Unorm, NV12 Plane1 -> Rg8Unorm).
1393    //
1394    // When taking this path, `copy_size` and `source.origin` are
1395    // interpreted in *plane* texels, not luma texels: copying NV12
1396    // Plane1 into an Rg8Unorm of size (W/2, H/2) requires
1397    // `copy_size = (W/2, H/2)`. The plane-extent check further down
1398    // enforces this against the subsampled plane extent, so a caller
1399    // passing luma-sized values gets a source-side error pointing at
1400    // the actual mistake rather than an opaque destination overrun.
1401    let src_fmt_no_srgb = src_texture.desc.format.remove_srgb_suffix();
1402    let dst_fmt_no_srgb = dst_texture.desc.format.remove_srgb_suffix();
1403    let planar_split_ok = src_fmt_no_srgb.is_multi_planar_format()
1404        && src_fmt_no_srgb.aspect_specific_format(source.aspect) == Some(dst_fmt_no_srgb);
1405    if src_fmt_no_srgb != dst_fmt_no_srgb && !planar_split_ok {
1406        return Err(TransferError::TextureFormatsNotCopyCompatible {
1407            src_format: src_texture.desc.format,
1408            dst_format: dst_texture.desc.format,
1409        }
1410        .into());
1411    }
1412
1413    let (src_copy_size, array_layer_count) =
1414        validate_texture_copy_range(source, &src_texture.desc, CopySide::Source, copy_size)?;
1415    let (dst_copy_size, _) = validate_texture_copy_range(
1416        destination,
1417        &dst_texture.desc,
1418        CopySide::Destination,
1419        copy_size,
1420    )?;
1421
1422    // For planar -> single-plane copies, re-check the source extent
1423    // in plane coordinates. `validate_texture_copy_range` above used
1424    // the full luma extent of the planar source, so it does not
1425    // catch a caller treating `copy_size` / `origin` as luma-sized
1426    // when targeting a subsampled plane (NV12/P010 plane 1).
1427    if planar_split_ok {
1428        // `planar_split_ok` implies `aspect_specific_format(source.aspect)`
1429        // returned `Some`, which is only true for `Plane{0,1,2}`.
1430        let plane = source.aspect.to_plane().expect("planar_split_ok aspect");
1431        let plane_extent = src_texture
1432            .desc
1433            .compute_render_extent(source.mip_level, Some(plane));
1434        let check = |dimension, start: u32, size: u32, plane_size: u32| {
1435            if start > plane_size || plane_size - start < size {
1436                Err(TransferError::TextureOverrun {
1437                    start_offset: start,
1438                    end_offset: start.wrapping_add(size),
1439                    texture_size: plane_size,
1440                    dimension,
1441                    side: CopySide::Source,
1442                })
1443            } else {
1444                Ok(())
1445            }
1446        };
1447        check(
1448            TextureErrorDimension::X,
1449            source.origin.x,
1450            copy_size.width,
1451            plane_extent.width,
1452        )?;
1453        check(
1454            TextureErrorDimension::Y,
1455            source.origin.y,
1456            copy_size.height,
1457            plane_extent.height,
1458        )?;
1459    }
1460
1461    if Arc::as_ptr(src_texture) == Arc::as_ptr(dst_texture) {
1462        validate_copy_within_same_texture(
1463            source,
1464            destination,
1465            src_texture.desc.format,
1466            array_layer_count,
1467        )?;
1468    }
1469
1470    let (src_range, src_tex_base) = extract_texture_selector(source, copy_size, src_texture)?;
1471    let (dst_range, dst_tex_base) = extract_texture_selector(destination, copy_size, dst_texture)?;
1472    let src_texture_aspects = hal::FormatAspects::from(src_texture.desc.format);
1473    let dst_texture_aspects = hal::FormatAspects::from(dst_texture.desc.format);
1474    // `planar_split_ok` already constrains `source.aspect` to a single plane.
1475    if src_tex_base.aspect != src_texture_aspects && !planar_split_ok {
1476        return Err(TransferError::CopySrcMissingAspects.into());
1477    }
1478    if dst_tex_base.aspect != dst_texture_aspects {
1479        return Err(TransferError::CopyDstMissingAspects.into());
1480    }
1481
1482    if src_texture.desc.sample_count != dst_texture.desc.sample_count {
1483        return Err(TransferError::SampleCountNotEqual {
1484            src_sample_count: src_texture.desc.sample_count,
1485            dst_sample_count: dst_texture.desc.sample_count,
1486        }
1487        .into());
1488    }
1489
1490    let src_raw = src_texture.try_inner(state.snatch_guard)?.raw();
1491    src_texture
1492        .check_usage(TextureUsages::COPY_SRC)
1493        .map_err(TransferError::MissingTextureUsage)?;
1494    let dst_raw = dst_texture.try_inner(state.snatch_guard)?.raw();
1495    dst_texture
1496        .check_usage(TextureUsages::COPY_DST)
1497        .map_err(TransferError::MissingTextureUsage)?;
1498
1499    // This must happen after parameter validation (so that errors are reported
1500    // as required by the spec), but before any side effects.
1501    if copy_size.width == 0 || copy_size.height == 0 || copy_size.depth_or_array_layers == 0 {
1502        log::trace!("Ignoring copy_texture_to_texture of size 0");
1503        return Ok(());
1504    }
1505
1506    // Handle texture init *before* dealing with barrier transitions so we
1507    // have an easier time inserting "immediate-inits" that may be required
1508    // by prior discards in rare cases.
1509    handle_src_texture_init(state, source, copy_size, src_texture)?;
1510    handle_dst_texture_init(state, destination, copy_size, dst_texture)?;
1511
1512    let src_pending =
1513        state
1514            .tracker
1515            .textures
1516            .set_single(src_texture, src_range, wgt::TextureUses::COPY_SRC);
1517
1518    //TODO: try to avoid this the collection. It's needed because both
1519    // `src_pending` and `dst_pending` try to hold `trackers.textures` mutably.
1520    let mut barriers: ArrayVec<_, 2> = src_pending
1521        .map(|pending| pending.into_hal(src_raw))
1522        .collect();
1523
1524    let dst_pending =
1525        state
1526            .tracker
1527            .textures
1528            .set_single(dst_texture, dst_range, wgt::TextureUses::COPY_DST);
1529    barriers.extend(dst_pending.map(|pending| pending.into_hal(dst_raw)));
1530
1531    let hal_copy_size = hal::CopyExtent {
1532        width: src_copy_size.width.min(dst_copy_size.width),
1533        height: src_copy_size.height.min(dst_copy_size.height),
1534        depth: src_copy_size.depth.min(dst_copy_size.depth),
1535    };
1536
1537    let dst_format = dst_texture.desc.format;
1538
1539    let regions = (0..array_layer_count).map(|rel_array_layer| {
1540        let mut src_base = src_tex_base.clone();
1541        let mut dst_base = dst_tex_base.clone();
1542        src_base.array_layer += rel_array_layer;
1543        dst_base.array_layer += rel_array_layer;
1544        hal::TextureCopy {
1545            src_base,
1546            dst_base,
1547            size: hal_copy_size,
1548        }
1549    });
1550
1551    let regions = if dst_tex_base.aspect == hal::FormatAspects::DEPTH_STENCIL {
1552        regions
1553            .flat_map(|region| {
1554                let (mut depth, mut stencil) = (region.clone(), region);
1555                depth.src_base.aspect = hal::FormatAspects::DEPTH;
1556                depth.dst_base.aspect = hal::FormatAspects::DEPTH;
1557                stencil.src_base.aspect = hal::FormatAspects::STENCIL;
1558                stencil.dst_base.aspect = hal::FormatAspects::STENCIL;
1559                [depth, stencil]
1560            })
1561            .collect::<Vec<_>>()
1562    } else if let Some(plane_count) = dst_format.planes() {
1563        regions
1564            .into_iter()
1565            .flat_map(|region| {
1566                (0..plane_count).map(move |plane| {
1567                    let mut plane_region = region.clone();
1568
1569                    let plane_aspect = wgt::TextureAspect::from_plane(plane)
1570                        .expect("expected texture aspect to exist for the plane");
1571                    let plane_aspect = hal::FormatAspects::new(dst_format, plane_aspect);
1572                    plane_region.src_base.aspect = plane_aspect;
1573                    plane_region.dst_base.aspect = plane_aspect;
1574
1575                    let (w_subsampling, h_subsampling) =
1576                        dst_format.subsampling_factors(Some(plane));
1577                    plane_region.src_base.origin.x /= w_subsampling;
1578                    plane_region.src_base.origin.y /= h_subsampling;
1579                    plane_region.dst_base.origin.x /= w_subsampling;
1580                    plane_region.dst_base.origin.y /= h_subsampling;
1581
1582                    plane_region.size.width /= w_subsampling;
1583                    plane_region.size.height /= h_subsampling;
1584
1585                    plane_region
1586                })
1587            })
1588            .collect::<Vec<_>>()
1589    } else {
1590        regions.collect::<Vec<_>>()
1591    };
1592    unsafe {
1593        state.raw_encoder.transition_textures(&barriers);
1594        state.raw_encoder.copy_texture_to_texture(
1595            src_raw,
1596            wgt::TextureUses::COPY_SRC,
1597            dst_raw,
1598            &regions,
1599        );
1600    }
1601
1602    Ok(())
1603}