Rebel Fork Framework
Urho3D::DefaultRenderPipelineView Class Reference

Default implementation of render pipeline instance. More...

#include <Urho3D/RenderPipeline/DefaultRenderPipeline.h>

Inheritance diagram for Urho3D::DefaultRenderPipelineView:
Urho3D::RenderPipelineView Urho3D::Object Urho3D::RenderPipelineInterface Urho3D::RefCounted

Classes

struct  DeferredLightingData

Public Member Functions

 DefaultRenderPipelineView (RenderPipeline *renderPipeline)
const RenderPipelineSettings & GetSettings () const
void SetSettings (const RenderPipelineSettings &settings)
void SetRenderPath (RenderPath *renderPath)
void MarkParametersDirty ()
RenderPipelineDebugger * GetDebugger () override
bool Define (RenderSurface *renderTarget, Viewport *viewport) override
void Update (const FrameInfo &frameInfo) override
 Called for defined pipelines before rendering. Frame info is only partially filled.
void Render () override
 Called for updated pipelines in appropriate order.
const FrameInfo & GetFrameInfo () const override
 Return frame info with all members filled.
const RenderPipelineStats & GetStats () const override
 Return render pipeline statistics for profiling.
void DrawDebugGeometries (bool depthTest) override
 Draw debug geometries, if applicable.
void DrawDebugLights (bool depthTest) override
 Draw debug lights, if applicable.
Public Member Functions inherited from Urho3D::RenderPipelineView
 RenderPipelineView (RenderPipeline *renderPipeline)
RenderPipeline * GetRenderPipeline () const
Context * GetContext () const override
RenderPipelineDebugger * GetDebugger () override
bool IsLinearColorSpace () const override
Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 Construct.
 ~Object () override
 Destruct. Clean up self from event sender & receiver structures.
virtual StringHash GetType () const =0
virtual const ea::string & GetTypeName () const =0
virtual const TypeInfo * GetTypeInfo () const =0
 Return type info.
virtual bool IsInstanceOf (StringHash type) const =0
 Check whether current instance implements specified type.
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
virtual void SerializeInBlock (Archive &archive)
 Serialize content from/to archive. May throw ArchiveException.
template<typename T>
bool IsInstanceOf () const
 Check current instance is type of specified class.
template<typename T>
T * Cast ()
 Cast the object to specified most derived class.
template<typename T>
const T * Cast () const
 Cast the object to specified most derived class.
void SubscribeToEventManual (StringHash eventType, EventHandler *handler)
 Subscribe to an event that can be sent by any sender.
void SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
 Subscribe to a specific sender's event.
template<class T>
void SubscribeToEvent (StringHash eventType, T handler)
 Subscribe to an event that can be sent by any sender.
template<class T>
void SubscribeToEvent (Object *sender, StringHash eventType, T handler)
 Subscribe to a specific sender's event.
void UnsubscribeFromEvent (StringHash eventType)
 Unsubscribe from an event.
void UnsubscribeFromEvent (Object *sender, StringHash eventType)
 Unsubscribe from a specific sender's event.
void UnsubscribeFromEvents (Object *sender)
 Unsubscribe from a specific sender's events.
void UnsubscribeFromAllEvents ()
 Unsubscribe from all events.
void UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
 Unsubscribe from all events except those listed.
void UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
 Unsubscribe from all events except those with listed senders.
void SendEvent (StringHash eventType)
 Send event to all subscribers.
void SendEvent (StringHash eventType, VariantMap &eventData)
 Send event with parameters to all subscribers.
VariantMap & GetEventDataMap () const
 Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
template<typename... Args>
void SendEvent (StringHash eventType, const Args &... args)
 Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
Context * GetContext () const
 Return execution context.
const Variant & GetGlobalVar (StringHash key) const
const VariantMap & GetGlobalVars () const
void SetGlobalVar (StringHash key, const Variant &value)
Object * GetSubsystem (StringHash type) const
 Return subsystem by type.
Object * GetEventSender () const
 Return active event sender. Null outside event handling.
EventHandler * GetEventHandler () const
 Return active event handler. Null outside event handling.
bool HasSubscribedToEvent (StringHash eventType) const
 Return whether has subscribed to an event without specific sender.
bool HasSubscribedToEvent (Object *sender, StringHash eventType) const
 Return whether has subscribed to a specific sender's event.
bool HasEventHandlers () const
 Return whether has subscribed to any event.
template<class T>
T * GetSubsystem () const
 Template version of returning a subsystem.
const ea::string & GetCategory () const
void SendEvent (StringHash eventType, const VariantMap &eventData)
 Send event with parameters to all subscribers.
void SetBlockEvents (bool block)
 Block object from sending and receiving events.
bool GetBlockEvents () const
 Return sending and receiving events blocking status.
Public Member Functions inherited from Urho3D::RefCounted
 RefCounted ()
 Construct. Allocate the reference count structure and set an initial self weak reference.
virtual ~RefCounted ()
 Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
 RefCounted (const RefCounted &rhs)=delete
 Prevent copy construction.
RefCounted & operator= (const RefCounted &rhs)=delete
 Prevent assignment.
int AddRef () const
int ReleaseRef () const
int Refs () const
int WeakRefs () const
RefCount * RefCountPtr () const
 Return pointer to the reference count structure.
