Class MaterialBase

Base class for Material and MaterialInstance.

Inheritance

Object

ScriptingObject

ManagedScriptingObject

Asset

BinaryAsset

MaterialBase

Inherited Members

Asset::_deleteFileOnUnload

BinaryAsset::_dependantAssets

ScriptingObject::_gcHandle

BinaryAsset::_header

ScriptingObject::_id

BinaryAsset::_isSaving

Asset::_isVirtual

Asset::_loadingTask

Asset::_loadState

Asset::_refCount

BinaryAsset::_storageRef

ScriptingObject::_type

BinaryAsset::AddDependency(BinaryAsset* asset)

Asset::AddReference()

Asset::Asset(const SpawnParams& params, const AssetInfo* info)

IMaterial::Bind(BindParameters& params)

ScriptingObject::CanCast(const ScriptingTypeHandle& from, const ScriptingTypeHandle& to)

ScriptingObject::CanCast(const MClass* from, const MClass* to)

Asset::CancelStreaming()

IMaterial::CanUseInstancing(InstancingHandler& handler)

IMaterial::CanUseLightmap()

ScriptingObject::Cast(ScriptingObject* obj)

Asset::ChangeID(const Guid& newId)

BinaryAsset::ClearDependencies()

Asset::const

BinaryAsset::createLoadingTask()

Asset::CreateManaged()

ScriptingObject::CreateManagedInternal()

Asset::DECLARE_ENUM_7(LoadResult, Ok, Failed, MissingDataChunk, CannotLoadData, CannotLoadStorage, CannotLoadInitData, InvalidData)

ScriptingObject::Deleted

Asset::DeleteManaged()

Object::DeleteObject(float timeToLive = 0.0f, bool useGameTime=false)

Object::DeleteObjectNow()

BinaryAsset::Dependencies

Asset::DEPRECATED("Use GetReferences with assets and files parameter instead")

Asset::DestroyManaged()

MaterialBase

Object::Flags

ScriptingObject::FromInterface(void* interfaceObj, const ScriptingTypeHandle& interfaceType)

ScriptingObject::FromInterface(T* interfaceObj)

BinaryAsset::GetChunk(int32 index)

BinaryAsset::GetChunkData(int32 index, BytesContainer& data)

BinaryAsset::GetChunkSize(int32 index)

BinaryAsset::getChunksToPreload()

ScriptingObject::GetClass()

IMaterial::GetDrawModes()

ScriptingObject::GetID()

BinaryAsset::GetImportMetadata(String& path, String& username)

BinaryAsset::GetImportPath()

IMaterial::GetInfo()

ScriptingObject::GetManagedInstance()

BinaryAsset::GetMemoryUsage()

BinaryAsset::GetOrCreateChunk(int32 index)

ScriptingObject::GetOrCreateManagedInstance()

BinaryAsset::GetPath()

Asset::GetReferences(Array<Guid, HeapAllocation>& assets, Array<String, HeapAllocation>& files)

Asset::GetReferences()

Asset::GetReferencesCount()

BinaryAsset::GetSerializedVersion()

IMaterial::GetShader()

ScriptingObject::GetType()

ScriptingObject::GetTypeHandle()

Asset::GetTypeName()

BinaryAsset::HasChunk(int32 index)

BinaryAsset::HasChunkLoaded(int32 index)

BinaryAsset::HasDependenciesModified()

ScriptingObject::HasManagedInstance()

BinaryAsset::Init(const FlaxStorageReference& storage, AssetHeader& header)

BinaryAsset::Init(AssetInitData& initData)

BinaryAsset::init(AssetInitData& initData)

Asset::InitAsVirtual()

BinaryAsset::InitVirtual(AssetInitData& initData)

ScriptingObject::Is(const ScriptingTypeHandle& type)

ScriptingObject::Is(const MClass* type)

ScriptingObject::Is()

IMaterial::IsDecal()

IMaterial::IsDeformable()

IMaterial::IsGUI()

Asset::IsInternalType()

Asset::IsLoaded()

IMaterial::IsParticle()

IMaterial::IsPostFx()

IMaterial::IsReady()

ScriptingObject::IsRegistered()

IMaterial::IsSurface()

IMaterial::IsTerrain()

Asset::IsVirtual()

Asset::LastLoadFailed()

BinaryAsset::load()

BinaryAsset::loadAsset()

BinaryAsset::LoadChunk(int32 chunkIndex)

BinaryAsset::LoadChunks(AssetChunksFlag chunks)

