tinyrenderer README

The project's README from github.com/ssloy/tinyrenderer. As one markdown file: README.md.

Software rendering in 500 lines of bare C++

The code itself is of little interest. Check the course notes:

  1. Introduction
  2. Bresenham’s line drawing algorithm
  3. Triangle rasterization
  4. Primer on barycentric coordinates
  5. Hidden faces removal
  6. A crude (but simple) approach to camera handling
  7. Better camera handling
  8. Shading
  9. More data!
  10. Tangent space normal mapping
  11. Shadow mapping
  12. Indirect lighting
  13. Bonus: toon shading
  14. Afterword

In this series of articles, I aim to demonstrate how OpenGL, Vulkan, Metal, and DirectX work by writing a simplified clone from scratch. Surprisingly, many people struggle with the initial hurdle of learning a 3D graphics API. To help with this, I have prepared a short series of lectures, after which my students are able to produce quite capable renderers.

The task is as follows: using no third-party libraries (especially graphics-related ones), we will generate an image like this:

Warning: This is a training material that loosely follows the structure of modern 3D graphics libraries. It is a software renderer. I do not intend to show how to write GPU applications — I want to show how they work. I firmly believe that understanding this is essential for writing efficient applications using 3D libraries.

The starting point

The final code consists of about 500 lines. My students typically require 10 to 20 hours of programming to start producing such renderers. The input is a 3D model composed of a triangulated mesh and textures. The output is a rendering. There is no graphical interface, the program simply generates an image.

To minimize external dependencies, I provide my students with a single class for handling TGA files — one of the simplest formats supporting RGB, RGBA, and grayscale images. This serves as our foundation for image manipulation. At the beginning, the only available functionality (besides loading and saving images) is the ability to set the color of a single pixel.

There are no built-in functions for drawing line segments or triangles — we will implement all of this manually. While I provide my own source code, written alongside my students, I do not recommend using it directly, as doing the work yourself is essential to understanding the concepts. The complete code is available on github, and you can find the initial source code I provide to my students here. Behold, here is the starting point:

#include "tgaimage.h"

constexpr TGAColor white   = {255, 255, 255, 255}; // attention, BGRA order
constexpr TGAColor green   = {  0, 255,   0, 255};
constexpr TGAColor red     = {  0,   0, 255, 255};
constexpr TGAColor blue    = {255, 128,  64, 255};
constexpr TGAColor yellow  = {  0, 200, 255, 255};

int main(int argc, char** argv) {
    constexpr int width  = 64; 
    constexpr int height = 64; 
    TGAImage framebuffer(width, height, TGAImage::RGB);

    int ax =  7, ay =  3;  
    int bx = 12, by = 37; 
    int cx = 62, cy = 53; 

    framebuffer.set(ax, ay, white);
    framebuffer.set(bx, by, white);
    framebuffer.set(cx, cy, white);

    framebuffer.write_tga_file("framebuffer.tga");
    return 0;
}

It produces the 64x64 image framebuffer.tga, here I scaled it for better readability:

Teaser: few examples made with the renderer

Compilation

git clone https://github.com/ssloy/tinyrenderer.git &&
cd tinyrenderer &&
cmake -Bbuild &&
cmake --build build -j &&
build/tinyrenderer obj/diablo3_pose/diablo3_pose.obj obj/floor.obj

The rendered image is saved to framebuffer.tga.

tinyrenderer (ssloy/tinyrenderer)

Searching Database…

24.4K ·GitHub
Tinyrenderer
Что это такое?Это «tinyrenderer» — практический курс по компьютерной графике, в котором вы с нуля пишете программный 3D-рендерер примерно на 500 строках C++ и понимаете, как на самом деле устроены OpenGL, Vulkan, Metal и DirectX.
Это готовый рендерер или курс, по которому я занимаюсь?Это учебный проект, а не библиотека: вы проходите 14 коротких конспектов лекций и пишете код рендерера сами, используя эталонный код автора только как ориентир, а не как готовое решение для запуска.
Как начать курс?Возьмите минимальный стартовый код, который предоставляет автор (один класс для работы с TGA и пустой буфер кадра 64x64), и идите по конспектам лекций шаг за шагом, самостоятельно реализуя на C++ рисование линий, растеризацию треугольников, затенение и остальное.
Нужны ли мне графические библиотеки, чтобы пройти курс?Нет, сторонние и графические библиотеки не используются: всё, от установки пикселя до рисования линий и треугольников, реализуется вручную на обычном C++, а для загрузки и сохранения изображений есть только небольшой встроенный класс для TGA.
Есть ли у рендерера окно или графический интерфейс, с которым можно работать?Нет, графического интерфейса вообще нет: каждый запуск只 вычисляет пиксели и записывает на диск статичное изображение в формате TGA, без живого превью и интерактивности.
Для кого этот курс?Он рассчитан на программистов, которые хотят понимать устройство 3D-графики изнутри, а не просто пользоваться API; автор отмечает, что студентам обычно нужно от 10 до 20 часов программирования, чтобы получить работающий рендерер.
Какие темы охватывает курс из 14 частей?Курс идёт от алгоритма Брезенхэма для отрисовки линий и растеризации треугольников через барицентрические координаты, отсечение невидимых граней, работу с камерой, затенение, нормал-маппинг в касательном пространстве, карты теней и непрямое и мультяшное освещение.
Зачем писать программный рендерер вместо того, чтобы просто использовать OpenGL?По мнению автора, понимание того, как работают растеризация и затенение изнутри, необходимо, чтобы потом писать эффективные реальные GPU-приложения.
В каком формате сохраняются изображения?Изображения сохраняются в формате TGA: автор выбрал его, потому что это один из самых простых форматов, который при этом поддерживает данные RGB, RGBA и оттенки серого.
Можно ли просто взять исходный код, который предоставляет автор?Можно, но автор прямо не рекомендует этого делать: смысл курса в том, чтобы вы сами написали около 500 строк, а не копировали готовый рендерер.
What are similar projects?LearnOpenGL, 3d-game-shaders-for-beginners, bgfx, filament, Vulkan, assimp, blender, Hazel
Which topics is it in?rendering-engine, images, shader, 3d-graphics, engine, fun, shaders, opengl, computer-graphics, c-plus-plus, rendering, course
Creator
ssloy
Size
62.5 MB
Stars
24.4K
Updated
CommitJul 29
Age
11y
Commits · 90 Days