Version: 2018.2 (switch to 2018.3b or 2017.4)
LanguageEnglish
  • C#

Graphics.CopyTexture

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static void CopyTexture(Texture src, Texture dst);
public static void CopyTexture(Texture src, int srcElement, int srcMip, Texture dst, int dstElement, int dstMip);
public static void CopyTexture(Texture src, int srcElement, int srcMip, int srcX, int srcY, int srcWidth, int srcHeight, Texture dst, int dstElement, int dstMip, int dstX, int dstY);

Parameters

srcSource texture.
dstDestination texture.
srcElementSource texture element (cubemap face, texture array layer or 3D texture depth slice).
srcMipSource texture mipmap level.
dstElementDestination texture element (cubemap face, texture array layer or 3D texture depth slice).
dstMipDestination texture mipmap level.
srcXX coordinate of source texture region to copy (left side is zero).
srcYY coordinate of source texture region to copy (bottom is zero).
srcWidthWidth of source texture region to copy.
srcHeightHeight of source texture region to copy.
dstXX coordinate of where to copy region in destination texture (left side is zero).
dstYY coordinate of where to copy region in destination texture (bottom is zero).

Description

Copy texture contents.

This function allows copying pixel data from one texture into another efficiently. It also allows copying from an element (e.g. cubemap face) or a specific mip level, and from a subregion of a texture.

Copying does not do any scaling, i.e. source and destination sizes must be the same. Texture formats should be compatible (for example, TextureFormat.ARGB32 and RenderTextureFormat.ARGB32 are compatible). Exact rules for which formats are compatible vary a bit between graphics APIs; generally formats that are exactly the same can always be copied. On some platforms (e.g. D3D11) you can also copy between formats that are of the same bit width.

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).

If both source and destination textures are marked as "readable" (i.e. copy of data exists in system memory for reading/writing on the CPU), these functions copy it as well.

Some platforms might not have functionality of all sorts of texture copying (e.g. copy from a render texture into a regular texture). See CopyTextureSupport, and use SystemInfo.copyTextureSupport to check.

Calling Texture2D.Apply, Texture2DArray.Apply or Texture3D.Apply after CopyTexture yields undefined results as CopyTexture operates on GPU-side data exclusively, whereas Apply transfers data from CPU to GPU-side.

See Also: CopyTextureSupport.

Did you find this page useful? Please give it a rating: