Legacy Documentation: Version 2018.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

ParticleSystem.automaticCullingEnabled

Other Versions
Leave feedback
Switch to Manual
public bool automaticCullingEnabled;

Description

Does this system support Automatic Culling?

Internally, each Particle System has 2 modes of operating: procedural and non-procedural.

In procedural mode, it is possible to know the state of a Particle System for any point in time (past and future) whereas a non-procedural system is unpredictable. This means that it is possible to quickly fast forward (and rewind) a procedural system to any point in time.

When a system goes out of the view of any camera, it becomes culled. When this occurs, a procedural system will stop updating. It will efficiently fast forward to the new point in time when the system becomes visible again. A non-procedural system cannot do this, it must continue updating the system even when offscreen, due to its unpredictable nature.

In order to support Automtic Culling, only a subset of the Particle System modules and properties can be used. For example, using the Limit Velocity over Lifetime module will disable Automatic Culling. Additionally, modifying any properties from script whilst the system is playing will also disable Automatic Culling.

To discover if you are using any properties that disable this feature, a small speech bubble appears in the upper right corner of the Inspector. The tooltip for this icon gives you details about why Automatic Culling is disabled.

using UnityEngine;

public class CustomParticleCulling : MonoBehaviour
{
    public float cullingRadius = 10.0f;
    public ParticleSystem target;

    private CullingGroup m_CullingGroup;

    void Start ()
    {
        if (target.automaticCullingEnabled)
        {
            enabled = false;
            return
        }

        m_CullingGroup = new CullingGroup();
        m_CullingGroup.targetCamera = Camera.main;
        m_CullingGroup.SetBoundingSpheres(new BoundingSphere[] { new BoundingSphere(transform.position, cullingRadius) });
        m_CullingGroup.SetBoundingSphereCount(1);
        m_CullingGroup.onStateChanged += OnStateChanged;
    }

    void OnStateChanged(CullingGroupEvent sphere)
    {
        if (sphere.isVisible)
        {
            // We could simulate forward a little here to hide that the system was not updated off-screen.
            target.Play(true);
        }
        else
        {
            target.Pause();
        }
    }

    void OnDestroy()
    {
        if(m_CullingGroup != null)
            m_CullingGroup.Dispose();
    }

    void OnDrawGizmos()
    {
        // Draw gizmos to show the culling sphere.
        Gizmos.color = Color.yellow;
        Gizmos.DrawWireSphere(transform.position, cullingRadius);
    }
}

Did you find this page useful? Please give it a rating:

  • Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

    Copyright © 2018 Unity Technologies. Publication: 2018.1-002N. Built: 2018-12-04.
    TutorialsCommunity AnswersKnowledge BaseForumsAsset StoreLegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information