TUniformBuffer< TBufferStruct > Class Template Reference

#include <UniformBuffer.h>

Inheritance diagram for TUniformBuffer< TBufferStruct >:

Public Member Functions
	TUniformBuffer ()
	~TUniformBuffer ()
void	SetContents (FRHICommandListBase &RHICmdList, const TBufferStruct &NewContents)
void	SetContents (const TBufferStruct &NewContents)
void	SetContentsToZero (FRHICommandListBase &RHICmdList)
void	SetContentsToZero ()
const uint8 *	GetContents () const
virtual void	InitRHI (FRHICommandListBase &RHICmdList) override
virtual void	ReleaseRHI () override
FRHIUniformBuffer *	GetUniformBufferRHI () const
const TUniformBufferRef< TBufferStruct > &	GetUniformBufferRef () const
Public Member Functions inherited from FRenderResource
RENDERCORE_API	FRenderResource ()
RENDERCORE_API	FRenderResource (ERHIFeatureLevel::Type InFeatureLevel)
RENDERCORE_API	FRenderResource (const FRenderResource &)
RENDERCORE_API	FRenderResource (FRenderResource &&)
RENDERCORE_API FRenderResource &	operator= (const FRenderResource &Other)
RENDERCORE_API FRenderResource &	operator= (FRenderResource &&Other)
virtual RENDERCORE_API	~FRenderResource ()
virtual RENDERCORE_API void	InitResource (FRHICommandListBase &RHICmdList)
virtual RENDERCORE_API void	ReleaseResource ()
RENDERCORE_API void	UpdateRHI (FRHICommandListBase &RHICmdList)
virtual FString	GetFriendlyName () const
bool	IsInitialized () const
int32	GetListIndex () const
EInitPhase	GetInitPhase () const
void	SetOwnerName (FName InOwnerName)
FName	GetOwnerName () const
void	SetResourceName (FName InResourceName)
FName	GetResourceName () const

Public Attributes
EUniformBufferUsage	BufferUsage
Public Attributes inherited from FRenderResource
ERenderResourceState	ResourceState = ERenderResourceState::Default

Protected Member Functions
void	SetContentsNoUpdate (const TBufferStruct &NewContents)
Protected Member Functions inherited from FRenderResource
void	SetFeatureLevel (const FStaticFeatureLevel InFeatureLevel)
const FStaticFeatureLevel	GetFeatureLevel () const
bool	HasValidFeatureLevel () const
template<typename T >
FBufferRHIRef	CreateRHIBuffer (FRHICommandListBase &RHICmdList, T &InOutResourceObject, uint32 ResourceCount, EBufferUsageFlags InBufferUsageFlags, const TCHAR *InDebugName)
void	SetInitPhase (EInitPhase InInitPhase)

Additional Inherited Members
Public Types inherited from FRenderResource
enum class	EInitPhase : uint8 { Pre , Default , MAX }
Static Public Member Functions inherited from FRenderResource
static RENDERCORE_API void	ReleaseRHIForAllResources ()
static RENDERCORE_API void	InitPreRHIResources ()
static RENDERCORE_API void	ChangeFeatureLevel (ERHIFeatureLevel::Type NewFeatureLevel)
static RENDERCORE_API FName	SetScopeName (FName Name)
Static Protected Member Functions inherited from FRenderResource
static RENDERCORE_API FRHICommandListBase &	GetImmediateCommandList ()

Detailed Description

template<typename TBufferStruct>
class TUniformBuffer< TBufferStruct >

A uniform buffer resource.

Constructor & Destructor Documentation

TUniformBuffer()

template<typename TBufferStruct >

TUniformBuffer< TBufferStruct >::TUniformBuffer ( )

inline

~TUniformBuffer()

template<typename TBufferStruct >

TUniformBuffer< TBufferStruct >::~TUniformBuffer ( )

inline

Member Function Documentation

GetContents()

template<typename TBufferStruct >

const uint8 * TUniformBuffer< TBufferStruct >::GetContents ( ) const

inline

GetUniformBufferRef()

template<typename TBufferStruct >

const TUniformBufferRef< TBufferStruct > & TUniformBuffer< TBufferStruct >::GetUniformBufferRef ( ) const

inline

GetUniformBufferRHI()

template<typename TBufferStruct >

FRHIUniformBuffer * TUniformBuffer< TBufferStruct >::GetUniformBufferRHI ( ) const

inline

InitRHI()

template<typename TBufferStruct >

virtual void TUniformBuffer< TBufferStruct >::InitRHI ( FRHICommandListBase &  RHICmdList )

inlineoverridevirtual

Initializes the RHI resources used by this resource. Called when entering the state where both the resource and the RHI have been initialized. This is only called by the rendering thread.

Reimplemented from FRenderResource.

Reimplemented in FSpeedTreeWindNullUniformBuffer, FGPUSkinPassThroughFactoryNullUniformBuffer, FDefaultLightmapResourceClusterUniformBuffer, FDefaultMobileReflectionCaptureUniformBuffer, FEmptyPrecomputedLightingUniformBuffer, FEmptyIndirectLightingCacheUniformBuffer, FEmptyTranslucentSelfShadowUniformBuffer, and RuntimeVirtualTexture::FAstcParametersUniformBuffer.

ReleaseRHI()

template<typename TBufferStruct >

virtual void TUniformBuffer< TBufferStruct >::ReleaseRHI ( )

inlineoverridevirtual

Releases the RHI resources used by this resource. Called when leaving the state where both the resource and the RHI have been initialized. This is only called by the rendering thread.

Reimplemented from FRenderResource.

SetContents() [1/2]

template<typename TBufferStruct >

void TUniformBuffer< TBufferStruct >::SetContents ( const TBufferStruct &  NewContents )

inline

SetContents() [2/2]

template<typename TBufferStruct >

void TUniformBuffer< TBufferStruct >::SetContents ( FRHICommandListBase &  RHICmdList, const TBufferStruct &  NewContents  )

inline

Sets the contents of the uniform buffer.

SetContentsNoUpdate()

template<typename TBufferStruct >

void TUniformBuffer< TBufferStruct >::SetContentsNoUpdate ( const TBufferStruct &  NewContents )

inlineprotected

Sets the contents of the uniform buffer. Used within calls to InitRHI

SetContentsToZero() [1/2]

template<typename TBufferStruct >

void TUniformBuffer< TBufferStruct >::SetContentsToZero ( )

inline

SetContentsToZero() [2/2]

template<typename TBufferStruct >

void TUniformBuffer< TBufferStruct >::SetContentsToZero ( FRHICommandListBase &  RHICmdList )

inline

Sets the contents of the uniform buffer to all zeros.

Member Data Documentation

BufferUsage

template<typename TBufferStruct >

EUniformBufferUsage TUniformBuffer< TBufferStruct >::BufferUsage

---

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

• Engine/Source/Runtime/Engine/Public/MeshBatch.h
• Engine/Source/Runtime/RenderCore/Public/UniformBuffer.h