Create A Native Plugin for Unity

当 Unity 需要使用第三方的库的时候,特别是第三方开发库是使用 C/C++ 来实现的时候,我们就需要针对各个平台编译 Library 来供 Unity 使用。
最近刚刚有过一次封装经验,放在此供大家参考。

这里分三部分来介绍。

Unity 端函数声明

#if UNITY_STANDALONE_WIN || UNITY_EDITOR
public const string PluginName = "liblz4";
#else

#if UNITY_IOS || UNITY_XBOX360
// On iOS and Xbox 360 plugins are statically linked into
// the executable, so we have to use __Internal as the
// library name
public const string PluginName = "__Internal";
#else
// Other platforms load plugins dynamically, so pass the name
// of the plugin's dynamic library.
public const string PluginName = "lz4";
#endif
#endif

[DllImport(PluginName)]
static extern YOUR_RETURN_TYPE YOUR_FUNCTION_NAME(YOUR_PARAMETRES);

注意点:

  1. Standalone 平台, PluginName 就是动态库或者Bundle的名字;
  2. IOS 平台一般使用源文件就好,直接用 __Internal;
  3. Android 平台 PluginName 中不能有 lib 字段,导出的 so 中需要有 lib 字段,例如 liblz4.so。

封装代码

一般是一个头文件加上一个实现文件,头文件中声明函数,实现文件中实现函数。

函数声明格式

#ifdef _WIN32
#ifdef XXX_EXPORT
#define EXPORT_API  __declspec(dllexport)
#else
#define EXPORT_API __declspec(dllimport)
#endif
#else
#define EXPORT_API
#endif
extern "C" {
    EXPORT_API YOUR_RETURN_TYPE YOUR_FUNCTION_NAME(YOUR_PARAMETERS);
}

注意只有在 Windows 上需要在工程中设置 XXX_EXPORT 预处理变量。

C++ 对象参数怎么表示

在C#层使用 IntPtr 表示,在 C++ 层使用对象指针表示。
例如 Class A 作为函数参数:

// C++
EXPORT_API void Func(A* pA);
// C#
[DllImport(PluginName)]
static extern void Func(IntPtr a);

数组怎么传递

数组传递类似于对象传递,使用指针和一个数组长度字段表示即可。

List/Array 等对象怎么传递

转换成数组

平台库封装

Windows

Windows 使用 VisualStudio 来创建一个 Visual C++ 类库工程来编译,如下图所示。

image.png

然后注意导出的平台是 x86/x64 即可,注意需要在工程预处理器中声明 XXX_EXPORT, vs 提示缺少 stdafx.h 的时候设置配置属性->C/C++->预编译头不使用预编译头即可。

Mac

Mac 平台需要创建一个 Xcode Bundle 工程,如下图所示。

image.png

image.png

iOS

直接将 .c/.mm 放入工程就好,最为简单。

Android

需要下载 Android SDK 和 Android NDK, 使用 Android Studio 创建一个 Include C++ Support 的工程,然后将我们的 C/C++ 代码加入到工程中。最后使用 Android NDK 编译成 .so。

image.png

库文件存放位置

  1. Windows 放在 Plugins/x86(x64) 目录下;
  2. Mac 直接放在 Plugins 目录下;
  3. iOS 放在 Plugins/iOS 目录下;
  4. Android 放在 Plugins/Android/libs/armeabi-v7a 目录下。

注意点

  1. 如果修改了本地插件,需要将 dll 或者 bundle 覆盖了之后重启 Unity, 不然还是会使用老的 Native Plugin;
  2. 调试起来比较麻烦,建议使用文件的方式进行日志输出来进行比较。

Refs:

  1. Building Plugins for Desktop Platforms
  2. Building Plugins for iOS
  3. Building Plugins for Android
  4. 在OSX上开发UNITY本地插件的经验分享
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,047评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,807评论 3 386
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,501评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,839评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,951评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,117评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,188评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,929评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,372评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,679评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,837评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,536评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,168评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,886评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,129评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,665评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,739评论 2 351

推荐阅读更多精彩内容