将开源渲染引擎bgfx移植出Android版本

起因

之前看云风的博客说他们正在弄一个游戏引擎,用的就是bgfx库作为渲染库,结果这么久了游戏引擎还没开源出来,所以我就先弄弄bgfx。

GitHub有一个像是用bgfx的Android版本,项目地址是:https://github.com/Nodrev/bgfx-android-activity。打开看了一眼代码,发现这简直就是一个坑,哪里有半分bgfx代码的影子。所以就自己捣鼓了一个。

捣鼓的过程中遇到很多问题,比如CMake用着不熟,Android Studio用着不熟等等,逐步解决问题的过程就是一个积累成长的过程(没错,之前的文章也都是为了这次的移植所总结的)。

准备工作

首先要从github中clone三个项目,分别是bxbimgbgfx将这三个项目放到同一个目录下,这样,引用起来会比较方便。

然后,从google-samples里拷贝一份native-activity项目出来,将它放到前三个项目的同级目录下。完成之后,笔者的目录结构就是这个样子:

bgfx-ancroid-activity是github上别人移植bgfx的项目,就是笔者之前说的坑!

移植思路

从上面的项目选择就能看出,笔者采用的是NativeActivity的方式来显示界面。这样,项目中就不须要一行Java代码就能显示出想要的东西。

这一点,native-activity项目本身的配置就足以满足需要,如图:


需要编译成库的东西

用vs打开bgfx的解决方案,从工程列表中大致可以看出需要将哪些代码编译成库:



bgfx本身需要两个基础工程,分别是bimg和bx,这两个工程笔者之前已经下载完了。从工程目录来看,bx只需要编译成一个库,就是bx。bimg则需要编译成两个库,一个是bimg,另一个是bimg-decode。在添加编译命令的时候,笔者就把它分成了两个库来编译。然后,bgfx需要一个库,这点是毫无疑问的。这些是引擎的部分。

还有example的公共模块库,就是上图中的example-common。example-common工程中有3个库,分别是dear-imgui,ib-compress和其本身。

所以,需要编译的库大致有:
bx
bimg
bimg-decode
bgfx
dear-imgui
ib-compress
example-common

添加CMakeLists文件

因为笔者用的Android Studio版本是3.0.1,而且笔者也不熟悉原有的ndk-build编译方式,所以笔者选择了使用CMake作为编译器,在项目中添加CMakeLists文件来编译所有的库。主模块只有一个CMakeLists文件,位于src/main/cpp目录下面,该文件的完整内容是:

# 指定编译所需的CMake最低版本
cmake_minimum_required(VERSION 3.4.1)

# 设置c++编译器的编译选项:使用gnu++11库,打开警告开关,将所有警告当成错误处理
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=gnu++11 -Wall -Werror")

# 添加bx库
set(bx_dir ../../../../../bx)
add_subdirectory(${bx_dir} bx)

# 添加bimg库
set(bimg_dir ../../../../../bimg)
add_subdirectory(${bimg_dir} bimg)

# 添加bimg-decode库
set(bimg-decode_dir ../../../../../bimg/src)
add_subdirectory(${bimg-decode_dir} bimg-decode)

# 添加dear-imgui库
set(dear-imgui_dir ../../../../../bgfx/3rdparty/dear-imgui)
add_subdirectory(${dear-imgui_dir} dear-imgui)

# 添加ib-compress库
set(ib-compress_dir ../../../../../bgfx/3rdparty/ib-compress)
add_subdirectory(${ib-compress_dir} ib-compress)

# 添加bgfx库
set(bgfx_dir ../../../../../bgfx)
add_subdirectory(${bgfx_dir} bgfx)

# 添加examples-common库
set(examples-common_dir ../../../../../bgfx/examples/common)
add_subdirectory(${examples-common_dir} examples-common)

set(CMAKE_SHARED_LINKER_FLAGS
    "${CMAKE_SHARED_LINKER_FLAGS} -u ANativeActivity_onCreate")

# 编译成共享库
add_library(native-activity SHARED main.cpp)

# 设置目标库的包含目录
target_include_directories(native-activity PRIVATE
    ${ANDROID_NDK}/sources/android/native_app_glue
    ${bx_dir}/include
    ${bimg_dir}/include
    ${bgfx_dir}/include
    ${bgfx_dir}/3rdparty
    ${examples-common_dir})

