IrrIMGUI  0.3.1
Namespaces | Classes | Functions
IrrIMGUI Namespace Reference

Main namespace for Irrlicht IMGUI binding. More...

Namespaces

 Const
 Contains constant values for IrrIMGUI:
 
 Debug
 Contains classes for debug purpose.
 
 Inject
 Contains definitions for Dependency Injection.
 
 Private
 Private definitions for the IMGUI Irrlicht binding. Do not use them outside, the interface may change a lot of times!
 
 Tools
 Contains definitions for useful tools.
 
 UnitTest
 Contains unit test related definitions.
 

Classes

class  CCharFifo
 A Fifo Memory to store character inputs from the keyboard. More...
 
class  CIMGUIEventReceiver
 
class  CIMGUIEventStorage
 Stores the state of the Keyboard and Mouse input for IMGUI. More...
 
class  IGUITexture
 
class  IIMGUIHandle
 A interface to an IMGUI handle. Use this interface for mocking and dependency injection of the real IMGUI handle. More...
 
class  IReferenceCounter
 A class to count references. More...
 
struct  SIMGUISettings
 Stores the settings of the IMGUI. More...
 

Functions

static void updateScreenSize (irr::IrrlichtDevice *const pDevice)
 Updates the IMGUI screen size. More...
 
static void updateTimer (irr::IrrlichtDevice *const pDevice, irr::f32 *const pLastTime)
 Updated the IMGUI timer. More...
 
static void updateMouse (CIMGUIEventStorage *const pEventStorage)
 Updates the Mouse events from IMGUI. More...
 
static void updateKeyboard (CIMGUIEventStorage *const pEventStorage)
 Updates the Keyboard events from IMGUI. More...
 
void updateIMGUIFrameValues (irr::IrrlichtDevice *const pDevice, CIMGUIEventStorage *const pEventStorage, irr::f32 *const pLastTime)
 Updates the values for an IMGUI Frame, like delta time, input events and screen size. More...
 
IIMGUIHandlecreateIMGUI (irr::IrrlichtDevice *pDevice, CIMGUIEventStorage *pEventStorage=nullptr, SIMGUISettings const *pSettings=nullptr)
 Creates an IMGUI handle object. More...
 

Detailed Description

Main namespace for Irrlicht IMGUI binding.

Function Documentation

IRRIMGUI_DLL_API IIMGUIHandle * IrrIMGUI::createIMGUI ( irr::IrrlichtDevice *  pDevice,
CIMGUIEventStorage pEventStorage = nullptr,
SIMGUISettings const *  pSettings = nullptr 
)

Creates an IMGUI handle object.

Parameters
pDeviceIs a pointer to an Irrlicht device.
pEventStorageIs a pointer to an event storage.
pSettingsIs a pointer to a settings structure.
Returns
Returns an IIMGUIHandle object. Destroy this object with IIMGUIHandle::drop()

Definition at line 76 of file IrrIMGUIInject.cpp.

IRRIMGUI_DLL_API void IrrIMGUI::updateIMGUIFrameValues ( irr::IrrlichtDevice *const  pDevice,
CIMGUIEventStorage *const  pEventStorage,
irr::f32 *const  pLastTime 
)

Updates the values for an IMGUI Frame, like delta time, input events and screen size.

Parameters
pDeviceIs a pointer to an Irrlicht device.
pEventStorageIs a pointer to the event storage. If this pointer is NULL, no input event update is performed.
pLastTimeIs a pointer to a variable where the time from the last update is stored (in seconds).

Definition at line 127 of file IMGUIHelper.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

static void IrrIMGUI::updateKeyboard ( CIMGUIEventStorage *const  pEventStorage)
static

Updates the Keyboard events from IMGUI.

Parameters
pEventStorageIs a pointer to a CIMGUIEventStorage object.

Definition at line 92 of file IMGUIHelper.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

static void IrrIMGUI::updateMouse ( CIMGUIEventStorage *const  pEventStorage)
static

Updates the Mouse events from IMGUI.

Parameters
pEventStorageIs a pointer to a CIMGUIEventStorage object.

Definition at line 70 of file IMGUIHelper.cpp.

Here is the caller graph for this function:

static void IrrIMGUI::updateScreenSize ( irr::IrrlichtDevice *const  pDevice)
static

Updates the IMGUI screen size.

Parameters
pDeviceIs a pointer to an Irrlicht device.

Definition at line 42 of file IMGUIHelper.cpp.

Here is the caller graph for this function:

static void IrrIMGUI::updateTimer ( irr::IrrlichtDevice *const  pDevice,
irr::f32 *const  pLastTime 
)
static

Updated the IMGUI timer.

Parameters
pDeviceIs a pointer to an Irrlicht device.
pLastTimeIs a pointer to a variable that stores the timer value from the last update.

Definition at line 55 of file IMGUIHelper.cpp.

Here is the caller graph for this function: