Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@JoachimCoenen
JoachimCoenen authored Sep 1, 2017
1 parent 64796ba commit 34f9190
Showing 1 changed file with 101 additions and 26 deletions.
127 changes: 101 additions & 26 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,27 +1,41 @@
# Cat-Post Processing Effects for Unity 5
Various fast and efficient post-processing effects for Unity

![Main Img 1][ElevatorDoor_IMG]
The main goal is to create fast and efficient post-processing effects for Unity.

There are currently 5 different post-processing effects included:
- Temporal Anti-Alialising (TAA)
- Ambient Occlusion
- Importance Sampled Screen Space Reflections (SSR) with retro reflections and specular elongation
- Chromatic Aberration
- Bloom Effect with energy conservation
# Cat-Post Processing Effects for Unity 5.6
High Quality Post-processing effects for Unity. Download [Cat-Post Processing Effects][SourceCode_Newest_LINK] or [other versions][Releases_LINK].

<table style="width:100%;border-spacing:0px">
<tr style="padding:0px">
<td colspan="2" style="padding:0px"> <img src="Media/ElevatorDoorDetail.png" alt="Most Effects in action 2" style="width:width;height:height;"> </td>
</tr>

<tr style="padding:0px">
<td style="padding:0px"> <img src="Media/DragonFly3.png" alt="All Effects in action" style="width:width;height:height;"> </td>
<td style="padding:0px"> <img src="Media/coloredBalls.png" alt="Most Effects in action 3" style="width:width;height:height;"> </td>
</tr style="padding:0px">

<tr style="padding:0px">
<td colspan="2" style="padding:0px"> <img src="Media/ElevatorDoor.png" alt="Most Effects in action 2" style="width:width;height:height;"> </td>
</tr>
</table>

The main goal is to create high quality post-processing effects with only a small performance impact. Tested with Unity 5.6.1f1.

There are currently 7 different post-processing effects included:
- Ambient Occlusion ([AO][AO_ANCHOR])
- Stochastic Screen Space Reflections ([SSR][SSR_ANCHOR]), Importance Sampled with contact hardening, specular elongation and retro reflections
- Depth of Field ([DoF][DoF_ANCHOR])
- Chromatic Aberration ([CA][CA_ANCHOR])
- [Bloom][Bloom_ANCHOR] Effect with energy conservation
- Temporal Anti-Alialising ([TAA][TAA_ANCHOR])
- Color Grading ([CG][ColorGrading_ANCHOR])

