UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FLinuxConsoleOutputDevice Class Reference

#include <LinuxConsoleOutputDevice.h>

+ Inheritance diagram for FLinuxConsoleOutputDevice:

Public Member Functions

APPLICATIONCORE_API FLinuxConsoleOutputDevice ()
 
APPLICATIONCORE_API ~FLinuxConsoleOutputDevice ()
 
virtual APPLICATIONCORE_API void Show (bool bShowWindow)
 
virtual APPLICATIONCORE_API bool IsShown ()
 
virtual bool IsAttached ()
 
virtual APPLICATIONCORE_API bool CanBeUsedOnAnyThread () const override
 
virtual APPLICATIONCORE_API bool CanBeUsedOnPanicThread () const override
 
APPLICATIONCORE_API void Serialize (const TCHAR *Data, ELogVerbosity::Type Verbosity, const class FName &Category)
 
- Public Member Functions inherited from FOutputDeviceConsole
void SetIniFilename (const TCHAR *InFilename)
 
- Public Member Functions inherited from FOutputDevice
CORE_API FOutputDevice ()
 
CORE_API FOutputDevice (FOutputDevice &&)
 
CORE_API FOutputDevice (const FOutputDevice &)
 
CORE_API FOutputDeviceoperator= (FOutputDevice &&)
 
CORE_API FOutputDeviceoperator= (const FOutputDevice &)
 
virtual CORE_API ~FOutputDevice ()
 
virtual void Serialize (const TCHAR *V, ELogVerbosity::Type Verbosity, const FName &Category)=0
 
virtual void Serialize (const TCHAR *V, ELogVerbosity::Type Verbosity, const FName &Category, const double Time)
 
virtual CORE_API void SerializeRecord (const UE::FLogRecord &Record)
 
virtual void Flush ()
 
virtual void TearDown ()
 
void SetSuppressEventTag (bool bInSuppressEventTag)
 
UE_FORCEINLINE_HINT bool GetSuppressEventTag () const
 
void SetAutoEmitLineTerminator (bool bInAutoEmitLineTerminator)
 
UE_FORCEINLINE_HINT bool GetAutoEmitLineTerminator () const
 
virtual void Dump (class FArchive &Ar)
 
virtual bool IsMemoryOnly () const
 
virtual bool CanBeUsedOnMultipleThreads () const
 
CORE_API void Log (const TCHAR *S)
 
CORE_API void Log (ELogVerbosity::Type Verbosity, const TCHAR *S)
 
CORE_API void Log (const FName &Category, ELogVerbosity::Type Verbosity, const TCHAR *Str)
 
CORE_API void Log (const FString &S)
 
CORE_API void Log (const FText &S)
 
CORE_API void Log (ELogVerbosity::Type Verbosity, const FString &S)
 
CORE_API void Log (const FName &Category, ELogVerbosity::Type Verbosity, const FString &S)
 
template<typename FmtType >
void Logf (const FmtType &Fmt)
 
template<typename FmtType , typename... Types>
void Logf (const FmtType &Fmt, Types... Args)
 
template<typename FmtType , typename... Types>
void Logf (ELogVerbosity::Type Verbosity, const FmtType &Fmt, Types... Args)
 
template<typename FmtType , typename... Types>
void CategorizedLogf (const FName &Category, ELogVerbosity::Type Verbosity, const FmtType &Fmt, Types... Args)
 

Additional Inherited Members

- Protected Attributes inherited from FOutputDeviceConsole
FString IniFilename
 
- Protected Attributes inherited from FOutputDevice
bool bSuppressEventTag
 
bool bAutoEmitLineTerminator
 

Detailed Description

Linux implementation of console log window, just a printf to the terminal for now

Constructor & Destructor Documentation

◆ FLinuxConsoleOutputDevice()

FLinuxConsoleOutputDevice::FLinuxConsoleOutputDevice ( )

Constructor, setting console control handler.

◆ ~FLinuxConsoleOutputDevice()

FLinuxConsoleOutputDevice::~FLinuxConsoleOutputDevice ( )

Member Function Documentation

◆ CanBeUsedOnAnyThread()

bool FLinuxConsoleOutputDevice::CanBeUsedOnAnyThread ( ) const
overridevirtual
Returns
whether this output device can be used on any thread.

Reimplemented from FOutputDevice.

◆ CanBeUsedOnPanicThread()

bool FLinuxConsoleOutputDevice::CanBeUsedOnPanicThread ( ) const
overridevirtual
Returns
whether this output device can be used after a panic (crash or fatal error) has been flagged.
Note
The return value is cached by AddOutputDevice because calling this during a panic may fail.

Reimplemented from FOutputDevice.

◆ IsAttached()

virtual bool FLinuxConsoleOutputDevice::IsAttached ( )
inlinevirtual

Returns whether the application is already attached to a console window.

Returns
true if console is attached, false otherwise.

Reimplemented from FOutputDeviceConsole.

◆ IsShown()

bool FLinuxConsoleOutputDevice::IsShown ( )
virtual

Returns whether console is currently shown or not

Returns
true if console is shown, false otherwise

Implements FOutputDeviceConsole.

◆ Serialize()

void FLinuxConsoleOutputDevice::Serialize ( const TCHAR Data,
ELogVerbosity::Type  Verbosity,
const class FName Category 
)

Displays text on the console and scrolls if necessary.

Parameters
DataText to display
EventEvent type, used for filtering/ suppression

◆ Show()

void FLinuxConsoleOutputDevice::Show ( bool  bShowWindow)
virtual

Shows or hides the console window.

Parameters
ShowWindowWhether to show (true) or hide (false) the console window.

Implements FOutputDeviceConsole.


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