orhi

KO | EN

gitlite — search

#python #javascript #android #python3 #csharp #golang #html #r #docker #tensorflow #android-app #bitcoin

★ 110 Open GitHub ↗

Cross-Platform Interface for Modern Graphics APIs (Vulkan, DirectX 12, Metal)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# OpenRHI

**OpenRHI** — *orhi* — is a lightweight, permissive, and cross-platform **Render Hardware Interface** for modern graphics APIs, built with C++20.

Write hardware-agnostic graphics code once, and run it seamlessly across multiple platforms and graphics APIs.

> [!important]
> _OpenRHI_ is a collaborative, open-source project, and we’re **actively looking for contributors**! The Vulkan backend is partially implemented, and the DirectX 12 backend is in progress (see this [pull request](https://github.com/adriengivry/orhi/pull/24) for more info). Whether you’re experienced in graphics programming or just eager to learn, your contributions can help _OpenRHI_ become a modern open-source reference for rendering. Join us and make an impact!

**OpenRHI** is...
- 🧩 **Simple:** Easy to understand and extend
- ⚡ **Fast:** Minimal runtime overhead with template-based design
- ⛓️‍💥 **Standalone:** Zero external dependencies
- 📃 **Documented:** Comprehensive source code documentation
- 🌈 **Cross-platform:** Native support for Windows, macOS, and Linux
- ⚙️ **Build-ready:** Quick setup with [CMake](https://cmake.org/)

**Goals:**
- Provide a thin, explicit abstraction over modern graphics APIs
- Offer low-level access to each backend through a unified interface
- Maintain explicitness: no hidden logic or implicit behavior
- Ensure minimal runtime overhead with zero-cost abstractions
- Remain cross-platform and hardware-agnostic
- Maintain minimal external dependencies

**Non-Goals:**
- Hiding platform or API-specific implementation details
- Acting as a high-level rendering engine or framework
- Abstracting away or simplifying modern graphics concepts
- Automatically managing resources, pipelines, or synchronization

## Supported Graphics APIs

**OpenRHI** primarily targets **desktop platforms**, with an [API](include/orhi/api/) architecture designed for maximum flexibility to support any backend your application needs.

**Target platforms:** Windows (🪟), Linux (🐧), and macOS (🍎)

> [!WARNING]
> **OpenRHI** is actively evolving as support for additional graphics backends is added. The [API](include/orhi/api/) may change to accommodate the unique requirements and design philosophies of each backend. Implementation details are also subject to refinement as the project works toward production-quality standards.

> [!NOTE]
> **OpenRHI** currently builds only as a static library.

## Multi-Backend Architecture
**OpenRHI** supports compiling with multiple graphics APIs simultaneously.

You can also choose which graphics API serves as the default backend for API-agnostic objects, while still having access to backend-specific implementations when needed.

### Using the Default Graphics API
```cpp
#include <orhi/Buffer.h>

orhi::Buffer buffer{};
```

### Using Specific Graphics APIs
```cpp
#include <orhi/impl/vk/Buffer.h>
#include <orhi/impl/mock/Buffer.h>

orhi::impl::vk::Buffer vulkanBuffer{};
orhi::impl::mock::Buffer mockBuffer{};
```

## Examples
**OpenRHI** comes with a set of [examples](examples/) for you to try.

> [!IMPORTANT]
> Example projects depend on [glfw](https://github.com/glfw/glfw), [glm](https://github.com/g-truc/glm), and [stb](https://github.com/nothings/stb), which are included as Git submodules. Make sure to initialize submodules before generating projects.

**Windows:**
```powershell
git clone https://github.com/adriengivry/orhi --recurse-submodules
cd .\orhi
.\gen_proj_win32.bat
.\build\orhi.sln # (optional) open solution in Visual Studio
```

**Linux:**
```powershell
git clone https://github.com/adriengivry/orhi --recurse-submodules
cd ./orhi
./gen_proj_linux.sh
```

## Contributing
All contributions to **OpenRHI** are welcome — from bug reports and feature suggestions to code improvements and documentation enhancements.

Feel free to open issues or submit pull requests for review. Every contribution helps make **OpenRHI** better!

For more information on contributing, check out [CONTRIBUTING.md](CONTRIBUTING.md).

*By contributing, you agree that your contributions will be licensed under the [MIT License](LICENSE).*

## License
**OpenRHI** is licensed under the [MIT License](LICENSE).

You are free to use, modify, and distribute this project with proper attribution. See the license file for more details.

orhi

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README