Interface IAssetCompiler

Namespace

Stride.Core.Assets.Compiler

Assembly

Stride.Core.Assets.dll

Main interface for compiling an Asset.

public interface IAssetCompiler

Properties

AlwaysCheckRuntimeTypes

bool AlwaysCheckRuntimeTypes { get; }

Property Value

bool

Methods

GetInputFiles(AssetItem)

Enumerates all the dependencies required to compile this asset

IEnumerable<ObjectUrl> GetInputFiles(AssetItem assetItem)

Parameters

assetItem AssetItem

The asset for which dependencies are enumerated

Returns

IEnumerable<ObjectUrl>

The dependencies

GetInputTypes(AssetItem)

Enumerates all the asset types required to compile this asset

IEnumerable<BuildDependencyInfo> GetInputTypes(AssetItem assetItem)

Parameters

assetItem AssetItem

The asset for which types are enumerated

Returns

IEnumerable<BuildDependencyInfo>

The dependencies

GetInputTypesToExclude(AssetItem)

Enumerates all the asset types to exclude when compiling this asset

IEnumerable<Type> GetInputTypesToExclude(AssetItem assetItem)

Parameters

assetItem AssetItem

The asset for which types are enumerated

Returns

IEnumerable<Type>

The types to exclude

Remarks

This method takes higher priority, it will exclude assets included with inclusion methods even in the same compiler

GetRuntimeTypes(AssetItem)

IEnumerable<Type> GetRuntimeTypes(AssetItem assetItem)

Parameters

assetItem AssetItem

Returns

IEnumerable<Type>

Prepare(AssetCompilerContext, AssetItem)

Compiles a list of assets from the specified package.

AssetCompilerResult Prepare(AssetCompilerContext context, AssetItem assetItem)

Parameters

context AssetCompilerContext

assetItem AssetItem

The asset reference.

Returns

AssetCompilerResult

The result of the compilation.