Rebel Fork Framework
Urho3D::SceneProcessor Class Reference

Scene processor for RenderPipeline. More...

#include <Urho3D/RenderPipeline/SceneProcessor.h>

Inheritance diagram for Urho3D::SceneProcessor:
Urho3D::Object Urho3D::LightProcessorCallback Urho3D::RefCounted

Public Member Functions

 SceneProcessor (RenderPipelineInterface *renderPipeline, const ea::string &shadowTechnique, ShadowMapAllocator *shadowMapAllocator, InstancingBuffer *instancingBuffer)
 
void SetPasses (ea::vector< SharedPtr< ScenePass >> passes)
 
void SetSettings (const ShaderProgramCompositorSettings &settings)
 
template<class T , class ... Args>
SharedPtr< T > CreatePass (Args &&... args)
 
bool Define (const CommonFrameInfo &frameInfo)
 
void SetRenderCamera (Camera *camera)
 
void SetRenderCameras (ea::span< Camera *const > cameras)
 
virtual void Update ()
 
void PrepareInstancingBuffer ()
 
void PrepareDrawablesBeforeRendering ()
 
void RenderShadowMaps ()
 
void RenderSceneBatches (ea::string_view debugName, Camera *camera, const PipelineBatchGroup< PipelineBatchByState > &batchGroup, ea::span< const ShaderResourceDesc > globalResources={}, ea::span< const ShaderParameterDesc > cameraParameters={}, unsigned instanceMultiplier=1u)
 
void RenderSceneBatches (ea::string_view debugName, Camera *camera, const PipelineBatchGroup< PipelineBatchBackToFront > &batchGroup, ea::span< const ShaderResourceDesc > globalResources={}, ea::span< const ShaderParameterDesc > cameraParameters={}, unsigned instanceMultipler=1u)
 
void RenderLightVolumeBatches (ea::string_view debugName, Camera *camera, ea::span< const ShaderResourceDesc > globalResources, ea::span< const ShaderParameterDesc > cameraParameters, unsigned instanceMultiplier=1u)
 
const SceneProcessorSettingsGetSettings () const
 
const FrameInfoGetFrameInfo () const
 
BatchCompositorPassGetUserPass (Object *pass) const
 
const auto & GetLightVolumeBatches () const
 
CameraProcessorGetCameraProcessor () const
 
PipelineStateBuilderGetPipelineStateBuilder () const
 
DrawableProcessorGetDrawableProcessor () const
 
BatchCompositorGetBatchCompositor () const
 
BatchRendererGetBatchRenderer () const
 
- 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 TypeInfoGetTypeInfo () 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.
 
VariantMapGetEventDataMap () 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.
 
ContextGetContext () const
 Return execution context.
 
const VariantGetGlobalVar (StringHash key) const
 
const VariantMapGetGlobalVars () const
 
void SetGlobalVar (StringHash key, const Variant &value)
 
ObjectGetSubsystem (StringHash type) const
 Return subsystem by type.
 
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
 
EventHandlerGetEventHandler () 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.
 
RefCountedoperator= (const RefCounted &rhs)=delete
 Prevent assignment.
 
int AddRef ()
 
int ReleaseRef ()
 
int Refs () const
 
int WeakRefs () const
 
RefCountRefCountPtr () 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.
 
- Public Member Functions inherited from Urho3D::LightProcessorCallback
virtual ~LightProcessorCallback ()
 Destruct.
 

Protected Member Functions

virtual void DrawOccluders ()
 

Protected Attributes

Graphicsgraphics_ {}
 
RenderDevice * renderDevice_ {}
 
RenderContext * renderContext_ {}
 
RenderPipelineInterfacerenderPipeline_ {}
 
RenderPipelineDebuggerdebugger_ {}
 
SceneProcessorSettings settings_
 
ea::vector< SharedPtr< ScenePass > > passes_
 
FrameInfo frameInfo_
 
bool flipCameraForRendering_ {}
 
OcclusionBuffercurrentOcclusionBuffer_ {}
 
ea::vector< Drawable * > occluders_
 
ea::vector< Drawable * > drawables_
 
SharedPtr< ShadowMapAllocatorshadowMapAllocator_
 
SharedPtr< InstancingBufferinstancingBuffer_
 
SharedPtr< DrawCommandQueue > drawQueue_
 
SharedPtr< CameraProcessorcameraProcessor_
 
SharedPtr< PipelineStateBuilderpipelineStateBuilder_
 
SharedPtr< DrawableProcessordrawableProcessor_
 
SharedPtr< BatchCompositorbatchCompositor_
 
SharedPtr< BatchRendererbatchRenderer_
 
SharedPtr< OcclusionBufferocclusionBuffer_
 
BatchStateCacheCallbackbatchStateCacheCallback_ {}
 
- Protected Attributes inherited from Urho3D::Object
WeakPtr< Contextcontext_
 Execution context.
 

Private Member Functions

 URHO3D_OBJECT (SceneProcessor, Object)
 
template<class T >
void RenderBatchesInternal (ea::string_view debugName, Camera *camera, const PipelineBatchGroup< T > &batchGroup, ea::span< const ShaderResourceDesc > globalResources, ea::span< const ShaderParameterDesc > cameraParameters, unsigned instanceMultiplier=1u)
 
void OnUpdateBegin (const CommonFrameInfo &frameInfo)
 
void OnRenderBegin (const CommonFrameInfo &frameInfo)
 
void OnRenderEnd (const CommonFrameInfo &frameInfo)
 
bool IsLightShadowed (Light *light) override
 
unsigned GetShadowMapSize (Light *light, unsigned numActiveSplits) const override
 Return best shadow map size for given light. Should be safe to call from multiple threads.
 
ShadowMapRegion AllocateTransientShadowMap (const IntVector2 &size) override
 Allocate shadow map for one frame.
 

Additional Inherited Members

- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.
 
- Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 > TypeHierarchy {}
 

Detailed Description

Scene processor for RenderPipeline.

Member Function Documentation

◆ CreatePass()

template<class T , class ... Args>
SharedPtr<T> Urho3D::SceneProcessor::CreatePass ( Args &&...  args)
inline

Create scene passes

◆ Define()

bool Urho3D::SceneProcessor::Define ( const CommonFrameInfo frameInfo)

Called on every frame.

◆ GetSettings()

const SceneProcessorSettings& Urho3D::SceneProcessor::GetSettings ( ) const
inline

Getters

◆ GetUserPass()

BatchCompositorPass * Urho3D::SceneProcessor::GetUserPass ( Object pass) const

Takes pass object from BatchStateCreateContext. Returns user-configured pass (inherited from BatchCompositorPass) if possible. Returns nullptr if internal pass from BatchCompositor itself (e.g. shadow or light volume pass).

◆ IsLightShadowed()

bool Urho3D::SceneProcessor::IsLightShadowed ( Light light)
overrideprivatevirtual

◆ OnUpdateBegin()

void Urho3D::SceneProcessor::OnUpdateBegin ( const CommonFrameInfo frameInfo)
private

Callbacks from RenderPipeline

◆ SetPasses()

void Urho3D::SceneProcessor::SetPasses ( ea::vector< SharedPtr< ScenePass >>  passes)

Setup. Slow, called rarely.

It's okay to pass null passes in vector.

Member Data Documentation

◆ cameraProcessor_

SharedPtr<CameraProcessor> Urho3D::SceneProcessor::cameraProcessor_
protected

Owned objects

◆ shadowMapAllocator_

SharedPtr<ShadowMapAllocator> Urho3D::SceneProcessor::shadowMapAllocator_
protected

Shared objects


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