Urho3D::RenderPath Class Reference
Base class for serializable resource that uses Archive serialization. More...
#include <Urho3D/RenderPipeline/RenderPath.h>
Inheritance diagram for Urho3D::RenderPath:
Public Member Functions | |
| RenderPath (Context *context) | |
| void | CollectParameters (StringVariantMap ¶ms) const |
| Fill missing parameters with defaults. | |
| void | InitializeView (RenderPipelineView *view) |
| Initialize render path before using it in view. | |
| void | UpdateParameters (const RenderPipelineSettings &settings, const EnabledRenderPasses &enabledPasses, const StringVariantMap ¶ms) |
| Update settings for all passes. | |
| void | Update (const SharedRenderPassState &sharedState) |
| Perform update that does not invoke any rendering commands. | |
| void | Render (const SharedRenderPassState &sharedState) |
| Execute render commands. | |
| SharedPtr< RenderPath > | Clone () const |
| Make deep copy of RenderPath. | |
| EnabledRenderPasses | RepairEnabledRenderPasses (const EnabledRenderPasses &sourcePasses) const |
| Repair the array of enabled render passes. | |
| const ea::vector< SharedPtr< RenderPass > > & | GetPasses () const |
| const RenderPassTraits & | GetAggregatedPassTraits () const |
| void | AddPass (RenderPass *pass) |
| void | RemovePass (RenderPass *pass) |
| void | ReorderPass (RenderPass *pass, unsigned index) |
| void | SerializeInBlock (Archive &archive) override |
 Public Member Functions inherited from Urho3D::SimpleResource | |
| SimpleResource (Context *context) | |
| Construct. | |
| bool | Save (Serializer &dest, InternalResourceFormat format) const |
| Save resource in specified internal format. | |
| bool | SaveFile (const FileIdentifier &fileName, InternalResourceFormat format) const |
| Save file with specified internal format. | |
| bool | BeginLoad (Deserializer &source) override |
| bool | EndLoad () override |
| Finish resource loading. Always called from the main thread. Return true if successful. | |
| bool | Save (Serializer &dest) const override |
| Save resource. Return true if successful. | |
| bool | SaveFile (const FileIdentifier &fileName) const override |
| Save resource to file. | |
| Public Member Functions inherited from Urho3D::Resource | |
| Resource (Context *context) | |
| Construct. | |
| bool | Load (Deserializer &source) |
| Load resource synchronously. Call both BeginLoad() & EndLoad() and return true if both succeeded. | |
| bool | LoadFile (const FileIdentifier &fileName) |
| Load resource from file. | |
| void | SetName (const ea::string &name) |
| void | SetMemoryUse (unsigned size) |
| Set memory use in bytes, possibly approximate. | |
| void | ResetUseTimer () |
| Reset last used timer. | |
| void | SetAsyncLoadState (AsyncLoadState newState) |
| Set the asynchronous loading state. Called by ResourceCache. Resources in the middle of asynchronous loading are not normally returned to user. | |
| void | SetAbsoluteFileName (const ea::string &fileName) |
| Set absolute file name. | |
| const ea::string & | GetName () const |
| StringHash | GetNameHash () const |
| Return name hash. | |
| unsigned | GetMemoryUse () const |
| unsigned | GetUseTimer () |
| AsyncLoadState | GetAsyncLoadState () const |
| Return the asynchronous loading state. | |
| const ea::string & | GetAbsoluteFileName () const |
| Return absolute file name. | |
| 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. | |
| 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. | |
Static Public Member Functions | |
| static void | RegisterObject (Context *context) |
| Static Public Member Functions inherited from Urho3D::Resource | |
| static Resource * | LoadFromCache (Context *context, StringHash type, const ea::string &name) |
| Load resource by reference. | |
| Static Public Member Functions inherited from Urho3D::Object | |
| static const TypeInfo * | GetTypeInfoStatic () |
| Return type info static. | |
Private Attributes | |
| ea::vector< SharedPtr< RenderPass > > | passes_ |
| RenderPassTraits | traits_ |
Additional Inherited Members | |
| Static Public Attributes inherited from Urho3D::Object | |
| static constexpr ea::array< StringHash, 0 > | TypeHierarchy {} |
| Protected Member Functions inherited from Urho3D::SimpleResource | |
| virtual BinaryMagic | GetBinaryMagic () const |
| Binary archive magic word. Should be 4 bytes. | |
| virtual const char * | GetRootBlockName () const |
| Root block name. Used for XML serialization only. | |
| virtual InternalResourceFormat | GetDefaultInternalFormat () const |
| Default internal resource format on save. | |
| virtual bool | LoadLegacyXML (const XMLElement &source) |
| Try to load legacy XML format, whatever it is. | |
| Protected Attributes inherited from Urho3D::Object | |
| WeakPtr< Context > | context_ |
| Execution context. | |
Detailed Description
Base class for serializable resource that uses Archive serialization.
Member Function Documentation
◆ GetPasses()
|
inline |
Manage passes.
◆ SerializeInBlock()
|
overridevirtual |
Implement SimpleResource.
Implements Urho3D::SimpleResource.
The documentation for this class was generated from the following files:
- Urho3D/RenderPipeline/RenderPath.h
- Urho3D/RenderPipeline/RenderPath.cpp