Class OpenXRFeatureBuildHooks | OpenXR Plugin | 0.1.2-preview.2
docs.unity3d.com
    Show / Hide Table of Contents

    Class OpenXRFeatureBuildHooks

    Inherit from this class to get callbacks to hook into the build process when your OpenXR Extension is enabled.

    Inheritance
    Object
    OpenXRFeatureBuildHooks
    Inherited Members
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: UnityEditor.XR.OpenXR.Features
    Syntax
    public abstract class OpenXRFeatureBuildHooks : IPostGenerateGradleAndroidProject, IPostprocessBuildWithReport, IPreprocessBuildWithReport, IOrderedCallback

    Properties

    callbackOrder

    Returns the current callback order for build processing.

    Declaration
    public abstract int callbackOrder { get; }
    Property Value
    Type Description
    Int32

    Int value denoting the callback oarder.

    Implements
    IOrderedCallback.callbackOrder

    featureType

    System.Type of the class that implements OpenXRFeature.

    Declaration
    public abstract Type featureType { get; }
    Property Value
    Type Description
    Type

    Methods

    OnPostGenerateGradleAndroidProject(String)

    Post process build step for checking if a feature is enabled for android builds. If so will call to the feature to run their build post processing for android builds.

    Declaration
    public virtual void OnPostGenerateGradleAndroidProject(string path)
    Parameters
    Type Name Description
    String path

    Path to gradle project.

    Implements
    IPostGenerateGradleAndroidProject.OnPostGenerateGradleAndroidProject(String)

    OnPostGenerateGradleAndroidProjectExt(String)

    Called during build process when extension is enabled. Implement this function to receive a callback after the Android Gradle project is generated and before building begins. Function is not called for Internal builds.

    Declaration
    protected abstract void OnPostGenerateGradleAndroidProjectExt(string path)
    Parameters
    Type Name Description
    String path

    The path to the root of the Gradle project. Note: When exporting the project, this parameter holds the path to the folder specified for export.

    OnPostprocessBuild(BuildReport)

    Pre-process build step for checking if a feature is enabled. If so will call to the feature to run their build post processing.

    Declaration
    public virtual void OnPostprocessBuild(BuildReport report)
    Parameters
    Type Name Description
    BuildReport report

    Build report.

    Implements
    IPostprocessBuildWithReport.OnPostprocessBuild(BuildReport)

    OnPostprocessBuildExt(BuildReport)

    Called during the build process when extension is enabled. Implement this function to receive a callback after the build is complete.

    Declaration
    protected abstract void OnPostprocessBuildExt(BuildReport report)
    Parameters
    Type Name Description
    BuildReport report

    BuildReport that contains information about the build, such as the target platform and output path.

    OnPreprocessBuild(BuildReport)

    Post process build step for checking if a feature is enabled. If so will call to the feature to run their build pre processing.

    Declaration
    public virtual void OnPreprocessBuild(BuildReport report)
    Parameters
    Type Name Description
    BuildReport report

    Build report.

    Implements
    IPreprocessBuildWithReport.OnPreprocessBuild(BuildReport)

    OnPreprocessBuildExt(BuildReport)

    Called during the build process when the feature is enabled. Implement this function to receive a callback before the build starts.

    Declaration
    protected abstract void OnPreprocessBuildExt(BuildReport report)
    Parameters
    Type Name Description
    BuildReport report

    Report that contains information about the build, such as its target platform and output path.

    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