GPU Particles #51

HifiExperiments · 2024-04-20T03:22:00Z

No description provided.

HifiExperiments · 2024-11-02T04:13:32Z

this is ready for review now

JulianGro

Little suggestions.
Ready to merge, as long as the CI passes. (Which it does without my suggestions at least.)

JulianGro · 2024-12-18T21:40:19Z

source/create/entities/procedural-particle-entity.rst

+Add a Procedural Particle Entity
+################################
+
+Particles are a powerful tool for creating a variety of effects. When you add a Particle Entity via **Create**, you will be asked if you want it to be procedural or not. Non-procedural particles are represented by the `ParticleEffect` `EntityType <https://apidocs.overte.org/Entities.html#.EntityType>`_. They have many configuration options (see `EntityProperties-ParticleEffect <https://apidocs.overte.org/Entities.html#.EntityProperties-ParticleEffect>`_) and are suitable for many situations. However, they also have a few limitations, including only supporting up to 100,000 particles / entity, only allowing flat, billboarded, quads, and moving via euler integration (position + velocity + acceleration).


Suggested change

Particles are a powerful tool for creating a variety of effects. When you add a Particle Entity via **Create**, you will be asked if you want it to be procedural or not. Non-procedural particles are represented by the `ParticleEffect` `EntityType <https://apidocs.overte.org/Entities.html#.EntityType>`_. They have many configuration options (see `EntityProperties-ParticleEffect <https://apidocs.overte.org/Entities.html#.EntityProperties-ParticleEffect>`_) and are suitable for many situations. However, they also have a few limitations, including only supporting up to 100,000 particles / entity, only allowing flat, billboarded, quads, and moving via euler integration (position + velocity + acceleration).

Particles are a powerful tool for creating a variety of effects. When you add a Particle Entity via **Create**, you will be asked if you want it to be procedural or not.

**Non-procedural particles** are represented by the `ParticleEffect` `EntityType <https://apidocs.overte.org/Entities.html#.EntityType>`_. They have many configuration options (see `EntityProperties-ParticleEffect <https://apidocs.overte.org/Entities.html#.EntityProperties-ParticleEffect>`_) and are suitable for many situations. However, they also have a few limitations, including only supporting up to 100,000 particles / entity, only allowing flat, billboarded, quads, and moving via euler integration (position + velocity + acceleration).

JulianGro · 2024-12-18T21:40:31Z

source/create/entities/procedural-particle-entity.rst

+
+Particles are a powerful tool for creating a variety of effects. When you add a Particle Entity via **Create**, you will be asked if you want it to be procedural or not. Non-procedural particles are represented by the `ParticleEffect` `EntityType <https://apidocs.overte.org/Entities.html#.EntityType>`_. They have many configuration options (see `EntityProperties-ParticleEffect <https://apidocs.overte.org/Entities.html#.EntityProperties-ParticleEffect>`_) and are suitable for many situations. However, they also have a few limitations, including only supporting up to 100,000 particles / entity, only allowing flat, billboarded, quads, and moving via euler integration (position + velocity + acceleration).
+
+If you instead create a procedural particle entity, you will get an entity with the `ProceduralParticleEffect` `EntityType <https://apidocs.overte.org/Entities.html#.EntityType>`_. This gives you fine-grained control over a GPU particle system using procedural shaders for updating and rendering, plus higher per-system limits (up to millions of particles). Procedural particles have a different set of properties, see `EntityProperties-ProceduralParticleEffect <https://apidocs.overte.org/Entities.html#.EntityProperties-ProceduralParticleEffect>`_


Suggested change

If you instead create a procedural particle entity, you will get an entity with the `ProceduralParticleEffect` `EntityType <https://apidocs.overte.org/Entities.html#.EntityType>`_. This gives you fine-grained control over a GPU particle system using procedural shaders for updating and rendering, plus higher per-system limits (up to millions of particles). Procedural particles have a different set of properties, see `EntityProperties-ProceduralParticleEffect <https://apidocs.overte.org/Entities.html#.EntityProperties-ProceduralParticleEffect>`_

If you instead create a **procedural particle** entity, you will get an entity with the `ProceduralParticleEffect` `EntityType <https://apidocs.overte.org/Entities.html#.EntityType>`_. This gives you fine-grained control over a GPU particle system using procedural shaders for updating and rendering, plus higher per-system limits (up to millions of particles). Procedural particles have a different set of properties (see `EntityProperties-ProceduralParticleEffect <https://apidocs.overte.org/Entities.html#.EntityProperties-ProceduralParticleEffect>`_).

JulianGro · 2024-12-18T21:41:42Z

source/create/entities/procedural-particle-entity.rst

+
+    void updateParticleProps(const int particleID, inout ParticleUpdateProps particleProps)
+
+``particleProps`` will contain as many update props as you specified. For example, if ``numUpdateProps == 3``, you'll have ``particleProps.prop0``, ``particleProps.prop1``, and ``particleProps.prop2``. They will initially contain all 0s, and then will persist any values from previous frames. You can look up these properties during rendering (in both the vertex and fragment shaders) with:


Suggested change

``particleProps`` will contain as many update props as you specified. For example, if ``numUpdateProps == 3``, you'll have ``particleProps.prop0``, ``particleProps.prop1``, and ``particleProps.prop2``. They will initially contain all 0s, and then will persist any values from previous frames. You can look up these properties during rendering (in both the vertex and fragment shaders) with:

