Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


Low Level Native Plugin Rendering Extensions

Access low-level graphics device and rendering features from native plug-ins.
Read time 1 minuteLast updated 14 days ago

On top of the low-level native plug-in interface, Unity also supports low level rendering extensions that can receive callbacks when certain events happen. This is mostly used to implement and control low-level rendering in your plug-in and enable it to work with Unity’s multithreaded rendering.
Due to the low-level nature of this extension the plug-in might need to be preloaded before the devices get created. Currently the convention is name-based; the plug-in name must begin GfxPlugin (for example: GfxPluginMyNativePlugin).
The rendering extension definition exposed by Unity is in the file IUnityRenderingExtensions.h, provided with the Editor (see file path Unity\Editor\Data\PluginAPI).
All platforms supporting native plug-ins support these extensions.

Rendering extensions API

To take advantage of the rendering extension, a plug-in should export UnityRenderingExtEvent and optionally UnityRenderingExtQuery. There is a lot of documentation provided inside the include file.

plug-in callbacks on the rendering thread

A plug-in gets called via UnityRenderingExtEvent whenever Unity triggers one of the built-in events. The callbacks can also be added to CommandBuffers via CommandBuffer.IssuePluginEventAndData or CommandBuffer.IssuePluginCustomBlit from scripts.

Additional resources