ezEngine Release 26.9
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
ezSimpleRenderPass Class Reference

#include <SimpleRenderPass.h>

Inheritance diagram for ezSimpleRenderPass:
Inheritance graph
[legend]

Public Member Functions

 ezSimpleRenderPass (const char *szName="SimpleRenderPass")
 
virtual ezStatus AddRenderPasses (const ezViewData &viewData, const ezCamera &camera, ezRenderGraph &ref_graph, const ezArrayPtr< const ezRenderPipelinePinConnection > inputs, ezArrayPtr< ezRenderPipelinePinConnection > outputs) override
 Called by the render pipeline when this pass is active. The pass declares its render-graph passes and writes the resulting transient handles into the outputs array.
 
virtual ezResult Serialize (ezStreamWriter &inout_stream) const override
 
virtual ezResult Deserialize (ezStreamReader &inout_stream) override
 
void SetMessage (const char *szMessage)
 Sets a debug message that can be displayed during rendering.
 
- Public Member Functions inherited from ezRenderPipelinePass
 ezRenderPipelinePass (const char *szName, bool bIsStereoAware=false)
 
void SetName (const char *szName)
 Sets the name of the pass.
 
const char * GetName () const
 returns the name of the pass.
 
EZ_ALWAYS_INLINE bool IsStereoAware () const
 True if the render pipeline pass can handle stereo cameras correctly.
 
virtual void ReadBackProperties (ezView *pView)
 Allows for the pass to write data back using ezView::SetRenderPassReadBackProperty. E.g. picking results etc.
 
void DeclareRendererDependenciesForCategory (ezRenderData::Category category, ezRenderGraph &ref_graph, ezRenderGraphPassBuilder &ref_passBuilder)
 
void RenderDataWithCategory (const ezRenderViewContext &renderViewContext, ezRenderData::Category category)
 
EZ_ALWAYS_INLINE ezRenderPipeline * GetPipeline ()
 
EZ_ALWAYS_INLINE const ezRenderPipeline * GetPipeline () const
 
virtual ezStatus AddRenderPassesInactive (const ezViewData &viewData, const ezCamera &camera, ezRenderGraph &ref_graph, const ezArrayPtr< const ezRenderPipelinePinConnection > inputs, ezArrayPtr< ezRenderPipelinePinConnection > outputs)
 Called by the render pipeline when this pass is inactive instead of AddRenderPasses. The default implementation does nothing; passes that produce outputs must override this and at minimum write the same output handles they would in AddRenderPasses (typically by adding a clear pass) so downstream passes still see a valid resource.
 
virtual ezGALTextureHandle QueryTextureProvider (const ezRenderPipelineNodePin *pPin, const ezGALTextureCreationDescription &desc)
 
- Public Member Functions inherited from ezRenderPipelineNode
void InitializePins ()
 
ezHashedString GetPinName (const ezRenderPipelineNodePin *pPin) const
 
const ezRenderPipelineNodePin * GetPinByName (ezTempHashedString sName) const
 
const ezArrayPtr< const ezRenderPipelineNodePin *const > GetInputPins () const
 
const ezArrayPtr< const ezRenderPipelineNodePin *const > GetOutputPins () const
 
- Public Member Functions inherited from ezReflectedClass
virtual const ezRTTI * GetDynamicRTTI () 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.
 

Protected Attributes

ezRenderPipelineNodePassThroughPin m_PinColor
 Color target pass-through.
 
ezRenderPipelineNodePassThroughPin m_PinDepthStencil
 Depth-stencil target pass-through.
 
ezString m_sMessage
 Debug message string.
 

Additional Inherited Members

- Static Public Member Functions inherited from ezNoBase
static const ezRTTI * GetStaticRTTI ()
 
- Protected Member Functions inherited from ezRenderPipelinePass
void SetReadBackProperty (ezView *pView, ezStringView sPropertyName, const ezVariant &value)
 

Detailed Description

Basic render pass that renders into a color target.

Can work as passthrough or directly render into the view's render target if no input is present. It is responsible for rendering unlit objects, all debug rendering and also GUI elements.

Member Function Documentation

◆ AddRenderPasses()

ezStatus ezSimpleRenderPass::AddRenderPasses ( const ezViewData &  viewData,
const ezCamera &  camera,
ezRenderGraph &  ref_graph,
const ezArrayPtr< const ezRenderPipelinePinConnection >  inputs,
ezArrayPtr< ezRenderPipelinePinConnection >  outputs 
)
overridevirtual

Called by the render pipeline when this pass is active. The pass declares its render-graph passes and writes the resulting transient handles into the outputs array.

Reimplemented from ezRenderPipelinePass.

◆ Deserialize()

ezResult ezSimpleRenderPass::Deserialize ( ezStreamReader &  inout_stream)
overridevirtual

Reimplemented from ezRenderPipelinePass.

◆ Serialize()

ezResult ezSimpleRenderPass::Serialize ( ezStreamWriter &  inout_stream) const
overridevirtual

Reimplemented from ezRenderPipelinePass.

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