Version: 2023.1
言語: 日本語
ネイティブプラグイン
低レベルのネイティブプラグインインターフェース

デスクトップ向けのプラグインのビルド

Plug-ins for desktop platforms are libraries of native code you can write in C, C++ and Objective C. This page describes plug-ins for macOS, Windows, and Linux. For more information, refer to Native plug-ins.

macOS プラグイン

You can deploy macOS plug-ins as bundles or, if you are using the IL2CPP scripting backend, loose C++ files, which you can invoke with [DllImport("__Internal")] syntax. For further information on loose C++ plug-ins refer to C++ source code plugins for IL2CPP.

To create the bundle project with Xcode:

  1. Xcode を開きます。
  2. File > New > Project > macOS > Framework & Library > Bundle の順に選択します。

For more information about working with Xcode, refer to Apple’s documentation on Xcode.

要件

  • You can build your plug-in as a universal binary that’s compatible with 64-bit architectures. Alternatively, you can provide separate dylib files.
  • If you are using C++ (.cpp) or Objective-C (.mm) to implement the plug-in, declare the functions with C linkage to avoid name mangling issues:
extern "C"
{
  float ExamplePluginFunction ();
}

Windows プラグイン

Plug-ins on Windows are either .dll files with exported functions, or loose C++ files if you are using IL2CPP. You can use most languages and development environments that can create .dll files to create plug-ins. You must declare any C++ functions with C linkage to avoid name mangling issues.

Linux プラグイン

Plug-ins on Linux are .so files with exported functions. Although these libraries are usually in C or C++, you can use any language. You must declare any C++ functions with C linkage to avoid name mangling issues.

When you build the native plug-ins for Linux, if the built library has dependencies on another native plug-in, you must specify the rpath for that library while compiling it.

Add the linker flag -Wl, -rpath=$ORIGIN to specify the runtime search path. The linker flag instructs the loader to find its dependencies in the current directory of the library besides searching the system search path. You can add other linker flags along with -Wl, -rpath=$ORIGIN, however, Unity doesn’t control them. For example, /usr/bin/g++ -o binary.c.o -Wl,-rpath=$ORIGIN.

Alternatively, you can set LD_LIBRARY_PATH=dependency path in the environment to instruct the loader to search that path for dependencies. Linux doesn’t automatically search the current directory for dependencies. Make sure to set the correct dependency search path because incorrect path causes missing library errors in the Unity Editor.

Unity 内のプラグインの管理

In Unity, the Plugin Inspector manages your plug-ins. To access the Plugin Inspector, select a plug-in file in the Project window. For Standalone platforms you can choose the CPU architecture with which the library is compatible. For cross-platform plug-ins you must include the .bundle file (for macOS), the .dll file(for Windows), and the .so file (for Linux). Unity automatically picks the right plug-in for the target platform and includes it with the player. For further information, refer to Import and configure plug-ins.

Plugin Inspector
Plugin Inspector

C# スクリプトからプラグインを呼び出す

ビルドしたプラグインを Assets フォルダーまたは Unity プロジェクトの適切なアーキテクチャ固有のサブディレクトリに配置します。C# スクリプトから呼び出すと、Unity は名前でそれを見つけます。例: [DllImport ("PluginName")] private static extern float ExamplePluginFunction ();

ノート: PluginName がライブラリのプレフィックスやファイル拡張子を含まないように注意してください。例えば、プラグインファイルの実際の名前は、PluginName.dll (Windows の場合) や libPluginName.so (Linux の場合) にします。

プラグインの例

これらのプロジェクトをダウンロードして使用することで、Unity でのプラグイン実装の方法を学ぶことができます。

  • Simplest Plugin Example: このプロジェクトは、基本的な操作 (例えば、数値の表示、文字列の表示、2 つの float の加算、2 つの int の加算) を実装します。このプロジェクトには、Windows、macOS、Linux のプロジェクトファイルが含まれています。
  • Native Renderer Plugin: This is a low-level rendering plug-in that renders a rotating triangle from C++ code after all regular rendering is done and fills a procedural texture from C++ code, using Texture.GetNativeTexturePtr to access it. This project includes Windows, UWP, macOS, WebGL and Android files.
ネイティブプラグイン
低レベルのネイティブプラグインインターフェース
Copyright © 2023 Unity Technologies
优美缔软件(上海)有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961