Merge pull request #13 from pgilfernandez/effects-v01

Effects section
friction2d · Feb 22, 2025 · 0193c07 · 0193c07
2 parents ff53106 + eabbe37
commit 0193c07
Show file tree

Hide file tree

Showing 10 changed files with 67 additions and 0 deletions.
diff --git a/assets/documentation/effects/effects_01.png b/assets/documentation/effects/effects_01.png
diff --git a/assets/documentation/effects/effects_02.png b/assets/documentation/effects/effects_02.png
diff --git a/assets/documentation/effects/effects_03.png b/assets/documentation/effects/effects_03.png
diff --git a/assets/documentation/effects/effects_04.png b/assets/documentation/effects/effects_04.png
diff --git a/assets/documentation/effects/effects_05.png b/assets/documentation/effects/effects_05.png
diff --git a/assets/documentation/effects/effects_06.png b/assets/documentation/effects/effects_06.png
diff --git a/assets/documentation/effects/effects_07.png b/assets/documentation/effects/effects_07.png
diff --git a/assets/documentation/effects/effects_cg.png b/assets/documentation/effects/effects_cg.png
diff --git a/documentation/effects.md b/documentation/effects.md
@@ -0,0 +1,66 @@
+---
+title: "Effects"
+layout: default
+permalink: documentation/effects.html
+---
+
+# Effects
+
+* table of contents
+{:toc}
+
+Effects can be applied to any object, path, image or text.
+
+To apply them it is needed to open  the contextual menu (secondary mouse button) while selecting an object and select a type of Effect.
+
+## Raster Effects
+
+Raster effects are applicable to shapes and images and the effect applied or rendered as bitmap, that is, pixel based or raster.
+
+Friction comes with the following effects installed:
+
+![Raster Effects](/assets/documentation/effects/effects_01.png)
+
+Users can **install their own shaders** or start by installing [this bundle](https://github.com/friction2d/friction-shader-plugins) with lots of them. The installation that can be checked in `Preferences > Shaders` or changed to any custom one. More information about custom shaders can be found under **[Shaders](shaders.html)** section.
+
+Next to an applied raster effect label, there is an icon that lets users choose who renders it if the `CPU` or the `GPU`:
+
+![Rendered by CPU or GPU](/assets/documentation/effects/effects_cg.png)
+
+In `Preferences > Hardware > Raster Effects` it is possible to set the default rendering one.
+
+## Path Effects
+
+The effects that can be applied to stroke, fill and outer line are the same for all.
+
+These effects have properties that can be animated.
+
+![Path Effects](/assets/documentation/effects/effects_02.png)
+
+## Fill Effects
+
+The effects that can be applied to stroke, fill and outer line are the same for all.
+
+These effects have properties that can be animated.
+
+![Fill Effects](/assets/documentation/effects/effects_03.png)
+
+## Outline Base Effects
+
+The effects that can be applied to stroke, fill and outer line are the same for all.
+
+These effects have properties that can be animated.
+
+![Outline base Effects 1](/assets/documentation/effects/effects_04.png)
+
+![Outline base Effects 2](/assets/documentation/effects/effects_05.png)
+
+## Outline Effects
+
+The effects that can be applied to stroke, fill and outer line are the same for all.
+
+These effects have properties that can be animated.
+
+![Outline Effects 1](/assets/documentation/effects/effects_06.png)
+
+![Outline Effects 2](/assets/documentation/effects/effects_07.png)
diff --git a/documentation/index.md b/documentation/index.md
@@ -26,6 +26,7 @@ Motion graphics has a wide variety of uses, including:
 * [Shortcuts](shortcuts.html)
 * [Export](export.html)
 * [Expressions](expressions.html)
+* [Effects](effects.html)
 * [Shader Effects](shaders.html)
 * [FAQ](faq.html)