Skip to main content Link Menu Expand (external link) Document Search 复制 已复制

此篇为使用 C++ 为 GM8 生成 dll 的扩展篇,在阅读此篇之前,请确保你已经阅读使用 C++ 为 GM8 生成 dll

GMAPI 是由国外神仙 Snake 所写的,能够在 C++ 的 DLL 中直接调用 GM 函数,并且获取内部数据的库。由于年代久远,该作者所提供的个人主页链接已经失效,故不在此贴出。

GMAPI 下载请点击此处

该篇教程部分代码参考自 FoxWriting 项目。(对的,比如下面某注释里的 vs2015 就是 fw 里的注释)

在 VS 中使用 GMAPI

配置项目

解压 GMAPI.zip,可以看到里面有两个文件夹:

Folder

将 GMAPI 下的所有 .h 与 .cpp 文件全部复制到项目下,并且导入:

Solution

项目->属性->链接器->常规->附加库目录中,添加 GMAPICore 文件夹的路径(注意,左上角选择所有配置):

GMAPICore

紧接着,在项目->属性->链接器->输入->附加依赖项中添加 GMAPICore.lib:

GMAPICore Lib

之后,在项目->属性->链接器->命令行中键入 /nodefaultlib:libci /SAFESEH:NO):

Command

初始化 GMAPI

在你自己的 “项目名.h” 头文件中,包含 Gmapi.h:

1
#include "Gmapi.h"

声明一个 CGMAPI全局指针,我们之后会用到它:

1
extern gm::CGMAPI *gmapi;

再进入到你的 “项目名.cpp” 文件中,在全局域定义该指针:

1
gm::CGMAPI *gmapi = nullptr;

然后来到 dllmain.cpp 中,先 #include 上你的 “项目名.h” 头文件,然后使用下面的代码替换你的 DllMain 函数:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
switch (ul_reason_for_call)
{
    case DLL_PROCESS_ATTACH:
    {
        DWORD result = 0;
        gmapi = gm::CGMAPI::Create(&result);
        // Check the initialization
        if (result == gm::GMAPI_INITIALIZATION_FAILED)
        {
            MessageBox(NULL, L"Unable to initialize GMAPI.", NULL, MB_SYSTEMMODAL | MB_ICONERROR);
            return FALSE;
        }
    }
    break;

    case DLL_THREAD_ATTACH:
    case DLL_THREAD_DETACH:
    break;

    case DLL_PROCESS_DETACH:
    gm::CGMAPI::Destroy();
    break;
}
return TRUE;

至此,GMAPI 初始化完毕。

调用 GM8 的函数

任何 GM8 中的函数,均可通过 gm::function_name(args) 的形式来使用。

使用 D3D8

D3D8DirectX 3D 8.0 版本。通过 D3D8 我们可以访问 GM8 的图像数据。D3D8 下载请点击此处

解压 d3d8.zip 并将其放在项目目录下。

项目->属性->VC++目录->包含目录中,添加 D3D8 的文件夹路径。注意,请将 D3D8 的路径放在包含目录的最后面,否则 winnt.h 会报错。

D3D8 Include

同样,在项目->属性->链接器->常规->附加库目录也添加 D3D8 的文件夹路径。(Debug 和 Release 最好分开配置)

D3D8 LIB

项目->属性->C/C++->预处理器->预处理器定义中,添加 GMAPI_USE_D3D_CRT_SECURE_NO_WARNINGS 两个宏。

D3D8 Macros

打开你的 “项目名.h“,包含 D3D8 的头文件以及库:

1
2
3
4
#include <d3d8.h>
#pragma comment (lib, "d3d8.lib")
#include <d3dx8.h>
#pragma comment (lib, "d3dx8.lib")

打开 dllmain.cpp,在 case DLL_PROCESS_ATTACH: 之后添加下面的代码:

1
2
3
4
5
{
    // 应对 vs2015 内联 sprintf 导致 d3d8.lib 找不到 _sprintf 的问题
    char f__kInline[1];
    sprintf(f__kInline, "");
}

此时,你的 dllmain.cpp 应该是这样的:

DllMain

GM8 的图像,背景图片,表面都是以材质储存的,我们可以通过 gm::xxx_get_texture() 的方式得到他们的材质索引 texid。

之后,我们可以使用:

1
IDirect3DTexture8 *texture = gm::CGMAPI::GetTextureArray()[texid].texture;

来获取对应的 D3D8 中的材质类型。如果你在预处理器中设置的宏没问题,那么 gm::CGMAPI::GetTextureArray()[texid].texture 应当返回一个 IDirect3DTexture8 * 类型的指针,反之则是 void * 类型。我们可以在 GmapiDefs.h 中第 29 行看出:

GMAPI Defs

我并不建议你修改图像和背景图片的材质,除非是你通过 sprite_add()background_add() 所创建的(事实上,FoxWriting 的原理就是修改一个精灵的材质,然后再绘制该精灵实现的)。更多情况下我们应当修改表面的材质。应当提醒一句,GMAPI 的效率并不高,形如 surface_set_target()screen_redraw() 之类的操作最好放在 GML 里去操作,然后将 surface 的 id 传入到 dll 中。

IDirect3DTexture8 有一个成员函数 LockRect 可以获取其数据并且修改。但是由于 GM8 的材质被设置为 D3DPOOL_DEFAULT,从 D3D8 文档中我们得知:

D3DPOOL DEFAULT

没办法,我们只好走一点弯路,先自己创建一个 IDirect3DTexture8,拷贝数据过来,修改完成后再 update 回去了。

为了防止每一次调用函数就创建一个额外的 IDirect3DTexture8,我们将我们的 IDirect3DTexture8 指针声明在全局域。方法类似于 gm::CGMAPI 的创建,不再赘述。假设它叫做 textureTemp 吧,我们使用下面的代码来修改其中的图像数据:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
IDirect3DTexture8 *texture = gm::CGMAPI::GetTextureArray()[texid].texture;
IDirect3DDevice8 *device;
texture->GetDevice(&device);
IDirect3DSurface8 *surface, *surfaceTemp;
// 创建 textureTemp,width 和 height 可以指定为 gm::surface_get_width(surfid) 和 gm::surface_get_height(surfid),考虑到效率也可以设置为全局变量。其中第五个变量就是与 GM8 的材质不同的点,GM8 的材质该参数是 D3DPOOL_DEFAULT。
if (textureTemp == nullptr)
    device->CreateTexture(width, height, 0, D3DUSAGE_DYNAMIC, D3DFMT_A8R8G8B8, D3DPOOL_SYSTEMMEM, &textureTemp);
texture->GetSurfaceLevel(0, &surface);
textureTemp->GetSurfaceLevel(0, &surfaceTemp);
// 拷贝数据
device->CopyRects(surface, NULL, 0, surfaceTemp, NULL);
D3DLOCKED_RECT lock;
textureTemp->LockRect(0, &lock, NULL, 0);
// imageData 为图像数据
unsigned *imageData = reinterpret_cast<unsigned *>(lock.pBits);
/*
    some_function_here();
    在此处处理imageData
*/
textureTemp->UnlockRect(0);
device->UpdateTexture(textureTemp, texture);

imageData 是一个无符号整数的数组,总长度是 width * height,每一个整数代表一个像素,格式为 AGBR。你可以这样获取红,绿,蓝,透明度值:

1
2
3
4
unsigned char red = imageData[i] & 0xFFU,
    green = (imageData[i] & 0xFF00U) >> 8,
    blue = (imageData[i] & 0xFF0000U) >> 16,
    alpha = (imageData[i] & 0xFF000000U) >> 24;

注意,由于 C++ 整型使用小端储存,如果你将该指针强制转换为 unsigned char * 指针,那么图像数据的顺序就是 R, G, B, A。值得注意的是,C++ 计算位运算远远快过四则运算,因此下面的代码反而比上面的慢。

1
2
3
4
5
6
unsigned char *imageData = reinterpret_cast<unsigned char *>(lock.pBits);
...
unsigned char red = imageData[i * 4];
    green = imageData[i * 4 + 1];
    blue = imageData[i * 4 + 2];
    alpha = imageData[i * 4 + 3];

例如,将图像灰度化:

1
2
3
4
5
6
7
unsigned gray;
for (int i = 0; i < width * height; i++)
{
    gray = ((imageData[i] & 0xFFU) + ((imageData[i] & 0xFF00U) >> 8) + ((imageData[i] & 0xFF0000U) >> 16)) / 3;
    // 强制设置透明度为 255 以防止 bm_normal 对表面的腐蚀。非 screen_redraw 的情况下应使用原透明度。
    imageData[i] = 0xFF000000U | gray << 16 | gray << 8 | gray;
}

我不得不提醒你,使用 CPU 来逐个像素处理是非常慢的,如果你想要制作类似 GMS 的 shader 的效果,我建议你使用 GPU 来处理,使用 openGLopenCV 等 GPU 库,或者 D3D8 自带的 LLSL(Low Level Shading Language)着色器,而不是使用 for 循环来逐个像素处理。再加上,GM8 本身效率也低,如果你的房间放了很多的东西,处理了很多逻辑,留给 C++ 的余地就更少了。具体在什么程度下会开始出现掉帧,不同的电脑不一样,可以自己试一试,但真的是稍微复杂点就掉帧。

你可能会问 LLSL 是什么,我怎么听说 D3D 用的是 HLSL(High Level Shading Language)?遗憾的是,HLSL 是 D3D9 才有的东西,然而 GMAPI 只支持 D3D8,而 D3D8 中使用的着色器也就是 LLSL,所谓低级着色器语言。

如果你只是需要写入,而不需要读取(就像 FoxWriting 那样),那就更简单了,你可以使用自己创建的 IDirect3DTexture8 直接顶替掉 gm::CGMAPI::GetTextureArray()[texid].texture 即可,也就是说:

1
gm::CGMAPI::GetTextureArray()[texid].texture = yourTextrue;

如果你想将 texture 保存为文件,你可以使用:

1
D3DXSaveTextureToFile(L"Enter Your File Path", D3DXIFF_BMP, texture, NULL);

粗略测试感觉这个函数的效率要高于 GM8 的 surface_save()

使用 OpenMP 加速 for 循环

如果你觉得学 GPU 编程太麻烦了,还是想用 CPU 使用 for 循环来逐个处理像素,那么你可以考虑使用 OpenMP 来加速 for 循环。

不过不要指望 OpenMP 能有非常惊人的提升,如果你的代码本来会让游戏掉到 30 帧,使用了 OpenMP 最多也就帮你提高到 40 多帧。优化 for 循环的结构,减少循环体的计算量才是更有效率的。

VS2017 自带 OpenMP,你只需要在项目->属性->C/C++->语言->OpenMP 支持选择是即可。

OpenMP

在你的 “项目名.h” 中 #include <omp.h>,在 for 循环前,加上

1
#pragma omp parallel for

即可。注意,OpenMP 通过多线程加速 for 循环,它不能保证 for 循环的顺序,(也就是说,i = 3 可能会比 i = 2早执行),因此,for 循环内部不应该存在可能会互相影响的代码。

例如,上述灰度化代码即可通过 OpenMP 加速:

1
2
3
4
5
6
#pragma omp parallel for
for (int i = 0; i < width * height; i++)
{
    gray = ((imageData[i] & 0xFFU) + ((imageData[i] & 0xFF00U) >> 8) + ((imageData[i] & 0xFF0000U) >> 16)) / 3;
    imageData[i] = 0xFF000000U | gray << 16 | gray << 8 | gray;
}

And More?

GMAPI 中还有更多底层的东西,比如 GM 变量的底层实现 gm::CGMVariable,精灵的底层实现 gm::GMSPRITE(其中包含有以 BYTE* 储存的图像比特数据)等等,因为我本人也并不是很能看懂 GMAPI(摊手),更多的功能就留给各位一起探索。