Deno_sdl2 项目使用教程

1. 项目目录结构及介绍

Deno_sdl2 是一个为 Deno 提供 SDL2 绑定的开源项目。以下是项目的目录结构及其简单介绍：

deno_sdl2/
├── .github/                # GitHub 工作流和模板
│   └── workflows/
├── examples/               # 示例代码
├── tests/                  # 测试代码
├── webgpu-examples/        # 使用 WebGPU 的示例代码
├── .gitignore              # Git 忽略文件
├── .gitmodules             # Git 子模块配置
├── LICENSE                 # 项目许可证文件
├── README.md               # 项目自述文件
├── byte_type.ts            # 类型定义文件
├── deno.jsonc              # Deno 配置文件
├── deno.lock               # Deno 锁文件
└── mod.ts                  # 项目主模块文件

• .github/: 包含 GitHub Actions 工作流文件，用于自动化项目的一些操作，如测试、发布等。
• examples/: 包含了项目的一些使用示例，可以帮助开发者快速上手。
• tests/: 包含项目的测试代码，确保代码的质量和稳定性。
• webgpu-examples/: 包含了使用 WebGPU 技术的示例代码。
• .gitignore: 指定 Git 忽略的文件和目录，以避免将不必要的文件提交到仓库。
• .gitmodules: 如果项目包含子模块，该文件会列出这些子模块。
• LICENSE: 项目使用的许可证文件，本项目使用 MIT 许可证。
• README.md: 项目自述文件，介绍了项目的相关信息和使用方法。
• byte_type.ts: 类型定义文件，可能包含了对 SDL2 库的类型定义。
• deno.jsonc: Deno 的配置文件，可以包含项目的依赖和脚本。
• deno.lock: Deno 锁文件，确保项目在不同环境中使用相同的依赖版本。
• mod.ts: 项目的主模块文件，包含了 SDL2 的绑定和接口。

2. 项目的启动文件介绍

项目的启动文件是 mod.ts。该文件定义了与 SDL2 相关的接口和功能。开发者可以通过导入这个模块来使用 SDL2 的功能。以下是一个简单的示例：

import { WindowBuilder, EventType } from "jsr:@divy/sdl2@0.14";

const window = new WindowBuilder("Hello, Deno!", 640, 480).build();
const canvas = window.canvas();

for await (const event of window.events()) {
  if (event.type == EventType.Quit) {
    break;
  } else if (event.type == EventType.Draw) {
    // 在这里编写绘图逻辑
  }
}

在这个示例中，我们创建了一个窗口，并处理了绘制和退出事件。

3. 项目的配置文件介绍

项目的配置文件是 deno.jsonc。这个文件用于定义 Deno 项目的配置，例如指定依赖项和运行脚本。以下是一个配置文件的示例：

{
  "name": "deno_sdl2",
  "version": "0.14.0",
  "description": "SDL2 module for Deno",
  "main": "mod.ts",
  "dependencies": {
    // 在这里列出项目依赖
  },
  "scripts": {
    "start": "deno run --allow-env --allow-ffi mod.ts"
  }
}

在这个配置文件中，我们定义了项目的名称、版本和描述，指定了主文件 mod.ts，列出了项目依赖，并定义了一个运行项目的脚本 start。使用这个脚本，可以方便地启动项目。