xiiEditorProcessViewWindow Class Reference

Represents the window inside the editor process, into which the engine process renders. More...

#include <EngineProcessViewContext.h>

Inheritance diagram for xiiEditorProcessViewWindow:

Public Member Functions
	~xiiEditorProcessViewWindow ()
	Copyright (c) Theophilus Eriata. All Rights Reserved.
xiiResult	UpdateWindow (xiiWindowHandle hParentWindow, xiiUInt16 uiWidth, xiiUInt16 uiHeight)
virtual xiiSizeU32	GetClientAreaSize () const override
	Returns the size of the client area of the window, i.e. the area that can be drawn into.
virtual xiiWindowHandle	GetNativeWindowHandle () const override
	Returns the position and size of the entire window, including borders and title bar.
virtual void	ProcessWindowMessages () override
	Processes all pending window messages, such as input or resize events. This should be called regularly (typically once per frame) to keep the window responsive.
virtual bool	IsFullscreenWindow (bool bOnlyProperFullscreenMode=false) const override
virtual bool	IsVisible () const override
virtual void	AddReference () override
	Adds a reference to the window. The window will not be destroyed until all references are removed.
virtual void	RemoveReference () override
	Removes a reference from the window. If this was the last reference, the window will be destroyed.
void	SetOutputTarget (xiiUniquePtr< xiiWindowOutputTargetBase > &&pOutputTarget) override
xiiWindowOutputTargetBase *	GetOutputTarget () const override
	Gets the output target for this window.

Public Attributes
xiiUInt16	m_uiWidth
xiiUInt16	m_uiHeight

Detailed Description

Represents the window inside the editor process, into which the engine process renders.

Member Function Documentation

AddReference()

virtual void xiiEditorProcessViewWindow::AddReference ( )

inlineoverridevirtual

Adds a reference to the window. The window will not be destroyed until all references are removed.

Implements xiiWindowBase.

GetClientAreaSize()

virtual xiiSizeU32 xiiEditorProcessViewWindow::GetClientAreaSize ( ) const

inlineoverridevirtual

Returns the size of the client area of the window, i.e. the area that can be drawn into.

Implements xiiWindowBase.

GetNativeWindowHandle()

virtual xiiWindowHandle xiiEditorProcessViewWindow::GetNativeWindowHandle ( ) const

inlineoverridevirtual

Returns the position and size of the entire window, including borders and title bar.

Implements xiiWindowBase.

GetOutputTarget()

xiiWindowOutputTargetBase * xiiEditorProcessViewWindow::GetOutputTarget ( ) const

inlineoverridevirtual

Gets the output target for this window.

Implements xiiWindowBase.

IsFullscreenWindow()

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

inlineoverridevirtual

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".

Implements xiiWindowBase.

IsVisible()

virtual bool xiiEditorProcessViewWindow::IsVisible ( ) const

inlineoverridevirtual

Whether the window can potentially be seen by the user.

Windows that are minimized or hidden are not visible.

Implements xiiWindowBase.

ProcessWindowMessages()

virtual void xiiEditorProcessViewWindow::ProcessWindowMessages ( )

inlineoverridevirtual

Processes all pending window messages, such as input or resize events. This should be called regularly (typically once per frame) to keep the window responsive.

Implements xiiWindowBase.

RemoveReference()

virtual void xiiEditorProcessViewWindow::RemoveReference ( )

inlineoverridevirtual

Removes a reference from the window. If this was the last reference, the window will be destroyed.

Implements xiiWindowBase.

SetOutputTarget()

void xiiEditorProcessViewWindow::SetOutputTarget ( xiiUniquePtr< xiiWindowOutputTargetBase > && pOutputTarget )

inlineoverridevirtual

Sets the output target for this window.

Output targets are destroyed before the window to ensure proper cleanup order. Setting a new output target replaces any existing one.

Implements xiiWindowBase.

---

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

• /home/runner/work/XII/XII/Source/Editor/EditorEngineProcessFramework/EngineProcess/EngineProcessViewContext.h
• /home/runner/work/XII/XII/Source/Editor/EditorEngineProcessFramework/EngineProcess/Implementation/Linux/EngineProcessViewContext_linux.h
• /home/runner/work/XII/XII/Source/Editor/EditorEngineProcessFramework/EngineProcess/Implementation/Windows/EngineProcessViewContext_win.h