• Stars
    star
    1,333
  • Rank 35,259 (Top 0.7 %)
  • Language
    C++
  • License
    MIT License
  • Created over 4 years ago
  • Updated about 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

⚡ 可编程渲染管线实现,帮助初学者学习渲染

RenderHelp

⚡ 可编程渲染管线实现,全中文注释,帮助初学者学习渲染原理。

GitHub license Maintenance Join the chat at https://gitter.im/skywind3000/asynctasks.vim

特性介绍

  • 单个 RenderHelp.h 文件,从画点开始实现可编程渲染管线,无外部依赖。
  • 模型标准,计算精确,使用类 Direct3D 接口。
  • 包含一套完整的矢量/矩阵库。
  • 包含一套位图 Bitmap 库,方便画点、画线、加载纹理、纹理采样等。
  • 使用 C++ 编写顶点着色器 (Vertex Shader) 和像素着色器 (Pixel Shader),方便断点和调试。
  • 使用 Edge Equation 精确计算三角形覆盖范围,处理好邻接三角形的边界。
  • 使用重心坐标公式计算 varying 插值。
  • 使用 1/w 进行透视矫正,绘制透视正确的纹理。
  • 使用二次线性插值进行采样,更好的渲染效果。
  • 核心渲染实现仅 200 行,突出易读性。
  • 写满中文注释,每一处计算都有解释。
  • 多个教程例子,从如何画三角形到模型以及光照。

编译运行

随便找个 sample_ 开头的例子文件直接 gcc 单文件编译即可:

gcc -O2 sample_07_specular.cpp -o sample_07_specular -lstdc++

在 Mac 下好像要加个 -std=c++17,我应该没用啥 17 的东西,不过没环境不太确定。某些平台下可能要加一个 -lm ,显示声明一下链接数学库。

运行:

./sample_07_specular

然后得到一个图片文件 output.bmp

本项目的模型使用的是 tinyrender 里面的开源模型。

编程接口

着色器变量

主要使用一个 ShaderContext 的结构体,用于 VS->PS 之间传参,里面都是一堆各种类型的 varying。

// 着色器上下文,由 VS 设置,再由渲染器按像素逐点插值后,供 PS 读取
struct ShaderContext {
    std::map<int, float> varying_float;    // 浮点数 varying 列表
    std::map<int, Vec2f> varying_vec2f;    // 二维矢量 varying 列表
    std::map<int, Vec3f> varying_vec3f;    // 三维矢量 varying 列表
    std::map<int, Vec4f> varying_vec4f;    // 四维矢量 varying 列表
};

顶点着色器

外层需要提供给渲染器 VS 的函数指针,并在渲染器的 DrawPrimitive 函数进行顶点初始化时对三角形的三个顶点依次调用:

// 顶点着色器:因为是 C++ 编写,无需传递 attribute,传个 0-2 的顶点序号
// 着色器函数直接在外层根据序号读取响应数据即可,最后需要返回一个坐标 pos
// 各项 varying 设置到 output 里,由渲染器插值后传递给 PS 
typedef std::function<Vec4f(int index, ShaderContext &output)> VertexShader;

每次调用时,渲染器会依次将三个顶点的编号 0, 1, 2 通过 index 字段传递给 VS 程序,方便从外部读取顶点数据。

像素着色器

渲染器对三角形内每个需要填充的点调用像素着色器:

// 像素着色器:输入 ShaderContext,需要返回 Vec4f 类型的颜色
// 三角形内每个点的 input 具体值会根据前面三个顶点的 output 插值得到
typedef std::function<Vec4f(ShaderContext &input)> PixelShader;

像素着色程序返回的颜色会被绘制到 Frame Buffer 的对应位置。

绘制三角形

调用下面接口可以绘制一个三角形:

bool RenderHelp::DrawPrimitive()

该函数是渲染器的核心,先依次调用 VS 初始化顶点,获得顶点坐标,然后进行齐次空间裁剪,归一化后得到三角形的屏幕坐标。

然后两层 for 循环迭代屏幕上三角形外接矩形的每个点,判断在三角形范围内以后就调用 VS 程序计算该点具体是什么颜色。

