galaxy 1.0.0
Real-Time C++23 Game Programming Framework. Built on data-driven design principles and agile software engineering.
Loading...
Searching...
No Matches
galaxy::EditorSink Class Referencefinal

Sink to display log messages in overlay editor. More...

#include <LogPanel.hpp>

Inheritance diagram for galaxy::EditorSink:
Collaboration diagram for galaxy::EditorSink:

Public Member Functions

 EditorSink ()=default
 Constructor.
virtual ~EditorSink () noexcept
 Destructor.
void sink (const LogMessage &message) override
 Sink the message.
void clear ()
 Clear all logs stored.
const std::vector< LogMessage > & get_messages () const
 Get all stored logs.
Public Member Functions inherited from galaxy::Sink
virtual ~Sink () noexcept
 Virtual destructor.

Private Attributes

std::vector< LogMessage > m_logs
 Stored logs.

Additional Inherited Members

Protected Member Functions inherited from galaxy::Sink
 Sink ()=default
 Constructor.
 Sink (const Sink &)=default
 Copy constructor.
 Sink (Sink &&)=default
 Move constructor.
Sink & operator= (const Sink &)=default
 Copy assignment operator.
Sink & operator= (Sink &&)=default
 Move assignment operator.

Detailed Description

Sink to display log messages in overlay editor.

Definition at line 20 of file LogPanel.hpp.

Constructor & Destructor Documentation

◆ EditorSink()

galaxy::EditorSink::EditorSink ( )
default

Constructor.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ~EditorSink()

galaxy::EditorSink::~EditorSink ( )
virtualnoexcept

Destructor.

Definition at line 15 of file LogPanel.cpp.

Member Function Documentation

◆ sink()

void galaxy::EditorSink::sink ( const LogMessage & message)
overridevirtual

Sink the message.

Parameters
messageMessage data to send to sink.

Implements galaxy::Sink.

Definition at line 20 of file LogPanel.cpp.

Here is the caller graph for this function:

◆ clear()

void galaxy::EditorSink::clear ( )

Clear all logs stored.

Definition at line 25 of file LogPanel.cpp.

Here is the caller graph for this function:

◆ get_messages()

const std::vector< LogMessage > & galaxy::EditorSink::get_messages ( ) const

Get all stored logs.

Returns
List of all stored logs.

Definition at line 30 of file LogPanel.cpp.

Here is the caller graph for this function:

Member Data Documentation

◆ m_logs

std::vector<LogMessage> galaxy::EditorSink::m_logs
private

Stored logs.

Definition at line 56 of file LogPanel.hpp.


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