ezWindowBase Class Reference

Base class of all window classes that have a client area and a native window handle. More...

#include <Window.h>

Inheritance diagram for ezWindowBase:

Public Member Functions
virtual ezSizeU32	GetClientAreaSize () const =0
virtual ezWindowHandle	GetNativeWindowHandle () const =0
	Returns the platform specific window handle.
virtual bool	IsFullscreenWindow (bool bOnlyProperFullscreenMode=false) const =0
	Whether the window is a fullscreen window or should be one - some platforms may enforce this via the GALSwapchain)
virtual bool	IsVisible () const =0
	Whether the window can potentially be seen by the user. Windows that are minimized or hidden are not visible.
virtual void	ProcessWindowMessages ()=0
	Runs the platform specific message pump.
virtual void	AddReference ()=0
virtual void	RemoveReference ()=0

Detailed Description

Base class of all window classes that have a client area and a native window handle.

Member Function Documentation

GetClientAreaSize()

virtual ezSizeU32 ezWindowBase::GetClientAreaSize ( ) const

pure virtual

Implemented in ezWindowPlatformShared.

GetNativeWindowHandle()

virtual ezWindowHandle ezWindowBase::GetNativeWindowHandle ( ) const

pure virtual

Returns the platform specific window handle.

Implemented in ezEditorProcessViewWindow, ezWindowAndroid, ezWindowGLFW, ezWindowNoImpl, ezWindowUWP, ezWindowWin, and ezWindowXR.

IsFullscreenWindow()

virtual bool ezWindowBase::IsFullscreenWindow ( bool  bOnlyProperFullscreenMode = false ) const

pure virtual

Whether the window is a fullscreen window or should be one - some platforms may enforce this via the GALSwapchain)

If bOnlyProperFullscreenMode, the caller accepts borderless windows that cover the entire screen as "fullscreen".

Implemented in ezWindowXR, ezEditorProcessViewWindow, and ezWindowPlatformShared.

IsVisible()

virtual bool ezWindowBase::IsVisible ( ) const

pure virtual

Whether the window can potentially be seen by the user. Windows that are minimized or hidden are not visible.

Implemented in ezEditorProcessViewWindow, ezWindowPlatformShared, and ezWindowXR.

ProcessWindowMessages()

virtual void ezWindowBase::ProcessWindowMessages ( )

pure virtual

Runs the platform specific message pump.

You should call ProcessWindowMessages every frame to keep the window responsive.

Implemented in ezEditorProcessViewWindow, ezWindowAndroid, ezWindowGLFW, ezWindowNoImpl, ezWindowUWP, ezWindowWin, and ezWindowXR.

---

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

• /home/runner/work/ezEngine/ezEngine/Code/Engine/Core/System/Window.h