Skip to content
API referenceDevelopmentEngine APIEngine ccf7d03f
Synced
  • Provides the single application-level entry point for importing, loading, saving and collecting assets.

  • Owns cancellable Sample preparation and owner-thread publication through the shared source transaction.

  • Prepares isolated source catalogs and adopts them at the pipeline’s owner-thread safe point.

API: engine
Implements: System.IDisposable, Inno.Assets.IAssetLookup, Inno.Assets.IAssetReferenceResolver, Inno.Assets.IAssetPropertyStateResolver, Inno.Assets.IAssetArtifactLookup, Inno.Assets.IAssetResidency, Inno.Assets.Pipeline.IAssetSourceSnapshot
Inherits: Inno.Assets.AssetResidencyProvider
Project: Inno.Assets.Pipeline

public sealed class Inno.Assets.Pipeline.AssetPipeline : Inno.Assets.AssetResidencyProvider, System.IDisposable, Inno.Assets.IAssetLookup, Inno.Assets.IAssetReferenceResolver, Inno.Assets.IAssetPropertyStateResolver, Inno.Assets.IAssetArtifactLookup, Inno.Assets.IAssetResidency, Inno.Assets.Pipeline.IAssetSourceSnapshot
Kind Element Description
Constructors AssetPipeline.Constructor Creates one isolated authoring or deployed-runtime asset pipeline.
Events AssetPipeline.AssetReloaded Occurs after a canonical loaded asset has been updated in place.
Events AssetPipeline.Changed Occurs after an asset database transaction has committed.
Events AssetPipeline.SourceMountsChanged Occurs after a complete isolated source-mount generation is atomically replaced.
Methods AssetPipeline.AcquireArtifact Acquires one verified authoring artifact generation for an explicit lifetime.
Methods AssetPipeline.AcquireAsync(Inno.Assets.AssetPath,System.Threading.CancellationToken) Asynchronously acquires a canonical authoring asset by path for an explicit managed lifetime.
Methods AssetPipeline.AcquireAsync(System.Guid,System.Threading.CancellationToken) Asynchronously acquires a canonical authoring asset by persistent identity.
Methods AssetPipeline.BuildAsync Runs an aggregate asset build using the processor registered for a definition.
Methods AssetPipeline.CaptureProperties Captures native settings and nested asset dependencies through this explicit authoring owner.
Methods AssetPipeline.CompleteExtensionDiscovery Ends initial authoring extension discovery and strictly retries dependent imports.
Methods AssetPipeline.CreateDirectory Creates a tracked source directory and its persistent metadata.
Methods AssetPipeline.CreateSourceStore Creates a detached source editor sharing this owner’s mounts, native converters and references.
Methods AssetPipeline.Delete Deletes a source asset and its metadata while retaining a Library tombstone for existing references.
Methods AssetPipeline.Dispose Releases watchers, catalog participants, canonical objects, and rebuildable staging state.
Methods AssetPipeline.ExportRuntimeArtifacts Exports the current source-free runtime catalog and its exact artifact closure.
Methods AssetPipeline.ExportRuntimeArtifactsAsync Exports a runtime-only artifact snapshot on a worker without loading artifact files into memory.
Methods AssetPipeline.GetDependencies Gets direct or transitive runtime dependencies of an asset.
Methods AssetPipeline.GetFileSystemChildren Gets immediate indexed children of a source directory.
Methods AssetPipeline.GetFileSystemEntries Gets indexed source entries.
Methods AssetPipeline.GetImportDependencies Gets source import dependencies that invalidate an asset artifact.
Methods AssetPipeline.GetImportSettings Reads a detached settings copy for the currently registered importer.
Methods AssetPipeline.GetLoadedPaths Gets isolated source paths for all canonical loaded assets.
Methods AssetPipeline.GetReferenceInfo Gets an engine-known reference diagnostic snapshot.
Methods AssetPipeline.Import Imports one source asset from an isolated source mount.
Methods AssetPipeline.Load(Inno.Assets.AssetPath,System.Type) Loads a canonical asset using a runtime asset type selected by an authoring workflow.
Methods AssetPipeline.Load(Inno.Assets.AssetPath) Loads a canonical asset by isolated source path.
Methods AssetPipeline.Load(System.Guid) Loads a canonical asset by persistent identity.
Methods AssetPipeline.LoadAsync(Inno.Assets.AssetPath,System.Threading.CancellationToken) Asynchronously loads a canonical asset by isolated source path.
Methods AssetPipeline.LoadAsync(System.Guid,System.Threading.CancellationToken) Asynchronously loads a canonical asset by persistent identity.
Methods AssetPipeline.Move Moves a source asset while preserving its persistent identity and generated metadata.
Methods AssetPipeline.PrepareSampleImport Starts a private background sample clone without waiting for file copying or transformation.
Methods AssetPipeline.PrepareSourceMounts Builds and validates an isolated source-mount candidate without changing active AssetPipeline state.
Methods AssetPipeline.ReplaceSourceMounts Validates and atomically replaces the complete source-mount generation while preserving the active generation after any candidate failure.
Methods AssetPipeline.Rescan Reconciles source files, generated files and the persistent catalog.
Methods AssetPipeline.RestoreProperties Restores serialized properties to the existing asset object.
Methods AssetPipeline.Save(Inno.Assets.AssetObject) Saves an asset to its current source path.
Methods AssetPipeline.Save(Inno.Assets.AssetPath,Inno.Assets.AssetObject) Saves an asset to a writable isolated source path, preserving the destination source identity when it exists.
Methods AssetPipeline.SaveImportSettings Saves import settings with conflict detection and immediately attempts to reimport the source.
Methods AssetPipeline.TryGetArtifact Tries to resolve a named artifact output.
Methods AssetPipeline.TryGetAssetType Tries to resolve an asset type without loading the asset.
Methods AssetPipeline.TryGetFileSystemEntry Tries to resolve an indexed source entry.
Methods AssetPipeline.TryGetInfo(Inno.Assets.AssetPath,Inno.Assets.AssetInfo@) Tries to get a catalog snapshot by source-relative path.
Methods AssetPipeline.TryGetInfo(System.Guid,Inno.Assets.AssetInfo@) Tries to get a catalog snapshot by persistent identity.
Methods AssetPipeline.TryGetPersistentId Tries to resolve a persistent identity without loading the asset.
Methods AssetPipeline.TryLoad(Inno.Assets.AssetPath,“0@) Tries to load a canonical asset by isolated source path.
Methods AssetPipeline.TryLoad(System.Guid,“0@) Tries to load a canonical asset by persistent identity.
Methods AssetPipeline.UnloadUnusedAssets Collects assets that have no external managed references.
Methods AssetPipeline.Update Applies queued source and build changes on the initialization thread.
Methods AssetPipeline.WaitForIdle Waits until queued source watcher changes have been processed.
Properties AssetPipeline.artifactRoot Gets the absolute generated artifact root.
Properties AssetPipeline.assetRoot Gets the absolute source asset root.
Properties AssetPipeline.identities Gets the authoring identity domain shared by canonical assets and addressable source entries.
Properties AssetPipeline.isInitialized Gets whether asset services are initialized.
Properties AssetPipeline.libraryRoot Gets the absolute root containing rebuildable asset database data.
Properties AssetPipeline.revision Gets the monotonic identity of the current committed asset and source-mount state.
Properties AssetPipeline.sourceMounts Gets the active isolated source mount snapshot.