Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
241 changes: 87 additions & 154 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,190 +3,123 @@ CIS565: Project 6: Deferred Shader
-------------------------------------------------------------------------------
Fall 2013
-------------------------------------------------------------------------------
Due Friday 11/15/2013
Qiong Wang
-------------------------------------------------------------------------------

-------------------------------------------------------------------------------
NOTE:
INTRODUCTION:
-------------------------------------------------------------------------------
This project requires any graphics card with support for a modern OpenGL
pipeline. Any AMD, NVIDIA, or Intel card from the past few years should work
fine, and every machine in the SIG Lab and Moore 100 is capable of running
this project.

This is an openGL based project for CIS 565 GPU Programming.
In this project, the basics of deferred shading were introduced and implemented through
writing codes in GLSL and OpenGL.

The deferred lighting pipeline can be the following three stages:

1. Stage 1: renders the scene geometry to the G-Buffer (pass.vert, pass.frag)

2. Stage 2: renders the lighting passes and accumulates to the P-Buffer (shade.vert, ambient.frag, point.frag, diagnostic.frag)

3. Stage 3: renders the post processing (post.vert, post.frag)

Note: this project cannot be running on ultra-book machine with Intel Graphics card, since Intel Graphics card only offer support for version 130 at most currently.

-------------------------------------------------------------------------------
INTRODUCTION:
FEATURES IMPLEMENTED
-------------------------------------------------------------------------------
In this project, you will get introduced to the basics of deferred shading. You will write GLSL and OpenGL code to perform various tasks in a deferred lighting pipeline such as creating and writing to a G-Buffer.

* Bloom effect
* "Toon" Shading (with basic silhouetting)
* Point light sources
* An additional G buffer slot and some effect showing it off
* Screen space ambient occlusion (SSAO)


-------------------------------------------------------------------------------
CONTENTS:
OPERATION INSTRUCTION
-------------------------------------------------------------------------------
The Project6 root directory contains the following subdirectories:

* base/
* PROJ_WIN/ contains the vs2010 project files
* PROJ_NIX/ contains makefile for building (tested on ubuntu 12.04 LTS)
* res/ contains resources including shader source and obj files
* src/ contains the c++ code for the project along with SOIL and tiny_obj_loader
* shared32/ contains freeglut, glm, and glew.
**Keyboard Interaction**

---
BASE CODE TOUR
---
| Operation | Function |
|:-------------------------:|:-----------------------------:|
| 'x' | Toggle scissor test |
| 'r' | Reload shaders |
| 'wasdqz' | Movement and Zoom |
| '1' | View depth |
| '2' | View eye space normals |
| '3' | View Diffuse color |
| '4' | View eye space positions |
| '5' | View lighting debug mode |
| '6' | View result of bloom |
| '7' | View result of Toon effect |
| '8' | View result of SSAO |
| '0' | Standard view |

Most of your edits will be confined to the various fragment shader programs and main.cpp.

Some methods worth exploring are:

