IPassPipeline

Fully qualified name: omni::graph::exec::unstable::IPassPipeline

class IPassPipeline : public omni::core::Generated<omni::graph::exec::unstable::IPassPipeline_abi>

Runs registered passes.

The role of pass pipeline is to populate and prepare the execution graph. The base implementation runs passes based on the type and registration order. Most applications will define their own pass pipeline to control how the execution graph is generated.

See Pass Concepts for an in-depth guide on how passes are used during graph construction.

See omni::graph::exec::unstable::PassPipeline for a concrete implementation of this interface.

See Passes for more pass related functionality.

Public Functions

inline bool needsConstruction() noexcept

Test if the pipeline needs to rebuild (mostly for its acceleration structures).

An example of when a pipeline would need to be reconstructed is when a pass is either added or removed from omni::graph::exec::unstable::IPassRegistry.

inline void construct() noexcept

Build the pipeline (mostly for its acceleration structures).

inline bool needsRun(

const omni::graph::exec::unstable::Stamp &globalTopology,

) noexcept

Test if pipeline needs to run (after topology changes in the graph).

inline void run(

omni::core::ObjectParam<omni::graph::exec::unstable::IGraphBuilderContext> builderContext,

omni::core::ObjectParam<omni::graph::exec::unstable::INodeGraphDef> nodeGraphDef,

) noexcept

Run the graph transformations pipeline.

inline void *castWithoutAcquire(omni::core::TypeId id) noexcept

Casts this object to the type described the the given id.

Returns nullptr if the cast was not successful.

Unlike omni::core::IObject::cast(), this casting method does not call omni::core::IObject::acquire().

Thread Safety

This method is thread safe.

inline uint32_t getUseCount() noexcept

Returns the number of different instances (this included) referencing the current object.

Thread Safety

This method is thread safe.

inline void *cast(omni::core::TypeId id) noexcept

Returns a pointer to the interface defined by the given type id if this object implements the type id’s interface.

Objects can support multiple interfaces, even interfaces that are in different inheritance chains.

The returned object will have omni::core::IObject::acquire() called on it before it is returned, meaning it is up to the caller to call omni::core::IObject::release() on the returned pointer.

The returned pointer can be safely reinterpret_cast<> to the type id’s C++ class. For example, “omni.windowing.IWindow” can be cast to omni::windowing::IWindow.

Do not directly use this method, rather use a wrapper function like omni::core::cast() or omni::core::ObjectPtr::as().

Thread Safety

This method is thread safe.

inline void acquire() noexcept

Increments the object’s reference count.

Objects may have multiple reference counts (e.g. one per interface implemented). As such, it is important that you call omni::core::IObject::release() on the same pointer from which you called omni::core::IObject::acquire().

Do not directly use this method, rather use omni::core::ObjectPtr, which will manage calling omni::core::IObject::acquire() and omni::core::IObject::release() for you.

Thread Safety

This method is thread safe.

inline void release() noexcept

Decrements the objects reference count.

Most implementations will destroy the object if the reference count reaches 0 (though this is not a requirement).

Objects may have multiple reference counts (e.g. one per interface implemented). As such, it is important that you call omni::core::IObject::release() on the same pointer from which you called omni::core::IObject::acquire().

Do not directly use this method, rather use omni::core::ObjectPtr, which will manage calling omni::core::IObject::acquire() and omni::core::IObject::release() for you.

Thread Safety

This method is thread safe.

Protected Functions

virtual bool needsConstruction_abi() noexcept = 0

Test if the pipeline needs to rebuild (mostly for its acceleration structures).

An example of when a pipeline would need to be reconstructed is when a pass is either added or removed from omni::graph::exec::unstable::IPassRegistry.

virtual void construct_abi() noexcept = 0

Build the pipeline (mostly for its acceleration structures).

virtual bool needsRun_abi(Stamp globalTopology) noexcept = 0

Test if pipeline needs to run (after topology changes in the graph).

virtual void run_abi(

IGraphBuilderContext *builderContext,

INodeGraphDef *nodeGraphDef,

) noexcept = 0

Run the graph transformations pipeline.

virtual void *castWithoutAcquire_abi(

omni::core::TypeId id,

) noexcept = 0

Casts this object to the type described the the given id.

Returns nullptr if the cast was not successful.

Unlike omni::core::IObject::cast(), this casting method does not call omni::core::IObject::acquire().

Thread Safety

This method is thread safe.

virtual uint32_t getUseCount_abi() noexcept = 0

Returns the number of different instances (this included) referencing the current object.

Thread Safety

This method is thread safe.

virtual void *cast_abi(TypeId id) noexcept = 0

Returns a pointer to the interface defined by the given type id if this object implements the type id’s interface.

Objects can support multiple interfaces, even interfaces that are in different inheritance chains.

The returned object will have omni::core::IObject::acquire() called on it before it is returned, meaning it is up to the caller to call omni::core::IObject::release() on the returned pointer.

The returned pointer can be safely reinterpret_cast<> to the type id’s C++ class. For example, “omni.windowing.IWindow” can be cast to omni::windowing::IWindow.

Do not directly use this method, rather use a wrapper function like omni::core::cast() or omni::core::ObjectPtr::as().

Thread Safety

This method is thread safe.

virtual void acquire_abi() noexcept = 0

Increments the object’s reference count.

Objects may have multiple reference counts (e.g. one per interface implemented). As such, it is important that you call omni::core::IObject::release() on the same pointer from which you called omni::core::IObject::acquire().

Do not directly use this method, rather use omni::core::ObjectPtr, which will manage calling omni::core::IObject::acquire() and omni::core::IObject::release() for you.

Thread Safety

This method is thread safe.

virtual void release_abi() noexcept = 0

Decrements the objects reference count.

Most implementations will destroy the object if the reference count reaches 0 (though this is not a requirement).

Objects may have multiple reference counts (e.g. one per interface implemented). As such, it is important that you call omni::core::IObject::release() on the same pointer from which you called omni::core::IObject::acquire().

Do not directly use this method, rather use omni::core::ObjectPtr, which will manage calling omni::core::IObject::acquire() and omni::core::IObject::release() for you.

Thread Safety

This method is thread safe.