Class StandardMaterialMapper

Converts TriLib virtual materials into Unity Standard materials. This mapper is designed to work with the Unity Standard shader and processes texture maps and various material properties (e.g., diffuse, glossiness, metallic, emission, normal, occlusion, and displacement) using an asynchronous coroutine pipeline.

Inheritance

object

Object

ScriptableObject

MaterialMapper

StandardMaterialMapper

AutodeskInteractiveStandardMaterialMapper

glTF2StandardMaterialMapper

Inherited Members

MaterialMapper.CheckingOrder

MaterialMapper.DisableAlpha

MaterialMapper.ApplyMaterialToRenderer(MaterialRendererContext)

MaterialMapper.Cleanup(MaterialRendererContext)

MaterialMapper.Map(MaterialMapperContext)

MaterialMapper.CheckTextureOffsetAndScaling(TextureLoadingContext)

MaterialMapper.CheckTextureOffsetAndScaling(MaterialMapperContext, ITexture, bool)

MaterialMapper.CheckTextureOffsetAndScalingCoroutine(TextureLoadingContext)

MaterialMapper.BuildMaterial(MaterialMapperContext)

MaterialMapper.LoadTextureWithCallbacks(MaterialMapperContext, TextureType, ITexture, params Action<TextureLoadingContext>[])

MaterialMapper.LoadTextureWithCoroutineCallbacks(MaterialMapperContext, TextureType, ITexture, params Func<TextureLoadingContext, IEnumerable>[])

MaterialMapper.RegisteredMapperNamespaces

MaterialMapper.RegisteredMappers

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsOfType<T>(bool)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindObjectOfType(Type, bool)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: TriLibCore.Mappers

Assembly: Assembly-CSharp.dll

Syntax

[Serializable]
[CreateAssetMenu(menuName = "TriLib/Mappers/Material/Standard Material Mapper", fileName = "StandardMaterialMapper")]
public class StandardMaterialMapper : MaterialMapper

Fields

ForceShaderVariantCollection

Declaration

public bool ForceShaderVariantCollection

Field Value

Type	Description
bool

Properties

ConvertMaterialTextures

Indicates whether this Material Mapper does "Metallic/Smoothness/Specular/Roughness/Emission" automatic texture creation.

Declaration

public override bool ConvertMaterialTextures { get; }

Property Value

Type	Description
bool

Overrides

MaterialMapper.ConvertMaterialTextures

CutoutMaterialPreset

A cutout material preset for materials that use alpha testing (fully transparent vs. fully opaque).

Declaration

public override Material CutoutMaterialPreset { get; }

Property Value

Type	Description
Material

Overrides

MaterialMapper.CutoutMaterialPreset

CutoutMaterialPresetNoMetallicTexture

A cutout material preset for materials with no metallic texture usage.

Declaration

public override Material CutoutMaterialPresetNoMetallicTexture { get; }

Property Value

Type	Description
Material

Overrides

MaterialMapper.CutoutMaterialPresetNoMetallicTexture

ExtractMetallicAndSmoothness

Indicates whether this Material Mapper automatically extracts Metallic and Smoothness textures.

Declaration

public override bool ExtractMetallicAndSmoothness { get; }

Property Value

Type	Description
bool

Overrides

MaterialMapper.ExtractMetallicAndSmoothness

LoadingMaterial

An optional placeholder material used while a model’s final materials and textures are still loading.

Declaration

public override Material LoadingMaterial { get; }

Property Value

Type	Description
Material

Overrides

MaterialMapper.LoadingMaterial

MaterialPreset

The default (opaque) material preset.

Declaration

public override Material MaterialPreset { get; }

Property Value

Type	Description
Material

Overrides

MaterialMapper.MaterialPreset

MaterialPresetNoMetallicTexture

The default (opaque) material preset for materials with no metallic texture usage.

Declaration

public override Material MaterialPresetNoMetallicTexture { get; }

Property Value

Type	Description
Material

Overrides

MaterialMapper.MaterialPresetNoMetallicTexture

TransparentComposeMaterialPreset

A “compose” material preset used in layered alpha workflows when AlphaMaterialMode is set to CutoutAndTransparent. This is applied as a secondary pass for partially transparent regions.

Declaration