bool HasScriptObject () const
 Return true if script runtime object wrapping this native object exists.
bool IsScriptStrongRef () const
 Return true if script reference is strong.

Protected Member Functions

unsigned RecalculatePipelineStateHash () const
void SendViewEvent (StringHash eventType)
void ApplySettings ()
void UpdateRenderOutputFlags ()
Protected Member Functions inherited from Urho3D::RenderPipelineView
void UpdateFrameParameters ()

Private Member Functions

 URHO3D_OBJECT (DefaultRenderPipelineView, RenderPipelineView)

Private Attributes

SharedPtr< RenderPath > originalRenderPath_
SharedPtr< RenderPath > renderPath_
bool parametersDirty_ {}
RenderPipelineSettings settings_
unsigned settingsPipelineStateHash_ {}
bool settingsDirty_ {}
TextureFormat albedoFormat_ {TextureFormat::TEX_FORMAT_RGBA8_UNORM}
TextureFormat normalFormat_ {TextureFormat::TEX_FORMAT_RGBA8_UNORM}
TextureFormat specularFormat_ {TextureFormat::TEX_FORMAT_RGBA8_UNORM}
unsigned oldPipelineStateHash_ {}
 Previous pipeline state hash.
CommonFrameInfo frameInfo_
RenderOutputFlags renderOutputFlags_
RenderPipelineStats stats_
RenderPipelineDebugger debugger_
SharedRenderPassState state_
SharedPtr< RenderBufferManager > renderBufferManager_
SharedPtr< ShadowMapAllocator > shadowMapAllocator_
SharedPtr< InstancingBuffer > instancingBuffer_
SharedPtr< SceneProcessor > sceneProcessor_
SharedPtr< UnorderedScenePass > depthPrePass_
SharedPtr< UnorderedScenePass > opaquePass_
SharedPtr< UnorderedScenePass > postOpaquePass_
SharedPtr< UnorderedScenePass > deferredDecalPass_
SharedPtr< BackToFrontScenePass > alphaPass_
SharedPtr< BackToFrontScenePass > postAlphaPass_
SharedPtr< RenderBuffer > outlineBuffer_
SharedPtr< OutlineScenePass > outlineScenePass_
ea::optional< DeferredLightingData > deferred_

Additional Inherited Members

Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo * GetTypeInfoStatic ()
 Return type info static.
Public Attributes inherited from Urho3D::RenderPipelineInterface
Signal< void(const CommonFrameInfo &frameInfo)> OnUpdateBegin
Signal< void(const CommonFrameInfo &frameInfo)> OnUpdateEnd
Signal< void(const CommonFrameInfo &frameInfo)> OnRenderBegin
Signal< void(const CommonFrameInfo &frameInfo)> OnRenderEnd
Signal< void()> OnPipelineStatesInvalidated
Signal< void(RenderPipelineStats &stats)> OnCollectStatistics
Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 > TypeHierarchy {}
Protected Attributes inherited from Urho3D::RenderPipelineView
RenderPipeline *const renderPipeline_ {}
Graphics *const graphics_ {}
Renderer *const renderer_ {}
bool linearColorSpace_ {}
ea::vector< ShaderParameterDesc > frameParameters_
Protected Attributes inherited from Urho3D::Object
WeakPtr< Context > context_
 Execution context.

Detailed Description

Default implementation of render pipeline instance.

Member Function Documentation

◆ Define()

bool Urho3D::DefaultRenderPipelineView::Define ( RenderSurface * renderTarget,
Viewport * viewport )
overridevirtual

◆ DrawDebugGeometries()

void Urho3D::DefaultRenderPipelineView::DrawDebugGeometries ( bool depthTest)
overridevirtual

Draw debug geometries, if applicable.

Implements Urho3D::RenderPipelineView.

◆ DrawDebugLights()

void Urho3D::DefaultRenderPipelineView::DrawDebugLights ( bool depthTest)
overridevirtual

Draw debug lights, if applicable.

Implements Urho3D::RenderPipelineView.

◆ GetDebugger()

RenderPipelineDebugger * Urho3D::DefaultRenderPipelineView::GetDebugger ( )
inlineoverridevirtual

◆ GetFrameInfo()

const FrameInfo & Urho3D::DefaultRenderPipelineView::GetFrameInfo ( ) const
overridevirtual

Return frame info with all members filled.

Implements Urho3D::RenderPipelineView.

◆ GetStats()

const RenderPipelineStats & Urho3D::DefaultRenderPipelineView::GetStats ( ) const
inlineoverridevirtual

Return render pipeline statistics for profiling.

Implements Urho3D::RenderPipelineView.

◆ Render()

void Urho3D::DefaultRenderPipelineView::Render ( )
overridevirtual

Called for updated pipelines in appropriate order.

Implements Urho3D::RenderPipelineView.

◆ Update()

void Urho3D::DefaultRenderPipelineView::Update ( const FrameInfo & frameInfo)
overridevirtual

Called for defined pipelines before rendering. Frame info is only partially filled.

Implements Urho3D::RenderPipelineView.


The documentation for this class was generated from the following files:
  • Urho3D/RenderPipeline/DefaultRenderPipeline.h
  • Urho3D/RenderPipeline/DefaultRenderPipeline.cpp