---
title: "copy(from:sourceOffset:sourceBytesPerRow:sourceBytesPerImage:sourceSize:to:destinationSlice:destinationLevel:destinationOrigin:options:)"
framework: metal
role: symbol
role_heading: Instance Method
path: "metal/mtlblitcommandencoder/copy(from:sourceoffset:sourcebytesperrow:sourcebytesperimage:sourcesize:to:destinationslice:destinationlevel:destinationorigin:options:)"
---

# copy(from:sourceOffset:sourceBytesPerRow:sourceBytesPerImage:sourceSize:to:destinationSlice:destinationLevel:destinationOrigin:options:)

Encodes a command to copy image data from a source buffer into a destination texture.

## Declaration

```swift
func copy(from sourceBuffer: any MTLBuffer, sourceOffset: Int, sourceBytesPerRow: Int, sourceBytesPerImage: Int, sourceSize: MTLSize, to destinationTexture: any MTLTexture, destinationSlice: Int, destinationLevel: Int, destinationOrigin: MTLOrigin, options: MTLBlitOption)
```

## Parameters

- `sourceBuffer`: A buffer the command copies data from.
- `sourceOffset`: A byte offset within sourceBuffer that the command copies from, which needs to be a multiple of the destination texture’s pixel size, in bytes.
- `sourceBytesPerRow`: The number of bytes between adjacent rows of pixels in the source buffer’s memory, which needs to be: A multiple of the source texture’s pixel size, in bytes Less than or equal to the product of the destination texture’s pixel size, in bytes, and the largest pixel width the destination texture’s type allows If destinationTexture uses a compressed pixel format, set sourceBytesPerRow to the number of bytes between the starts of two row blocks.
- `sourceBytesPerImage`: The number of bytes between each 2D image of a 3D texture. This value needs to be a multiple of the source texture’s pixel size, in bytes. Set this value to 0 for 2D textures, which means sourceSize.doc://com.apple.metal/documentation/Metal/MTLSize/depth is equal to 1.
- `sourceSize`: An doc://com.apple.metal/documentation/Metal/MTLSize instance, which can represent a 3D region, that instructs the command how many pixels to copy to destinationTexture, starting at destinationOrigin. Assign 1 to each dimension that’s not relevant to destinationTexture. For example: If the destination texture is a 2D texture, set the size’s doc://com.apple.metal/documentation/Metal/MTLSize/depth property to 1. If the destination texture is a 1D texture, set the size’s doc://com.apple.metal/documentation/Metal/MTLSize/height and doc://com.apple.metal/documentation/Metal/MTLSize/depth properties to 1. If destinationTexture uses a compressed pixel format, set sourceSize to a multiple of the pixel format’s block size. If the block extends outside the bounds of the texture, clamp sourceSize to the edge of the texture.
- `destinationTexture`: A texture with an doc://com.apple.metal/documentation/Metal/MTLTexture/isFramebufferOnly property value of doc://com.apple.documentation/documentation/Swift/false that the command copies data to.
- `destinationSlice`: A slice within destinationTexture. For textures that use a combined depth/stencil pixel format, configure the options parameter appropriately.
- `destinationLevel`: A mipmap level within destinationTexture.
- `destinationOrigin`: A location within destinationTexture that the command begins copying data to. Assign 0 to each dimension that’s not relevant to destinationTexture. For example: If the destination texture is a 2D texture, set the origin’s doc://com.apple.metal/documentation/Metal/MTLOrigin/z property to 0. If the destination texture is a 1D texture, set the origin’s doc://com.apple.metal/documentation/Metal/MTLOrigin/y and doc://com.apple.metal/documentation/Metal/MTLOrigin/z properties to 0.
- `options`: An option set that applies to textures with applicable pixel formats, such as combined depth/stencil or PVRTC formats. If the texture’s pixel format is a combined depth/stencil format, set options to either doc://com.apple.metal/documentation/Metal/MTLBlitOption/depthFromDepthStencil or doc://com.apple.metal/documentation/Metal/MTLBlitOption/stencilFromDepthStencil, but not both. If the texture’s pixel format is a PVRTC format, set options to doc://com.apple.metal/documentation/Metal/MTLBlitOption/rowLinearPVRTC.

## Discussion

Discussion Passing an empty OptionSet to the options parameter is the equivalent of calling copy(from:sourceOffset:sourceBytesPerRow:sourceBytesPerImage:sourceSize:to:destinationSlice:destinationLevel:destinationOrigin:). In Swift, pass [] to represent an empty option set, and in Objective-C, pass MTLBlitOptionNone.

## See Also

### Copying buffer data to a texture

- [copy(from:sourceOffset:sourceBytesPerRow:sourceBytesPerImage:sourceSize:to:destinationSlice:destinationLevel:destinationOrigin:)](metal/mtlblitcommandencoder/copy(from:sourceoffset:sourcebytesperrow:sourcebytesperimage:sourcesize:to:destinationslice:destinationlevel:destinationorigin:).md)