MaterialBase

Asset::Locker

ManagedScriptingObject::ManagedScriptingObject(const SpawnParams& params)

BinaryAsset::Metadata

ScriptingObject::NewObject(const ScriptingTypeHandle& typeHandle)

ScriptingObject::NewObject()

Asset::OnCheckSave(const StringView& path=StringView::Empty)

BinaryAsset::OnDeleteObject()

BinaryAsset::OnDependencyModified(BinaryAsset* asset)

Asset::onLoad(LoadAssetTask* task)

Asset::OnLoaded

Asset::onLoaded()

Asset::onLoaded_MainThread()

Asset::OnManagedInstanceDeleted()

Asset::OnReloading

BinaryAsset::onRename(const StringView& newPath)

Asset::OnScriptingDispose()

Asset::onUnload_MainThread()

Asset::OnUnloaded

ScriptingObject::RegisterObject()

BinaryAsset::Reimport()

BinaryAsset::ReleaseChunk(int32 index)

BinaryAsset::ReleaseChunks()

BinaryAsset::releaseStorage()

Asset::Reload()

Asset::RemoveReference()

BinaryAsset::RequestChunkDataAsync(int32 index)

Asset::Save(const StringView& path=StringView::Empty)

BinaryAsset::SaveAsset(AssetInitData& data, bool silentMode=false)

BinaryAsset::SaveAsset(const StringView& path, AssetInitData& data, bool silentMode=false)

BinaryAsset::SaveToAsset(const StringView& path, AssetInitData& data, bool silentMode=false)

ScriptingObject::ScriptingObject(const SpawnParams& params)

BinaryAsset::SetChunk(int32 index, const Span<byte>& data)

ManagedScriptingObject::SetManagedInstance(MObject* instance)

Asset::ShouldDeleteFileOnUnload()

MaterialBase

Asset::startLoading()

BinaryAsset::Storage

ScriptingObject::ToInterface(ScriptingObject* obj, const ScriptingTypeHandle& interfaceType)

ScriptingObject::ToInterface(ScriptingObject* obj)

ScriptingObject::ToManaged(const ScriptingObject* obj)

ScriptingObject::ToNative(MObject* obj)

Asset::ToString()

Asset::unload(bool isReloading)

ScriptingObject::UnregisterObject()

Asset::WaitForLoaded(double timeoutInMilliseconds=30000.0)

BinaryAsset::~BinaryAsset()

Object::~Object()

ScriptingObject::~ScriptingObject()

Assembly: FlaxEngine.dll

File: Engine/Content/Assets/MaterialBase.h

Syntax

public class MaterialBase : public BinaryAsset, public IMaterial

Fields

Params

The material parameters collection.

Declaration

public MaterialParams Params

Field Value

MaterialParams

ParamsChanged

Event called when parameters collections gets modified.

Declaration

public Action ParamsChanged

Field Value

Action

Methods

CreateVirtualInstance()

Creates the virtual material instance of this material which allows to override any material parameters.

Declaration

public MaterialInstance* CreateVirtualInstance()

Returns

MaterialInstance The created virtual material instance asset.

GetParameter(const StringView& name)

Gets the material parameter.

Declaration

public MaterialParameter* GetParameter(const StringView& name)

Parameters

StringView name

Returns

MaterialParameter

GetParameters()

Gets the material parameters collection.

Declaration

public Array<MaterialParameter> GetParameters() const

Returns

Array<MaterialParameter>

GetParameterValue(const StringView& name)

Gets the material parameter value.

Declaration

public Variant GetParameterValue(const StringView& name)

Parameters

StringView name

Returns

Variant The parameter value.

GetReferences(Array<Guid>& assets, Array<String>& files)

Declaration

public void GetReferences(Array<Guid>& assets, Array<String>& files) const override

Parameters

Array<Guid> assets

Array<String> files

Info()

Gets the material info, structure which describes material surface.

Declaration

public MaterialInfo Info() const

Returns

MaterialInfo

IsMaterialInstance()

Returns true if material is a material instance.

Declaration

public virtual bool IsMaterialInstance() const = 0

Returns

bool

SetParameterValue(const StringView& name, const Variant& value, bool warnIfMissing=true)

Sets the material parameter value (and sets IsOverride to true).

Declaration

public void SetParameterValue(const StringView& name, const Variant& value, bool warnIfMissing=true)

Parameters

StringView name The parameter name.

Variant value The value to set.

bool warnIfMissing True to warn if parameter is missing, otherwise will do nothing.

See Also