CeresEngine 0.2.0
A game development framework
Loading...
Searching...
No Matches
CeresEngine::BasicOutputSlot Class Reference

A basic output slot. More...

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

Inheritance diagram for CeresEngine::BasicOutputSlot:
CeresEngine::OutputSlot CeresEngine::Slot CeresEngine::TSlot< BasicOutputSlot, RT > CeresEngine::TOutput< RT >

Public Member Functions

const Vector< ConnectionPtr > & getConnections () const final
 A list of all connections to this output slot.
 
 OutputSlot (RenderTask *task, const StringView name)
 
 OutputSlot (RenderTask &task, StringView name)
 
- Public Member Functions inherited from CeresEngine::OutputSlot
 OutputSlot (RenderTask *task, const StringView name)
 
 OutputSlot (RenderTask &task, StringView name)
 
 ~OutputSlot ()
 
Type getType () const final
 
Connection * getConnection (Slot &slot) const override
 Finds a connection to the given slot.
 
ConnectionPtr connect (InputSlot &input)
 Connects the given input to this output slot.
 
bool supports (Slot &slot) const override
 Checks if this slot supports a connection to the given slot.
 
- 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.
 
virtual RenderResourceType getResourceType () const =0
 The type of resource accepted by 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 ()
 

Public Attributes

Vector< ConnectionPtr > mConnections
 The connections that use 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

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::OutputSlot
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.
 

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.
 
- 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

A basic output slot.

Member Function Documentation

◆ didConnect()

void CeresEngine::BasicOutputSlot::didConnect ( Connection &  connection)
overrideprotectedvirtual

An internal method called after the slot is connected.

Reimplemented from CeresEngine::Slot.

◆ didDisconnect()

void CeresEngine::BasicOutputSlot::didDisconnect ( Connection &  slot)
overrideprotectedvirtual

An internal method called whenever the slot is disconnected.

Reimplemented from CeresEngine::Slot.

◆ getConnections()

const Vector< ConnectionPtr > & CeresEngine::BasicOutputSlot::getConnections ( ) const
inlinefinalvirtual

A list of all connections to this output slot.

Implements CeresEngine::OutputSlot.

◆ OutputSlot() [1/2]

CeresEngine::OutputSlot::OutputSlot ( RenderTask &  task,
StringView  name 
)

◆ OutputSlot() [2/2]

CeresEngine::OutputSlot::OutputSlot ( RenderTask *  task,
const StringView  name 
)
inline

Member Data Documentation

◆ mConnections

Vector<ConnectionPtr> CeresEngine::BasicOutputSlot::mConnections

The connections that use this slot.


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