xiiMaterialResource Class Reference

Inheritance diagram for xiiMaterialResource:

Public Types
enum class	DefaultMaterialType {   Fullbright , FullbrightAlphaTest , Lit , LitAlphaTest ,   Sky , MissingMaterial }
	Use these enum values together with GetDefaultMaterialFileName() to get the default file names for these material types.
Public Types inherited from xiiResource
enum class	DoUpdate : xiiUInt8 { OnMainThread = 0U , OnAnyThread }
	Specifies the thread type on which update operations should be performed. More...

Public Member Functions
xiiHashedString	GetPermutationValue (const xiiTempHashedString &sName)
xiiHashedString	GetSurface () const
xiiEnum< xiiMaterialDomain >	GetDomain () const
xiiEnum< xiiMaterialShadingModel >	GetShadingModel () const
xiiEnum< xiiMaterialBlendMode >	GetBlendMode () const
xiiEnum< xiiMaterialAlphaMode >	GetAlphaMode () const
xiiBitflags< xiiMaterialFeatureFlags >	GetFeatureFlags () const
const xiiMaterialRuntimeState &	GetRuntimeState () const
xiiUInt32	GetRuntimeHash () const
xiiUInt32	GetTextureMask () const
bool	IsTranslucent () const
xiiSharedPtr< const xiiMaterialSchema >	GetSchema ()
	Returns the immutable, inheritance-flattened schema used by runtime instances.
xiiSharedPtr< xiiMaterialInstance >	GetDefaultInstance ()
xiiSharedPtr< xiiMaterialInstance >	CreateInstance ()
void	SetParameter (const xiiHashedString &sName, const xiiVariant &value)
void	SetParameter (xiiStringView sName, const xiiVariant &value)
xiiVariant	GetParameter (const xiiTempHashedString &sName)
void	SetTexture2DBinding (const xiiHashedString &sName, const xiiTexture2DResourceHandle &value)
void	SetTexture2DBinding (xiiStringView sName, const xiiTexture2DResourceHandle &value)
xiiTexture2DResourceHandle	GetTexture2DBinding (const xiiTempHashedString &sName)
void	SetTextureCubeBinding (const xiiHashedString &sName, const xiiTextureCubeResourceHandle &value)
void	SetTextureCubeBinding (xiiStringView sName, const xiiTextureCubeResourceHandle &value)
xiiTextureCubeResourceHandle	GetTextureCubeBinding (const xiiTempHashedString &sName)
void	PreserveCurrentDescription ()
	Copies current description to the loading description so the material is not modified on reset.
virtual void	ResetResource () override
const xiiMaterialResourceDescriptor &	GetCurrentDescription () const
Public Member Functions inherited from xiiResource
XII_ALWAYS_INLINE xiiStringView	GetResourceID () const
XII_ALWAYS_INLINE xiiUInt64	GetResourceIDHash () const
	Returns the hash of the unique ID.
void	SetResourceDescription (xiiStringView sDescription)
const xiiString &	GetResourceDescription () const
const xiiString &	GetResourceIdOrDescription () const
XII_ALWAYS_INLINE xiiResourceState	GetLoadingState () const
	Returns the current state in which this resource is in.
XII_ALWAYS_INLINE xiiUInt8	GetNumQualityLevelsDiscardable () const
XII_ALWAYS_INLINE xiiUInt8	GetNumQualityLevelsLoadable () const
	Returns how many quality levels the resource may additionally load.
float	GetLoadingPriority (xiiTime now) const
	Returns the priority that is used by the resource manager to determine which resource to load next.
xiiResourcePriority	GetPriority () const
	Returns the current resource priority.
void	SetPriority (xiiResourcePriority priority)
	Changes the current resource priority.
XII_ALWAYS_INLINE const xiiBitflags< xiiResourceFlags > &	GetBaseResourceFlags () const
	Returns the basic flags for the resource type. Mostly used the resource manager.
XII_ALWAYS_INLINE const MemoryUsage &	GetMemoryUsage () const
	Returns the information about the current memory usage of the resource.
