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

#include <MacConsoleOutputDevice.h>

+ Inheritance diagram for FMacConsoleOutputDevice:

Public Member Functions

 FMacConsoleOutputDevice ()
 
 ~FMacConsoleOutputDevice ()
 
virtual void Show (bool ShowWindow)
 
virtual bool IsShown ()
 
virtual bool IsAttached ()
 
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 CanBeUsedOnAnyThread () const
 
virtual bool CanBeUsedOnMultipleThreads () const
 
virtual bool CanBeUsedOnPanicThread () 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

Mac implementation of console log window, utilizing the Win32 console API

Constructor & Destructor Documentation

◆ FMacConsoleOutputDevice()

FMacConsoleOutputDevice::FMacConsoleOutputDevice ( )

Constructor, setting console control handler.

◆ ~FMacConsoleOutputDevice()

FMacConsoleOutputDevice::~FMacConsoleOutputDevice ( )

Member Function Documentation

◆ IsAttached()

virtual bool FMacConsoleOutputDevice::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 FMacConsoleOutputDevice::IsShown ( )
virtual

Returns whether console is currently shown or not

Returns
true if console is shown, false otherwise

Implements FOutputDeviceConsole.

◆ Serialize()

void FMacConsoleOutputDevice::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 FMacConsoleOutputDevice::Show ( bool  ShowWindow)
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: