birkeh/o3de
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

First pass at reworking and formalizing the way deferred material asset baking works. The feature basically works but needs more testing.

Browse Source 
Before, the material builder was loading the MaterialTypeAsset and doing some processing with it, but was avoiding declaring job dependencies that would cause reprocessing lots of assets when a shader or .materialtype file changes. Reading the asset data isn't safe when not declaring a job dependency (or when declaring a weak job dependency like OrderOnce which is the case here). This caused to several known bugs.

The main change here is it no longer loads the MaterialTypeAsset at all; all other changes flow from there.

The biggest changes (when deferred material processing is enabled) are ...
1) MaterialSourceData no longer loads MaterialTypeAsset. All it really needs is to determine whether a string is an image file reference or an enum value, which is easy to do by just looking for the "." for the extension.
2) MaterialAssetCreator no longer produces a finalized material asset. It no longer uses MaterialAssetCreatorCommon because that only produces a non-finalized MaterialAsset, which has very different needs for the SetPropertyValue function. (We could consider merging MaterialAssetCreatorCommon into MaterialTypeAssetCreator since that's the only subclass at this point). And it doesn't do any validation against the properties layout since that can be done at runtime.
3) Moved processing of enum property values from MaterialSourceData to MaterialAsset::Finalize (this was the only thing being done in the builder that actually needed to read the material type asset data).

Also...
- Updated the MaterialAsset class mostly to clarify and formalize the two different modes it can be in: whether it is finalized or not.
- Merged the separate "IncludeMaterialPropertyNames" registry settings from MaterialConverterSystemComponent and MaterialBuilder into one "FinalizeMaterialAssets" setting used for both.
- Removed MaterialSourceData::ApplyVersionUpdates. Now the flow of data is the same regardless of whether the materials are finalized by the AP or at runtime. Version updates are always applied on the MaterialAsset.
- Added a validation check to MaterialTypeAssetCreator ensuring that once a property is renamed, the old name can never be used again for a new property. This assumption was already made previously, but not formalized, in that Material::FindPropertyIndex does not expect every caller to provide a version number for the material property name, also the material asset's list of raw property names was never versioned. The only way for this to be a safe assumption is to prevent reuse of old names.

Signed-off-by: santorac <55155825+santorac@users.noreply.github.com>
This commit is contained in:
santorac
2021-12-17 00:46:40 -08:00
parent 56475f529c
commit c5b128bec4
17 changed files with 368 additions and 361 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Gems/Atom/RPI/Code/Source/RPI.Reflect/Material/MaterialAsset.cpp
+91 -48
View File
@@ -33,11 +33,12 @@ namespace AZ
if (auto* serializeContext = azrtti_cast<SerializeContext*>(context))
{
serializeContext->Class<MaterialAsset, AZ::Data::AssetData>()
->Version(11) // Material version update
->Version(13) // added m_rawPropertyValues
->Field("materialTypeAsset", &MaterialAsset::m_materialTypeAsset)
->Field("materialTypeVersion", &MaterialAsset::m_materialTypeVersion)
->Field("propertyValues", &MaterialAsset::m_propertyValues)
->Field("propertyNames", &MaterialAsset::m_propertyNames)
->Field("rawPropertyValues", &MaterialAsset::m_rawPropertyValues)
->Field("isFinalized", &MaterialAsset::m_isFinalized)
;
}
}
@@ -102,32 +103,95 @@ namespace AZ
{
return m_materialTypeAsset->GetMaterialPropertiesLayout();
}
AZStd::array_view<MaterialPropertyValue> MaterialAsset::GetPropertyValues() const
bool MaterialAsset::IsFinalized() const
{
// If property names are included, they are used to re-arrange the property value list to align with the
// MaterialPropertiesLayout. This realignment would be necessary if the material type is updated with
// a new property layout, and a corresponding material is not reprocessed by the AP and continues using the
// old property layout.
if (!m_propertyNames.empty())
if (m_isFinalized)
{
const uint32_t materialTypeVersion = m_materialTypeAsset->GetVersion();
if (m_materialTypeVersion < materialTypeVersion)
{
// It is possible that the material type has had some properties renamed. If that's the case, and this material
// is still referencing the old property layout, we need to apply any auto updates to rename those properties
// before using them to realign the property values.
const_cast<MaterialAsset*>(this)->ApplyVersionUpdates();
}
AZ_Assert(GetMaterialPropertiesLayout() && m_propertyValues.size() == GetMaterialPropertiesLayout()->GetPropertyCount(), "MaterialAsset is marked as Finalized but does not have the right number of property values.");
}
if (m_isDirty)
return m_isFinalized;
}
void MaterialAsset::Finalize()
{
if (IsFinalized())
{
return;
}
const uint32_t materialTypeVersion = m_materialTypeAsset->GetVersion();
if (m_materialTypeVersion < materialTypeVersion)
{
// It is possible that the material type has had some properties renamed or otherwise updated. If that's the case,
// and this material is still referencing the old property layout, we need to apply any auto updates to rename those
// properties before using them to realign the property values.
ApplyVersionUpdates();
}
const MaterialPropertiesLayout* propertyLayout = GetMaterialPropertiesLayout();
AZStd::vector<MaterialPropertyValue> finalizedPropertyValues(m_materialTypeAsset->GetDefaultPropertyValues().begin(), m_materialTypeAsset->GetDefaultPropertyValues().end());
for (const auto& [name, value] : m_rawPropertyValues)
{
const MaterialPropertyIndex propertyIndex = propertyLayout->FindPropertyIndex(name);
if (propertyIndex.IsValid())
{
const_cast<MaterialAsset*>(this)->RealignPropertyValuesAndNames();
const MaterialPropertyDescriptor* propertyDescriptor = propertyLayout->GetPropertyDescriptor(propertyIndex);
if (value.Is<AZStd::string>() && propertyDescriptor->GetDataType() == MaterialPropertyDataType::Enum)
{
AZ::Name enumName = AZ::Name(value.GetValue<AZStd::string>());
uint32_t enumValue = propertyDescriptor->GetEnumValue(enumName);
if (enumValue == MaterialPropertyDescriptor::InvalidEnumValue)
{
AZ_Error(s_debugTraceName, false, "Material property name \"%s\" has invalid enum value \"%s\".", name.GetCStr(), enumName.GetCStr());
}
else
{
finalizedPropertyValues[propertyIndex.GetIndex()] = enumValue;
}
}
else if (value.Is<AZStd::string>() && propertyDescriptor->GetDataType() == MaterialPropertyDataType::Image)
{
// Here we assume that the material asset builder resolved any image source file paths to an ImageAsset reference.
// So the only way a string could be present is if it's an empty image path reference, meaning no image should be bound.
AZ_Assert(value.GetValue<AZStd::string>().empty(), "Material property '%s' references in image '%s'. Image file paths must be resolved by the material asset builder.");
finalizedPropertyValues[propertyIndex.GetIndex()] = Data::Asset<ImageAsset>{};
}
else
{
finalizedPropertyValues[propertyIndex.GetIndex()] = value;
}
}
else
{
AZ_Warning(s_debugTraceName, false, "Material property name \"%s\" is not found in the material properties layout and will not be used.", name.GetCStr());
}
}
m_propertyValues.swap(finalizedPropertyValues);
m_isFinalized = true;
}
const AZStd::vector<MaterialPropertyValue>& MaterialAsset::GetPropertyValues() const
{
// This can't be done in MaterialAssetHandler::LoadAssetData because the MaterialTypeAsset isn't necessarily loaded at that point.
// And it can't be done in PostLoadInit() because that happens on the next frame which might be too late. So we finalize just-in-time
// when properties are accessed.
const_cast<MaterialAsset*>(this)->Finalize();
return m_propertyValues;
}
const AZStd::vector<AZStd::pair<Name, MaterialPropertyValue>>& MaterialAsset::GetRawPropertyValues() const
{
return m_rawPropertyValues;
}
void MaterialAsset::SetReady()
{
@@ -173,34 +237,6 @@ namespace AZ
}
}
void MaterialAsset::RealignPropertyValuesAndNames()
{
const MaterialPropertiesLayout* propertyLayout = GetMaterialPropertiesLayout();
AZStd::vector<MaterialPropertyValue> alignedPropertyValues(m_materialTypeAsset->GetDefaultPropertyValues().begin(), m_materialTypeAsset->GetDefaultPropertyValues().end());
for (size_t i = 0; i < m_propertyNames.size(); ++i)
{
const MaterialPropertyIndex propertyIndex = propertyLayout->FindPropertyIndex(m_propertyNames[i]);
if (propertyIndex.IsValid())
{
alignedPropertyValues[propertyIndex.GetIndex()] = m_propertyValues[i];
}
else
{
AZ_Warning(s_debugTraceName, false, "Material property name \"%s\" is not found in the material properties layout and will not be used.", m_propertyNames[i].GetCStr());
}
}
m_propertyValues.swap(alignedPropertyValues);
const size_t propertyCount = propertyLayout->GetPropertyCount();
m_propertyNames.resize(propertyCount);
for (size_t i = 0; i < propertyCount; ++i)
{
m_propertyNames[i] = propertyLayout->GetPropertyDescriptor(MaterialPropertyIndex{ i })->GetName();
}
m_isDirty = false;
}
void MaterialAsset::ApplyVersionUpdates()
{
if (m_materialTypeVersion == m_materialTypeAsset->GetVersion())
@@ -248,7 +284,13 @@ namespace AZ
// This also covers the case where just the MaterialTypeAsset is reloaded and not the MaterialAsset.
m_materialTypeAsset = newMaterialTypeAsset;
m_isDirty = true;
// If the material asset was not finalized on disk, then we clear the previously finalized property values to force re-finalize.
// This
if (!m_wasPreFinalized)
{
m_isFinalized = false;
m_propertyValues.clear();
}
// Notify interested parties that this MaterialAsset is changed and may require other data to reinitialize as well
MaterialReloadNotificationBus::Event(GetId(), &MaterialReloadNotifications::OnMaterialAssetReinitialized, Data::Asset<MaterialAsset>{this, AZ::Data::AssetLoadBehavior::PreLoad});
@@ -276,6 +318,7 @@ namespace AZ
if (Base::LoadAssetData(asset, stream, assetLoadFilterCB) == Data::AssetHandler::LoadResult::LoadComplete)
{
asset.GetAs<MaterialAsset>()->AssetInitBus::Handler::BusConnect();
asset.GetAs<MaterialAsset>()->m_wasPreFinalized = asset.GetAs<MaterialAsset>()->m_isFinalized;
return Data::AssetHandler::LoadResult::LoadComplete;
}