Version: 2022.3
LanguageEnglish
  • C#

ContentBuildInterface.CalculateBuildUsageTags

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

Submission failed

For 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.

Close

Cancel

Declaration

public static void CalculateBuildUsageTags(ObjectIdentifier[] objectIDs, ObjectIdentifier[] dependentObjectIDs, Build.Content.BuildUsageTagGlobal globalUsage, Build.Content.BuildUsageTagSet usageSet);

Declaration

public static void CalculateBuildUsageTags(ObjectIdentifier[] objectIDs, ObjectIdentifier[] dependentObjectIDs, Build.Content.BuildUsageTagGlobal globalUsage, Build.Content.BuildUsageTagSet usageSet, Build.Content.BuildUsageCache usageCache);

Parameters

objectIDs Objects that will have their build usage calculated.
dependentObjectIDs Objects that reference the Objects being calculated.
globalUsage Lighting information used by the build.
usageSet The BuildUsageTagSet where the calculated usage information will be stored.
usageCache Optional cache object to use for improving performance with multiple calls to this api.

Description

Calculates the build usage of a set of objects.

Internal use only. See note on ContentBuildInterface.

To calculate how any given Object is being used in a build, we need two pieces of information. First, we need to know that Object's dependents, or in other words, what references that Object. For example, for a Shader, we would need to know the list Materials that reference that shader. Second, we need the combined lighting information for Scenes where the Object can be used. Using these two pieces of information, we calculate the correct usage information for an Object, and then store that information in the BuildUsageTagSet.