ezWindowOutputTargetBase Class Reference

Base class for window output targets. More...

#include <WindowOutputTargetBase.h>

Inheritance diagram for ezWindowOutputTargetBase:

Public Member Functions
virtual void	AcquireImage ()=0
virtual void	PresentImage (bool bEnableVSync)=0
virtual ezResult	StartCaptureImage ()=0
virtual ezEnum< ezCaptureImageResult >	WaitCaptureImage (ezImage &out_image)=0

Detailed Description

Base class for window output targets.

A window output target is usually tied tightly to a window (

See also

ezWindowBase) and represents the graphics APIs side of the render output. E.g. in a DirectX implementation this would be a swapchain.

This interface provides the high level functionality that is needed by ezGameApplication to work with the render output.

Member Function Documentation

StartCaptureImage()

virtual ezResult ezWindowOutputTargetBase::StartCaptureImage ( )

pure virtual

Starts an asynchronous capture of the current back buffer. Returns EZ_FAILURE if a capture is already in flight or if the operation cannot be started.

Implemented in ezWindowOutputTargetGAL, and ezWindowOutputTargetXR.

WaitCaptureImage()

virtual ezEnum< ezCaptureImageResult > ezWindowOutputTargetBase::WaitCaptureImage ( ezImage &  out_image )

pure virtual

Polls the state of a pending capture. Returns Ready once the image data has been copied into out_image.

Implemented in ezWindowOutputTargetGAL, and ezWindowOutputTargetXR.

---

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

• /home/runner/work/ezEngine/ezEngine/Code/Engine/Core/GameApplication/WindowOutputTargetBase.h