Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

CopyPixels

Copies pixel data from another texture on the CPU.
Read time 5 minutesLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule

CopyPixels(Texture)

Copies pixel data from another texture on the CPU.
public void CopyPixels(Texture src)

Parameters

src

Texture
The source texture.

Remarks

This method copies pixel data from a source texture to this one on the CPU. Texture.isReadable must be 
true
for both the texture and 
src
, and you must call Texture3D.Apply after 
CopyPixels
to upload the changed pixels to the GPU.
Texture3D.Apply is an expensive operation because it copies all the pixels in the texture even if you've only changed some of the pixels, so change as many pixels as possible before you call it. If you only need to copy pixels on the GPU, Graphics.CopyTexture with GraphicsTexture parameters is faster to use instead.
To use 
CopyPixels
, the size to be copied must be the same in both textures. Use the region-based overload to specify a smaller region than a full mipmap level.
Crunch compressed texture formats are not supported in the element-based overload. Compressed texture formats are not supported at all for for the region-based overload. Unity throws a 
UnityException
if either texture is unreadable, and throws an 
ArgumentException
if 
CopyPixels
fails.
Additional Resources: Texture3D.Apply, Graphics.CopyTexture, Texture3D.SetPixels.

CopyPixels(Texture, int, int, int, int)

Copies pixel data from another texture on the CPU.
public void CopyPixels(Texture src, int srcElement, int srcMip, int dstElement, int dstMip)

Parameters

src

Texture
The source texture.

srcElement

int
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

int
The mipmap level to copy from. The range is 
0
through the source texture's Texture.mipmapCount. The default value is 
0
.

dstElement

int
The depth slice to copy to in this 3D texture.

dstMip

int
The mipmap level to write to. The range is 
0
through this texture's Texture.mipmapCount. The default value is 
0
.

Remarks

This method copies pixel data from a source texture to this one on the CPU. Texture.isReadable must be 
true
for both the texture and 
src
, and you must call Texture3D.Apply after 
CopyPixels
to upload the changed pixels to the GPU.
Texture3D.Apply is an expensive operation because it copies all the pixels in the texture even if you've only changed some of the pixels, so change as many pixels as possible before you call it. If you only need to copy pixels on the GPU, Graphics.CopyTexture with GraphicsTexture parameters is faster to use instead.
To use 
CopyPixels
, the size to be copied must be the same in both textures. Use the region-based overload to specify a smaller region than a full mipmap level.
Crunch compressed texture formats are not supported in the element-based overload. Compressed texture formats are not supported at all for for the region-based overload. Unity throws a 
UnityException
if either texture is unreadable, and throws an 
ArgumentException
if 
CopyPixels
fails.
Additional Resources: Texture3D.Apply, Graphics.CopyTexture, Texture3D.SetPixels.

CopyPixels(Texture, int, int, int, int, int, int, int, int, int, int)

Copies pixel data from another texture on the CPU.
public void CopyPixels(Texture src, int srcElement, int srcMip, int srcX, int srcY, int srcWidth, int srcHeight, int dstElement, int dstMip, int dstX, int dstY)

Parameters

src

Texture
The source texture.

srcElement

int
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

int
The mipmap level to copy from. The range is 
0
through the source texture's Texture.mipmapCount. The default value is 
0
.

srcX

int
The starting x coordinate of 
src
to copy from. 
0
is the left of the texture.

srcY

int
The starting y coordinate of 
src
to copy from. 
0
is the bottom of the texture.

srcWidth

int
The width of 
src
to copy.

srcHeight

int
The height of 
src
to copy.

dstElement

int
The depth slice to copy to in this 3D texture.

dstMip

int
The mipmap level to write to. The range is 
0
through this texture's Texture.mipmapCount. The default value is 
0
.

dstX

int
The x coordinate of this texture to copy to.

dstY

int
The y coordinate to this texture to copy to.

Remarks

This method copies pixel data from a source texture to this one on the CPU. Texture.isReadable must be 
true
for both the texture and 
src
, and you must call Texture3D.Apply after 
CopyPixels
to upload the changed pixels to the GPU.
Texture3D.Apply is an expensive operation because it copies all the pixels in the texture even if you've only changed some of the pixels, so change as many pixels as possible before you call it. If you only need to copy pixels on the GPU, Graphics.CopyTexture with GraphicsTexture parameters is faster to use instead.
To use 
CopyPixels
, the size to be copied must be the same in both textures. Use the region-based overload to specify a smaller region than a full mipmap level.
Crunch compressed texture formats are not supported in the element-based overload. Compressed texture formats are not supported at all for for the region-based overload. Unity throws a 
UnityException
if either texture is unreadable, and throws an 
ArgumentException
if 
CopyPixels
fails.
Additional Resources: Texture3D.Apply, Graphics.CopyTexture, Texture3D.SetPixels.