mirror of
https://github.com/MobileGL-Dev/MobileGL
synced 2026-09-08 04:08:32 +09:00
124 lines
5.0 KiB
Markdown
124 lines
5.0 KiB
Markdown
<h1 align="center">MobileGL</h1>
|
||
|
||
<p align="center">
|
||
<img src="https://img.shields.io/badge/Language-C%2B%2B-00599c?style=flat&logo=c%2B%2B" alt="C++">
|
||
<img src="https://img.shields.io/badge/License-GNU%20LGPL%203.0-00399c?style=flat" alt="GNU LGPL 3.0">
|
||
<img src="https://img.shields.io/badge/Status-Development-0078d7?style=flat" alt="Development">
|
||
</p>
|
||
|
||
<p align="center"><em>
|
||
A desktop OpenGL implementation
|
||
</em></p>
|
||
|
||
MobileGL is a *free* and *open-source* project that implements a desktop **OpenGL** API. The goal is to provide a complete desktop OpenGL implementation with a state management layer and multi-backend support.
|
||
|
||
> [!NOTE]
|
||
>
|
||
> **Status:** In development. Parts of the codebase are incomplete. Current short-term target: **OpenGL 3.3 (Core Profile)**.
|
||
|
||
## Project positioning
|
||
|
||
MobileGL is an implementation of a desktop OpenGL library. It aims to provide:
|
||
|
||
* Full OpenGL state management.
|
||
* A front-end that exposes OpenGL functions.
|
||
* Multiple independent backend implementations, where each backend targets a specific graphics API and remains fully isolated from others.
|
||
|
||
This project is intended as an implementation/translation layer.
|
||
|
||
## Key components
|
||
|
||
The repository is organized into following top-level modules:
|
||
|
||
1. **MG_State** — state tracking and management logic for Graphics APIs.
|
||
2. **MG_Impl** — front-end implementations of Graphics APIs that interact with `MG_State` and `MG_Backend`.
|
||
3. **MG_Backend** — per-backend translation layer that maps front-end Graphics APIs' semantics and state into concrete backend API calls (e.g. OpenGL ES, Vulkan).
|
||
4. **MG_Util** and other utility modules.
|
||
|
||
## Third-party components
|
||
|
||
MobileGL reuses several open-source projects:
|
||
|
||
* **SPIRV-Cross** by **KhronosGroup** - [Apache License 2.0](https://github.com/KhronosGroup/SPIRV-Cross/blob/master/LICENSE): [github](https://github.com/KhronosGroup/SPIRV-Cross)
|
||
* **glslang** by **KhronosGroup** - [Various Licenses](https://github.com/KhronosGroup/glslang/blob/main/LICENSE.txt): [github](https://github.com/KhronosGroup/glslang)
|
||
* **DiligentCore** by **Diligent Graphics** - [Apache License 2.0](https://github.com/DiligentGraphics/DiligentCore/blob/master/License.txt): [github](https://github.com/DiligentGraphics/DiligentCore)
|
||
|
||
Refer to each component's repository for exact license texts. Any bundled third-party code in this repository is included under the upstream project's license.
|
||
|
||
## Compatibility & target
|
||
|
||
* **Short-term target:** `OpenGL 3.3 (Core Profile)`.
|
||
* **Current development focus:**
|
||
* `MG_State` and `MG_Impl` for `OpenGL 3.3 (Core Profile)`
|
||
* `Direct (Vulkan)` backend
|
||
* `Direct (OpenGL ES)` backend
|
||
|
||
## Build Instructions
|
||
|
||
We currently provide **no releases** and **no precompiled binaries**.
|
||
If you want to try the project right now, you’ll need to build it yourself:
|
||
|
||
1. Clone the repository:
|
||
|
||
```sh
|
||
git clone https://github.com/MobileGL-Dev/MobileGL.git
|
||
```
|
||
|
||
2. Initialize and update all submodules recursively:
|
||
|
||
```sh
|
||
git submodule update --init --recursive
|
||
```
|
||
|
||
3. Follow glslang’s own documentation for its required initiation.
|
||
|
||
4. Configure and build the project with CMake:
|
||
|
||
```sh
|
||
cmake -B build
|
||
cmake --build build
|
||
```
|
||
|
||
or do it in a modern way:
|
||
|
||
```sh
|
||
cmake -S . -B build -G Ninja -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++
|
||
cmake --build build
|
||
```
|
||
|
||
Alternatively, you can use platform-specific build commands as needed.
|
||
|
||
## Build Options
|
||
|
||
| Option | Description | Default |
|
||
|------------------------------| ----------------------------------------------------- | ------- |
|
||
| `MOBILEGL_BUILD_TEST` | Build MobileGL tests (requires Clang) | ON |
|
||
| `MOBILEGL_BUILD_BENCHMARK` | Build MobileGL benchmarks (requires Clang) | ON |
|
||
| `MOBILEGL_FORCE_RELEASE_OPT` | Enable O3 and LTO in Debug build | ON |
|
||
| `MOBILEGL_ENABLE_TRACY` | Enable Tracy profiler for performance analysis | OFF |
|
||
|
||
**Notes:**
|
||
|
||
* The project requires C++23.
|
||
* `MG_Test` and `MG_Benchmark` can only be built with Clang, not GCC. To enforce Clang, add `-DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++` to your command.
|
||
* On Android, tests and benchmarks are always disabled.
|
||
|
||
## Environment Variables
|
||
|
||
MobileGL supports runtime configuration via environment variables.
|
||
|
||
### Supported Keys
|
||
|
||
| Variable | Description | Allowed Values | Default |
|
||
|-------------------------|--------------------------------------------------|--------------------------------------|----------------|
|
||
| `MOBILEGL_BACKEND_TYPE` | Select active backend implementation at startup. | `DirectGLES`, `DirectVulkan` | `DirectGLES` |
|
||
|
||
## Notice
|
||
|
||
* MobileGL is **not** production-ready currently.
|
||
* Some `OpenGL 3.3 (Core Profile)` features are still missing or under development.
|
||
|
||
## License
|
||
|
||
This project is distributed under **GNU LGPL v3.0**. See the `LICENSE` file in the repository for detailed information.
|