ezEngine Release 26.9
Loading...
Searching...
No Matches
ezMsgExtractRenderData Struct Reference
Inheritance diagram for ezMsgExtractRenderData:

Public Member Functions

 EZ_DECLARE_MESSAGE_TYPE (ezMsgExtractRenderData, ezMessage)
 
void AddRenderData (const ezRenderData *pRenderData, ezRenderData::Category category, ezRenderData::Caching::Enum cachingBehavior)
 Adds render data for the current view. This data can be cached depending on the specified caching behavior. Non-cached data is only valid for this frame. Cached data must be manually deleted using the ezRenderWorld::DeleteCachedRenderData function.
 
void AddDependency (ezGALTextureHandle hTexture, ezRenderData::Category category, ezBitflags< ezGALResourceState > requiredState, ezBitflags< ezGALShaderStageFlags > stage=ezGALShaderStageFlags::Auto)
 Records that the given texture must be in requiredState when category is rendered. Invalid handles are ignored so safe to pass in without checking. Like render data, dependencies are cached for static objects when the component's render data is cached.
 
void AddDependency (ezGALBufferHandle hBuffer, ezRenderData::Category category, ezBitflags< ezGALResourceState > requiredState, ezBitflags< ezGALShaderStageFlags > stage=ezGALShaderStageFlags::Auto)
 Records that the given buffer must be in requiredState when category is rendered. Invalid handles are ignored so safe to pass in without checking. Like render data, dependencies are cached for static objects when the component's render data is cached.
 
- Public Member Functions inherited from ezMessage
virtual ezInt32 GetSortingKey () const
 Derived message types can override this method to influence sorting order. Smaller keys are processed first.
 
EZ_ALWAYS_INLINE ezMessageId GetId () const
 Returns the id for this message type.
 
EZ_ALWAYS_INLINE ezUInt16 GetSize () const
 Returns the size in byte of this message.
 
EZ_ALWAYS_INLINE ezUInt64 GetHash () const
 Calculates a hash of the message.
 
virtual void Serialize (ezStreamWriter &inout_stream) const
 Implement this for efficient transmission across process boundaries (e.g. network transfer etc.)
 
virtual void Deserialize (ezStreamReader &inout_stream, ezUInt8 uiTypeVersion)
 
- Public Member Functions inherited from ezReflectedClass
virtual const ezRTTIGetDynamicRTTI () const
 
bool IsInstanceOf (const ezRTTI *pType) const
 Returns whether the type of this instance is of the given type or derived from it.
 
template<typename T >
EZ_ALWAYS_INLINE bool IsInstanceOf () const
 Returns whether the type of this instance is of the given type or derived from it.
 

Public Attributes

const ezViewm_pView = nullptr
 
const ezRenderDataManagerm_pRenderDataManager = nullptr
 
ezRenderData::Category m_OverrideCategory = ezInvalidRenderDataCategory
 

Friends

class ezExtractor
 

Additional Inherited Members

- Static Public Member Functions inherited from ezMessage
static void PackageForTransfer (const ezMessage &msg, ezStreamWriter &inout_stream)
 Writes msg to stream in such a way that ReplicatePackedMessage() can restore it even in another process.
 
static ezUniquePtr< ezMessageReplicatePackedMessage (ezStreamReader &inout_stream)
 Restores a message that was written by PackageForTransfer()
 
- Static Public Member Functions inherited from ezNoBase
static const ezRTTIGetStaticRTTI ()
 
- Protected Member Functions inherited from ezMessage
 ezMessage (size_t messageSize)
 
- Static Protected Member Functions inherited from ezMessage
static EZ_ALWAYS_INLINE ezMessageId GetNextMsgId ()
 
- Protected Attributes inherited from ezMessage
ezMessageId m_Id
 
ezUInt16 m_uiSize
 
- Static Protected Attributes inherited from ezMessage
static ezMessageId s_NextMsgId = 0
 

Member Function Documentation

◆ AddDependency() [1/2]

void ezMsgExtractRenderData::AddDependency ( ezGALBufferHandle  hBuffer,
ezRenderData::Category  category,
ezBitflags< ezGALResourceState requiredState,
ezBitflags< ezGALShaderStageFlags stage = ezGALShaderStageFlags::Auto 
)

Records that the given buffer must be in requiredState when category is rendered. Invalid handles are ignored so safe to pass in without checking. Like render data, dependencies are cached for static objects when the component's render data is cached.

See also
ezRenderPipelinePass::DeclareRendererDependenciesForCategory

◆ AddDependency() [2/2]

void ezMsgExtractRenderData::AddDependency ( ezGALTextureHandle  hTexture,
ezRenderData::Category  category,
ezBitflags< ezGALResourceState requiredState,
ezBitflags< ezGALShaderStageFlags stage = ezGALShaderStageFlags::Auto 
)

Records that the given texture must be in requiredState when category is rendered. Invalid handles are ignored so safe to pass in without checking. Like render data, dependencies are cached for static objects when the component's render data is cached.

See also
ezRenderPipelinePass::DeclareRendererDependenciesForCategory

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