Legacy Documentation: Version 5.1
LanguageEnglish
  • C#
  • JS

Script language

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

AnimationCullingType

enumeration

Suggest a change

Success!

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.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual

Description

This enum controlls culling of Animation component.

When culling is enabled, Unity might stop animating if it thinks that the results of the animation won't be visible to the user. This could save you some performance if you have things animating outside of the viewport, whose animation is only important when the user can actually see the thing that is being animated. When Animation component is culled it won't do anything: it won't update animation states, execute events or sample animations.

Variables

AlwaysAnimateAnimation culling is disabled - object is animated even when offscreen.
BasedOnRenderersAnimation is disabled when renderers are not visible.
BasedOnClipBoundsAnimation is disabled when Animation.localBounds are not visible.
BasedOnUserBoundsAnimation is disabled when Animation.localBounds are not visible.