Giter Club home page Giter Club logo

ue5niagaracomputeexample's Introduction

Niagara Compute Shader Example

Overview: This project is an Unreal Engine 5 plugin that demonstrates compute shader integration with the Niagara particle system. I hope that this repo is a good place to start playing with UE5 graph builder.

Temaran has produced an awesome resource to learn compute shaders and I suggest checking it out if you havent already UnrealEngineShaderPluginDemo

boidsVFX

Modules

1. ComputeGBExample

  • Overview:
    • Demonstrates the use of Graph Builder to setup and run compute shaders through a boids example as part of the PreRender pass
    • GEngine->GetPreRenderDelegateEx
  • Examples:
    • Example1: Structured Buffer -> Niagara
    • Example2: Structured Buffer -> Render Target -> Niagara
    • Example3: Structured Buffer -> Instanced Static Meshes (WIP AND PRIVATISED)

2. ComputeRPExample

  • Overview:
    • Demonstrates the use of Graph Builder to setup and run compute shaders through a boids example as part of a custom pass
    • ENQUEUE_RENDER_COMMAND
  • Examples:
    • Example1: Structured Buffer -> Niagara

3. ComputeRPLegacyExample

  • Overview:
    • Demonstrates the use of Graph Builder to setup and run compute shaders through a boids example as part of a custom pass through legacy methods of binding shader paramaters
    • ENQUEUE_RENDER_COMMAND
  • Examples:
    • Example1: Structured Buffer -> Niagara

4. NiagaraExample

  • Overview:
    • A boids system implemented entirely within Niagara without compute shaders and using the Particle Attribute Reader instead.

5. ShaderCore

  • Overview:
    • A shared module that provides default shader settings and utilities, ensuring consistency and efficiency across all modules.

Prerequisites

  • Unreal Engine 5.4.1
  • C++ Project for generating binaries and intermediate folders
  • Basic understanding of Unreal Engine and its plugin system.

Usage

To integrate this plugin into your Unreal Engine project:

  1. Clone the repository to your local machine.
  2. Copy the plugin folder into the Plugins directory of your Unreal Engine project.
  3. Rebuild project files from your .uproject
  4. Enable the plugin within your project settings via the Plugins menu.
  5. Open Maps/M_TestLab
  6. Configure boids parameters through Compute Example Settings inside Project Settings. Please assign the niagara systems as follows.

boidsSettings

  1. Enjoy. You can play with the compute example settings even in runtime. :)

Contributing

Contributions to this project are welcome. Please follow the standard GitHub workflow for submitting pull requests.

License

This project is licensed under the MIT License. See the LICENSE file for details.

ue5niagaracomputeexample's People

Contributors

aarontrotter avatar

Stargazers

enfpdev avatar  avatar

Watchers

James Ford avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.