class in UnityEngine
/
Inherits from:Renderer
/
Implemented in:UnityEngine.ParticleSystemModule
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseUse this class to render particles on to the screen.
activeTrailVertexStreamsCount | The number of currently active custom trail vertex streams. |
activeVertexStreamsCount | The number of currently active custom vertex streams. |
alignment | Control the direction that particles face. |
allowRoll | Allow billboard particles to roll around their z-axis. |
cameraVelocityScale | How much do the particles stretch depending on the Camera's speed. |
enableGPUInstancing | Enables GPU Instancing on platforms that support it. |
flip | Flip a percentage of the particles, along each axis. |
freeformStretching | Enables freeform stretching behavior. |
lengthScale | How much are the particles stretched in their direction of motion, defined as the length of the particle compared to its width. |
maskInteraction | Specifies how the Particle System Renderer interacts with SpriteMask. |
maxParticleSize | Clamp the maximum particle size. |
mesh | The Mesh that the particle uses instead of a billboarded Texture. |
meshCount | The number of Meshes the system uses for particle rendering. |
meshDistribution | Specifies how the system randomly assigns meshes to particles. |
minParticleSize | Clamp the minimum particle size. |
normalDirection | Specifies how to calculate lighting for the billboard. |
pivot | Modify the pivot point used for rotating particles. |
renderMode | Specifies how the system draws particles. |
rotateWithStretchDirection | Rotate the particles based on the direction they are stretched in. This is added on top of other particle rotation. |
shadowBias | Apply a shadow bias to prevent self-shadowing artifacts. The specified value is the proportion of the particle size. |
sortingFudge | Biases Particle System sorting amongst other transparencies. |
sortMode | Specifies how to sort particles within a system. |
supportsMeshInstancing | Determines whether the Particle System can be rendered using GPU Instancing. |
trailMaterial | Set the Material that the TrailModule uses to attach trails to particles. |
velocityScale | Specifies how much particles stretch depending on their velocity. |
BakeMesh | Creates a snapshot of ParticleSystemRenderer and stores it in a mesh. |
BakeTexture | Creates a snapshot of ParticleSystemRenderer and stores it in a Texture2D. |
BakeTrailsMesh | Creates a snapshot of ParticleSystem Trails and stores them in a mesh. |
BakeTrailsTexture | Creates a snapshot of ParticleSystem Trails and stores them in a Texture2D. |
GetActiveTrailVertexStreams | Queries which trail Vertex Shader streams are enabled on the ParticleSystemRenderer. |
GetActiveVertexStreams | Queries which Vertex Shader streams are enabled on the ParticleSystemRenderer. |
GetMeshes | Gets the array of Meshes to use when selecting particle meshes. |
GetMeshWeightings | Gets the array of Mesh weightings to use when randomly selecting particle meshes. |
SetActiveTrailVertexStreams | Enables a set of Vertex Shader streams on the ParticleSystemRenderer for particle trails. |
SetActiveVertexStreams | Enables a set of Vertex Shader streams on the ParticleSystemRenderer. |
SetMeshes | Sets the Meshes that the ParticleSystemRenderer uses to display particles when the ParticleSystemRenderer.renderMode is set to ParticleSystemRenderMode.Mesh. |
SetMeshWeightings | Sets the weights that the ParticleSystemRenderer uses to assign Meshes to particles. |
gameObject | The game object this component is attached to. A component is always attached to a game object. |
tag | The tag of this game object. |
transform | The Transform attached to this GameObject. |
hideFlags | Should the object be hidden, saved with the Scene or modifiable by the user? |
name | The name of the object. |
allowOcclusionWhenDynamic | Controls if dynamic occlusion culling should be performed for this renderer. |
bounds | The bounding box of the renderer in world space. |
enabled | Makes the rendered 3D object visible if enabled. |
forceRenderingOff | Allows turning off rendering for a specific component. |
isPartOfStaticBatch | Indicates whether the renderer is part of a static batch with other renderers. |
isVisible | Is this renderer visible in any camera? (Read Only) |
lightmapIndex | The index of the baked lightmap applied to this renderer. |
lightmapScaleOffset | The UV scale & offset used for a lightmap. |
lightProbeProxyVolumeOverride | If set, the Renderer will use the Light Probe Proxy Volume component attached to the source GameObject. |
lightProbeUsage | The light probe interpolation type. |
localBounds | The bounding box of the renderer in local space. |
localToWorldMatrix | Matrix that transforms a point from local space into world space (Read Only). |
material | Returns the first instantiated Material assigned to the renderer. |
materials | Returns all the instantiated materials of this object. |
motionVectorGenerationMode | Specifies the mode for motion vector rendering. |
probeAnchor | If set, Renderer will use this Transform's position to find the light or reflection probe. |
rayTracingMode | Describes how this renderer is updated for ray tracing. |
realtimeLightmapIndex | The index of the real-time lightmap applied to this renderer. |
realtimeLightmapScaleOffset | The UV scale & offset used for a real-time lightmap. |
receiveShadows | Does this object receive shadows? |
reflectionProbeUsage | Should reflection probes be used for this Renderer? |
rendererPriority | This value sorts renderers by priority. Lower values are rendered first and higher values are rendered last. |
renderingLayerMask | Determines which rendering layer this renderer lives on, if you use a scriptable render pipeline. |
shadowCastingMode | Does this object cast shadows? |
sharedMaterial | The shared material of this object. |
sharedMaterials | All the shared materials of this object. |
sortingLayerID | Unique ID of the Renderer's sorting layer. |
sortingLayerName | Name of the Renderer's sorting layer. |
sortingOrder | Renderer's order within a sorting layer. |
staticShadowCaster | Is this renderer a static shadow caster? |
worldToLocalMatrix | Matrix that transforms a point from world space into local space (Read Only). |
BroadcastMessage | Calls the method named methodName on every MonoBehaviour in this game object or any of its children. |
CompareTag | Checks the GameObject's tag against the defined tag. |
GetComponent | Gets a reference to a component of type T on the same GameObject as the component specified. |
GetComponentInChildren | Gets a reference to a component of type T on the same GameObject as the component specified, or any child of the GameObject. |
GetComponentIndex | Gets the index of the component on its parent GameObject. |
GetComponentInParent | Gets a reference to a component of type T on the same GameObject as the component specified, or any parent of the GameObject. |
GetComponents | Gets references to all components of type T on the same GameObject as the component specified. |
GetComponentsInChildren | Gets references to all components of type T on the same GameObject as the component specified, and any child of the GameObject. |
GetComponentsInParent | Gets references to all components of type T on the same GameObject as the component specified, and any parent of the GameObject. |
SendMessage | Calls the method named methodName on every MonoBehaviour in this game object. |
SendMessageUpwards | Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. |
TryGetComponent | Gets the component of the specified type, if it exists. |
GetInstanceID | Gets the instance ID of the object. |
ToString | Returns the name of the object. |
GetClosestReflectionProbes | Returns an array of closest reflection probes with weights, weight shows how much influence the probe has on the renderer, this value is also used when blending between reflection probes occur. |
GetMaterials | Returns all the instantiated materials of this object. |
GetPropertyBlock | Get per-Renderer or per-Material property block. |
GetSharedMaterials | Returns all the shared materials of this object. |
HasPropertyBlock | Returns true if the Renderer has a material property block attached via SetPropertyBlock. |
ResetBounds | Reset custom world space bounds. |
ResetLocalBounds | Reset custom local space bounds. |
SetMaterials | Assigns the shared materials of this object using the list of materials provided. |
SetPropertyBlock | Lets you set or clear per-renderer or per-material parameter overrides. |
SetSharedMaterials | Assigns the shared materials of this object using the list of materials provided. |
Destroy | Removes a GameObject, component or asset. |
DestroyImmediate | Destroys the object obj immediately. You are strongly recommended to use Destroy instead. |
DontDestroyOnLoad | Do not destroy the target Object when loading a new Scene. |
FindAnyObjectByType | Retrieves any active loaded object of Type type. |
FindFirstObjectByType | Retrieves the first active loaded object of Type type. |
FindObjectOfType | Returns the first active loaded object of Type type. |
FindObjectsByType | Retrieves a list of all loaded objects of Type type. |
FindObjectsOfType | Gets a list of all loaded objects of Type type. |
Instantiate | Clones the object original and returns the clone. |
InstantiateAsync | Captures a snapshot of the original object (that must be related to some GameObject) and returns the AsyncInstantiateOperation. |
bool | Does the object exist? |
operator != | Compares if two objects refer to a different object. |
operator == | Compares two object references to see if they refer to the same object. |
OnBecameInvisible | OnBecameInvisible is called when the object is no longer visible by any camera. |
OnBecameVisible | OnBecameVisible is called when the object became visible by any camera. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.