| src | The source texture. |
| dst | The destination texture. |
| srcElement | The element in the source texture to copy from. For example, the CubemapFace in a Cubemap or the slice in a texture array. Set the value to 0 if src is a 2D texture. |
| srcMip | The mipmap level to copy from. The range is 0 through the texture's Texture.mipmapCount. The default value is 0. |
| dstElement | The element in the source texture to copy to. For example, the CubemapFace in a Cubemap or the slice in a texture array. Set the value to 0 if `dst` is a 2D texture. |
| dstMip | The mipmap level to write to. The range is 0 through the texture's Texture.mipmapCount. The default value is 0. |
| srcX | The starting x coordinate of src to copy from. 0 is the left of the texture. |
| srcY | The starting y coordinate of src to copy from. 0 is the bottom of the texture. |
| srcWidth | The width of src to copy. |
| srcHeight | The height of src to copy. |
| dstX | The x coordinate of dst to copy to. |
| dstY | The y coordinate to dst to copy to. |
Copies pixel data from one texture to another.
This method copies pixel data from one texture to another on the GPU. If you set Texture.isReadable to true for both src and dst textures, the method also copies pixel data on the CPU.
If you set Texture.isReadable to false, CopyTexture is one of the fastest ways to copy a texture. But to use CopyTexture, the following must be the same in both the source and destination texture areas:
You might be able to copy between incompatible formats depending on your graphics API. For example, on some APIs you can copy between formats with the same bit width.
Depending on your graphics API, you might not be able to copy between different types of textures. For more information on compatibility, see SystemInfo.copyTextureSupport and CopyTextureSupport.
If src is a depth-only render texture, you must copy the whole texture, not part of it. A depth-only render texture has its color buffer set to a color format of None and its depth buffer set to a valid RenderTexture.depthStencilFormat.
When you use Texture2D.ignoreMipmapLimit, textures can have a variety of mipmap limit settings. This means you may not be able to copy from one mipmap level to another, because for example the source texture is limited to half resolution and the destination texture is limited to quarter resolution.
You can load Textures at different resolutions by using QualitySettings.masterTextureLimit. Note that this affects CopyTextures as you cannot copy a full mip between textures with different master
texture limit values. If you need to copy between textures with a different master texture limit, use the region-based overload. The region-based overload adjusts the source rectangle based on the source
texture's master texture limit. It also adjusts the destination offset based on the destination's master texture limit. For example, copying a 128x128 area from position 16,16 to position 32,32 results
in the following behaviours in these example cases:
Mipmap level arguments always apply to the texture as loaded under the current master texture limit. For example, a 256x256 texture with master texture limit set to 0 mip 1 refers to a 128x128 mip.
However, if the mastertexture limit is set to 2 on that texture, mip 1 refers to a 32x32 mip. This means that in many cases when using CopyTexture you do not need to take the master texture limit into
account in your calls. In less common calls (for example, copying from Texture2D to TextureArray) you do need to adjust for it. To copy textures in a cubemap array, calculate the destination element as
6 * cubemapIndex + faceIndex. As a result, the six faces from the cubemap at index 0 are elements 0,1,2... 5. The six faces from the cubemap at array index 1 are 6,7 .... 11 and so on.
- Format. You can also use two compatible formats - for example, TextureFormat.ARGB32 and RenderTextureFormat.ARGB32.
- Size.
- RenderTexture.antiAliasing values, if the textures are render textures.
Mipmap level arguments always refer to a texture's currently loaded mipmap levels. For example, mip 1 of a 256x256 texture subject to a global texture mipmap limit of 0 refers to a 128x128 mip. However, for that same texture if the global texture mipmap limit is set to 1, mip 1 refers to a 64x64 mip. If we were to set the global texture mipmap limit to 2, mip 1 of that same texture would refer to a 32x32 mip, and so on...
This means when you use CopyTexture you do not need to take mipmap limit settings into account in your calls in most cases. However, if the source and destination's mipmap limit settings differ, you need to adjust for those settings. Keep in mind that non-2D texture types are always uploaded to the GPU at full resolution as they do not support mipmap limit settings of any sort.
Compressed texture formats add some restrictions to the CopyTexture with a region variant. For example, PVRTC formats
are not supported since they are not block-based (for these formats you can only copy whole texture or whole mip level).
For block-based formats (e.g. DXT, ETC), the region size and coordinates must be a multiple of compression block size
(4 pixels for DXT).
Even if you set Texture.isReadable to true, this method doesn't copy pixel data on the CPU if you copy only a region of a compressed texture.
Don't use an Apply method such as Texture2D.Apply after CopyTexture, because you might copy old or undefined CPU texture data to the GPU.
See Also: CopyTextureSupport.