[initShader](https://github.com/CIS565-Fall-2013/Project6-DeferredShader/blob/master/base/src/main.cpp#L223):
This method initializes each shader program from specified source files. Note that the source name is declared inside a `#ifdef WIN32` guard block. This is done to reflect the relative directory structure between the linux and windows versions of the code.
-------------------------------------------------------------------------------
SCREENSHOTS OF RESULTS
-------------------------------------------------------------------------------
* Source Point Light Grid
![screenshot](https://raw.github.com/GabriellaQiong/Project6-DeferredShader/master/blueceiling.png)

[initFBO](https://github.com/CIS565-Fall-2013/Project6-DeferredShader/blob/master/base/src/main.cpp#L360):
This method initializes the framebuffer objects used as render targets for the first and second stage of the pipeline. When you go to add another slot to the G buffer you will need to modify to first FBO accordingly. Try finding all the places where `colorTexture` is used (ctrl+F in windows will be helpful) and look at how textures are created, freed, added to the FBO, and assigned to the appropriate shader programs before adding your own. Also keep in mind that textures can be reused as inputs in other pipeline stages, for instance you might want access to the normals both in the lighting stage and in the post process stage.
* Light Display
![screenshot](https://raw.github.com/GabriellaQiong/Project6-DeferredShader/master/light_display.png)

[draw_mesh](https://github.com/CIS565-Fall-2013/Project6-DeferredShader/blob/master/base/src/main.cpp#L574),
[draw_quad](https://github.com/CIS565-Fall-2013/Project6-DeferredShader/blob/master/base/src/main.cpp#L647),
[draw_light](https://github.com/CIS565-Fall-2013/Project6-DeferredShader/blob/master/base/src/main.cpp#L657):
These methods render the scene geometry, viewing quad, and point light quad to the screen. The draw_light method in particular is interesting because it will set up the scissor window for efficient rendering of point lights.
* Bloom with add new slot to G-buffer
![screenshot](https://raw.github.com/GabriellaQiong/Project6-DeferredShader/master/bloom.png)

[display](https://github.com/CIS565-Fall-2013/Project6-DeferredShader/blob/master/base/src/main.cpp#L742):
This is where the graphical work of your program is done. The method is separated into three stages with the majority of work being done in stage 2.
* Toon with Silhouetting

Stage 1 renders the scene geometry to the G-Buffer
* pass.vert
* pass.frag
*Pure Toon*
![screenshot](https://raw.github.com/GabriellaQiong/Project6-DeferredShader/master/cornell_toon.png)

Stage 2 renders the lighting passes and accumulates to the P-Buffer
* shade.vert
* ambient.frag
* point.frag
* diagnostic.frag
*Toon with Silhouetting*
![screenshot](https://raw.github.com/GabriellaQiong/Project6-DeferredShader/master/toon_silhouetting.png)

Stage 3 renders the post processing
* post.vert
* post.frag
* SSAO comparison

[keyboard](https://github.com/CIS565-Fall-2013/Project6-DeferredShader/blob/master/base/src/main.cpp#L870):
This is a good reference for the key mappings in the program.
WASDQZ - Movement
X - Toggle scissor test
R - Reload shaders
1 - View depth
2 - View eye space normals
3 - View Diffuse color
4 - View eye space positions
5 - View lighting debug mode
0 - Standard view
*With SSAO*
![screenshot](https://raw.github.com/GabriellaQiong/Project6-DeferredShader/master/SSAO.png)

-------------------------------------------------------------------------------
REQUIREMENTS:
-------------------------------------------------------------------------------
*Without SSAO*
![screenshot](https://raw.github.com/GabriellaQiong/Project6-DeferredShader/master/no_SSAO.png)

In this project, you are given code for:
* Loading .obj files
* Rendering to a minimal G buffer:
* Depth
* Normal
* Color
* Eye space position
* Rendering simple ambient and directional lighting to texture
* Example post process shader to add a vignette
Detailed ones:

You are required to implement:
* Either of the following effects
* Bloom (feel free to use [GPU Gems](http://http.developer.nvidia.com/GPUGems/gpugems_ch21.html) as a rough guide)
* "Toon" Shading (with basic silhouetting)
* Point light sources
* An additional G buffer slot and some effect showing it off
*With SSAO*
![screenshot](https://raw.github.com/GabriellaQiong/Project6-DeferredShader/master/SSAO1.png)

**NOTE**: Implementing separable convolution will require another link in your pipeline and will count as an extra feature if you do performance analysis with a standard one-pass 2D convolution. The overhead of rendering and reading from a texture _may_ offset the extra computations for smaller 2D kernels.
*Without SSAO*
![screenshot](https://raw.github.com/GabriellaQiong/Project6-DeferredShader/master/no_SSAO1.png)

You must implement two of the following extras:
* The effect you did not choose above
* Screen space ambient occlusion
* Compare performance to a normal forward renderer with
* No optimizations
* Coarse sort geometry front-to-back for early-z
* Z-prepass for early-z
* Optimize g-buffer format, e.g., pack things together, quantize, reconstruct z from normal x and y (because it is normalized), etc.
* Must be accompanied with a performance analysis to count
* Additional lighting and pre/post processing effects! (email first please, if they are good you may add multiple).

-------------------------------------------------------------------------------
README
PERFORMANCE EVALUATION
-------------------------------------------------------------------------------
All students must replace or augment the contents of this Readme.md in a clear
manner with the following:
Here is the table for the performance evaluation when rendering the cornell_box.obj in scissor mode.

| Feature | approximate fps |
|:------------------:|:-----------------:|
| point light grid | 38.20 |
| Bloom | 12.14 |
| Toon Shading | 35.86 |
| SSAO | 37.25 |

* A brief description of the project and the specific features you implemented.
* At least one screenshot of your project running.
* A 30 second or longer video of your project running. To create the video you
can use http://www.microsoft.com/expression/products/Encoder4_Overview.aspx
* A performance evaluation (described in detail below).
Note: Here each time I toggled to the non-scissor-test mode,light_display.png the FPS dropped dramatically to 1.2 or less. Besides,
when we zoom in, the FPS decreased and vice versa.

-------------------------------------------------------------------------------
PERFORMANCE EVALUATION
REFERENCES
-------------------------------------------------------------------------------
* Deferred Shading: http://en.wikipedia.org/wiki/Deferred_shading
* Z-buffering: http://en.wikipedia.org/wiki/Z-buffering
* Attenuation: http://imdoingitwrong.wordpress.com/2011/01/31/light-attenuation/
* Bloom and glow: http://http.developer.nvidia.com/GPUGems/gpugems_ch21.html
* Toon Shader: http://en.wikipedia.org/wiki/Cel_shading
* SSAO: https://developer.valvesoftware.com/wiki/Screen_Space_Ambient_Occlusion_(SSAO)

-------------------------------------------------------------------------------
ACKNOWLEDGEMENT
-------------------------------------------------------------------------------
The performance evaluation is where you will investigate how to make your
program more efficient using the skills you've learned in class. You must have
performed at least one experiment on your code to investigate the positive or
negative effects on performance.

We encourage you to get creative with your tweaks. Consider places in your code
that could be considered bottlenecks and try to improve them.

Each student should provide no more than a one page summary of their
optimizations along with tables and or graphs to visually explain any
performance differences.

-------------------------------------------------------------------------------
THIRD PARTY CODE POLICY
-------------------------------------------------------------------------------
* Use of any third-party code must be approved by asking on the Google groups.
If it is approved, all students are welcome to use it. Generally, we approve
use of third-party code that is not a core part of the project. For example,
for the ray tracer, we would approve using a third-party library for loading
models, but would not approve copying and pasting a CUDA function for doing
refraction.
* Third-party code must be credited in README.md.
* Using third-party code without its approval, including using another
student's code, is an academic integrity violation, and will result in you
receiving an F for the semester.

-------------------------------------------------------------------------------
SELF-GRADING
-------------------------------------------------------------------------------
* On the submission date, email your grade, on a scale of 0 to 100, to Liam,
liamboone@gmail.com, with a one paragraph explanation. Be concise and
realistic. Recall that we reserve 30 points as a sanity check to adjust your
grade. Your actual grade will be (0.7 * your grade) + (0.3 * our grade). We
hope to only use this in extreme cases when your grade does not realistically
reflect your work - it is either too high or too low. In most cases, we plan
to give you the exact grade you suggest.
* Projects are not weighted evenly, e.g., Project 0 doesn't count as much as
the path tracer. We will determine the weighting at the end of the semester
based on the size of each project.


---
SUBMISSION
---
As with the previous projects, you should fork this project and work inside of
your fork. Upon completion, commit your finished project back to your fork, and
make a pull request to the master repository. You should include a README.md
file in the root directory detailing the following

* A brief description of the project and specific features you implemented
* At least one screenshot of your project running.
* A link to a video of your project running.
* Instructions for building and running your project if they differ from the
base code.
* A performance writeup as detailed above.
* A list of all third-party code used.
* This Readme file edited as described above in the README section.

---
ACKNOWLEDGEMENTS
---
This project makes use of [tinyobjloader](http://syoyo.github.io/tinyobjloader/) and [SOIL](http://lonesock.net/soil.html)
Thanks a lot to Patrick and Liam for the preparation of this project. Thank you :)
Binary file added SSAO.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added SSAO1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added base/PROJ_NIX/565DefferedShader
Binary file not shown.
2 changes: 1 addition & 1 deletion base/PROJ_NIX/makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
LFLAGS := -lglut -lGL -lGLEW
CFLAGS := -Wall
IFLAGS := -I../../shared32/glm/ -I../../shared32/freeglut -I../../shared32/glew -I../src/SOIL -I../src/tiny_obj_loader
IFLAGS := -I../../shared32/glm/ -I../../shared32/freeglut/include/ -I../../shared32/glew/include/ -I../src/SOIL -I../src/tiny_obj_loader

565DefferedShader: Utility.o tiny_obj_loader.o main.o image_helper.o stb_image_aug.o image_DXT.o SOIL.o
g++ *.o -o 565DefferedShader $(LFLAGS)
Expand Down
24 changes: 22 additions & 2 deletions base/res/cornell/cornell_box.mtl
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
newmtl white
Ka 0 0 0
Ka 0 0 0;
Kd 0.9 0.9 0.9
Ks 0 0 0

Expand All @@ -18,7 +18,27 @@ Ka 0 0 0
Kd 0 0 1
Ks 0 0 0

newmtl purple
Ka 1.2 0.2 1.2
Kd 1 0 1
Ks 0 0 0

newmtl yellow
Ka 1.2 1.2 0.2
Kd 1 0.9 0.1
Ks 0 0 0

newmtl lightblue
Ka 0 0 0
Kd 0.5 0.3 1.5
Ks 0 0 0

newmtl light
Ka 20 20 20
Ka 2 2 2
Kd 1 1 1
Ks 0 0 0

newmtl grey
Ka 0 0 0
Kd 0.1 0.1 0.1
Ks 0 0 0
8 changes: 4 additions & 4 deletions base/res/cornell/cornell_box.obj
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ v 213.0 548.0 227.0
f -4 -3 -2 -1

o ceiling
usemtl white
usemtl lightblue
v 556.0 548.8 0.0
v 556.0 548.8 559.2
v 0.0 548.8 559.2
Expand Down Expand Up @@ -77,7 +77,7 @@ v 556.0 548.8 0.0
f -4 -3 -2 -1

o short_block
usemtl white
usemtl purple

v 130.0 165.0 65.0
v 82.0 165.0 225.0
Expand Down Expand Up @@ -110,15 +110,15 @@ v 82.0 0.0 225.0
f -4 -3 -2 -1

o tall_block
usemtl white
usemtl yellow

v 423.0 330.0 247.0
v 265.0 330.0 296.0
v 314.0 330.0 456.0
v 472.0 330.0 406.0
f -4 -3 -2 -1

usemtl white
usemtl yellow
v 423.0 0.0 247.0
v 423.0 330.0 247.0
v 472.0 330.0 406.0
Expand Down
Loading