Debug

Collaboration diagram for Debug:

Data Structures
struct	GX2DebugCaptureInterface

Typedefs
typedef struct GX2DebugCaptureInterface	GX2DebugCaptureInterface
typedef enum GX2DebugCaptureInterfaceVersion	GX2DebugCaptureInterfaceVersion
typedef enum GX2DebugCaptureStartFlags	GX2DebugCaptureStartFlags
	Options for GX2DebugCaptureStart. More...
typedef enum GX2DebugCaptureEndFlags	GX2DebugCaptureEndFlags
	Options for GX2DebugCaptureEnd. More...

Enumerations
enum	GX2DebugCaptureInterfaceVersion { GX2_DEBUG_CAPTURE_INTERFACE_VERSION = 1 }
enum	GX2DebugCaptureStartFlags {   GX2_DEBUG_CAPTURE_START_FLAGS_NONE = 0 ,   GX2_DEBUG_CAPTURE_START_FLAGS_DISABLE_GX2DRAWDONE = 1 }
	Options for GX2DebugCaptureStart. More...
enum	GX2DebugCaptureEndFlags {   GX2_DEBUG_CAPTURE_END_FLAGS_NONE = 0 ,   GX2_DEBUG_CAPTURE_END_FLAGS_DISABLE_GX2FLUSH = 1 }
	Options for GX2DebugCaptureEnd. More...

Functions
BOOL	_GX2DebugSetCaptureInterface (GX2DebugCaptureInterface *interface)
void	GX2DebugCaptureStart (const char *filename, GX2DebugCaptureStartFlags flags)
	Starts a debug capture. More...
void	GX2DebugCaptureEnd (GX2DebugCaptureEndFlags flags)
	Ends a debug capture. More...
void	GX2DebugCaptureFrame (const char *filename)
	Will capture the next frame. More...
void	GX2DebugCaptureFrames (const char *filename, uint32_t count)
	Will capture count frames. More...

Detailed Description

Typedef Documentation

GX2DebugCaptureInterface

typedef struct GX2DebugCaptureInterface GX2DebugCaptureInterface

Definition at line 1 of file debug.h.

GX2DebugCaptureInterfaceVersion

typedef enum GX2DebugCaptureInterfaceVersion GX2DebugCaptureInterfaceVersion

GX2DebugCaptureStartFlags

typedef enum GX2DebugCaptureStartFlags GX2DebugCaptureStartFlags

Options for GX2DebugCaptureStart.

GX2DebugCaptureEndFlags

typedef enum GX2DebugCaptureEndFlags GX2DebugCaptureEndFlags

Options for GX2DebugCaptureEnd.

Enumeration Type Documentation

GX2DebugCaptureInterfaceVersion

enum GX2DebugCaptureInterfaceVersion

Enumerator
GX2_DEBUG_CAPTURE_INTERFACE_VERSION

Definition at line 17 of file debug.h.

GX2DebugCaptureStartFlags

enum GX2DebugCaptureStartFlags

Options for GX2DebugCaptureStart.

Enumerator
GX2_DEBUG_CAPTURE_START_FLAGS_NONE	When set GX2DebugCaptureStart will call GX2DrawDone before the capture is started.
GX2_DEBUG_CAPTURE_START_FLAGS_DISABLE_GX2DRAWDONE	When set GX2DebugCaptureStart will NOT call GX2DrawDone.

Definition at line 23 of file debug.h.

GX2DebugCaptureEndFlags

enum GX2DebugCaptureEndFlags

Options for GX2DebugCaptureEnd.

Enumerator
GX2_DEBUG_CAPTURE_END_FLAGS_NONE	When set GX2DebugCaptureEnd will call GX2Flush before the capture is completed.
GX2_DEBUG_CAPTURE_END_FLAGS_DISABLE_GX2FLUSH	When set GX2DebugCaptureEnd will NOT call GX2Flush.

Definition at line 33 of file debug.h.

Function Documentation

_GX2DebugSetCaptureInterface()

BOOL _GX2DebugSetCaptureInterface

(

GX2DebugCaptureInterface *

interface

)

GX2DebugCaptureStart()

void GX2DebugCaptureStart	(	const char *	filename,
		GX2DebugCaptureStartFlags	flags
	)

Starts a debug capture.

User must have set interface first via _GX2DebugSetCaptureInterface.

Note this doesn't write to filename, that is up to the implementor of the GX2DebugCaptureInterface. This argument might not even be filename but I at least know it is a string because GX2DebugCaptureFrame does a strncpy on it.

Parameters

filename	This is passed as first argument to GX2DebugCaptureInterface.onCaptureStart
flags	A GX2DebugCaptureStartFlags option.

GX2DebugCaptureEnd()

void GX2DebugCaptureEnd

(

GX2DebugCaptureEndFlags

flags

)

Ends a debug capture.

Parameters

flags

A GX2DebugCaptureEndFlags option.

GX2DebugCaptureFrame()

void GX2DebugCaptureFrame

(

const char *

filename

)

Will capture the next frame.

Capture begins during the next call to GX2SwapScanBuffers, and will end at the next GX2SwapScanBuffers.

Equivalent to calling GX2DebugCaptureFrames(filename, 1)

GX2DebugCaptureFrames()

void GX2DebugCaptureFrames	(	const char *	filename,
		uint32_t	count
	)

Will capture count frames.

Capture begins during the next call to GX2SwapScanBuffers, and will end after count frames have been swapped in GX2SwapScanBuffers.

Capture begins and ends during GX2SwapScanBuffers.