xiiFrameCaptureInterface Class Reference

Inheritance diagram for xiiFrameCaptureInterface:

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 (xiiStringView 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 xiiStringView	GetAbsCaptureFilePathTemplate () const =0
	Retrieve the absolute file path for storing frame captures.
virtual void	StartFrameCapture (xiiWindowHandle 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 (xiiWindowHandle hWnd)=0
	End the current frame capture and write the result to the path given by SetAbsCaptureFilePathTemplate.
virtual void	EndFrameCaptureAndDiscardResult (xiiWindowHandle hWnd)=0
	End the current frame capture and discard the corresponding data, saving processing time and file I/O in the process.
virtual xiiResult	GetLastAbsCaptureFileName (xiiStringBuilder &out_sFileName) const =0
	Retrieve the absolute file name of the last successful frame capture. Returns XII_FAILURE if no successful capture has been performed.

Member Function Documentation

EndFrameCaptureAndDiscardResult()

virtual void xiiFrameCaptureInterface::EndFrameCaptureAndDiscardResult ( xiiWindowHandle 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 xiiRenderDoc.

EndFrameCaptureAndWriteOutput()

virtual void xiiFrameCaptureInterface::EndFrameCaptureAndWriteOutput ( xiiWindowHandle hWnd )

pure virtual

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

Implemented in xiiRenderDoc.

GetAbsCaptureFilePathTemplate()

virtual xiiStringView xiiFrameCaptureInterface::GetAbsCaptureFilePathTemplate ( ) const

pure virtual

Retrieve the absolute file path for storing frame captures.

Implemented in xiiRenderDoc.

GetLastAbsCaptureFileName()

virtual xiiResult xiiFrameCaptureInterface::GetLastAbsCaptureFileName ( xiiStringBuilder & out_sFileName ) const

pure virtual

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

Implemented in xiiRenderDoc.

IsFrameCapturing()

virtual bool xiiFrameCaptureInterface::IsFrameCapturing ( ) const

pure virtual

Determine if a frame capture is currently in progress.

Implemented in xiiRenderDoc.

IsInitialized()

virtual bool xiiFrameCaptureInterface::IsInitialized ( ) const

pure virtual

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

Implemented in xiiRenderDoc.

SetAbsCaptureFilePathTemplate()

virtual void xiiFrameCaptureInterface::SetAbsCaptureFilePathTemplate ( xiiStringView 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 xiiRenderDoc.

StartFrameCapture()

virtual void xiiFrameCaptureInterface::StartFrameCapture ( xiiWindowHandle hWnd )

pure virtual

Start capturing a frame rendered to the given window.

Implemented in xiiRenderDoc.

---

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

• /home/runner/work/XII/XII/Source/Engine/Core/Interfaces/FrameCaptureInterface.h