public override Material TransparentComposeMaterialPreset { get; }

Property Value

Type	Description
Material

Overrides

MaterialMapper.TransparentComposeMaterialPreset

TransparentComposeMaterialPresetNoMetallicTexture

The “compose” material preset for partially transparent materials that have no metallic texture usage.

Declaration

public override Material TransparentComposeMaterialPresetNoMetallicTexture { get; }

Property Value

Type	Description
Material

Overrides

MaterialMapper.TransparentComposeMaterialPresetNoMetallicTexture

TransparentMaterialPreset

A fully transparent (alpha) material preset.

Declaration

public override Material TransparentMaterialPreset { get; }

Property Value

Type	Description
Material

Overrides

MaterialMapper.TransparentMaterialPreset

TransparentMaterialPresetNoMetallicTexture

A fully transparent (alpha) material preset for materials without a metallic texture.

Declaration

public override Material TransparentMaterialPresetNoMetallicTexture { get; }

Property Value

Type	Description
Material

Overrides

MaterialMapper.TransparentMaterialPresetNoMetallicTexture

UseShaderVariantCollection

If overridden to return true, indicates that this mapper uses a Shader Variant Collection instead of the usual material presets. By default, it returns false.

Declaration

public override bool UseShaderVariantCollection { get; }

Property Value

Type	Description
bool

Overrides

MaterialMapper.UseShaderVariantCollection

Remarks

Implementers can override this to provide advanced material handling, especially when working with different pipelines or specialized shader setups.

UsesCoroutines

Indicates whether this mapper’s Map(MaterialMapperContext) process requires an asynchronous coroutine approach (true), or can run synchronously (false).

Declaration

public override bool UsesCoroutines { get; }

Property Value

Type	Description
bool

Overrides

MaterialMapper.UsesCoroutines

Remarks

Returning true means MapCoroutine(MaterialMapperContext) will be called instead of Map(MaterialMapperContext).

Methods

ApplyDiffuseMapTexture(TextureLoadingContext)

Declaration

protected virtual IEnumerable ApplyDiffuseMapTexture(TextureLoadingContext textureLoadingContext)

Parameters

Type	Name	Description
TextureLoadingContext	textureLoadingContext

Returns

Type	Description
IEnumerable

ApplyDisplacementTexture(TextureLoadingContext)

Declaration

protected virtual IEnumerable ApplyDisplacementTexture(TextureLoadingContext textureLoadingContext)

Parameters

Type	Name	Description
TextureLoadingContext	textureLoadingContext

Returns

Type	Description
IEnumerable

ApplyEmissionMapTexture(TextureLoadingContext)

Declaration

protected virtual IEnumerable ApplyEmissionMapTexture(TextureLoadingContext textureLoadingContext)

Parameters

Type	Name	Description
TextureLoadingContext	textureLoadingContext

Returns

Type	Description
IEnumerable

ApplyGlossinessMapTexture(TextureLoadingContext)

Declaration

protected virtual IEnumerable ApplyGlossinessMapTexture(TextureLoadingContext textureLoadingContext)

Parameters

Type	Name	Description
TextureLoadingContext	textureLoadingContext

Returns

Type	Description
IEnumerable

ApplyMetallicGlossMapTexture(TextureLoadingContext)

Declaration

protected virtual IEnumerable ApplyMetallicGlossMapTexture(TextureLoadingContext textureLoadingContext)

Parameters

Type	Name	Description
TextureLoadingContext	textureLoadingContext

Returns

Type	Description
IEnumerable

ApplyNormalMapTexture(TextureLoadingContext)

Declaration

protected virtual IEnumerable ApplyNormalMapTexture(TextureLoadingContext textureLoadingContext)

Parameters

Type	Name	Description
TextureLoadingContext	textureLoadingContext

Returns

Type	Description
IEnumerable

ApplyOcclusionMapTexture(TextureLoadingContext)

Declaration

protected virtual IEnumerable ApplyOcclusionMapTexture(TextureLoadingContext textureLoadingContext)

Parameters

Type	Name	Description
TextureLoadingContext	textureLoadingContext

Returns

Type	Description
IEnumerable

CheckDiffuseColor(MaterialMapperContext)

Declaration

protected virtual IEnumerable CheckDiffuseColor(MaterialMapperContext materialMapperContext)

