Skip to content

Commit 54114d9

Browse files
Lewis JordanJordanL8
authored andcommitted
Vfx/docs/system requirements (#69)
* Added system requirements documentation. * Corrected phrasing * Added toc entry * Reorganised toc entry Co-authored-by: Lewis Jordan <lewis.jordan@hotmail.co.uk>
1 parent 40c04ca commit 54114d9

3 files changed

Lines changed: 33 additions & 7 deletions

File tree

com.unity.visualeffectgraph/Documentation~/GettingStarted.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,7 @@ This page shows you how to install Visual Effect Graph, and gives a brief overv
44
Visual Effect Graph is a Unity package that uses a [Scriptable Render Pipeline](https://docs.unity3d.com/Manual/ScriptableRenderPipeline.html) to render visual effects. Visual Effect graph uses on compute Shaders to simulate effects.
55

66
## Requirements
7-
* Unity 2018.3 or newer. Verified packages start at Unity 2019.3.
8-
* A [Scriptable Render Pipeline](https://docs.unity3d.com/Manual/ScriptableRenderPipeline.html) package:
9-
* [High Definition Render Pipeline](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@latest/index.html) (HDRP): Unity 2018.3 or newer. Verified from Unity 2019.3.<br/>The Visual Effect Graph supports every platform that HDRP supports. For information on which platforms this includes, see HDRP's [system requirements](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@latest/index.html?subfolder=/manual/System-Requirements.html).
10-
* [Universal Render Pipeline](https://docs.unity3d.com/Packages/com.unity.render-pipelines.universal@latest/index.html) (URP): Unity 2019.3 or newer.<br/>The Visual Effect Graph is not out of preview with URP and so only supports a subset of platforms that URP supports. It also does not support every feature that is does with HDRP and also only supports unlit particles.
11-
12-
**Note:** When you download the High Definition Render Pipeline package from Package Manager, Unity automatically installs the Visual Effect Graph package.
13-
* A target device that can use compute Shaders, such as aWindows PC, Playstation 4, XBox One, or Mac running MacOS.
7+
For information on system requirements for the Visual Effect Graph, see [Requirements and compatibility](System-Requirements.md).
148

159
## Installing Visual Effect Graph
1610

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Requirements and compatibility
2+
3+
This page contains information on system requirements and compatibility for the Visual Effect Graph package.
4+
5+
## Unity Editor compatibility
6+
7+
The following table shows the compatibility of the Visual Effect Graph versions with different Unity Editor versions.
8+
9+
| **Package version** | **Minimum Unity version** | **Maximum Unity version** |
10+
| ------------------- | ------------------------- | ------------------------- |
11+
| 10.x | 2020.2 | 2020.2 |
12+
| 8.x / 9.x-preview | 2020.1 | 2020.1 |
13+
| 7.x | 2019.3 | 2019.4 |
14+
| 6.x | 2019.2 | 2019.2 |
15+
16+
## **Render pipeline compatibility**
17+
18+
The Visual Effect Graph supports the [High Definition Render Pipeline](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@latest/index.html) (HDRP) from Unity 2018.3 and is verified for HDRP from Unity 2019.3. The Visual Effect Graph supports every platform that HDRP supports. For information on which platforms this includes, see HDRP's [system requirements](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@latest/index.html?subfolder=/manual/System-Requirements.html).
19+
20+
**Note**: When you download the HDRP package from the Package Manager, Unity automatically installs the Visual Effect Graph package.
21+
22+
The Visual Effect Graph supports the [Universal Render Pipeline](https://docs.unity3d.com/Packages/com.unity.render-pipelines.universal@latest/index.html) (URP) from Unity 2019.3. However, it is not yet out of preview for URP, which means it only supports a subset of platforms that URP supports. It also does not support every feature that it does with HDRP, and also only supports unlit particles.
23+
24+
## **Unity Player system requirements**
25+
26+
The Unity Player system requirements for the Visual Effect Graph depend on which render pipeline you use.
27+
28+
- The Visual Effect Graph is out of preview for HDRP, which means it supports every platform that HDRP supports. For information on which platforms this includes, see HDRP's [system requirements](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@latest/index.html?subfolder=/manual/System-Requirements.html).
29+
- The Visual Effect Graph is not out of preview for URP, which means it only supports a subset of platforms that URP supports.
30+
31+
For more information on general system requirements for the Unity Player, see [System requirements for Unity](https://docs.unity3d.com/Manual/system-requirements.html).

com.unity.visualeffectgraph/Documentation~/TableOfContents.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
* [Visual Effect Graph](index.md)
2+
* [Requirements](System-Requirements.md)
23
* [Getting Started](GettingStarted.md)
34
* [Visual Effect Graph Assets](VisualEffectGraphAsset.md)
45
* [Visual Effect Graph Window](VisualEffectGraphWindow.md)

0 commit comments

Comments
 (0)