#include <Window.h>

Inheritance diagram for xiiWindowOutputTargetBase:

Public Member Functions
virtual bool	GetVSyncEnabled () const =0
	Returns whether VSync is enabled for this output target.
virtual void	SetVSyncEnabled (bool bEnableVSync)=0
	Enables or disables VSync for this output target.
virtual void	PresentImage ()=0
	Presents the current back buffer to the screen. This should be called every frame after rendering is done.
virtual void	Resize (const xiiSizeU32 &newSize)=0
	Resizes the output target to the new size. This should be called when the window is resized.
virtual xiiResult	CaptureImage (xiiImage &out_image)=0
	Captures the current back buffer and stores it in the given image. This can be used for screenshots or similar purposes.

Detailed Description

Base class for window output targets

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

See also: xiiWindowBase) and represents the graphics APIs side of the render output. E.g. in a Vulkan or DirectX implementation this would be a swap chain.

Member Function Documentation

virtual xiiResult xiiWindowOutputTargetBase::CaptureImage ( xiiImage & out_image )

pure virtual

Captures the current back buffer and stores it in the given image. This can be used for screenshots or similar purposes.

virtual bool xiiWindowOutputTargetBase::GetVSyncEnabled ( ) const

pure virtual

Returns whether VSync is enabled for this output target.

virtual void xiiWindowOutputTargetBase::PresentImage ( )

pure virtual

Presents the current back buffer to the screen. This should be called every frame after rendering is done.

virtual void xiiWindowOutputTargetBase::Resize ( const xiiSizeU32 & newSize )

pure virtual

Resizes the output target to the new size. This should be called when the window is resized.

virtual void xiiWindowOutputTargetBase::SetVSyncEnabled ( bool bEnableVSync )

pure virtual

Enables or disables VSync for this output target.

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