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

#include <SourcePass.h>

Inheritance diagram for ezSourcePass:
Inheritance graph
[legend]

Public Member Functions

 ezSourcePass (const char *szName="SourcePass")
 
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
 
- 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.
 

Static Public Member Functions

static ezGALTextureCreationDescription GetOutputDescription (const ezViewData &viewData, const ezCamera &camera, ezEnum< ezSourceFormat > format, ezEnum< ezGALMSAASampleCount > msaaMode)
 Builds a texture description for the output based on format and MSAA settings.
 
- Static Public Member Functions inherited from ezNoBase
static const ezRTTI * GetStaticRTTI ()
 

Protected Attributes

ezRenderPipelineNodeOutputPin m_PinOutput
 Output render target.
 
ezEnum< ezSourceFormat > m_Format = ezSourceFormat::Default
 Texture format for the render target.
 
ezEnum< ezGALMSAASampleCount > m_MsaaMode = ezGALMSAASampleCount::None
 MSAA sample count.
 
ezColor m_ClearColor = ezColor::Black
 Clear color if clearing is enabled.
 
bool m_bClear = false
 Whether to clear the render target on each execution.
 

Additional Inherited Members

- Protected Member Functions inherited from ezRenderPipelinePass
void SetReadBackProperty (ezView *pView, ezStringView sPropertyName, const ezVariant &value)
 

Detailed Description

Render pass that creates a render target for other passes to render into.

Entry point pass that allocates and optionally clears a render target with specified format and MSAA settings. The output is then used by downstream passes for rendering.

Member Function Documentation

◆ AddRenderPasses()

ezStatus ezSourcePass::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 ezSourcePass::Deserialize ( ezStreamReader &  inout_stream)
overridevirtual

Reimplemented from ezRenderPipelinePass.

◆ Serialize()

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

Reimplemented from ezRenderPipelinePass.

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