Parameters

Type	Name	Description
MaterialMapperContext	materialMapperContext

Returns

Type	Description
IEnumerable

CheckDiffuseMapTexture(MaterialMapperContext)

Declaration

protected virtual IEnumerable CheckDiffuseMapTexture(MaterialMapperContext materialMapperContext)

Parameters

Type	Name	Description
MaterialMapperContext	materialMapperContext

Returns

Type	Description
IEnumerable

CheckDisplacementTexture(MaterialMapperContext)

Declaration

protected virtual IEnumerable CheckDisplacementTexture(MaterialMapperContext materialMapperContext)

Parameters

Type	Name	Description
MaterialMapperContext	materialMapperContext

Returns

Type	Description
IEnumerable

CheckEmissionColor(MaterialMapperContext)

Declaration

protected virtual IEnumerable CheckEmissionColor(MaterialMapperContext materialMapperContext)

Parameters

Type	Name	Description
MaterialMapperContext	materialMapperContext

Returns

Type	Description
IEnumerable

CheckEmissionMapTexture(MaterialMapperContext)

Declaration

protected virtual IEnumerable CheckEmissionMapTexture(MaterialMapperContext materialMapperContext)

Parameters

Type	Name	Description
MaterialMapperContext	materialMapperContext

Returns

Type	Description
IEnumerable

CheckGlossinessMapTexture(MaterialMapperContext)

Declaration

protected virtual IEnumerable CheckGlossinessMapTexture(MaterialMapperContext materialMapperContext)

Parameters

Type	Name	Description
MaterialMapperContext	materialMapperContext

Returns

Type	Description
IEnumerable

CheckGlossinessValue(MaterialMapperContext)

Declaration

protected virtual IEnumerable CheckGlossinessValue(MaterialMapperContext materialMapperContext)

Parameters

Type	Name	Description
MaterialMapperContext	materialMapperContext

Returns

Type	Description
IEnumerable

CheckMetallicGlossMapTexture(MaterialMapperContext)

Declaration

protected virtual IEnumerable CheckMetallicGlossMapTexture(MaterialMapperContext materialMapperContext)

Parameters

Type	Name	Description
MaterialMapperContext	materialMapperContext

Returns

Type	Description
IEnumerable

CheckMetallicValue(MaterialMapperContext)

Declaration

protected virtual IEnumerable CheckMetallicValue(MaterialMapperContext materialMapperContext)

Parameters

Type	Name	Description
MaterialMapperContext	materialMapperContext

Returns

Type	Description
IEnumerable

CheckNormalMapTexture(MaterialMapperContext)

Declaration

protected virtual IEnumerable CheckNormalMapTexture(MaterialMapperContext materialMapperContext)

Parameters

Type	Name	Description
MaterialMapperContext	materialMapperContext

Returns

Type	Description
IEnumerable

CheckOcclusionMapTexture(MaterialMapperContext)

Declaration

protected virtual IEnumerable CheckOcclusionMapTexture(MaterialMapperContext materialMapperContext)

Parameters

Type	Name	Description
MaterialMapperContext	materialMapperContext

Returns

Type	Description
IEnumerable

CheckSpecularMapTexture(MaterialMapperContext)

Declaration

protected virtual IEnumerable CheckSpecularMapTexture(MaterialMapperContext materialMapperContext)

Parameters

Type	Name	Description
MaterialMapperContext	materialMapperContext

Returns

Type	Description
IEnumerable

CheckTransparencyMapTexture(MaterialMapperContext)

Declaration

protected virtual IEnumerable CheckTransparencyMapTexture(MaterialMapperContext materialMapperContext)

Parameters

Type	Name	Description
MaterialMapperContext	materialMapperContext

Returns

Type	Description
IEnumerable

GetDiffuseColorName(MaterialMapperContext)

Retrieves the property name for the diffuse (albedo) color within this mapper’s target shaders.

Declaration

public override string GetDiffuseColorName(MaterialMapperContext materialMapperContext)

Parameters

Type	Name	Description
MaterialMapperContext	materialMapperContext	Context containing the TriLib virtual material and Unity material references.

Returns

Type	Description
string

Overrides

MaterialMapper.GetDiffuseColorName(MaterialMapperContext)

