From 3928fcc82bbdd64c442bacecda0f600e09a43fcb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tur=C3=A1nszki=20J=C3=A1nos?= Date: Wed, 12 Apr 2017 21:10:56 +0200 Subject: [PATCH 1/2] updated documentation --- Documentation/WickedEngine-Documentation.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Documentation/WickedEngine-Documentation.md b/Documentation/WickedEngine-Documentation.md index ded6cc546..f41bb11ce 100644 --- a/Documentation/WickedEngine-Documentation.md +++ b/Documentation/WickedEngine-Documentation.md @@ -16,6 +16,7 @@ This class is completely overridable to the user's desired control flow logic. This is an abstract class which is void of any logic, but its overriders can implement several methods of it like Load, Update, Render, etc. Any class implementing this interface can be "activated" on the MainComponent and that will just run it. The available functions for overriding are the following: + - void Initialize() : Initialize common state - void Load() : Use it for resource loading - void Unload() : Destroy resources inside of this @@ -47,6 +48,7 @@ Forward rendering pipeline. #### LoadingScreenComponent A helper engine component to load resources or an entire component. It can be activated by the MainComponent as a regular component but has some additional features which are not available in any other. + - void addLoadingFunction(function loadingFunction) : Assign a function to do on a separate loading thread. Multiple functions can be assigned - void addLoadingComponent(RenderableComponent* component, MainComponent* main) : A helper for loading a whole component. When it's finished, the MainComponent which is provided in the arguments, will activate that component - void onFinshed(function finishFunction) : Tell the component what to do when loading is completely finished From e960e3a7238c01ce2de106239faa664811b28b8b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tur=C3=A1nszki=20J=C3=A1nos?= Date: Wed, 12 Apr 2017 21:11:46 +0200 Subject: [PATCH 2/2] updated documentation --- Documentation/WickedEngine-Documentation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/WickedEngine-Documentation.md b/Documentation/WickedEngine-Documentation.md index f41bb11ce..d49cd29d2 100644 --- a/Documentation/WickedEngine-Documentation.md +++ b/Documentation/WickedEngine-Documentation.md @@ -41,7 +41,7 @@ The simplest kind of 3D renderable component. It supports only directional light ##### TiledForwardRenderableComponent This implements the Forward+ rendering pipeline which is a forward rendering using per-screenspace-tile light list while rendering objects. It has a Z-buffer creation prepass to eficiently cull lights per tile and reduce overdraw. -#### DeferredRenderableComponent +##### DeferredRenderableComponent This implements a Deferred rendering pipeline. Several screen space geometry buffers are created while rendering the objects, then the lights are rendered in screen space while looking up the geometry information. It has a lower entry barrier performance wise than Tiled Forward rendering but has some disadvantages. It scales worse for increasing number of lights, has lower precision output and transparent objects are rendered using the Forward rendering pipeline.