XII_ALWAYS_INLINE xiiTime	GetLastAcquireTime () const
XII_ALWAYS_INLINE xiiInt32	GetReferenceCount () const
	Returns the reference count of this resource.
XII_ALWAYS_INLINE const xiiTimestamp &	GetLoadedFileModificationTime () const
XII_ALWAYS_INLINE xiiUInt32	GetCurrentResourceChangeCounter () const
XII_ALWAYS_INLINE void	IncResourceChangeCounter ()
	Allows to manually increase the resource change counter to signal that dependent code might need to update.
void	PrintHandleStackTraces ()
Public Member Functions inherited from xiiReflectedClass
virtual const xiiRTTI *	GetDynamicRTTI () const
bool	IsInstanceOf (const xiiRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.
template<typename T>
XII_ALWAYS_INLINE bool	IsInstanceOf () const
	Returns whether the type of this instance is of the given type or derived from it.

Static Public Member Functions
static xiiStringView	GetDefaultMaterialFileName (DefaultMaterialType materialType)
	Returns the default material file name for the given type (materials in Data/Base/Materials/BaseMaterials).
Static Public Member Functions inherited from xiiNoBase
static const xiiRTTI *	GetStaticRTTI ()

Private Member Functions
virtual xiiResourceLoadDescription	UnloadData (Unload WhatToUnload) override
virtual xiiResourceLoadDescription	UpdateContent (xiiStreamReader *Stream) override
virtual void	UpdateMemoryUsage (MemoryUsage &out_NewMemoryUsage) override

Additional Inherited Members
Public Attributes inherited from xiiResource
xiiEvent< const xiiResourceEvent &, xiiMutex >	m_ResourceEvents
Protected Types inherited from xiiResource
enum class	Unload : xiiUInt8 { AllQualityLevels = 0U , OneQualityLevel }
Protected Member Functions inherited from xiiResource
	xiiResource (DoUpdate resourceUpdateThread, xiiUInt8 uiQualityLevelsLoadable)
	Default constructor.
virtual	~xiiResource ()
	virtual destructor.
MemoryUsage &	ModifyMemoryUsage ()
	Non-const version for resources that want to write this variable directly.
void	SetIsReloadable (bool bIsReloadable)
void	SetHasLoadingFallback (bool bHasLoadingFallback)
	Used internally by the code injection macros.

Member Function Documentation

GetDefaultInstance()

xiiSharedPtr< xiiMaterialInstance > xiiMaterialResource::GetDefaultInstance

(

)

Returns the resource's default instance. Runtime systems should create their own instance when values are animated per object or per simulation entity.

ResetResource()

void xiiMaterialResource::ResetResource ( )

overridevirtual

If the resource has modifications from the original state, it should reset itself to that state now (or force a reload on itself).

Reimplemented from xiiResource.

UnloadData()

xiiResourceLoadDescription xiiMaterialResource::UnloadData ( Unload WhatToUnload )

overrideprivatevirtual

Requests the resource to unload another quality level. If bFullUnload is true, the resource should unload all data, because it is going to be deleted afterwards.

Implements xiiResource.

UpdateContent()

xiiResourceLoadDescription xiiMaterialResource::UpdateContent ( xiiStreamReader * pStream )

overrideprivatevirtual

Called whenever more data for the resource is available. The resource must read the stream to update it's data.

pStream may be nullptr in case the resource data could not be found.

Implements xiiResource.

UpdateMemoryUsage()

void xiiMaterialResource::UpdateMemoryUsage ( MemoryUsage & out_NewMemoryUsage )

overrideprivatevirtual

This function must be overridden by all resource types.

It has to compute the memory used by this resource. It is called by the resource manager whenever the resource's data has been loaded or unloaded.

Implements xiiResource.

---

The documentation for this class was generated from the following files:

• /home/runner/work/XII/XII/Source/Engine/GraphicsCore/Material/MaterialResource.h
• /home/runner/work/XII/XII/Source/Engine/GraphicsCore/Material/Implementation/MaterialResource.cpp