## Install Intructions
[Download here](https://github.com/JoachimCoenen/Cat-PostProcessing/releases "https://github.com/JoachimCoenen/Cat-PostProcessing/releases"), unpack the .zip and then put the "Cat" folder into your "Assets" folder.
Download the [newest version here][SourceCode_Newest_LINK], unpack the .zip and then put the "Cat" folder into your "Assets" folder.

## Temporal Anti-Alialising
![TemporalAntiAlialisingGUI_IMG][TemporalAntiAlialisingGUI_IMG]
- **Sharpness:** Artificially sharpens the image. High values can look cheap.
- **Velocity Scale:** Controls how sensitive it reacts when pixels move along the screen.
- **Response:** Controls how fast a pixel responds to a change of color.
- **Tolerance Margin:**
- **Jitter Matrix:** What jitter sequence should be used to shake the camera. (Halton Sequence recomended)
- **Halton Seq. Length:** The length of the Halton Sequence if selected.
## Usage
> For maximum awesomeness we recommend that you work in **Linear + HDR**. Some effects will look wired in Gamma or without LDR. Using the **Deferred rendering path** is also recommended (and required for some effects like [Screen Space Reflections][SSR_ANCHOR] and [Ambient Occlusion][AO_ANCHOR]).
To add an effect to your camera, either
- Use the menu `Component`&rarr;`Cat`&rarr;`Post Processing`. Or
- Use the `Add Component` button in the inspector. `Add Component`&rarr;`Cat`&rarr;`Post Processing`.

## Ambient Occlusion
![AmbientOcclusionGUI_IMG][AmbientOcclusionGUI_IMG]
Expand All @@ -30,7 +44,6 @@ There are currently 5 different post-processing effects included:
- **Radius:** The search radius. Try to keep it small, too.
- **Debug On:** Visualizes the generated Ambient Occlusion.


## Screen Space Reflections
For best Results use this effect together with Temporal Anti-Alialising.

Expand Down Expand Up @@ -74,6 +87,13 @@ Debugging
- **Debug Mode:** TBD.
- **Mip Level For Debug:** TBD.

## Depth of Field
![DepthOfFieldGUI_IMG][DepthOfFieldGUI_IMG]
- **f-Stop f/n:** Also: f-number. Describes the size of the aperture. A smaller value means a larger aperture and you get a smaller depth of field. See [Wikipedia][fNumberWikipedia_LINK].
- **Focus Distance:** The Distance of object in focus (*S<sub>1</sub>*). Not to be confused with the [focal length][FocalLengthWikipedia_LINK] *f*.
- **Radius:** a value of `5` semms to work pretty good.
- **Debug On:** Shows the Focus Distance in red .

## Chromatic Aberration
![ChromaticAberrationGUI_IMG][ChromaticAberrationGUI_IMG]

Expand All @@ -86,13 +106,68 @@ Debugging
- **Knee Strength:**
- **Debug On:** Visualizes the Bloom only.

![Main Img 2][coloredBalls_IMG]
## Temporal Anti-Alialising
![TemporalAntiAlialisingGUI_IMG][TemporalAntiAlialisingGUI_IMG]
- **Sharpness:** Artificially sharpens the image. High values can look cheap.
- **Velocity Scale:** Controls how sensitive it reacts when pixels move along the screen.
- **Response:** Controls how fast a pixel responds to a change of color.
- **Tolerance Margin:**
- **Jitter Matrix:** What jitter sequence should be used to shake the camera. (Halton Sequence recomended)
- **Halton Seq. Length:** The length of the Halton Sequence if selected.

## Color Grading
![ColorGradingGUI_IMG][ColorGradingGUI_IMG]
Color Grading
- **Exposure:** Artificially darkens / brightens the image (post exposure).
- **Contrast:** Changes the contrast without altering the saturation.
- **Saturation:** Changes the colorfullness of the image.

Color Correction
- **Temperature:** Blue / Orange.
- **Tint:** Lime Green / Pink.

[coloredBalls_IMG]: Media/coloredBalls.png "All Effects in action 1"
[ElevatorDoor_IMG]: Media/ElevatorDoor.png "All Effects in action 2"
[TemporalAntiAlialisingGUI_IMG]: Media/CatAAGUI.png "Temporal Anti-Alialising GUI"
Curves
- **BlackPoint:** Moves the black point of the image.
- **MidPoint:** Moves the mid grays of the image.
- **WhitePoint:** Moves the white point of the image.

- **Shadows:** Strengthens / weakens the shadows.
- **Highlights:** Strengthens / weakens the highlights.



![Main Img 2][DragonFly_IMG]


[coloredBalls_IMG]: Media/coloredBalls.png "Most Effects in action 1"
[ElevatorDoor_IMG]: Media/ElevatorDoor.png "Most Effects in action 2"
[ElevatorDoorDetail_IMG]: Media/ElevatorDoorDetail.png "Most Effects in action 3"
[DragonFly_IMG]: Media/DragonFly3.png "Most Effects in action 4"
[AmbientOcclusionGUI_IMG]: Media/CatAOGUI.png "Ambient Occlusion GUI"
[ScreenSpaceReflectionsGUI_IMG]: Media/CatSSRGUI.png "Screen Space Reflections GUI"
[DepthOfFieldGUI_IMG]: Media/CatDoFGUI.png "Depth of Field GUI"
[ChromaticAberrationGUI_IMG]: Media/CatChromaticAberrationGUI.png "Chromatic Aberration GUI"
[BloomGUI_IMG]: Media/CatBloomGUI.png "Bloom Effect GUI"
[TemporalAntiAlialisingGUI_IMG]: Media/CatAAGUI.png "Temporal Anti-Alialising GUI"
[ColorGradingGUI_IMG]: Media/CatColorGradingGUI.png "Color Grading GUI"

[Install_ANCHOR]: #install-intructions
[Usage_ANCHOR]: #usage
[AO_ANCHOR]: #ambient-occlusion
[SSR_ANCHOR]: #screen-space-reflections
[CA_ANCHOR]: #chromatic-aberration
[DoF_ANCHOR]: #depth-of-field
[TAA_ANCHOR]: #temporal-anti-alialising
[Bloom_ANCHOR]: #bloom
[ColorGrading_ANCHOR]: #color-grading

[Releases_LINK]: https://github.com/JoachimCoenen/Cat-PostProcessing/releases "Cat-PostProcessing/releases"
[SourceCode_Newest_LINK]: https://github.com/JoachimCoenen/Cat-PostProcessing/archive/v0.4.0-alpha.zip "Cat-Post Processing v0.4.0-alpha - Source Code"

[fNumberWikipedia_LINK]: https://en.wikipedia.org/wiki/F-number "f-number - Wikipedia"
[FocalLengthWikipedia_LINK]: https://en.wikipedia.org/wiki/Focal_length "Focal length - Wikipedia"





0 comments on commit 34f9190

Please sign in to comment.