CeresEngine 0.2.0
A game development framework
Loading...
Searching...
No Matches
CeresEngine::TInput< RT > Class Template Referencefinal

A type-safe input slot type. More...

#include <CeresEngine/Renderer/RenderGraph/RenderGraphSlot.hpp>

Inheritance diagram for CeresEngine::TInput< RT >:
CeresEngine::TSlot< BasicInputSlot, RT > CeresEngine::BasicInputSlot CeresEngine::InputSlot CeresEngine::Slot

Public Member Functions

ConnectionPtr operator= (TSlot< BasicOutputSlot, RT > &slot)
 Connects the given output to this input slot.
 
- Public Member Functions inherited from CeresEngine::TSlot< BasicInputSlot, RT >
RenderResourceType getResourceType () const final
 The type of resource accepted by the slot.
 
- Public Member Functions inherited from CeresEngine::BasicInputSlot
const ConnectionPtr & getConnection () const final
 Finds a connection to the given slot.
 
 InputSlot (RenderTask *task, const StringView name)
 
 InputSlot (RenderTask &task, StringView name)
 
- Public Member Functions inherited from CeresEngine::InputSlot
 InputSlot (RenderTask *task, const StringView name)
 
 InputSlot (RenderTask &task, StringView name)
 
 ~InputSlot ()
 
Type getType () const final
 
Connection * getConnection (Slot &slot) const override
 Finds a connection to the given slot.
 
ConnectionPtr connect (OutputSlot &output)
 Connects the given output to this input slot.
 
bool supports (Slot &slot) const override
 Checks if this slot supports a connection to the given slot.
 
OutputSlot * getConnectedSlot () const
 Gets the output slot used in the current connection.
 
- Public Member Functions inherited from CeresEngine::Slot
 Slot (RenderTask *task, const StringView name)
 
 Slot (RenderTask &task, StringView name)
 
 ~Slot ()
 
RenderTask & getRenderTask () const
 The render task that owns this render graph slot.
 
StringView getName () const
 A human-readable name for the slot.
 
bool isInput () const
 Returns true if the slot is an input slot, false otherwise.
 
InputSlot & asInput ()
 
const InputSlot & asInput () const
 
bool isOutput () const
 Returns true if the slot is an output slot, false otherwise.
 
OutputSlot & asOutput ()
 
const OutputSlot & asOutput () const
 
bool isConnected (Slot &slot) const
 Checks if there's an active connection to the given slot.
 
UInt32 disconnectAll ()
 

Additional Inherited Members

- Public Types inherited from CeresEngine::Slot
enum class  Type { Input , Output }
 A enumeration of the types of slots. More...
 
- Static Public Member Functions inherited from CeresEngine::Slot
static ConnectionPtr connect (InputSlot &input, OutputSlot &output)
 Connects an output slot into an input slot.
 
static bool disconnect (InputSlot &input, OutputSlot &output)
 Disconnect the given slot from this slot.
 
- Public Attributes inherited from CeresEngine::Slot
Event< void(Connection &)> onConnect
 An event triggered whenever the slot is connected to another.
 
Event< void(Connection &)> onDisconnect
 An event triggered whenever the slot is disconnected from another.
 
- Protected Member Functions inherited from CeresEngine::BasicInputSlot
void didConnect (Connection &connection) override
 An internal method called after the slot is connected.
 
void didDisconnect (Connection &slot) override
 An internal method called whenever the slot is disconnected.
 
- Protected Member Functions inherited from CeresEngine::InputSlot
bool shouldDisconnect (Connection &connection) const override
 An internal method called whenever a new disconnection is being made.
 
- Protected Member Functions inherited from CeresEngine::Slot
virtual bool shouldConnect (Slot &slot) const
 An internal method called whenever a new connection is being made.
 
virtual void willConnect (Slot &slot)
 An internal method called before the slot is connected.
 
virtual void willDisconnect (Connection &connection)
 An internal method called before the slot is disconnected.
 
- Protected Attributes inherited from CeresEngine::Slot
RenderTask & mTask
 The render task that owns this render graph slot.
 
const StringView mName
 A human-readable name for the slot.
 

Detailed Description

template<typename RT>
class CeresEngine::TInput< RT >

A type-safe input slot type.

Template Parameters
RTThe type of resource that can be connected to the slot.

Member Function Documentation

◆ operator=()

Connects the given output to this input slot.


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