bpf::io::Console class
#include <Base/include/Framework/IO/Console.hpp>

Contents

Low-level console IO

Public types

struct ClearTextStyle
class TextStyle

Public static functions

static void WriteLine(const String& str, EConsoleStream type = EConsoleStream::OUTPUT) noexcept
static void SetTextStyle(const TextStyle& style, EConsoleStream type = EConsoleStream::OUTPUT) noexcept
static void ResetTextStyle(EConsoleStream type = EConsoleStream::OUTPUT) noexcept
static void SetTitle(const String& title) noexcept
static auto IsRedirected(EConsoleStream type = EConsoleStream::OUTPUT) -> bool noexcept

Function documentation

static void bpf::io::Console::WriteLine(const String& str, EConsoleStream type = EConsoleStream::OUTPUT) noexcept

Parameters
str the text to write
type which stream to write to (ERROR/OUTPUT)

Writes a line of text to the console

static void bpf::io::Console::SetTextStyle(const TextStyle& style, EConsoleStream type = EConsoleStream::OUTPUT) noexcept

Parameters
style the new text style
type which stream to set the style (ERROR/OUTPUT)

Sets the text style for the next write operations

static void bpf::io::Console::ResetTextStyle(EConsoleStream type = EConsoleStream::OUTPUT) noexcept

Parameters
type which stream to set the style (ERROR/OUTPUT)

Resets the text style to the default for a given stream

static void bpf::io::Console::SetTitle(const String& title) noexcept

Parameters
title new title to apply to the console

Sets the console title

static bool bpf::io::Console::IsRedirected(EConsoleStream type = EConsoleStream::OUTPUT) noexcept

Parameters
type type of console to check
Returns true if the given console type is redirected, false otherwise

Checks if this console is redirected