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.
CloseFor 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.
Closesrc | The source 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 source texture's Texture.mipmapCount. The default value is 0 . |
dstMip | The mipmap level to write to. The range is 0 through this 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 this texture to copy to. |
dstY | The y coordinate to this texture to copy to. |
Copies pixel data from another texture on the CPU.
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 Apply after CopyPixels
to upload the changed pixels to the GPU.
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: Apply, Graphics.CopyTexture, SetPixels.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.