SC::Console Struct Reference

Writes to console using SC::StringFormat. More...

#include <Console.h>

Public Member Functions
	Console (Buffer &encodingConversionBuffer)
	Constructs a console with a conversion buffer used for string conversions (UTF8 / UTF16)
template<typename... Types>
bool	print (StringView fmt, Types &&... args)
	Prints a formatted string using SC::StringFormat.
void	print (const StringView str)
	Prints a StringView to console.
void	printLine (const StringView str)
	Prints a StringView to console and adds a newline at the end of it.

Static Public Member Functions
static bool	tryAttachingToParentConsole ()
	Tries attaching current process to parent console (Windows only, has no effect elsewhere)
static bool	isAttachedToConsole ()
	Returns true if current process has an active console (Windows only, returns true elsewhere)

Detailed Description

Writes to console using SC::StringFormat.

Example:

// Create a buffer used for UTF conversions (if necessary)
SmallBuffer< 512 * sizeof(native_char_t)> consoleConversionBuffer;
// Construct console with the buffer
String str = StringView("Test Test\n");
// Have fun printing
console.print(str.view());

Constructor & Destructor Documentation

Console()

SC::Console::Console

(

Buffer &

encodingConversionBuffer

)

Constructs a console with a conversion buffer used for string conversions (UTF8 / UTF16)

Parameters

encodingConversionBuffer

The buffer used for UTF conversions

Member Function Documentation

isAttachedToConsole()

static bool SC::Console::isAttachedToConsole ( )

static

Returns true if current process has an active console (Windows only, returns true elsewhere)

print() [1/2]

void SC::Console::print

(

const StringView

str

)

Prints a StringView to console.

Parameters

str	The StringView to print

print() [2/2]

template<typename... Types>

bool SC::Console::print ( StringView fmt, Types &&... args )

inline

Prints a formatted string using SC::StringFormat.

Template Parameters

Types

Types of args

Parameters

fmt	Format string
args	Arguments to be formatted in the string

Returns

true if message has been printed successfully to Console

printLine()

void SC::Console::printLine

(

const StringView

str

)

Prints a StringView to console and adds a newline at the end of it.

Parameters

str	The StringView to print

tryAttachingToParentConsole()

static bool SC::Console::tryAttachingToParentConsole ( )

static

Tries attaching current process to parent console (Windows only, has no effect elsewhere)

Returns

true if the parent console has been attached (Windows only, returns true elsewhere)

---

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

• Console.h