ParticleSystem.CustomDataModule
Script interface for CustomDataModule.
Read time 1 minuteLast updated 7 days ago
Definition
- Type: Struct
- Namespace: UnityEngine
- Assembly: UnityEngine.ParticleSystemModule
public struct ParticleSystem.CustomDataModule
Remarks
Once configured, this module generates custom per-particle data, which you can use either in script or shaders. To read the data from script, simply call ParticleSystem.GetCustomParticleData. To read it in a shader, enable the custom data streams in the ParticleSystemRenderer Module, or call ParticleSystemRenderer.SetActiveVertexStreams from script. Once enabled, the custom data will be passed to your vertex shader through a TEXCOORD channel. The ParticleSystemRenderer Inspector will tell you which channels are being used.
Additional Resources: ParticleSystem, _customData
Properties
Property | Description |
|---|---|
| enabled | Specifies whether the CustomDataModule is enabled or disabled. |
Methods
Method | Description |
|---|---|
| GetColor | Get a ParticleSystem.MinMaxGradient, that is being used to generate custom HDR color data. |
| GetMode | Find out the type of custom data that is being generated for the chosen data stream. |
| GetVector | Get a ParticleSystem.MinMaxCurve, that is being used to generate custom data. |
| GetVectorComponentCount | Query how many ParticleSystem.MinMaxCurve elements are being used to generate this stream of custom data. |
| SetColor | Set a ParticleSystem.MinMaxGradient, in order to generate custom HDR color data. |
| SetMode | Choose the type of custom data to generate for the chosen data stream. |
| SetVector | Set a ParticleSystem.MinMaxCurve, in order to generate custom data. |
| SetVectorComponentCount | Specify how many curves are used to generate custom data for this stream. |