ドキュメント

Unity Engine

Unity Engine

ネイティブ プラグイン API の概要

ネイティブ プラグイン API ファイルを探し、ネイティブ プラグインにインポートします。
読み終わるまでの所要時間 9 分最終更新 5日前

Unity のネイティブ プラグインは、特定のイベントが発生するとコールバックを受け取ることができます。これを使用してプラグインに低レベルのレンダリングを実装し、Unity のマルチスレッドレンダリングで動作させることができます。

インターフェースレジストリ

Unity のメインイベントを処理するには、プラグインは
UnityPluginLoad
と
UnityPluginUnload
機能をエクスポートする必要があります。IUnityInterfaces を使用すると、プラグインはこれらの関数にアクセスできます。これらの関数は、プラグイン API の
IUnityInterface.h
にあります。
#include "IUnityInterface.h"#include "IUnityGraphics.h"// Unity plugin load eventextern "C" void UNITY_INTERFACE_EXPORT UNITY_INTERFACE_API UnityPluginLoad(IUnityInterfaces* unityInterfaces){ IUnityGraphics* graphics = unityInterfaces->Get<IUnityGraphics>();}

グラフィックスデバイスへのアクセス

IUnityGraphics.h
にある
IUnityGraphics
インターフェースを使用して、プラグインにジェネリックグラフィックスデバイス機能へのアクセスを提供します。このスクリプトは、
IUnityGraphics
インターフェースを使用してコールバックを登録する方法を示します。
#include "IUnityInterface.h"#include "IUnityGraphics.h" static IUnityInterfaces* s_UnityInterfaces = NULL;static IUnityGraphics* s_Graphics = NULL;static UnityGfxRenderer s_RendererType = kUnityGfxRendererNull; // Unity plugin load eventextern "C" void UNITY_INTERFACE_EXPORT UNITY_INTERFACE_API UnityPluginLoad(IUnityInterfaces* unityInterfaces){ s_UnityInterfaces = unityInterfaces; s_Graphics = unityInterfaces->Get<IUnityGraphics>(); s_Graphics->RegisterDeviceEventCallback(OnGraphicsDeviceEvent); // Run OnGraphicsDeviceEvent(initialize) manually on plugin load // to not miss the event in case the graphics device is already initialized OnGraphicsDeviceEvent(kUnityGfxDeviceEventInitialize);} // Unity plugin unload eventextern "C" void UNITY_INTERFACE_EXPORT UNITY_INTERFACE_API UnityPluginUnload(){ s_Graphics->UnregisterDeviceEventCallback(OnGraphicsDeviceEvent);} static void UNITY_INTERFACE_API OnGraphicsDeviceEvent(UnityGfxDeviceEventType eventType){ switch (eventType) { case kUnityGfxDeviceEventInitialize: { s_RendererType = s_Graphics->GetRenderer(); //TODO: user initialization code on graphics device initialization. 例えば、D3D11 リソース作成など。 break; } case kUnityGfxDeviceEventShutdown: { s_RendererType = kUnityGfxRendererNull; //TODO: user graphics API code to call on graphics device shutdown. break; } case kUnityGfxDeviceEventBeforeReset: { //TODO: user graphics API code to call before graphics device reset. break; } case kUnityGfxDeviceEventAfterReset: { //TODO: user graphics API code to call after graphics device reset. break; } };}

レンダリングスレッドのプラグインコールバック

プラットフォームと使用可能な CPU 数が許す限り、マルチスレッドを使用して Unity でレンダリングすることができます。
注
マルチスレッドレンダリングを使用する場合、レンダリング API コマンドは MonoBehaviour スクリプトを実行するスレッドとは完全に別のスレッドで実行されます。メインスレッドとレンダリングするスレッド間の通信は、メインスレッドがレンダリングするスレッドにプッシュした作業量に応じて、プラグインがすぐにレンダリングを開始しないことを意味します。
プラグインからレンダリングするには、マネージプラグインスクリプトから GL.IssuePluginEvent を呼び出します。これにより、以下のコード例に示すように、Unity のレンダーパイプラインがレンダリングするスレッドからネイティブ機能をコールします。例えば、カメラの OnPostRender 関数から GL.IssuePluginEvent をコールすると、カメラのレンダリングが完了した直後にプラグインコールバックが関数からコールされます。
ネイティブプラグインコード:
// Plugin function to handle a specific rendering eventstatic void UNITY_INTERFACE_API OnRenderEvent(int eventID){ // User rendering code} // Freely defined function to pass a callback to plugin-specific scriptsextern "C" UnityRenderingEvent UNITY_INTERFACE_EXPORT UNITY_INTERFACE_API GetRenderEventFunc(){ return OnRenderEvent;}
マネージプラグインコード:
#if UNITY_IPHONE && !UNITY_EDITOR[DllImport ("__Internal")]#else[DllImport("RenderingPlugin")]#endifprivate static extern IntPtr GetRenderEventFunc(); // Queue a specific callback to be called on the render threadGL.IssuePluginEvent(GetRenderEventFunc(), 1);
UnityRenderingEvent
コールバックのシグネチャは、IUnityGraphics.h のネイティブレンダリングプラグインサンプルで提供されています。

OpenGL グラフィックス API を使用したプラグイン

OpenGL オブジェクトには 2 種類あります。
  • テクスチャ、バッファ、レンダーバッファ、サンプラー、クエリ、シェーダー、プログラムオブジェクトなど、OpenGL コンテキストで共有されるオブジェクト。
  • 頂点配列、フレームバッファ、プログラムパイプライン、Transform フィードバック、同期オブジェクトなど、OpenGL ごとのコンテキストオブジェクト。
Unity は複数の OpenGL コンテキストを使用します。エディターとプレイヤーの初期化と終了時には、Unity はマスターコンテキストに依存しますが、レンダリング時には専用のコンテキストを使用します。つまり、
kUnityGfxDeviceEventInitialize
および
kUnityGfxDeviceEventShutdown
イベント中にコンテキストごとのオブジェクトを作成することはできません。

VulkanグラフィックスAPIを使用したプラグイン

Vulkan グラフィックス API を使用するネイティブグラフィックスプラグインを開発する場合は、妥当性検査レイヤーを通じてデバッグを有効にできます。検証レイヤーを有効にするには、プラグイン実行中のクラッシュを防ぐために以下の確認してください。
  • ネイティブグラフィックスプラグインと同じディレクトリに検証レイヤープラグインを追加します。
  • Plugin Inspector ウィンドウで、ネイティブと Vulkan 検証レイヤープラグインの両方に同じ起動時にロード設定を行います。

追加リソース