scopeDescription.h File Reference

Include dependency graph for scopeDescription.h:

Go to the source code of this file.

Classes
class	TfScopeDescription
	This class is used to provide high-level descriptions about scopes of execution that could possibly block, or to provide relevant information about high-level action that would be useful in a crash report. More...

Macros
#define	TF_DESCRIBE_SCOPE(...)
	Convenience macro for annotating the current scope with a description.

Functions
TF_API std::vector< std::string >	TfGetCurrentScopeDescriptionStack ()
	Return a copy of the current description stack for the "main" thread as identified by ArchGetMainThreadId() as a vector of strings.
TF_API std::vector< std::string >	TfGetThisThreadScopeDescriptionStack ()
	Return a copy of the current description stack for the current thread of execution as a vector of strings.

Macro Definition Documentation

TF_DESCRIBE_SCOPE

#define TF_DESCRIBE_SCOPE

(

...

)

Convenience macro for annotating the current scope with a description.

This macro accepts either a single string, or printf-style arguments and creates a scope description local variable with the resulting string.

Definition at line 136 of file scopeDescription.h.

Function Documentation

TfGetCurrentScopeDescriptionStack()

TF_API std::vector< std::string > TfGetCurrentScopeDescriptionStack

(

)

Return a copy of the current description stack for the "main" thread as identified by ArchGetMainThreadId() as a vector of strings.

The most recently pushed description is at back(), and the least recently pushed description is at front().

TfGetThisThreadScopeDescriptionStack()

TF_API std::vector< std::string > TfGetThisThreadScopeDescriptionStack

(

)

Return a copy of the current description stack for the current thread of execution as a vector of strings.

The most recently pushed description is at back(), and the least recently pushed description is at front().