Assertion Debug

This category contains assertion & debug macro functions. More...

Macros

Type	Name
#define	fplAlwaysAssert(exp) Always crashes the application with a null-pointer assignment when the specified expression evaluates to false.
#define	fplAssert(exp) Breaks with a runtime assertion when the specified expression evaluates to false.
#define	fplAssertPtr(ptr) Breaks when the specified pointer is null.
#define	fplDebugBreak() Stops the debugger on this line always.
#define	fplStaticAssert(exp) Breaks the compilation when the specified expression evaluates to false.

Functions

Type	Name
fpl_common_api void	fplDebugFormatOut (const char *format,...) Writes the given formatted text into the debugger output stream.
fpl_platform_api void	fplDebugOut (const char *text) Writes the given text into the debugger output stream.

Detailed Description

This category contains assertion & debug macro functions.

Macro Definition Documentation

fplAlwaysAssert

#define fplAlwaysAssert ( exp)

Always crashes the application with a null-pointer assignment when the specified expression evaluates to false.

Parameters

Direction	Parameter	Description
[in]	exp	Expression to evaluate.

Definition at line 3137 of file final_platform_layer.h.

fplAssert

#define fplAssert ( exp)

Breaks with a runtime assertion when the specified expression evaluates to false.

Parameters

Direction	Parameter	Description
[in]	exp	Expression to evaluate.

Definition at line 3123 of file final_platform_layer.h.

fplAssertPtr

#define fplAssertPtr ( ptr)

Breaks when the specified pointer is null.

Parameters

Direction	Parameter	Description
[in]	ptr	Pointer to evaluate.

Definition at line 3144 of file final_platform_layer.h.

fplDebugBreak

#define fplDebugBreak ( )

Stops the debugger on this line always.

Definition at line 3186 of file final_platform_layer.h.

fplStaticAssert

#define fplStaticAssert ( exp)

Breaks the compilation when the specified expression evaluates to false.

Parameters

Direction	Parameter	Description
[in]	exp	Expression to evaluate.

Definition at line 3130 of file final_platform_layer.h.

Function Documentation

fplDebugFormatOut()

fpl_common_api void fplDebugFormatOut ( const char * format, ... )

Writes the given formatted text into the debugger output stream.

Parameters

Direction	Parameter	Description
[in]	format	The format used for writing into the debugger output stream.
[in]	...	The dynamic arguments used for formatting the text.

Note: This function will only work in IDEs such as MSVC.

See also: Output to the Debug-Console

fplDebugOut()

fpl_platform_api void fplDebugOut ( const char * text)

Writes the given text into the debugger output stream.

Parameters

Direction	Parameter	Description
[in]	text	The text to write into the debugger output stream.

Note: This function will only work in IDEs such as MSVC.

See also: Output to the Debug-Console