Hazel 开源项目教程

Hazel 开源项目教程

Hazel Hazel Engine 项目地址: https://gitcode.com/gh_mirrors/ha/Hazel

1. 项目的目录结构及介绍

Hazel/
├── Hazel/
│   ├── Assets/
│   ├── Hazel/
│   │   ├── Core/
│   │   ├── Platform/
│   │   ├── Renderer/
│   │   ├── Scripting/
│   │   └── Utils/
│   ├── Sandbox/
│   └── vendor/
├── .gitignore
├── CMakeLists.txt
├── LICENSE
└── README.md

目录结构介绍

• Hazel/: 项目的主目录，包含所有核心代码和资源。
  • Assets/: 存放项目的资源文件，如图片、音频等。
  • Hazel/: 核心代码目录，包含项目的各个模块。
    • Core/: 项目的核心功能模块。
    • Platform/: 平台相关的代码，如窗口管理、输入处理等。
    • Renderer/: 渲染相关的代码，负责图形渲染。
    • Scripting/: 脚本相关的代码，可能用于扩展功能。
    • Utils/: 工具类和辅助功能的代码。
  • Sandbox/: 沙盒项目，用于测试和演示Hazel引擎的功能。
  • vendor/: 第三方库和依赖项的存放目录。
• .gitignore: Git忽略文件，指定哪些文件和目录不需要被版本控制。
• CMakeLists.txt: CMake构建文件，用于配置和构建项目。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档，包含项目的基本信息和使用指南。

2. 项目的启动文件介绍

项目的启动文件通常位于 Hazel/Sandbox/ 目录下，具体文件名为 SandboxApp.cpp 或 SandboxApp.h。这个文件是沙盒项目的入口点，负责初始化引擎并启动应用程序。

启动文件示例

// SandboxApp.cpp
#include "Hazel.h"

class Sandbox : public Hazel::Application
{
public:
    Sandbox()
    {
        // 初始化代码
    }

    ~Sandbox()
    {
        // 清理代码
    }
};

Hazel::Application* Hazel::CreateApplication()
{
    return new Sandbox();
}

启动文件功能

• 初始化: 在构造函数中初始化引擎和应用程序的各个组件。
• 运行: 通过 Hazel::Application::Run() 方法启动应用程序的主循环。
• 清理: 在析构函数中清理资源，确保应用程序正常退出。

3. 项目的配置文件介绍

项目的配置文件通常位于项目根目录下，文件名为 CMakeLists.txt。这个文件用于配置项目的构建过程，包括编译选项、依赖项管理等。

配置文件示例

cmake_minimum_required(VERSION 3.10)
project(Hazel)

set(CMAKE_CXX_STANDARD 17)

# 添加Hazel核心库
add_library(Hazel
    Hazel/Core/Application.cpp
    Hazel/Core/Layer.cpp
    # 其他源文件
)

# 添加沙盒项目
add_executable(Sandbox
    Sandbox/SandboxApp.cpp
    # 其他源文件
)

# 链接Hazel库
target_link_libraries(Sandbox Hazel)

# 添加第三方库
add_subdirectory(vendor)

配置文件功能

• 设置编译器版本: 通过 set(CMAKE_CXX_STANDARD 17) 设置C++标准为C++17。
• 添加库和可执行文件: 使用 add_library 和 add_executable 添加Hazel库和沙盒项目。
• 链接库: 使用 target_link_libraries 将Hazel库链接到沙盒项目。
• 管理第三方库: 通过 add_subdirectory(vendor) 添加和管理第三方库。

通过以上配置，可以确保项目能够正确编译和运行。

Hazel Hazel Engine 项目地址: https://gitcode.com/gh_mirrors/ha/Hazel