``particleProps`` will contain as many update props as you specified. For example, if ``numUpdateProps == 3``, you'll have ``particleProps.prop0``, ``particleProps.prop1``, and ``particleProps.prop2``.

They will initially contain all 0s, and then will persist any values from previous frames. You can look up these properties during rendering (in both the vertex and fragment shaders) with:

JulianGro

Actually, we should probably use GLSL syntax highlighting instead of JavaScript syntax highlighting.

JulianGro · 2024-12-18T22:01:11Z

source/create/entities/procedural-particle-entity.rst

+
+The vertex shader must implement:
+
+::


Suggested change

::

.. code-block:: glsl

JulianGro · 2024-12-18T22:01:18Z

source/create/entities/procedural-particle-entity.rst

+
+The fragment shader must implement one of the same functions as our existing procedural materials depending on version:
+
+::


Suggested change

::

.. code-block:: glsl

JulianGro · 2024-12-18T22:01:30Z

source/create/entities/procedural-particle-entity.rst

+
+Each "update prop" is a per-particle vec4 of ``float`` values. The update shader must define:
+
+::


Suggested change

::

.. code-block:: glsl

JulianGro · 2024-12-18T22:01:39Z

source/create/entities/procedural-particle-entity.rst

+
+``particleProps`` will contain as many update props as you specified. For example, if ``numUpdateProps == 3``, you'll have ``particleProps.prop0``, ``particleProps.prop1``, and ``particleProps.prop2``. They will initially contain all 0s, and then will persist any values from previous frames. You can look up these properties during rendering (in both the vertex and fragment shaders) with:
+
+::


Suggested change

::

.. code-block:: glsl

JulianGro · 2024-12-18T22:01:46Z

source/create/entities/procedural-particle-entity.rst

+
+Update shader to compute a cube of sinusoidal motion:
+
+::


Suggested change

::

.. code-block:: glsl

JulianGro · 2024-12-18T22:01:52Z

source/create/entities/procedural-particle-entity.rst

+
+Vertex shader to billboard a single triangle using a stored position property:
+
+::


Suggested change

::

.. code-block:: glsl

gpu particles

c96556e

JulianGro approved these changes Dec 18, 2024

View reviewed changes

JulianGro requested changes Dec 18, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GPU Particles #51

GPU Particles #51

HifiExperiments commented Apr 20, 2024

HifiExperiments commented Nov 2, 2024

JulianGro left a comment

JulianGro Dec 18, 2024

JulianGro Dec 18, 2024

JulianGro Dec 18, 2024

JulianGro left a comment

JulianGro Dec 18, 2024

JulianGro Dec 18, 2024

JulianGro Dec 18, 2024

JulianGro Dec 18, 2024

JulianGro Dec 18, 2024

JulianGro Dec 18, 2024


		Particles are a powerful tool for creating a variety of effects. When you add a Particle Entity via Create, you will be asked if you want it to be procedural or not. Non-procedural particles are represented by the `ParticleEffect` `EntityType <https://apidocs.overte.org/Entities.html#.EntityType>`_. They have many configuration options (see `EntityProperties-ParticleEffect <https://apidocs.overte.org/Entities.html#.EntityProperties-ParticleEffect>`_) and are suitable for many situations. However, they also have a few limitations, including only supporting up to 100,000 particles / entity, only allowing flat, billboarded, quads, and moving via euler integration (position + velocity + acceleration).

		If you instead create a procedural particle entity, you will get an entity with the `ProceduralParticleEffect` `EntityType <https://apidocs.overte.org/Entities.html#.EntityType>`_. This gives you fine-grained control over a GPU particle system using procedural shaders for updating and rendering, plus higher per-system limits (up to millions of particles). Procedural particles have a different set of properties, see `EntityProperties-ProceduralParticleEffect <https://apidocs.overte.org/Entities.html#.EntityProperties-ProceduralParticleEffect>`_


		void updateParticleProps(const int particleID, inout ParticleUpdateProps particleProps)

		``particleProps`` will contain as many update props as you specified. For example, if ``numUpdateProps == 3``, you'll have ``particleProps.prop0``, ``particleProps.prop1``, and ``particleProps.prop2``. They will initially contain all 0s, and then will persist any values from previous frames. You can look up these properties during rendering (in both the vertex and fragment shaders) with:

	``particleProps`` will contain as many update props as you specified. For example, if ``numUpdateProps == 3``, you'll have ``particleProps.prop0``, ``particleProps.prop1``, and ``particleProps.prop2``. They will initially contain all 0s, and then will persist any values from previous frames. You can look up these properties during rendering (in both the vertex and fragment shaders) with:
	``particleProps`` will contain as many update props as you specified. For example, if ``numUpdateProps == 3``, you'll have ``particleProps.prop0``, ``particleProps.prop1``, and ``particleProps.prop2``.
	They will initially contain all 0s, and then will persist any values from previous frames. You can look up these properties during rendering (in both the vertex and fragment shaders) with:


		The fragment shader must implement one of the same functions as our existing procedural materials depending on version:

		::


		Each "update prop" is a per-particle vec4 of ``float`` values. The update shader must define:

		::


		Vertex shader to billboard a single triangle using a stored position property:

		::

GPU Particles #51

Are you sure you want to change the base?

GPU Particles #51

Conversation

HifiExperiments commented Apr 20, 2024

HifiExperiments commented Nov 2, 2024

JulianGro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JulianGro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment