eventID | User defined id to send to the callback. |
callback | Native code callback to queue for Unity's renderer to invoke. |
Send a user-defined event to a native code plugin.
Rendering in Unity can be multithreaded if the platform and number
of available CPUs will allow for it. When multithreaded rendering is
used, the rendering API commands happen on a thread which is
completely separate from the one that runs the scripts. Consequently,
it is not possible for your plugin to start rendering immediately,
since it might interfere with what the render thread is doing at the time.
In order to do any rendering from the plugin, you should call
GL.IssuePluginEvent from your script, which will cause your native
plugin to be called from the render thread. For example, if you
call GL.IssuePluginEvent from the camera's OnPostRender function, you'll
get a plugin callback immediately after the camera has finished rendering.
Callback must be a native function of "void UNITY_INTERFACE_API UnityRenderingEvent(int eventId)" signature.
See Native Plugin Interface for more details
and an example.
See Also: SystemInfo.graphicsMultiThreaded.
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.