Interface IWriteOperation | Scriptable Build Pipeline | 1.5.10
docs.unity3d.com
    Show / Hide Table of Contents

    Interface IWriteOperation

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

    Namespace: UnityEditor.Build.Pipeline.Interfaces
    Syntax
    public interface IWriteOperation

    Properties

    Command

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

    Declaration
    WriteCommand Command { get; set; }
    Property Value
    Type Description
    WriteCommand

    ReferenceMap

    The specific reference data for objects in the write command.

    Declaration
    BuildReferenceMap ReferenceMap { get; set; }
    Property Value
    Type Description
    BuildReferenceMap

    UsageSet

    The specific usage data for objects in the write command.

    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.

    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

    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023