Oni

KO | EN

gitlite — search

#python #golang #javascript #java #framework #docker #android #cli #gui #c-plus-plus #cpp #documentation

★ 165 Open GitHub ↗

Modern toy DirectX 12 renderer

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Oni : a DirectX 12 renderer written in C++

Oni is a modern graphics engine written in C++ with the DirectX 12 API. Its goal is to showcase the latest advancements in real-time rendering.
Oni makes heavy use of compute shaders to accelerate the rendering pipeline -- everything that isn't a draw call is done through compute.

## DISCLAIMER

This is an experimental renderer as I am currently learning graphics programming. Please take this into consideration when reading the code for this renderer.

## Requirements

- [xmake](https://xmake.io/#/)
- Windows SDK Latest
- Visual Studio 2022 + ATL Toolkit
- HLSL Shader Model 6.6
- GPU with, ideally, the following features:
    - DXR
    - Mesh shaders
    - Work graphs

## Building

- xmake
- xmake f --mode={debug/release}
- Copy the contents of the bin folder in build/windows/x64/{debug/release}/
- Copy the D3D12 folder in build/windows/x64/{debug/release}/
- xmake run

## Screenshots

### Sponza Scene
![](https://raw.githubusercontent.com/AmelieHeinrich/Oni/master/screenshots/engine/Screenshot%20Fri%20Sep%2027%2022_56_42%202024.png)

### Editor showing meshlets and raytraced shadows output
![](https://raw.githubusercontent.com/AmelieHeinrich/Oni/master/screenshots/Editor.png)

### Bistro scene
![](https://raw.githubusercontent.com/AmelieHeinrich/Oni/master/screenshots/RTShadows.png)

### Bloom
![](https://raw.githubusercontent.com/AmelieHeinrich/Oni/master/screenshots/Bloom.png)

## Renderer features (techniques)

- Deferred rendering
- Shadow mapping (directional)
- HDR rendering
- Color grading
- TAA (Temporal Anti-Aliasing)
- Film Grain
- Bloom (Compute Downsample/Upsample)
- Debug renderer (lines, motion vector visualizer)
- PBR + metallic material workflow
- Emissive materials
- Point, directional lights
- Screen Space Ambient Occlusion (EXPERIMENTAL)
- Fully raytraced shadows with DXR

## Renderer features (GPU)
- Hardware accelerated mesh shaders & amplification shaders
- Meshlet rendering & culling
- Bindless resources via SM6.6
- Hardware accelerated raytracing
- In-engine BC7 texture compressor using custom texture format
- Mipmaps

## Other features
- UI powered by ImGui
- In-engine screenshot system
- Shader hot reloading and caching

## WIP (GPU Driven and latest GPU tech)
- Meshlet cone culling
- Indirect Buffers

## WIP (Shading and Math)

- Clustered forward

## Dependencies

- [D3D12MA](https://gpuopen.com/d3d12-memory-allocator/)
- [glm](https://github.com/g-truc/glm)
- [ImGui](https://github.com/ocornut/ImGui)
- [ImGuizmo](https://github.com/CedricGuillemet/ImGuizmo)
- [nvtt](https://github.com/castano/nvidia-texture-tools)
- [optick](https://github.com/bombomby/optick)
- [stb](https://github.com/nothings/stb)
- [Agility SDK](https://devblogs.microsoft.com/directx/directx12agility/)
- [cgltf](https://github.com/jkuhlmann/cgltf)
- [meshopt](https://github.com/zeux/meshoptimizer)

Oni

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README