VisualEffectGraph-Samples

Visual Effect Graph - Samples Project

1,853

387

1,853

View on GitHub

Top Related Projects

Skinner

3,292

Special Effects with Skinned Mesh in Unity

JTRP

1,807

JTRP : Unity HDRP ToonShading Render Pipeline (Preview)

VFXToolbox

1,118

Additional tools for Visual Effect Artists

FPSSample

4,850

A first person multiplayer shooter example project in Unity

Quick Overview

The Unity-Technologies/VisualEffectGraph-Samples repository provides a collection of sample projects and assets that demonstrate the capabilities of the Visual Effect Graph (VFX Graph) feature in the Unity game engine. The VFX Graph is a powerful visual scripting system for creating complex particle effects and other visual phenomena.

Pros

Comprehensive Samples: The repository offers a wide range of sample projects, covering various use cases and showcasing the versatility of the VFX Graph.
Detailed Documentation: Each sample project includes detailed documentation, providing insights into the implementation and usage of the VFX Graph.
Active Development: The repository is actively maintained by the Unity Technologies team, ensuring that the samples stay up-to-date with the latest VFX Graph features and improvements.
Learning Resource: The samples serve as an excellent learning resource for developers who want to explore and master the VFX Graph in Unity.

Cons

Specific to Unity: The samples are tailored for the Unity game engine and may not be directly applicable to other game development platforms.
Complexity: Some of the sample projects can be quite complex, which may be overwhelming for beginners or those new to the VFX Graph.
Performance Considerations: Depending on the complexity of the effects, the performance impact on the game or application may need to be carefully considered.
Limited Customization: The samples are designed to showcase specific features and may not provide extensive customization options out of the box.

Getting Started

To get started with the Unity-Technologies/VisualEffectGraph-Samples repository, follow these steps:

Clone the repository to your local machine:

git clone https://github.com/Unity-Technologies/VisualEffectGraph-Samples.git

Open the project in the Unity game engine. Make sure you have the latest version of Unity installed, as the samples may require specific Unity versions.
Explore the different sample projects located in the Samples directory. Each sample project has its own README file that provides detailed instructions on how to use and customize the VFX Graph assets.
Open the sample projects and familiarize yourself with the VFX Graph editor. Experiment with the various nodes, parameters, and settings to understand how the effects are created and how you can modify them to suit your needs.
Refer to the Unity documentation on the VFX Graph for additional information and guidance on using this feature in your own projects.

Competitor Comparisons

Skinner

3,292

Special Effects with Skinned Mesh in Unity

Pros of Skinner

Focuses on skeletal animation and mesh deformation, offering specialized tools for character animation
Lightweight and efficient, suitable for real-time applications
Provides unique visual effects like mesh skinning and vertex animation

Cons of Skinner

Limited scope compared to the broader Visual Effect Graph ecosystem
May require more manual setup and coding for complex effects
Less integrated with Unity's built-in particle systems

Code Comparison

Skinner:

[SerializeField] SkinnedMeshRenderer _source = null;
[SerializeField] Mesh _template = null;
[SerializeField] float _speedLimit = 10;
[SerializeField] float _drag = 5;

VisualEffectGraph-Samples:

public VisualEffect vfx;
public float spawnRate = 10f;
public float lifetime = 5f;
public Vector3 velocity = Vector3.up;
public float velocityRandomness = 1f;

Both repositories offer unique approaches to visual effects in Unity. Skinner excels in skeletal animation and mesh deformation, making it ideal for character-based effects. VisualEffectGraph-Samples, on the other hand, provides a more comprehensive toolkit for general particle and visual effects, leveraging Unity's Visual Effect Graph system. While Skinner may require more manual setup, it offers specialized tools for specific animation needs. VisualEffectGraph-Samples provides a broader range of effects and better integration with Unity's particle systems, but may be more complex for simple character animations.

JTRP

1,807

JTRP : Unity HDRP ToonShading Render Pipeline (Preview)

Pros of JTRP

Offers a more comprehensive rendering pipeline with advanced features like ray tracing
Provides a wider range of visual effects and post-processing options
Includes custom shaders and materials for enhanced visual quality

Cons of JTRP

May have a steeper learning curve due to its complexity
Potentially higher performance requirements compared to VisualEffectGraph-Samples
Less official documentation and support from Unity Technologies

Code Comparison

JTRP (Custom Shader Example):

Shader "JTRP/Standard"
{
    Properties
    {
        _Color ("Color", Color) = (1,1,1,1)
        _MainTex ("Albedo (RGB)", 2D) = "white" {}
        _Glossiness ("Smoothness", Range(0,1)) = 0.5
    }
    // ... (shader code continues)
}

VisualEffectGraph-Samples (VFX Graph Node):

using UnityEngine.VFX;

public class CustomVFXNode : VFXNode
{
    [VFXSetting]
    public Vector3 customParameter = Vector3.zero;
    // ... (node implementation)
}

Both repositories offer valuable resources for Unity developers, but they cater to different needs. VisualEffectGraph-Samples focuses on particle-based effects using Unity's Visual Effect Graph, while JTRP provides a more comprehensive rendering solution with advanced features. The choice between them depends on the specific requirements of your project and the level of visual fidelity you aim to achieve.

VFXToolbox

1,118

Additional tools for Visual Effect Artists

Pros of VFXToolbox

Provides a wider range of tools and utilities for VFX creation
Includes features for texture generation and processing
Offers standalone tools that can be used outside of Unity

Cons of VFXToolbox

Less focused on Visual Effect Graph-specific samples
May require more setup and integration effort
Potentially steeper learning curve for beginners

Code Comparison

VFXToolbox (Texture generation example):

public override Texture2D Get2DPreview()
{
    int resolution = 256;
    Texture2D preview = new Texture2D(resolution, resolution, TextureFormat.RGBA32, false);
    Color[] pixels = new Color[resolution * resolution];
    for (int i = 0; i < pixels.Length; i++)
    {
        // Generate texture data
    }
    preview.SetPixels(pixels);
    preview.Apply();
    return preview;
}

VisualEffectGraph-Samples (VFX Graph usage example):

public class VFXSpawner : MonoBehaviour
{
    public VisualEffect vfx;
    public void Spawn()
    {
        vfx.SendEvent("OnSpawn");
    }
}

The VFXToolbox provides more extensive tools for texture generation and processing, while VisualEffectGraph-Samples focuses on demonstrating the usage of the Visual Effect Graph system within Unity. VFXToolbox offers broader functionality, but VisualEffectGraph-Samples may be more accessible for those specifically working with the Visual Effect Graph.

FPSSample

4,850

A first person multiplayer shooter example project in Unity

Pros of FPSSample

Provides a complete, playable FPS game example
Demonstrates networking and multiplayer functionality
Includes advanced gameplay systems like weapon handling and character movement

Cons of FPSSample

Larger project size, potentially more complex to understand
Focused on a specific game genre, may not be as versatile for other project types
Requires more setup and configuration to run

Code Comparison

FPSSample (PlayerCharacterController.cs):

public void Move(Vector3 move, bool sprint)
{
    m_MoveWithForce = false;
    m_Controller.Move(move);
    m_Sprint = sprint;
}

VisualEffectGraph-Samples (SimpleSpawner.cs):

public void Spawn()
{
    var instance = Instantiate(prefab, transform.position, transform.rotation);
    instance.GetComponent<Rigidbody>().AddForce(transform.forward * force);
}

The FPSSample code snippet shows character movement control, while the VisualEffectGraph-Samples code demonstrates object spawning and force application, reflecting their different focus areas.

Convert designs to code with AI

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README