plFrameCaptureInterface Class Reference

Inheritance diagram for plFrameCaptureInterface:

Public Member Functions
virtual bool	IsInitialized () const =0
	Determine if a singleton implementing this interface has successfully been initialized and frame capture functionality is available.
virtual void	SetAbsCaptureFilePathTemplate (plStringView sFilePathTemplate)=0
	Specify the absolute base file path for storing frame captures. For the final output file name, an identifier and/or frame or capture number will be appended. Note that the final output file name is determined by the frame capture implementation. Use GetLastAbsCaptureFileName() for retrieving the actual absolute file name of the most recently written capture file.
virtual plStringView	GetAbsCaptureFilePathTemplate () const =0
	Retrieve the absolute file path for storing frame captures.
virtual void	StartFrameCapture (plWindowHandle hWnd)=0
	Start capturing a frame rendered to the given window.
virtual bool	IsFrameCapturing () const =0
	Determine if a frame capture is currently in progress.
virtual void	EndFrameCaptureAndWriteOutput (plWindowHandle hWnd)=0
	End the current frame capture and write the result to the path given by SetAbsCaptureFilePathTemplate.
virtual void	EndFrameCaptureAndDiscardResult (plWindowHandle hWnd)=0
	End the current frame capture and discard the corresponding data, saving processing time and file I/O in the process.
virtual plResult	GetLastAbsCaptureFileName (plStringBuilder &out_sFileName) const =0
	Retrieve the absolute file name of the last successful frame capture. Returns PL_FAILURE if no successful capture has been performed.

Member Function Documentation

EndFrameCaptureAndDiscardResult()

virtual void plFrameCaptureInterface::EndFrameCaptureAndDiscardResult ( plWindowHandle hWnd )

pure virtual

End the current frame capture and discard the corresponding data, saving processing time and file I/O in the process.

Implemented in plRenderDoc.

EndFrameCaptureAndWriteOutput()

virtual void plFrameCaptureInterface::EndFrameCaptureAndWriteOutput ( plWindowHandle hWnd )

pure virtual

End the current frame capture and write the result to the path given by SetAbsCaptureFilePathTemplate.

Implemented in plRenderDoc.

GetAbsCaptureFilePathTemplate()

virtual plStringView plFrameCaptureInterface::GetAbsCaptureFilePathTemplate ( ) const

pure virtual

Retrieve the absolute file path for storing frame captures.

Implemented in plRenderDoc.

GetLastAbsCaptureFileName()

virtual plResult plFrameCaptureInterface::GetLastAbsCaptureFileName ( plStringBuilder & out_sFileName ) const

pure virtual

Retrieve the absolute file name of the last successful frame capture. Returns PL_FAILURE if no successful capture has been performed.

Implemented in plRenderDoc.

IsFrameCapturing()

virtual bool plFrameCaptureInterface::IsFrameCapturing ( ) const

pure virtual

Determine if a frame capture is currently in progress.

Implemented in plRenderDoc.

IsInitialized()

virtual bool plFrameCaptureInterface::IsInitialized ( ) const

pure virtual

Determine if a singleton implementing this interface has successfully been initialized and frame capture functionality is available.

Implemented in plRenderDoc.

SetAbsCaptureFilePathTemplate()

virtual void plFrameCaptureInterface::SetAbsCaptureFilePathTemplate ( plStringView sFilePathTemplate )

pure virtual

Specify the absolute base file path for storing frame captures. For the final output file name, an identifier and/or frame or capture number will be appended. Note that the final output file name is determined by the frame capture implementation. Use GetLastAbsCaptureFileName() for retrieving the actual absolute file name of the most recently written capture file.

Implemented in plRenderDoc.

StartFrameCapture()

virtual void plFrameCaptureInterface::StartFrameCapture ( plWindowHandle hWnd )

pure virtual

Start capturing a frame rendered to the given window.

Implemented in plRenderDoc.

---

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

• Code/Engine/Core/Interfaces/FrameCaptureInterface.h