GameFoundry/bsf引擎插件开发指南

GameFoundry/bsf引擎插件开发指南

【免费下载链接】bsf Modern C++14 library for the development of real-time graphical applications 项目地址: https://gitcode.com/gh_mirrors/bs/bsf

插件系统概述

GameFoundry/bsf引擎采用模块化架构设计，其中许多核心系统通过插件(Plugins)机制实现。插件是独立于引擎核心的动态库，可以在运行时灵活加载或卸载。这种架构为开发者提供了高度可扩展性，是扩展引擎功能的首选方式。

引擎支持的插件类型

bsf引擎目前支持以下主要系统的插件实现：

1. 音频系统插件：负责音频播放功能实现
2. 资源导入器插件：处理第三方资源格式到引擎内部格式的转换
3. 物理系统插件：执行物理模拟计算
4. 渲染器插件：决定场景的呈现方式（光照、阴影、后期处理等）
5. 渲染后端插件：对底层图形API（如DirectX、OpenGL、Vulkan）的封装

插件加载配置

开发者需要在应用程序启动时通过START_UP_DESC结构体配置需要加载的插件。以下是一个典型配置示例：

START_UP_DESC startUpDesc;

// 必需的核心插件配置
startUpDesc.renderAPI = "bsfD3D11RenderAPI";  // 渲染API插件
startUpDesc.renderer = "bsfRenderBeast";      // 渲染器插件
startUpDesc.audio = "bsfOpenAudio";           // 音频插件
startUpDesc.physics = "bsfPhysX";             // 物理插件
startUpDesc.input = "bsfOISInput";            // 输入插件

// 资源导入器插件列表
startUpDesc.importers.push_back("bsfFreeImgImporter");  // 纹理导入
startUpDesc.importers.push_back("bsfFBXImporter");      // 网格导入
startUpDesc.importers.push_back("bsfFontImporter");     // 字体导入
startUpDesc.importers.push_back("bsfSL");               // 着色器导入

// 启动应用
Application::startUp(startUpDesc);

创建自定义插件项目

CMake项目配置

bsf引擎使用CMake构建系统管理项目。创建自定义插件需要：

1. 在Source/Plugins目录下创建插件文件夹（如Source/Plugins/MyPlugin）
2. 创建CMakeLists.txt文件定义插件项目

示例CMake配置：

# 源文件集合
set(SOURCE_FILES
    "Include/MyHeader.h"
    "Source/MyPlugin.cpp"    
)

# 定义插件目标
add_library(MyPlugin SHARED ${SOURCE_FILES})

# 包含目录
target_include_directories(MyPlugin PRIVATE "./")

# 依赖库
target_link_libraries(MyPlugin PUBLIC bsf)

3. 在主CMakeLists.txt中注册插件项目：

add_subdirectory(Plugins/MyPlugin)

插件接口实现

bsf插件需要实现三个核心接口函数（均为可选）：

1. loadPlugin() - 插件加载时调用
2. updatePlugin() - 每帧调用
3. unloadPlugin() - 插件卸载前调用

典型实现示例：

class MyPlugin : Module<MyPlugin>
{
    // 插件实现类
};

// 插件加载函数
extern "C" BS_MYPLUGIN_EXPORT void* loadPlugin()
{
    MyPlugin::startUp();
    return nullptr;
}

// 插件更新函数
extern "C" BS_MYPLUGIN_EXPORT void updatePlugin()
{
    // 每帧逻辑
}

// 插件卸载函数
extern "C" BS_MYPLUGIN_EXPORT void unloadPlugin()
{
    MyPlugin::shutDown();
}

重要提示：插件创建的所有对象必须在插件卸载前销毁，否则可能导致虚函数表损坏和程序崩溃。

完全自定义插件开发

除了实现引擎预定义系统的插件外，开发者还可以创建完全自定义的插件。这类插件不受引擎接口约束，但需要手动管理加载/卸载过程。

手动加载插件

DynLib* pluginLib;
gApplication()::loadPlugin("MyPlugin", &pluginLib);
// 使用插件...
gApplication()::unloadPlugin(pluginLib);

动态调用插件函数

// 获取函数指针
typedef void* (*LoadPluginFunc)();
LoadPluginFunc loadPluginFunc = (LoadPluginFunc)pluginLib->getSymbol("loadPlugin");

// 调用函数
loadPluginFunc();

最佳实践建议

1. 资源管理：确保插件创建的资源生命周期得到妥善管理
2. 错误处理：在插件接口函数中添加适当的错误检查
3. 性能考量：updatePlugin()函数中的逻辑应保持高效
4. 线程安全：考虑多线程环境下的安全性
5. 依赖管理：明确声明插件的依赖关系

通过理解bsf引擎的插件系统，开发者可以灵活扩展引擎功能，实现高度定制化的游戏开发解决方案。

【免费下载链接】bsf Modern C++14 library for the development of real-time graphical applications 项目地址: https://gitcode.com/gh_mirrors/bs/bsf