IntPtr Pointer to an underlying graphics API Texture resource.
Retrieve a native (underlying graphics API) pointer to the Texture resource.
Use this function to retrieve a pointer/handle corresponding to a particular Texture
as it is represented on the native graphics API level.
This can be used to enable Texture manipulation from native code plugins.
Note: When you use the Unity APIs to modify the pixel data of a Texture object, it changes the underlying graphics API native pointer. Call GetNativeTexturePtr to get the new native pointer.
For specific platforms, Unity has the following specifications:
On Direct3D-like devices, Unity returns a pointer to the base Texture type (ID3D11Resource
on D3D11, ID3D12Resource
on D3D12).
On OpenGL-like devices, the GL Texture "name" is returned; cast the pointer to an integer type to get it.
On Metal, Unity returns an id<MTLTexture>
pointer.
On Vulkan, Unity returns an VkImage
pointer.
On platforms that do not support native code plug-ins, this function always returns NULL.
Note that calling this function when using multi-threaded rendering will synchronize with the rendering
thread (a slow operation), so best practice is to set up needed Texture pointers only at initialization
time.
See Also: Native code plugins, Texture2D.CreateExternalTexture, Cubemap.CreateExternalTexture, RenderTexture.GetNativeDepthBufferPtr.
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.