FSceneUniformBuffer Class Reference

#include <SceneUniformBuffer.h>

Classes
struct	FDebugMemberInfo

Public Types
using	FMemberId = FSceneUniformBufferTypeRegistry::FMemberId
using	FRegistry = FSceneUniformBufferTypeRegistry

Public Member Functions
RENDERER_API	FSceneUniformBuffer ()
template<typename TMember >
bool	Set (const TSceneUniformBufferMemberRegistration< TMember > &Registration, const TMember &Value)
template<typename TMember >
const TMember &	Get (const TSceneUniformBufferMemberRegistration< TMember > &Registration) const UE_LIFETIMEBOUND
template<typename TMember >
const TMember &	GetOrDefault (const TSceneUniformBufferMemberRegistration< TMember > &Registration, FRDGBuilder &GraphBuilder) const UE_LIFETIMEBOUND
RENDERER_API TRDGUniformBufferRef< FSceneUniformParameters >	GetBuffer (FRDGBuilder &GraphBuilder)
RENDERER_API FRHIUniformBuffer *	GetBufferRHI (FRDGBuilder &GraphBuilder)
TArray< FDebugMemberInfo >	GetDebugInfo () const

Friends
template<typename TMember >
class	TSceneUniformBufferMemberRegistration
class	FSceneUniformParameters

Detailed Description

Holds scene-scoped parameters and stores these in uniform (constant) buffers for access on GPU.

Member Typedef Documentation

FMemberId

using FSceneUniformBuffer::FMemberId = FSceneUniformBufferTypeRegistry::FMemberId

FRegistry

using FSceneUniformBuffer::FRegistry = FSceneUniformBufferTypeRegistry

Constructor & Destructor Documentation

FSceneUniformBuffer()

FSceneUniformBuffer::FSceneUniformBuffer

(

)

Member Function Documentation

Get()

template<typename TMember >

const TMember & FSceneUniformBuffer::Get ( const TSceneUniformBufferMemberRegistration< TMember > &  Registration ) const

inline

Retrieve a field in the parameter struct. If the field has not been set, this will crash.

GetBuffer()

RENDERER_API TRDGUniformBufferRef< FSceneUniformParameters > FSceneUniformBuffer::GetBuffer

(

FRDGBuilder &

GraphBuilder

)

GetBufferRHI()

RENDERER_API FRHIUniformBuffer * FSceneUniformBuffer::GetBufferRHI

(

FRDGBuilder &

GraphBuilder

)

GetDebugInfo()

TArray< FSceneUniformBuffer::FDebugMemberInfo > FSceneUniformBuffer::GetDebugInfo

(

)

const

GetOrDefault()

template<typename TMember >

const TMember & FSceneUniformBuffer::GetOrDefault ( const TSceneUniformBufferMemberRegistration< TMember > &  Registration, FRDGBuilder &  GraphBuilder  ) const

inline

Retrieve a field in the parameter struct. If the field has not been set, this will set a default value.

Set()

template<typename TMember >

bool FSceneUniformBuffer::Set ( const TSceneUniformBufferMemberRegistration< TMember > &  Registration, const TMember &  Value  )

inline

Set a field in the parameter struct. The change will be reflected in any buffer that GetBuffer() returns after this call. Returns true if anything actually changed.

Friends And Related Symbol Documentation

FSceneUniformParameters

friend class FSceneUniformParameters

friend

TSceneUniformBufferMemberRegistration

template<typename TMember >

friend class TSceneUniformBufferMemberRegistration

friend

---

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

• Engine/Source/Runtime/Renderer/Public/SceneUniformBuffer.h
• Engine/Source/Runtime/Renderer/Private/SceneUniformBuffer.cpp