xiiImguiSingleton Class Reference

Singleton class through which one can control the third-party library 'Dear Imgui'. More...

#include <DearImguiSingleton.h>

Public Member Functions
XII_ALWAYS_INLINE xiiSizeU32	GetCurrentWindowResolution () const
	Returns the value that was passed to BeginFrame(). Useful for positioning UI elements.
XII_ALWAYS_INLINE void	SetPassInputToImgui (bool bPassInput)
XII_ALWAYS_INLINE bool	WantsInput () const
XII_ALWAYS_INLINE ImFontAtlas &	GetFontAtlas ()
	Returns the shared font atlas.
XII_ALWAYS_INLINE xiiEvent< const xiiView *, xiiMutex > &	GetUpdateEvent ()

Detailed Description

Singleton class through which one can control the third-party library 'Dear Imgui'.

Member Function Documentation

SetPassInputToImgui()

XII_ALWAYS_INLINE void xiiImguiSingleton::SetPassInputToImgui ( bool bPassInput )

inline

When this is disabled, the GUI will be rendered, but it will not react to any input. Useful if something else shall get exclusive input.

WantsInput()

XII_ALWAYS_INLINE bool xiiImguiSingleton::WantsInput ( ) const

inline

If this returns true, the GUI wants to use the input, and thus you might want to not use the input for anything else.

This is the case when the mouse hovers over any window or a text field has keyboard focus.

---

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

• /home/runner/work/XII/XII/Source/EnginePlugins/DearImguiPlugin/DearImguiSingleton.h
• /home/runner/work/XII/XII/Source/EnginePlugins/DearImguiPlugin/Implementation/DearImguiSingleton.cpp