完整例子

现在你想写个 D3D 12 的三角形绘制,没有一千行你搞不定,但是现在我们只需要下面几行:

#include "RenderHelp.h"

int main(void)
{
    // 初始化渲染器和帧缓存大小
    RenderHelp rh(800, 600);

    const int VARYING_COLOR = 0;    // 定义一个 varying 的 key

    // 顶点数据,由 VS 读取,如有多个三角形,可每次更新 vs_input 再绘制
    struct { Vec4f pos; Vec4f color; } vs_input[3] = {
        { {  0.0,  0.7, 0.90, 1}, {1, 0, 0, 1} },
        { { -0.6, -0.2, 0.01, 1}, {0, 1, 0, 1} },
        { { +0.6, -0.2, 0.01, 1}, {0, 0, 1, 1} },
    };

    // 顶点着色器,初始化 varying 并返回坐标,
    // 参数 index 是渲染器传入的顶点序号,范围 [0, 2] 用于读取顶点数据
    rh.SetVertexShader([&] (int index, ShaderContext& output) -> Vec4f {
            output.varying_vec4f[VARYING_COLOR] = vs_input[index].color;
            return vs_input[index].pos;        // 直接返回坐标
        });

    // 像素着色器,返回颜色
    rh.SetPixelShader([&] (ShaderContext& input) -> Vec4f {
            return input.varying_vec4f[VARYING_COLOR];
        });

    // 渲染并保存
    rh.DrawPrimitive();
    rh.SaveFile("output.bmp");

    return 0;
}

运行结果:

文件列表

文件名 说明
RenderHelp.h 渲染器的实现文件,使用时 include 它就够了
Model.h 加载模型
sample_01_triangle.cpp 绘制三角形的例子
sample_02_texture.cpp 如何使用纹理,如何设置摄像机矩阵等
sample_03_box.cpp 如何绘制一个盒子
sample_04_gouraud.cpp 对盒子进行简单高洛德着色
sample_05_model.cpp 如何加载和绘制模型
sample_06_normal.cpp 使用法向贴图增强模型细节
sample_07_specular.cpp 绘制高光

实现对比

十多年前我写了个软渲染器教程 mini3d,比较清晰的说明了软件渲染器的核心原理,这是标准软渲染器的实现方法,主要是基于 Edge Walking 和扫描线算法。

而本项目的实现方式是仿照 GPU 的 Edge Equation 实现法,以 mini3d 代表的实现方法其实相对比较复杂,但是很快,适合做 CPU 实时渲染。而本项目模拟 GPU 的实现方式相对简单直观,但是计算量很大,不适合 CPU 实时,却适合 GPU 粗暴的并行处理。

网上有很多可编程渲染管线的实现教程,但是很多都做的有问题,诸如屏幕坐标他们取的是像素方格左上角的点,其实应该取像素方格中心的那个点,不然模型动起来三角形边缘会有跳变的感觉;比如临接三角形的边该怎么处理,基本我没见到几个处理正确的;再比如纹理采样时整数坐标换算应该要四舍五入的,不然纹理旋转起来几个顶点位置不够稳定,会有微动的迹象;还有一些软件渲染器连纹理都不是透视正确的,还在用着仿式纹理映射。。。。

渲染器实现有很多非常细节的地方,如果注意不到,其实渲染结果是不准确的,本项目使用标准模型,不错绘一个点,不算错一个坐标。

再一个是易读性,某些项目为了刻意减少代码量,砍了不少细节处理不说,很多运算都是一大堆矩阵套矩阵,连个出处和说明都没有,这对于初学者来讲是十分费解的,你连公式或者概念的名字都不知道,搜都没得搜。

阅读说明

本项主文件 RenderHelp.h 一共一千多行,三分之一都是中文注释,复杂运算我全部展开了,并不一味为了节省代码尺寸牺牲可读性,某些计算其实可以提取到外层这样性能更快一些,但是为了可读性,我还是写到了和它相关的位置上,这样阅读理解更轻松。

基本原理,我在下面回答里解释过:

阅读时,代码前面基本都是一些工具库,可以从最后 200 行阅读即可,每个公式我都写了出处,基本半个小时拿笔推导下,你不但能理解渲染器的原理是啥,还多了一个方便随时调试 shader 验证想法的工具。

Credit

代码不理解可以在 issue 里提问,这样该问题经过回答放在那里也对后来的人有帮助,欢迎 PR 增强功能,补充各类高级渲染效果。

More Repositories

1

kcp

⚡ KCP - A Fast and Reliable ARQ Protocol
C
15,270
star
2

awesome-cheatsheets

超级速查表 - 编程语言、框架和开发工具的速查表,单个文件包含一切你需要知道的东西 ⚡
Shell
11,094
star
3

ECDICT

Free English to Chinese Dictionary Database
Python
5,922
star
4

preserve-cd

Game Preservation Project
3,654
star
5

z.lua

⚡ A new cd command that helps you navigate faster by learning your habits.
Lua
2,979
star
6

mini3d

3D Software Renderer in 700 Lines !!
C
2,173
star
7

asyncrun.vim

🚀 Run Async Shell Commands in Vim 8.0 / NeoVim and Output to the Quickfix Window !!
Vim Script
1,852
star
8

vim-quickui

The missing UI extensions for Vim 9 (and NeoVim) !! 😎
Vim Script
1,094
star
9

vim

Personal Vim Profile
Vim Script
911
star
10

asynctasks.vim

🚀 Modern Task System for Project Building, Testing and Deploying !!
Vim Script
910
star
11

vim-init

轻量级 Vim 配置框架,全中文注释
Vim Script
907
star
12

emake

你见过的最简单的 GCC/CLANG 项目构建工具,定义式构建,比命令式更简单
Python
802
star
13

PyStand

🚀 Python Standalone Deploy Environment !!
C++
736
star
14

FastMemcpy

Speed-up over 50% in average vs traditional memcpy in gcc 4.9 or vc2012
C
585
star
15

preserve-iso

绝版软件保护工程
580
star
16

avlmini

AVL implementation which is as fast/compact as linux's rbtree
C
347
star
17

quickmenu.vim

A nice customizable popup menu for vim
Vim Script
275
star
18

vim-auto-popmenu

😎 Display the Completion Menu Automantically (next AutoComplPop) !!
Vim Script
271
star
19

gutentags_plus

The right way to use gtags with gutentags
Vim Script
266
star
20

vim-terminal-help

Small changes make vim/nvim's internal terminal great again !!
Vim Script
243
star
21

translator

命令行聚合翻译工具,支持谷歌,必应,有道,百度,词霸,360
Python
227
star
22

ECDICT-ultimate

Ultimate ECDICT Database
219
star
23

GONGLUE

单机游戏攻略秘籍(1580+ 篇)
Python
180
star
24

vim-preview

The missing preview window for vim
Vim Script
167
star
25

pixellib

High Quality 2D Graphics Library
C
157
star
26

KanaQuiz

Hiragana/Katakana Speed Reading Quiz in Command Line !! 😎
Python
147
star
27

images

Static Page
C++
144
star
28

BasicBitmap

Simple and high-performance and platform independent Bitmap class (34% faster than GDI/GDI+, 40% faster than DDraw)
C++
131
star
29

AsyncNet

AsyncNet
C
117
star
30

gobang

Gobang game with artificial intelligence in 900 Lines !!
Python
115
star
31

vim-rt-format

😎 Prettify Current Line on Enter !!
Vim Script
113
star
32

vim-keysound

🍷 Play typewriter sound in Vim when you are typing a letter
Vim Script
112
star
33

Intel2GAS

Convert MSVC Style Inline Assembly to GCC Style Inline Assembly
Python
103
star
34

CloudClip

Your own clipboard in the cloud, copy and paste text with gist between systems !!
Python
79
star
35

googauth

The Python Command-line Reimplementaion of Google Authenticator
Python
74
star
36

LIBLR

Parser Generator for LR(1) and LALR
Python
68
star
37

markpress

Write WordPress in Markdown in Your Favorite Text Editor !! 😎 😎
Python
67
star
38

vim-dict

