-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: add graphic effects documentation (#69)
* doc: add docsify structure and first content * doc: add remaining graphic effects and images * doc: use .jpg instead of .png * doc: add banner image * doc: fix path replacement to show banner image properly Co-authored-by: Tobias Nett <skaldarnar@googlemail.com>
- Loading branch information
1 parent
abc3e0c
commit 3562c6e
Showing
29 changed files
with
422 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
<div align="center"> | ||
<img src="./docs/_media/banner.png"> | ||
</div> | ||
|
||
_This is a module for [Terasology]. | ||
It adds a directed acyclic graph (DAG) for rendering nodes of various kinds to the engine._ | ||
|
||
<h2 align="center"><a href="https://terasology.github.io/CoreRendering">👉 Documentation 👈</a></h2> | ||
|
||
## Contributing | ||
|
||
We welcome contributions to our modules, be it bug fixes or feature contributions. | ||
Check out the [Contributor Guide][contributor-guide] on the main project wiki to learn more. | ||
|
||
To check out this module (and all its dependencies) to your Terasology workspace run (in the workspace root): | ||
|
||
``` | ||
groovyw module recurse CoreRendering | ||
``` | ||
|
||
To build a module JAR for just this module run (in the workspace root): | ||
|
||
``` | ||
gradlew :module:CoreRendering:jar | ||
``` | ||
|
||
To run all tests and static code checks for this module run (in the workspace root): | ||
|
||
``` | ||
gradlew :module:CoreRendering:check | ||
``` | ||
|
||
### Documentation via gh-pages | ||
|
||
The documentation of this module is build with [docsify]. | ||
It is served via [gh-pages]. | ||
To preview the site you can either use the `docsify` [CLI tool](https://github.com/docsifyjs/docsify-cli) or just run a static server on the `docs` folder. | ||
|
||
<!-- References --> | ||
[Terasology]: https://github.com/MovingBlocks/Terasology | ||
[gh-pages]: https://pages.github.com/ | ||
[docsify]: https://docsify.js.org/#/ | ||
[contributor-guide]: https://github.com/MovingBlocks/Terasology/wiki/Contributor-Quick-Start |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
* [Home](README.md) | ||
* [Graphics Effects](graphics-effects.md) | ||
* API | ||
* [API](http://jenkins.terasology.io/teraorg/job/Terasology/job/Modules/job/C/job/CoreRendering/job/master/javadoc/overview-summary.html) | ||
* [API (SNAPSHOT)](http://jenkins.terasology.io/teraorg/job/Terasology/job/Modules/job/C/job/CoreRendering/job/develop/javadoc/overview-summary.html) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,305 @@ | ||
# Graphics Effects | ||
|
||
As a baseline for the following explanations, all graphics effects were disabled. | ||
This way, the effect of the individual settings can be shown in isolation, without being strengthened, lessened, or cancelled by other effects. | ||
This minimal setup (not to confuse with the "Minimal" preset) results in the following `config.cfg` section for `rendering` (omitting settings not related to in-game graphic effects): | ||
|
||
```json5 | ||
{ | ||
"rendering": { | ||
"chunkLods": 0.0, | ||
"flickeringLight": false, | ||
"animateGrass": false, | ||
"animateWater": false, | ||
"blurIntensity": 0, | ||
"reflectiveWater": false, | ||
"vignette": false, | ||
"motionBlur": false, | ||
"ssao": false, | ||
"filmGrain": false, | ||
"outline": false, | ||
"lightShafts": false, | ||
"bloom": false, | ||
"dynamicShadows": false, | ||
"maxChunksUsedForShadowMapping": 1024, | ||
"shadowMapResolution": 4096, | ||
"normalMapping": false, | ||
"parallaxMapping": false, | ||
"dynamicShadowsPcfFiltering": false, | ||
"cloudShadows": false, | ||
"particleEffectLimit": 10, | ||
"meshLimit": 400, | ||
"inscattering": false, | ||
"localReflections": false, | ||
"clampLighting": false, | ||
"volumetricFog": false | ||
} | ||
} | ||
``` | ||
|
||
The following screenshot shows the graphic effects baseline with all graphic effects disabled. | ||
|
||
<fig src="_media/img/graphic-effects_baseline.jpg">Baseline</fig> | ||
|
||
|
||
## Animate Grass | ||
|
||
The "Animate Grass" effect lets decorations such as grass and flowers sway in the wind. | ||
Enabling only animated grass equals the "Minimal" graphics preset. | ||
Animated grass can be enabled with the following config adjustment: | ||
```json5 | ||
{ | ||
"animateGrass": true | ||
} | ||
``` | ||
|
||
The following screenshots show the graphic setting baseline to the left and only the "Animate Grass" effect enabled to the right. | ||
|
||
<fig-side-by-side src1="_media/img/graphic-effects_baseline_close-up.jpg" src2="_media/img/graphic-effects_animate-grass_close-up.jpg">Baseline (left) and "Animate Grass" Effect (right)</fig-side-by-side> | ||
|
||
|
||
## Animate Water | ||
|
||
The "Animate Water" effect creates waves on blocks of water. | ||
Animated grass can be enabled with the following config adjustment: | ||
```json5 | ||
{ | ||
"animateWater": true | ||
} | ||
``` | ||
|
||
The following screenshots show the graphic setting baseline to the left and only the "Animate Water" effect enabled to the right. | ||
|
||
<fig-side-by-side src1="_media/img/graphic-effects_baseline.jpg" src2="_media/img/graphic-effects_animate-water.jpg">Baseline (left) and "Animate Water" Effect (right)</fig-side-by-side> | ||
|
||
|
||
## Bloom | ||
|
||
The "Bloom" effect produces fringes or feathers of light extending from the borders of bright areas. | ||
Bloom can be enabled with the following config adjustment: | ||
```json5 | ||
{ | ||
"bloom": true | ||
} | ||
``` | ||
|
||
The following screenshots show the graphic setting baseline to the left and only the "Bloom" effect enabled to the right. | ||
|
||
<fig-side-by-side src1="_media/img/graphic-effects_baseline.jpg" src2="_media/img/graphic-effects_bloom.jpg">Baseline (left) and "Bloom" Effect (right)</fig-side-by-side> | ||
|
||
|
||
## Blur | ||
|
||
As the name suggests, the "Blur" effect blurs the image. | ||
Terasology supports three levels of blur: "Some", "Normal", "Max". | ||
The respective levels can be enabled with the following config adjustment: | ||
```json5 | ||
{ | ||
"blurIntensity": lvl // with lvl = 1 for "Some", lvl = 2 for "Normal", lvl = 3 for "Max" | ||
} | ||
``` | ||
|
||
The following screenshots show the graphic setting baseline to the left and only the "Bloom" effect enabled to the right. | ||
|
||
<fig-side-by-side src1="_media/img/graphic-effects_baseline.jpg" src2="_media/img/graphic-effects_blur-some.jpg">Baseline (left) and "Blur" Effect on Level "Some" (right)</fig-side-by-side> | ||
<fig-side-by-side src1="_media/img/graphic-effects_blur-normal.jpg" src2="_media/img/graphic-effects_blur-max.jpg">"Blur" Effect on Level "Normal" (left) and "Blur" Effect on Level "Max" (right)</fig-side-by-side> | ||
|
||
|
||
## Clamp Lighting | ||
|
||
Clamp Lighting can be enabled with the following config adjustment: | ||
```json5 | ||
{ | ||
"clampLighting": true | ||
} | ||
``` | ||
|
||
The following screenshots show the graphic setting baseline to the left and only the "Clamp Lighting" effect enabled to the right. | ||
|
||
<fig-side-by-side src1="_media/img/graphic-effects_baseline.jpg" src2="_media/img/graphic-effects_clamp-lighting.jpg">Baseline (left) and "Clamp Lighting" Effect (right)</fig-side-by-side> | ||
|
||
|
||
## Cloud Shadows | ||
|
||
Cloud Shadows can be enabled with the following config adjustment: | ||
```json5 | ||
{ | ||
"cloudShadows": true | ||
} | ||
``` | ||
|
||
The following screenshots show the graphic setting baseline to the left and only the "Cloud Shadows" effect enabled to the right. | ||
|
||
<fig-side-by-side src1="_media/img/graphic-effects_baseline.jpg" src2="_media/img/graphic-effects_cloud-shadows.jpg">Baseline (left) and "Cloud Shadows" Effect (right)</fig-side-by-side> | ||
|
||
|
||
## Extra Lighting | ||
|
||
Extra Lighting can be enabled with the following config adjustment: | ||
```json5 | ||
{ | ||
"normalMapping": true | ||
} | ||
``` | ||
|
||
The following screenshots show the graphic setting baseline to the left and only the "Extra Lighting" effect enabled to the right. | ||
|
||
<fig-side-by-side src1="_media/img/graphic-effects_baseline.jpg" src2="_media/img/graphic-effects_extra-lighting.jpg">Baseline (left) and "Extra Lighting" Effect (right)</fig-side-by-side> | ||
|
||
|
||
## Film Grain | ||
|
||
Film Grain can be enabled with the following config adjustment: | ||
```json5 | ||
{ | ||
"filmGrain": true | ||
} | ||
``` | ||
|
||
The following screenshots show the graphic setting baseline to the left and only the "Film Grain" effect enabled to the right. | ||
|
||
<fig-side-by-side src1="_media/img/graphic-effects_baseline.jpg" src2="_media/img/graphic-effects_film-grain.jpg">Baseline (left) and "Film Grain" Effect (right)</fig-side-by-side> | ||
|
||
|
||
## Fog | ||
|
||
Fog can be enabled with the following config adjustment: | ||
```json5 | ||
{ | ||
"inscattering": true | ||
} | ||
``` | ||
|
||
The following screenshots show the graphic setting baseline to the left and only the "Fog" effect enabled to the right. | ||
|
||
<fig-side-by-side src1="_media/img/graphic-effects_baseline.jpg" src2="_media/img/graphic-effects_fog.jpg">Baseline (left) and "Fog" Effect (right)</fig-side-by-side> | ||
|
||
|
||
## Light Shafts | ||
|
||
Light Shafts can be enabled with the following config adjustment: | ||
```json5 | ||
{ | ||
"lightShafts": true | ||
} | ||
``` | ||
|
||
The following screenshots show the graphic setting baseline to the left and only the "Light Shafts" effect enabled to the right. | ||
|
||
<fig-side-by-side src1="_media/img/graphic-effects_baseline.jpg" src2="_media/img/graphic-effects_light-shafts.jpg">Baseline (left) and "Light Shafts" Effect (right)</fig-side-by-side> | ||
|
||
|
||
## Outline | ||
|
||
Outline can be enabled with the following config adjustment: | ||
```json5 | ||
{ | ||
"outline": true | ||
} | ||
``` | ||
|
||
The following screenshots show the graphic setting baseline to the left and only the "Outline" effect enabled to the right. | ||
|
||
<fig-side-by-side src1="_media/img/graphic-effects_baseline.jpg" src2="_media/img/graphic-effects_outline.jpg">Baseline (left) and "Outline" Effect (right)</fig-side-by-side> | ||
|
||
|
||
## Parallax Mapping | ||
|
||
Parallax Mapping can be enabled with the following config adjustment: | ||
```json5 | ||
{ | ||
"parallaxMapping": true | ||
} | ||
``` | ||
|
||
The following screenshots show the graphic setting baseline to the left and only the "Parallax Mapping" effect enabled to the right. | ||
|
||
<fig-side-by-side src1="_media/img/graphic-effects_baseline.jpg" src2="_media/img/graphic-effects_parallax-mapping.jpg">Baseline (left) and "Parallax Mapping" Effect (right)</fig-side-by-side> | ||
|
||
|
||
## Shadows | ||
|
||
Terasology supports two modes of shadows: "On" and "PCR". | ||
Shadows in mode "On" can be enabled with the following config adjustment: | ||
```json5 | ||
{ | ||
"dynamicShadows": true | ||
} | ||
``` | ||
|
||
Shadows in mode "PCR" can be enabled with the following config adjustment: | ||
```json5 | ||
{ | ||
"dynamicShadowsPcfFiltering": true | ||
} | ||
``` | ||
|
||
The following screenshots show the graphic setting baseline to the left and only the "Shadows" effect enabled to the right. | ||
|
||
<fig-side-by-side src1="_media/img/graphic-effects_baseline.jpg" src2="_media/img/graphic-effects_shadows-on.jpg">Baseline (left) and "Shadows" Effect in mode "On" (right)</fig-side-by-side> | ||
<fig-side-by-side src1="_media/img/graphic-effects_baseline.jpg" src2="_media/img/graphic-effects_shadows-PCR.jpg">Baseline (left) and "Shadows" Effect in mode "PCR" (right)</fig-side-by-side> | ||
|
||
|
||
## SSAO | ||
|
||
SSAO can be enabled with the following config adjustment: | ||
```json5 | ||
{ | ||
"ssao": true | ||
} | ||
``` | ||
|
||
The following screenshots show the graphic setting baseline to the left and only the "SSAO" effect enabled to the right. | ||
|
||
<fig-side-by-side src1="_media/img/graphic-effects_baseline.jpg" src2="_media/img/graphic-effects_SSAO.jpg">Baseline (left) and "SSAO" Effect (right)</fig-side-by-side> | ||
|
||
|
||
## Vignette | ||
|
||
Vignette can be enabled with the following config adjustment: | ||
```json5 | ||
{ | ||
"vignette": true | ||
} | ||
``` | ||
|
||
The following screenshots show the graphic setting baseline to the left and only the "Vignette" effect enabled to the right. | ||
|
||
<fig-side-by-side src1="_media/img/graphic-effects_baseline.jpg" src2="_media/img/graphic-effects_vignette.jpg">Baseline (left) and "Vignette" Effect (right)</fig-side-by-side> | ||
|
||
|
||
## Volumetric Fog | ||
|
||
Volumetric Fog can be enabled with the following config adjustment: | ||
```json5 | ||
{ | ||
"volumetricFog": true | ||
} | ||
``` | ||
|
||
The following screenshots show the graphic setting baseline to the left and only the "Volumetric Fog" effect enabled to the right. | ||
|
||
<fig-side-by-side src1="_media/img/graphic-effects_baseline.jpg" src2="_media/img/graphic-effects_volumetric-fog.jpg">Baseline (left) and "Volumetric Fog" Effect (right)</fig-side-by-side> | ||
|
||
|
||
## Water Reflections | ||
|
||
Terasology supports two modes of water reflections: "Global" and "SSR". | ||
Water Reflections in mode "Global" can be enabled with the following config adjustment: | ||
```json5 | ||
{ | ||
"reflectiveWater": true | ||
} | ||
``` | ||
|
||
Water Reflections in mode "SSR" can be enabled with the following config adjustment: | ||
```json5 | ||
{ | ||
"localReflections": true | ||
} | ||
``` | ||
|
||
The following screenshots show the graphic setting baseline to the left and only the "Water Reflections" effect enabled to the right. | ||
|
||
<fig-side-by-side src1="_media/img/graphic-effects_baseline.jpg" src2="_media/img/graphic-effects_water-reflections-global.jpg">Baseline (left) and "Water Reflections" Effect in mode "Global" (right)</fig-side-by-side> | ||
<fig-side-by-side src1="_media/img/graphic-effects_baseline.jpg" src2="_media/img/graphic-effects_water-reflections-SSR.jpg">Baseline (left) and "Water Reflections" Effect in mode "SSR" (right)</fig-side-by-side> |
Oops, something went wrong.