# 设置目标库的链接库
target_link_libraries(native-activity
    bgfx
    examples-common
    dear-imgui)

看上去很长,关键点并不多,我们一个个来看。

首先是set和add_subdirectory:

set(bx_dir ../../../../../bx)    # 这一行是设置bx_dir变量,将其设置为../../../../../bx
add_subdirectory(${bx_dir} bx)  # 这是添加子目录的命令,CMake会从指定的目录中读取CMakeLists.txt文件,并且编译,生成指定的库(bx)。${bx_dir}就是引用上面设置的变量

然后是add_library:

add_library(native-activity SHARED main.cpp)    # 将main.cpp编译成共享库,共享库的名字是native-activity

接着是target_include_directories:

target_include_directories(native-activity PRIVATE
    ${ANDROID_NDK}/sources/android/native_app_glue
    ${bx_dir}/include
    ${bimg_dir}/include
    ${bgfx_dir}/include
    ${bgfx_dir}/3rdparty
    ${examples-common_dir})    # 设置native-activity库的包含目录,PRIVATE的意思是这些包含目录只对native-activity起作用,这里我们设置了很多目录

最后是target_link_libraries:

target_link_libraries(native-activity
    bgfx
    examples-common
    dear-imgui)    # 添加native-activity的链接库,只有三个:bgfx、examples-common、dear-imgui

对照着这个文件,把bxbimgbimg-decodebgfxdear-imguiib-compress的CMakeLists文件都添加好。这里要把example-common项目的CMakeLists单独说一下:

set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=gnu++11 -Wall -fno-exceptions -fno-rtti")

add_library (examples-common STATIC
             debugdraw/debugdraw.cpp
             entry/cmd.cpp
             entry/entry.cpp
             entry/entry_android.cpp
             entry/entry_asmjs.cpp
             entry/entry_glfw.cpp
             entry/entry_noop.cpp
             entry/entry_sdl.cpp
             entry/entry_windows.cpp
             entry/entry_x11.cpp
             entry/input.cpp
             font/font_manager.cpp
             font/text_buffer_manager.cpp
             font/text_metrics.cpp
             font/utf8.cpp
             imgui/imgui.cpp
             imgui/scintilla.cpp
             nanovg/nanovg.cpp
             nanovg/nanovg_bgfx.cpp
             ps/particle_system.cpp
             bgfx_utils.cpp
             bounds.cpp
             camera.cpp
             cube_atlas.cpp
             example-glue.cpp)

target_include_directories (examples-common PRIVATE
                            ${ANDROID_NDK}/sources/android/native_app_glue
                            ../../../bx/include
                            ../../../bimg/include
                            ../../include
                            ../../3rdparty)

target_link_libraries (examples-common
                       bx
                       bimg
                       bimg-decode
                       ib-compress
                       bgfx
                       android
                       log
                       EGL
                       GLESv2)  # 这里注意,一定要加上android、log、EGL、GLESv2,这些库都是必要的

和原有的native-activity项目不同,examples-common库才是和Android系统对接的库,所以像android、EGL这些库都需要链接到examples-common上才行。原本native_app_glue库就不需要了,因为android_native_app_glue.c文件已经被包含到entry/entry_android.cpp文件中。

严重吐槽bgfx这种include源文件的方式,增加很多找依赖文件的时间!

添加实现代码

这一步操作非常简单,先把bgfx/examples/00-helloworld中的logo.h文件放到native-activity项目中去,放到src/main/cpp/目录下面,和main.cpp同级。然后,将helloworld.cpp中的代码复制到main.cpp文件中,全部复制过去,将main.cpp原有的代码全部删除。

编译运行,不出意外的话,就能在模拟器上得到这样的结果:


运行效果

有问题的话也不要紧,到笔者的GitHub上把上面提到的那些东西clone下来,用Android Studio打开native-activity项目就可以编译运行了。

剩下的坑

没错,还有坑没有解决,那就是点击界面上的Exit按钮会崩溃,吼吼,不打算去改了,水平有限。

参考资料

程序员的自我修养-链接、装载与库:让你知道隐藏在IDE之后的过程

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

推荐阅读更多精彩内容