IMaterialCacheTagProvider Class Reference

#include <IMaterialCacheTagProvider.h>

Inheritance diagram for IMaterialCacheTagProvider:

Public Member Functions
virtual	~IMaterialCacheTagProvider ()=default
virtual FMaterialCacheTagBindingData	GetBindingData (const FGuid &Guid)=0
virtual FMaterialCacheTagUniformData	GetUniformData (const FGuid &Guid)=0
virtual void	Register (FSceneInterface *Scene, FPrimitiveComponentId PrimitiveComponentId, const FMaterialCacheTagLayout &TagLayout, IAllocatedVirtualTexture *VirtualTexture)=0
virtual void	Unregister (FSceneInterface *Scene, FPrimitiveComponentId PrimitiveComponentId, const FGuid &TagGuid, IAllocatedVirtualTexture *VirtualTexture)=0
virtual void	Flush (FSceneInterface *Scene, FPrimitiveComponentId PrimitiveComponentId, const FGuid &TagGuid)=0
virtual void	AddTagSceneInvalidationCallback (const FGuid &TagGuid, FMaterialCacheTagProviderSceneInvalidationDelegate Delegate, void *Baton)=0
virtual void	RemoveTagSceneInvalidationCallbacks (void *Baton)=0
virtual IVirtualTexture *	CreateProducer (FSceneInterface *Scene, FPrimitiveComponentId PrimitiveComponentId, const FMaterialCacheTagLayout &TagLayout, const FVTProducerDescription &ProducerDesc)=0

Detailed Description

Serves as a general interface to decouple rendering

Constructor & Destructor Documentation

~IMaterialCacheTagProvider()

virtual IMaterialCacheTagProvider::~IMaterialCacheTagProvider ( )

virtualdefault

Member Function Documentation

AddTagSceneInvalidationCallback()

virtual void IMaterialCacheTagProvider::AddTagSceneInvalidationCallback ( const FGuid &  TagGuid, FMaterialCacheTagProviderSceneInvalidationDelegate  Delegate, void *  Baton  )

pure virtual

Add a callback for whenever the tag scene bindings / data has changed

Parameters

TagGuid	The tag to subscribe to
Delegate	Delegate to be called on invalidations
Baton	Baton to pass into the callback, also used for broad deregistration

Implemented in FMaterialCacheTagProvider.

CreateProducer()

virtual IVirtualTexture * IMaterialCacheTagProvider::CreateProducer ( FSceneInterface *  Scene, FPrimitiveComponentId  PrimitiveComponentId, const FMaterialCacheTagLayout &  TagLayout, const FVTProducerDescription &  ProducerDesc  )

pure virtual

Create

Parameters

Scene	The scene the producer renders for
PrimitiveComponentId	The primitive the producer renders for
TagLayout	Generated layout of the virtual texture
ProducerDesc	General producer description

Returns

nullptr if failed

Implemented in FMaterialCacheTagProvider.

Flush()

virtual void IMaterialCacheTagProvider::Flush ( FSceneInterface *  Scene, FPrimitiveComponentId  PrimitiveComponentId, const FGuid &  TagGuid  )

pure virtual

Flush all pages of a given tag

Parameters

Scene	Scene to flush against
PrimitiveComponentId	Primitive to flush against
TagGuid	Optional, null for default tag

Implemented in FMaterialCacheTagProvider.

GetBindingData()

virtual FMaterialCacheTagBindingData IMaterialCacheTagProvider::GetBindingData ( const FGuid &  Guid )

pure virtual

Get the scene resource binding data for a given tag

Parameters

Guid	Optional, null for default tag

Returns

Always valid

Implemented in FMaterialCacheTagProvider.

GetUniformData()

virtual FMaterialCacheTagUniformData IMaterialCacheTagProvider::GetUniformData ( const FGuid &  Guid )

pure virtual

Get the scene uniform data for a given tag

Parameters

Guid	Optional, null for default tag

Returns

Always valid

Implemented in FMaterialCacheTagProvider.

Register()

virtual void IMaterialCacheTagProvider::Register ( FSceneInterface *  Scene, FPrimitiveComponentId  PrimitiveComponentId, const FMaterialCacheTagLayout &  TagLayout, IAllocatedVirtualTexture *  VirtualTexture  )

pure virtual

Register a new virtual texture for a given primitive

Parameters

Scene	The scene it's registered against
PrimitiveComponentId	The primitive that is to own the virtual texture
TagLayout	Generated layout of the virtual texture
VirtualTexture	Texture to be registered

Implemented in FMaterialCacheTagProvider.

RemoveTagSceneInvalidationCallbacks()

virtual void IMaterialCacheTagProvider::RemoveTagSceneInvalidationCallbacks ( void *  Baton )

pure virtual

Remove all tag scene bindings / data listeners

Parameters

Baton

Baton whose listeners are to be removed

Implemented in FMaterialCacheTagProvider.

Unregister()

virtual void IMaterialCacheTagProvider::Unregister ( FSceneInterface *  Scene, FPrimitiveComponentId  PrimitiveComponentId, const FGuid &  TagGuid, IAllocatedVirtualTexture *  VirtualTexture  )

pure virtual

Deregister an existing virtual texture from a given primitive

Parameters

Scene	The scene it's registered against
PrimitiveComponentId	The primitive that owns the virtual texture
TagGuid	Optional, null for default tag
VirtualTexture	Texture to be deregistered

Implemented in FMaterialCacheTagProvider.

---

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

• Engine/Source/Runtime/Engine/Internal/MaterialCache/IMaterialCacheTagProvider.h