Interface IWriteOperation

Base interface for wrapping the different low level WriteSerializeFile API around a common high level Write function

Namespace: UnityEditor.Build.Pipeline.Interfaces

Assembly: Unity.ScriptableBuildPipeline.Editor.dll

Syntax

public interface IWriteOperation

Properties

Command

The specific write command containing the details about what to write to disk. WriteCommand

Declaration

WriteCommand Command { get; set; }

Property Value

Type	Description
WriteCommand

DependencyHash

The hash that represents the unique set of input dependencies for caching this write command.

Declaration

Hash128 DependencyHash { get; set; }

Property Value

Type	Description
Hash128

ReferenceMap

The specific reference data for objects in the write command. BuildReferenceMap

Declaration

BuildReferenceMap ReferenceMap { get; set; }

Property Value

Type	Description
BuildReferenceMap

UsageSet

The specific usage data for objects in the write command. BuildUsageTagSet

Declaration

BuildUsageTagSet UsageSet { get; set; }

Property Value

Type	Description
BuildUsageTagSet

Methods

GetHash128()

Optimized hash function for use with the Build Cache system.

Declaration

Hash128 GetHash128()

Returns

Type	Description
Hash128	Unique hash for the contents of this write operation.

GetHash128(IBuildLogger)

Optimized hash function for use with the Build Cache system.

Declaration

Hash128 GetHash128(IBuildLogger log)

Parameters

Type	Name	Description
IBuildLogger	log	The build log.

Returns

Type	Description
Hash128	Unique hash for the contents of this write operation.

Write(string, BuildSettings, BuildUsageTagGlobal)

Write function that wraps the low level WriteSerializeFile APIs that takes the common minimum set of parameters.

Declaration

WriteResult Write(string outputFolder, BuildSettings settings, BuildUsageTagGlobal globalUsage)

Parameters

Type	Name	Description
string	outputFolder	The location to write data to disk.
BuildSettings	settings	The build settings to use for writing data.
BuildUsageTagGlobal	globalUsage	The global usage to use for writing data.

Returns

Type	Description
WriteResult	The write results struct containing details about what was written to disk