gfxdebuggerbridge.h File Reference

#include <stddef.h>
#include <stdint.h>
#include "ship/Api.h"
#include <memory>

Include dependency graph for gfxdebuggerbridge.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	Fast

Functions
void	GfxDebuggerSetComponent (std::shared_ptr< Fast::GfxDebugger > gfxDebugger)
std::shared_ptr< Fast::GfxDebugger >	GfxDebuggerGetComponent ()
API_EXPORT void	GfxDebuggerRequestDebugging ()
	Requests that the graphics debugger begin capturing the next display list.
API_EXPORT bool	GfxDebuggerIsDebugging ()
	Returns true while the graphics debugger is actively capturing a display list.
API_EXPORT bool	GfxDebuggerIsDebuggingRequested ()
	Returns true if a debug capture has been requested but has not yet started.
API_EXPORT void	GfxDebuggerDebugDisplayList (void *cmds)
	Passes a display list to the graphics debugger for inspection.

Function Documentation

GfxDebuggerDebugDisplayList()

API_EXPORT void GfxDebuggerDebugDisplayList

(

void *

cmds

)

Passes a display list to the graphics debugger for inspection.

Should be called once per frame while GfxDebuggerIsDebugging() is true.

Parameters

cmds	Pointer to the head of the display list command buffer.

GfxDebuggerGetComponent()

std::shared_ptr< Fast::GfxDebugger > GfxDebuggerGetComponent

(

)

GfxDebuggerIsDebugging()

API_EXPORT bool GfxDebuggerIsDebugging

(

)

Returns true while the graphics debugger is actively capturing a display list.

GfxDebuggerIsDebuggingRequested()

API_EXPORT bool GfxDebuggerIsDebuggingRequested

(

)

Returns true if a debug capture has been requested but has not yet started.

GfxDebuggerRequestDebugging()

API_EXPORT void GfxDebuggerRequestDebugging

(

)

Requests that the graphics debugger begin capturing the next display list.

Sets an internal flag that is checked at the start of the next frame. Once capture begins, GfxDebuggerIsDebugging() returns true until the capture is complete.

GfxDebuggerSetComponent()

void GfxDebuggerSetComponent

(

std::shared_ptr< Fast::GfxDebugger >

gfxDebugger

)