Urho3D::RenderPipelineView Class Referenceabstract
Base interface of render pipeline viewport instance. More...
#include <Urho3D/RenderPipeline/RenderPipeline.h>
Inheritance diagram for Urho3D::RenderPipelineView:
Public Member Functions | |
| RenderPipelineView (RenderPipeline *renderPipeline) | |
| RenderPipeline * | GetRenderPipeline () const |
| virtual bool | Define (RenderSurface *renderTarget, Viewport *viewport)=0 |
| Called in the beginning of the update to check if pipeline should be executed. | |
| virtual void | Update (const FrameInfo &frameInfo)=0 |
| Called for defined pipelines before rendering. Frame info is only partially filled. | |
| virtual void | Render ()=0 |
| Called for updated pipelines in appropriate order. | |
| virtual const FrameInfo & | GetFrameInfo () const =0 |
| Return frame info with all members filled. | |
| virtual const RenderPipelineStats & | GetStats () const =0 |
| Return render pipeline statistics for profiling. | |
| virtual void | DrawDebugGeometries (bool depthTest)=0 |
| Draw debug geometries, if applicable. | |
| virtual void | DrawDebugLights (bool depthTest)=0 |
| Draw debug lights, if applicable. | |
| 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 () |
| int | ReleaseRef () |
| 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 Attributes | |
| RenderPipeline *const | renderPipeline_ {} |
| Graphics *const | graphics_ {} |
| Renderer *const | renderer_ {} |
| bool | linearColorSpace_ {} |
| Protected Attributes inherited from Urho3D::Object | |
| WeakPtr< Context > | context_ |
| Execution context. | |
Private Member Functions | |
| URHO3D_OBJECT (RenderPipelineView, Object) | |
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 {} |
Detailed Description
Base interface of render pipeline viewport instance.
Member Function Documentation
◆ GetContext()
|
inlineoverridevirtual |
Implement RenderPipelineInterface
Implements Urho3D::RenderPipelineInterface.
Reimplemented in Urho3D::StereoRenderPipelineView.
The documentation for this class was generated from the following files:
- Urho3D/RenderPipeline/RenderPipeline.h
- Urho3D/RenderPipeline/RenderPipeline.cpp