没办法,被逼的,重新整理一个词典补全的数据库
Vim Script
56
star
39

terminal

Open Terminal Window to execute command in Windows / Cygwin / Ubuntu / OS X
Python
51
star
40

LeaderF-snippet

Intuitive Way to Use Snippet
Vim Script
46
star
41

nanolib

Cross-Platform Networking Library
C
44
star
42

vim-gpt-commit

🚀 Generate git commit message using ChatGPT in Vim (and NeoVim) !!
Python
43
star
43

czmod

🚀 Native Module Written in C to Boost z.lua !!
C
42
star
44

collection

没地方放的代码,懒得开新项目了,放这里吧。
Python
40
star
45

atom-shell-commands

Execute user defined shell commands (looking for new maintainers)
JavaScript
36
star
46

vim-navigator

🚀 Navigate Your Commands Easily !!
Vim Script
32
star
47

lemma.en

English Lemma Database - Compiled by Referencing British National Corpus
29
star
48

ml

Machine Learning From Scratch
C
28
star
49

memslab

Slab Memory Allocator in Application Layer
C
28
star
50

asyncrun.extra

Extra runners for asyncrun to run your command in Tmux/Gnome-terminal panel, xterm, Floaterm and more.
Vim Script
27
star
51

vim-color-patch

🌈 Load colorscheme patch script automatically !!
Vim Script
25
star
52

zvi

🚀 Smallest Vi-clone Text Editor for Windows CLI and SSH session (only 62KB) !!
23
star
53

vim-color-export

🌈 A tool to backport NeoVim colorschemes to Vim !!
Vim Script
20
star
54

QuickNet

UDP Networking Library
C
19
star
55

asmpure

Asmpure is a library written in C for compiling assembly code at run-time
C
16
star
56

docker

Docker Images
Python
16
star
57

VmBasic

基于虚拟机的仿 QuickBasic 语言
C++
15
star
58

vim-cppman

Read Cppman/Man pages right inside your vim.
Vim Script
15
star
59

language

Language Collection
Python
12
star
60

tcz_cd

Autojump for Total Commander !!
Python
11
star
61

LanguageMark

Native Language Benchmark in Numerous Algorithms
C
9
star
62

abandonware

Abandonware Collection
9
star
63

rogue-clone

A fork of rogue-clone with bug fixes and improvements.
C
8
star
64

vim-proposal

Collection of Proposals for Vim
TypeScript
7
star
65

gosub

Golang Sub-routines for Network Development
Go
7
star
66

winxp-editors

🍷 Text Editors Preservation Project for Windows XP+
Batchfile
7
star
67

cannon

Cross Platform Network Framework
C
6
star
68

shell-scripts

常用的命令行脚本合集,让你每天的命令行生活更加高效
Shell
6
star
69

crtzero

Zero Dependent on CRT (libc)
C
6
star
70

pyp2p

Python P2P Framework
Python
6
star
71

SimdVector

Cross Platform SIMD Vector Math In A Single Header File (SimdVector.h)
C++
5
star
72

support

Win32 Command Line Tools for Development
Python
5
star
73

treasure

Single-file MIT Licensed C/C++ Portable Libraries
C
4
star
74

asyncredis

Async Redis Client for Python
Python
3
star
75

skywind

Personal Blog
HTML
3
star
76

directx9-samples

samples
C++
3
star
77

gfx

Just Another Toy yet !!
C++
3
star
78

script

Script I am using
Python
3
star
79

colors-from-neovim.vim

🌈 Backported NeoVim Colors for Vim
Vim Script
3
star
80

ones

One single file MIT licensed C/C++ Libraries
2
star
81

asclib

Basic Java Network Lib
Java
2
star
82

transmod

Automatically exported from code.google.com/p/transmod
C
2
star
83

toys

My PyQt Desktop Toys
Python
2
star
84

rust

Rust Learning Repository
1
star
85

vile

Vile the vi-clone text editor
C
1
star
86

xvi

A portable multi-file text editor and the smallest full-function vi clone
C
1
star
87

emacs

Personal Emacs Profile
Emacs Lisp
1
star
88

cmake-scratch

Cmake Templates
CMake
1
star