Added libbacktrace support.

include/bx/debug.h

@@ -12,27 +12,69 @@
 namespace bx
 {
 	class StringView;
+	class WriterI;
+	class Error;
 
+	/// Break in debugger.
 	///
 	void debugBreak();
 
+	/// Write string to debug output.
 	///
-	void debugOutput(const char* _out);
+	/// @param[in] _str Zero terminated string to write.
+	///
+	void debugOutput(const char* _str);
 
+	/// Write string to debug output.
+	///
+	/// @param[in] _str StringView to write.
 	///
 	void debugOutput(const StringView& _str);
 
+	/// Write formatted string to debug output.
 	///
 	void debugPrintfVargs(const char* _format, va_list _argList);
 
+	/// Write formatted string to debug output.
 	///
 	void debugPrintf(const char* _format, ...);
 
+	/// Write hex data into debug output.
 	///
 	void debugPrintfData(const void* _data, uint32_t _size, const char* _format, ...);
 
+	/// Return debug output writer.
 	///
-	struct WriterI* getDebugOut();
+	/// @returns Debug output writer.
+	///
+	WriterI* getDebugOut();
+
+	/// Capture current callstack.
+	///
+	/// @param[in]  _skip Skip top N stack frames.
+	/// @param[in]  _max Maximum frame to capture.
+	/// @param[out] _outStack Stack frames array. Must be at least `_max` elements.
+	///
+	/// @returns Number of stack frames captured.
+	///
+	uint32_t getCallStack(uint32_t _skip, uint32_t _max, uintptr_t* _outStack);
+
+	/// Write callstack.
+	///
+	/// @param[in]  _writer Writer.
+	/// @param[in]  _stack Callstack.
+	/// @param[in]  _num Number of stack addresses in `_stack` array.
+	/// @param[out] _err Error.
+	///
+	/// @returns Number of bytes writen to `_writer`.
+	///
+	int32_t writeCallstack(WriterI* _writer, uintptr_t* _stack, uint32_t _num, Error* _err);
+
+	/// Capture call stack, and write it to debug output.
+	///
+	/// @param[in] _skip Skip top N stack frames.
+	///
+	void debugOutputCallstack(uint32_t _skip);
 
 } // namespace bx