RenderDoc Class Reference

#include <RenderDoc.h>

Public Member Functions
bool	init ()
void	startCapture (VkDevice device) const
void	endCapture (VkDevice device) const
void	triggerCapture ()
bool	isCapturing () const
bool	isConnected () const
void	setCaptureTitle (const std::string &title)
void	setCapturePath (const std::string &pathTemplate)
void	triggerMultiFrameCapture (uint32_t numFrames)
void	printStatus () const
uint32_t	getNumCaptures () const
void	launchUI ()
void	showUI ()
void	enableCallstacks (bool enable)
void	enableAPIValidation (bool enable)
void	enableOverlay (bool enable)

Static Public Member Functions
static RenderDoc &	get ()

Private Member Functions
	RenderDoc ()=default

Private Attributes
bool	m_available = false

Detailed Description

Definition at line 14 of file RenderDoc.h.

Constructor & Destructor Documentation

RenderDoc()

RenderDoc::RenderDoc ( )

privatedefault

Referenced by get().

Here is the caller graph for this function:

Member Function Documentation

enableAPIValidation()

void RenderDoc::enableAPIValidation

(

bool

enable

)

Definition at line 187 of file RenderDoc.cpp.

enableCallstacks()

void RenderDoc::enableCallstacks

(

bool

enable

)

Definition at line 179 of file RenderDoc.cpp.

enableOverlay()

void RenderDoc::enableOverlay

(

bool

enable

)

Definition at line 195 of file RenderDoc.cpp.

endCapture()

void RenderDoc::endCapture

(

VkDevice

device

)

const

Definition at line 68 of file RenderDoc.cpp.

get()

RenderDoc & RenderDoc::get ( )

static

Definition at line 15 of file RenderDoc.cpp.

References RenderDoc().

Referenced by EngineCore::Engine::captureRenderdocFrame(), and EngineCore::Engine::initRenderDoc().

Here is the call graph for this function:

Here is the caller graph for this function:

getNumCaptures()

uint32_t RenderDoc::getNumCaptures

(

)

const

Definition at line 154 of file RenderDoc.cpp.

Referenced by printStatus().

Here is the caller graph for this function:

init()

bool RenderDoc::init

(

)

Definition at line 20 of file RenderDoc.cpp.

References m_available.

isCapturing()

bool RenderDoc::isCapturing

(

)

const

Definition at line 92 of file RenderDoc.cpp.

Referenced by printStatus(), and setCaptureTitle().

Here is the caller graph for this function:

isConnected()

bool RenderDoc::isConnected

(

)

const

Definition at line 105 of file RenderDoc.cpp.

Referenced by printStatus().

Here is the caller graph for this function:

launchUI()

void RenderDoc::launchUI

(

)

Definition at line 163 of file RenderDoc.cpp.

printStatus()

void RenderDoc::printStatus

(

)

const

Definition at line 138 of file RenderDoc.cpp.

References getNumCaptures(), isCapturing(), and isConnected().

Here is the call graph for this function:

setCapturePath()

void RenderDoc::setCapturePath

(

const std::string &

pathTemplate

)

Definition at line 122 of file RenderDoc.cpp.

setCaptureTitle()

void RenderDoc::setCaptureTitle

(

const std::string &

title

)

Definition at line 114 of file RenderDoc.cpp.

References isCapturing().

Here is the call graph for this function:

showUI()

void RenderDoc::showUI

(

)

Definition at line 171 of file RenderDoc.cpp.

startCapture()

void RenderDoc::startCapture

(

VkDevice

device

)

const

Definition at line 60 of file RenderDoc.cpp.

triggerCapture()

void RenderDoc::triggerCapture

(

)

Definition at line 80 of file RenderDoc.cpp.

triggerMultiFrameCapture()

void RenderDoc::triggerMultiFrameCapture

(

uint32_t

numFrames

)

Definition at line 130 of file RenderDoc.cpp.

Member Data Documentation

m_available

bool RenderDoc::m_available = false

private

Definition at line 52 of file RenderDoc.h.

Referenced by init().

---

The documentation for this class was generated from the following files:

• /home/magerbeton/Documents/gl3-vulkan/Engine/include/Engine/Logging/RenderDoc.h
• /home/magerbeton/Documents/gl3-vulkan/Engine/src/Engine/Logging/RenderDoc.cpp