CopyTexture
Adds a command to copy pixel data from one texture to another.
Read time 9 minutesLast updated 4 days ago
Definition
- Type: Method
- Namespace: UnityEngine.Rendering
- Assembly: UnityEngine.CoreModule
CopyTexture(RenderTargetIdentifier, RenderTargetIdentifier)
Adds a command to copy pixel data from one texture to another.
public void CopyTexture(RenderTargetIdentifier src, RenderTargetIdentifier dst)
Parameters
Remarks
This method adds a command to copy pixel data from one texture to another on the GPU. If you set Texture.isReadable to for both and textures, the method also copies pixel data on the CPU.
truesrcdstIf you set Texture.isReadable to , is one of the fastest ways to copy a texture. But to use , the following must be the same in both the source and destination texture areas:
falseCopyTextureCopyTexture- 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.
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 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 and its depth buffer set to a valid RenderTexture.depthStencilFormat.
srcNoneCompressed 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 mipmap level). For block-based formats (for instance, DXT, ETC), the region size and coordinates must be a multiple of compression block size (4 pixels for DXT).
Even if you set to true, this method doesn't copy pixel data on the CPU if you copy only a region of a compressed texture.
Texture.isReadableAdditional Resources: Graphics.CopyTexture, CopyTextureSupport.
CopyTexture(RenderTargetIdentifier, int, RenderTargetIdentifier, int)
Adds a command to copy pixel data from one texture to another.
public void CopyTexture(RenderTargetIdentifier src, int srcElement, RenderTargetIdentifier dst, int dstElement)
Parameters
The source texture or RenderTargetIdentifier.
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 if is a 2D texture.
0srcThe destination texture or RenderTargetIdentifier.
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 if is a 2D texture.
0dstRemarks
This method adds a command to copy pixel data from one texture to another on the GPU. If you set Texture.isReadable to for both and textures, the method also copies pixel data on the CPU.
truesrcdstIf you set Texture.isReadable to , is one of the fastest ways to copy a texture. But to use , the following must be the same in both the source and destination texture areas:
falseCopyTextureCopyTexture- 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.
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 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 and its depth buffer set to a valid RenderTexture.depthStencilFormat.
srcNoneCompressed 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 mipmap level). For block-based formats (for instance, DXT, ETC), the region size and coordinates must be a multiple of compression block size (4 pixels for DXT).
Even if you set to true, this method doesn't copy pixel data on the CPU if you copy only a region of a compressed texture.
Texture.isReadableAdditional Resources: Graphics.CopyTexture, CopyTextureSupport.
CopyTexture(RenderTargetIdentifier, int, int, RenderTargetIdentifier, int, int)
Adds a command to copy pixel data from one texture to another.
public void CopyTexture(RenderTargetIdentifier src, int srcElement, int srcMip, RenderTargetIdentifier dst, int dstElement, int dstMip)
Parameters
The source texture or RenderTargetIdentifier.
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 if is a 2D texture.
0srcThe mipmap level to copy from. The range is through the texture's Texture.mipmapCount. The default value is .
00The destination texture or RenderTargetIdentifier.
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 if is a 2D texture.
0dstThe mipmap level to write to. The range is through the texture's Texture.mipmapCount. The default value is .
00Remarks
This method adds a command to copy pixel data from one texture to another on the GPU. If you set Texture.isReadable to for both and textures, the method also copies pixel data on the CPU.
truesrcdstIf you set Texture.isReadable to , is one of the fastest ways to copy a texture. But to use , the following must be the same in both the source and destination texture areas:
falseCopyTextureCopyTexture- 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.
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 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 and its depth buffer set to a valid RenderTexture.depthStencilFormat.
srcNoneCompressed 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 mipmap level). For block-based formats (for instance, DXT, ETC), the region size and coordinates must be a multiple of compression block size (4 pixels for DXT).
Even if you set to true, this method doesn't copy pixel data on the CPU if you copy only a region of a compressed texture.
Texture.isReadableAdditional Resources: Graphics.CopyTexture, CopyTextureSupport.
CopyTexture(RenderTargetIdentifier, int, int, int, int, int, int, RenderTargetIdentifier, int, int, int, int)
Adds a command to copy pixel data from one texture to another.
public void CopyTexture(RenderTargetIdentifier src, int srcElement, int srcMip, int srcX, int srcY, int srcWidth, int srcHeight, RenderTargetIdentifier dst, int dstElement, int dstMip, int dstX, int dstY)
Parameters
The source texture or RenderTargetIdentifier.
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 if is a 2D texture.
0srcThe mipmap level to copy from. The range is through the texture's Texture.mipmapCount. The default value is .
00The starting x coordinate of to copy from. is the left of the texture.
src0The starting y coordinate of to copy from. is the bottom of the texture.
src0The width of to copy.
srcThe height of to copy.
srcThe destination texture or RenderTargetIdentifier.
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 if is a 2D texture.
0dstThe mipmap level to write to. The range is through the texture's Texture.mipmapCount. The default value is .
00The x coordinate of to copy to.
dstThe y coordinate to to copy to.
dstRemarks
This method adds a command to copy pixel data from one texture to another on the GPU. If you set Texture.isReadable to for both and textures, the method also copies pixel data on the CPU.
truesrcdstIf you set Texture.isReadable to , is one of the fastest ways to copy a texture. But to use , the following must be the same in both the source and destination texture areas:
falseCopyTextureCopyTexture- 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.
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 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 and its depth buffer set to a valid RenderTexture.depthStencilFormat.
srcNoneCompressed 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 mipmap level). For block-based formats (for instance, DXT, ETC), the region size and coordinates must be a multiple of compression block size (4 pixels for DXT).
Even if you set to true, this method doesn't copy pixel data on the CPU if you copy only a region of a compressed texture.
Texture.isReadableAdditional Resources: Graphics.CopyTexture, CopyTextureSupport.