IAssetCompiler Interface
Namespace: Stride.Core.Assets.CompilerAssembly: Stride.Core.Assets.dll
Main interface for compiling an Asset.
public interface IAssetCompiler
Name | Description | |
---|---|---|
Properties | ||
AlwaysCheckRuntimeTypes | ||
Methods | ||
GetInputFiles(AssetItem) | Enumerates all the dependencies required to compile this asset |
|
GetInputTypes(AssetItem) | Enumerates all the asset types required to compile this asset |
|
GetInputTypesToExclude(AssetItem) | Enumerates all the asset types to exclude when compiling this asset |
|
GetRuntimeTypes(AssetItem) | ||
Prepare(AssetCompilerContext, AssetItem) | Compiles a list of assets from the specified package. |
Properties
AlwaysCheckRuntimeTypes
bool AlwaysCheckRuntimeTypes { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Methods
GetInputFiles(AssetItem)
Enumerates all the dependencies required to compile this asset
IEnumerable<ObjectUrl> GetInputFiles(AssetItem assetItem)
Parameters
Type | Name | Description |
---|---|---|
AssetItem | assetItem | The asset for which dependencies are enumerated |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<ObjectUrl> | The dependencies |
GetInputTypes(AssetItem)
Enumerates all the asset types required to compile this asset
IEnumerable<BuildDependencyInfo> GetInputTypes(AssetItem assetItem)
Parameters
Type | Name | Description |
---|---|---|
AssetItem | assetItem | The asset for which types are enumerated |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<BuildDependencyInfo> | The dependencies |
GetInputTypesToExclude(AssetItem)
Enumerates all the asset types to exclude when compiling this asset
IEnumerable<Type> GetInputTypesToExclude(AssetItem assetItem)
Parameters
Type | Name | Description |
---|---|---|
AssetItem | assetItem | The asset for which types are enumerated |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.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
Type | Name | Description |
---|---|---|
AssetItem | assetItem |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.Type> |
Prepare(AssetCompilerContext, AssetItem)
Compiles a list of assets from the specified package.
AssetCompilerResult Prepare(AssetCompilerContext context, AssetItem assetItem)
Parameters
Type | Name | Description |
---|---|---|
AssetCompilerContext | context | |
AssetItem | assetItem | The asset reference. |
Returns
Type | Description |
---|---|
AssetCompilerResult | The result of the compilation. |