GetDiffuseTextureName(MaterialMapperContext)

Retrieves the property name for the diffuse (albedo) texture within this mapper’s target shaders.

Declaration

public override string GetDiffuseTextureName(MaterialMapperContext materialMapperContext)

Parameters

Type	Name	Description
MaterialMapperContext	materialMapperContext	Context containing the TriLib virtual material and Unity material references.

Returns

Type	Description
string

Overrides

MaterialMapper.GetDiffuseTextureName(MaterialMapperContext)

GetEmissionColorName(MaterialMapperContext)

Retrieves the property name for the emissive color within this mapper’s target shaders.

Declaration

public override string GetEmissionColorName(MaterialMapperContext materialMapperContext)

Parameters

Type	Name	Description
MaterialMapperContext	materialMapperContext	Context containing the TriLib virtual material and Unity material references.

Returns

Type	Description
string

Overrides

MaterialMapper.GetEmissionColorName(MaterialMapperContext)

GetGlossinessOrRoughnessName(MaterialMapperContext)

Retrieves the property name for glossiness or roughness, depending on the shader’s workflow.

Declaration

public override string GetGlossinessOrRoughnessName(MaterialMapperContext materialMapperContext)

Parameters

Type	Name	Description
MaterialMapperContext	materialMapperContext	Context containing the TriLib virtual material and Unity material references.

Returns

Type	Description
string

Overrides

MaterialMapper.GetGlossinessOrRoughnessName(MaterialMapperContext)

GetGlossinessOrRoughnessTextureName(MaterialMapperContext)

Retrieves the property name for the glossiness or roughness texture, if applicable.

Declaration

public override string GetGlossinessOrRoughnessTextureName(MaterialMapperContext materialMapperContext)

Parameters

Type	Name	Description
MaterialMapperContext	materialMapperContext	Context containing the TriLib virtual material and Unity material references.

Returns

Type	Description
string

Overrides

MaterialMapper.GetGlossinessOrRoughnessTextureName(MaterialMapperContext)

GetMetallicName(MaterialMapperContext)

Retrieves the property name for metallic values in PBR workflows.

Declaration

public override string GetMetallicName(MaterialMapperContext materialMapperContext)

Parameters

Type	Name	Description
MaterialMapperContext	materialMapperContext	Context containing the TriLib virtual material and Unity material references.

Returns

Type	Description
string

Overrides

MaterialMapper.GetMetallicName(MaterialMapperContext)

GetMetallicTextureName(MaterialMapperContext)

Retrieves the property name for the metallic texture, if used in the target shader.

Declaration

public override string GetMetallicTextureName(MaterialMapperContext materialMapperContext)

Parameters

Type	Name	Description
MaterialMapperContext	materialMapperContext	Context containing the TriLib virtual material and Unity material references.

Returns

Type	Description
string

Overrides

MaterialMapper.GetMetallicTextureName(MaterialMapperContext)

IsCompatible(MaterialMapperContext)

Determines whether this mapper can handle the specified material (e.g., by checking shader keywords, pipeline features, or other criteria). Mappers with false returns are skipped in favor of others with higher compatibility.

Declaration

public override bool IsCompatible(MaterialMapperContext materialMapperContext)

Parameters

Type	Name	Description
MaterialMapperContext	materialMapperContext	The context providing references to both the TriLib VirtualMaterial data and the underlying Unity UnityEngine.Material.

Returns

Type	Description
bool	true if compatible; otherwise false.

Overrides

MaterialMapper.IsCompatible(MaterialMapperContext)

MapCoroutine(MaterialMapperContext)

Begins the material mapping process asynchronously, yielding control back to the caller to allow frame updates or concurrent loading. Called if UsesCoroutines returns true.

Declaration

public override IEnumerable MapCoroutine(MaterialMapperContext materialMapperContext)

Parameters

Type	Name	Description
MaterialMapperContext	materialMapperContext	Holds references to the TriLib virtual material, the target Unity material, and the overall AssetLoaderContext.

Returns

Type	Description
IEnumerable	An IEnumerable sequence that yields at intermediate steps for cooperative asynchronous processing.

Overrides

MaterialMapper.MapCoroutine(MaterialMapperContext)

Extension Methods

IObjectExtensions.TryToDispose<T>(object)