Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zauonlok/renderer

A shader-based software renderer written from scratch in C89
https://github.com/zauonlok/renderer

3d 3d-graphics c cross-platform from-scratch graphics graphics-programming ibl pbr rendering shaders software-rendering

Last synced: 22 days ago
JSON representation

A shader-based software renderer written from scratch in C89

Host: GitHub
URL: https://github.com/zauonlok/renderer
Owner: zauonlok
License: mit
Created: 2017-03-20T13:25:08.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2021-03-06T07:55:05.000Z (over 3 years ago)
Last Synced: 2024-10-01T11:03:18.783Z (about 1 month ago)
Topics: 3d, 3d-graphics, c, cross-platform, from-scratch, graphics, graphics-programming, ibl, pbr, rendering, shaders, software-rendering
Language: C
Homepage: https://zauonlok.github.io/renderer/
Size: 128 MB
Stars: 2,462
Watchers: 62
Forks: 274
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Software Renderer ![](https://github.com/zauonlok/renderer/workflows/Windows/badge.svg) ![](https://github.com/zauonlok/renderer/workflows/macOS/badge.svg) ![](https://github.com/zauonlok/renderer/workflows/Linux/badge.svg)

 

 

This is a shader-based software renderer written from scratch in C89 with

minimal dependencies, available for Windows, macOS, and Linux.

## Features

* Cross platform

* Minimal dependencies

* Shader based

* Homogeneous clipping

* Back-face culling

* Perspective correct interpolation

* Depth testing

* Alpha testing

* Alpha blending

* Cubemapped skybox

* Skeletal animation

* Tangent space normal mapping

* Shadow mapping

* ACES tone mapping

* Blinn–Phong reflection model

* Physically based rendering (PBR)

* Metallic-roughness workflow

* Specular-glossiness workflow

* Image-based lighting (IBL)

* Orbital camera controls

* PBR material inspector

## Download

Pre-built binaries for Windows, macOS, and Linux are available for download

from the [Releases page](https://github.com/zauonlok/renderer/releases).

## Build

To build the software renderer from source, a C89 compiler and development

files for your window system are required.

### Windows

Install [Visual Studio](https://visualstudio.microsoft.com/downloads/)

with C++ support and run `build_win32.bat`.

### macOS

Install Command Line Tools for Xcode with the command below and

run `build_macos.sh`.

```

xcode-select --install

```

### Linux

Install GCC and Xlib with the following commands and run `build_linux.sh`.

#### Ubuntu / Debian

```

sudo apt install gcc libx11-dev

```

#### Fedora / RHEL

```

sudo dnf install gcc libX11-devel

```

#### openSUSE / SUSE

```

sudo zypper install gcc libX11-devel

```

### Bonus

A `CMakeLists.txt` file is provided for generating project files using

[CMake](https://cmake.org/) (see examples below).

#### Visual Studio

```

mkdir build

cd build

cmake -G "Visual Studio 16 2019" ..

start Renderer.sln

```

#### Xcode

```

mkdir build

cd build

cmake -G Xcode ..

open Renderer.xcodeproj

```

#### Makefile

```

mkdir build

cd build

cmake -G "Unix Makefiles" -D CMAKE_BUILD_TYPE=Release ..

make

```

## Usage

### Launch

If the software renderer is launched without arguments, one of the available

scenes will be chosen randomly. To display a specific scene (see below),

additional arguments should be supplied. The command line syntax is:

```

Viewer [test_name [scene_name]]

```

### Controls

* Orbit: left mouse button

* Pan: right mouse button

* Zoom: mouse wheel

* Rotate lighting: A D S W

* Reset everything: Space

### Inspector

For PBR scenes, a material inspector that is very similar to the layers view

of [Marmoset Viewer](https://marmoset.co/viewer/) is provided. Double click

to bring it up.

## Screenshots

| Scene 
| --------------------------------------------------------------------------------------- 
| [](assets/azura/README.md) 
| [](assets/centaur/README.md) 
| [](assets/craftsman/README.md) 
| [](assets/elfgirl/README.md) 
| [](assets/kgirl/README.md) 
| [](assets/lighthouse/README.md) 
| [](assets/mccree/README.md) 
| [](assets/nier2b/README.md) 
| [](assets/phoenix/README.md) 
| [](assets/vivi/README.md) 
| [](assets/whip/README.md) 
| [](assets/witch/README.md) 
| [](assets/assassin/README.md) 
| [](assets/buster/README.md) 
| [](assets/crab/README.md) 
| [](assets/dieselpunk/README.md) 
| [](assets/drone/README.md) 
| [](assets/helmet/README.md) 
| [](assets/horse/README.md) 
| [](assets/junkrat/README.md) 
| [](assets/ornitier/README.md) 
| [](assets/ponycar/README.md) 
| [](assets/robot/README.md) 
| [](assets/spruit/README.md) 
| [](assets/workshop/README.md)

| Command                   | | ------------------------- | | `Viewer blinn azura`      | | `Viewer blinn centaur`    | | `Viewer blinn craftsman`  | | `Viewer blinn elfgirl`    | | `Viewer blinn kgirl`      | | `Viewer blinn lighthouse` | | `Viewer blinn mccree`     | | `Viewer blinn nier2b`     | | `Viewer blinn phoenix`    | | `Viewer blinn vivi`       | | `Viewer blinn whip`       | | `Viewer blinn witch`      | | `Viewer pbr assassin`     | | `Viewer pbr buster`       | | `Viewer pbr crab`         | | `Viewer pbr dieselpunk`   | | `Viewer pbr drone`        | | `Viewer pbr helmet`       | | `Viewer pbr horse`        | | `Viewer pbr junkrat`      | | `Viewer pbr ornitier`     | | `Viewer pbr ponycar`      | | `Viewer pbr robot`        | | `Viewer pbr sphere`       | | `Viewer pbr spheres`      |

## References

### Rendering pipeline

* [Tiny Renderer](https://github.com/ssloy/tinyrenderer)

* [OpenGL ES 2.0 Specification](https://www.khronos.org/registry/OpenGL/specs/es/2.0/es_full_spec_2.0.pdf)

### Physically based rendering

* [glTF 2.0 Sample Viewer](https://github.com/KhronosGroup/glTF-Sample-Viewer)

* [SIGGRAPH 2013 Shading Course](https://blog.selfshadow.com/publications/s2013-shading-course/)

* [Physically Based Rendering in Filament](https://google.github.io/filament/Filament.html)

### File formats

* [Truevision TGA](http://www.dca.fee.unicamp.br/~martino/disciplinas/ea978/tgaffs.pdf)

* [Radiance HDR](https://www.graphics.cornell.edu/~bjw/rgbe.html)

* [Wavefront OBJ](http://www.cs.utah.edu/~boulos/cs3505/obj_spec.pdf)

* [Khronos glTF](https://github.com/KhronosGroup/glTF/blob/master/specification/2.0/README.md)

### Miscellaneous

* [Homogeneous clipping](http://fabiensanglard.net/polygon_codec/)

* [Barycentric coordinates](http://blackpawn.com/texts/pointinpoly/)

* [Perspective correct interpolation](https://www.comp.nus.edu.sg/~lowkl/publications/lowk_persp_interp_techrep.pdf)

* [Skeletal animation](https://people.rennes.inria.fr/Ludovic.Hoyet/teaching/IMO/05_IMO2016_Skinning.pdf)

* [Tangent space normal mapping](http://www.terathon.com/code/tangent.html)

* [Ambient occlusion](http://mentalraytips.blogspot.com/2008/11/joy-of-little-ambience.html)

* [ACES tone mapping](https://knarkowicz.wordpress.com/2016/01/06/aces-filmic-tone-mapping-curve/)

* [Orbital camera controls](https://github.com/mrdoob/three.js/blob/master/examples/js/controls/OrbitControls.js)

* [Xlib programming guide](https://web.archive.org/web/20071018025425/http://users.actcom.co.il/~choo/lupg/tutorials/xlib-programming/xlib-programming.html)

* [Type-safe dynamic array](https://github.com/nothings/stb/blob/master/stretchy_buffer.h)

## License

[MIT License](LICENSE)