A driver that uses Irrlicht primitive drawing functions for rendering. More...

#include <CIrrlichtIMGUIDriver.h>

Inheritance diagram for IrrIMGUI::Private::Driver::CIrrlichtIMGUIDriver:

Collaboration diagram for IrrIMGUI::Private::Driver::CIrrlichtIMGUIDriver:

Private Member Functions
Constructor and Destructor
	CIrrlichtIMGUIDriver (irr::IrrlichtDevice *const pDevice)
	The constructor. More...

	~CIrrlichtIMGUIDriver (void)
	The Destructor. More...

Methods used for setup.
void	setupFunctionPointer (void)
	Setups the IMGUI function pointer. More...

Image/Texture and Font related methods.
virtual IGUITexture *	createTexture (EColorFormat ColorFormat, irr::u8 *pPixelData, irr::u32 Width, irr::u32 Height)
	Creates a GUI texture object out of raw data. More...

virtual IGUITexture *	createTexture (irr::video::IImage *pImage)
	Creates a GUI texture object out of an Irrlicht image. More...

virtual IGUITexture *	createTexture (irr::video::ITexture *pTexture)
	Creates a GUI texture object out of an Irrlicht texture. More...

virtual IGUITexture *	createFontTexture (void)
	Creates a GUI texture out of the currently loaded fonts. More...

virtual void	updateTexture (IGUITexture pGUITexture, EColorFormat ColorFormat, irr::u8 pPixelData, irr::u32 Width, irr::u32 Height)
	Updates a GUI texture object with raw data. More...

virtual void	updateTexture (IGUITexture pGUITexture, irr::video::IImage pImage)
	Updates a GUI texture object with an Irrlicht image. More...

virtual void	updateTexture (IGUITexture pGUITexture, irr::video::ITexture pTexture)
	Updates a GUI texture object with an Irrlicht texture. More...

virtual void	updateFontTexture (IGUITexture *pGUITexture)
	Updates a GUI texture with the currently loaded fonts. More...

virtual void	deleteTexture (IGUITexture *pGUITexture)
	Deletes an texture from graphic memory. More...

Static Private Member Functions
Methods used for rendering.
static void	drawGUIList (ImDrawData *pDrawData)
	Renders a full IMGUI draw list (called by the IMGUI system). More...

static void	drawCommandList (ImDrawList *pCommandList)
	Renders a single command list. More...

Static Private Attributes
static irr::core::vector3df	mOffset
	An pixel offset that is applied to every vertex. More...

Friends
class	IrrIMGUI::Private::IIMGUIDriver

Additional Inherited Members
Public Member Functions inherited from IrrIMGUI::Private::IIMGUIDriver
virtual	~IIMGUIDriver (void)
	Destructor. More...

void	compileFonts (void)
	Copies the loaded Fonts into GPU memory to use them with the GUI. More...

Static Public Member Functions inherited from IrrIMGUI::Private::IIMGUIDriver
static IIMGUIDriver *	getInstance (irr::IrrlichtDevice *pDevice)
	This method returns an instance of the driver. If no driver yet exists, it will create a new driver by it's own choice. Otherwise it will simply return the instance of the existing driver. More...

static bool	deleteInstance (void)
	Tells the driver, that it is not needed anymore. It decided by it's own if it will delete the single instance or exist further. When the instance was deleted. More...

static irr::IrrlichtDevice *	getIrrDevice (void)

static SIMGUISettings const &	getSettings (void)

static void	setSettings (SIMGUISettings const &rSettings)

Protected Member Functions inherited from IrrIMGUI::Private::IIMGUIDriver
	IIMGUIDriver (irr::IrrlichtDevice *const pDevice)
	Constructor is protected to prevent an external function to create an instance of this class. More...

void	setupMouseControl (void)
	Setups the mouse controls to fit to Irrlicht. More...

void	setupKeyControl (void)
	Setups the keyboard controls to fit to Irrlicht. More...

Static Protected Attributes inherited from IrrIMGUI::Private::IIMGUIDriver
static irr::u32	mTextureInstances = 0

Detailed Description

A driver that uses Irrlicht primitive drawing functions for rendering.

Definition at line 59 of file CIrrlichtIMGUIDriver.h.

Constructor & Destructor Documentation

IrrIMGUI::Private::Driver::CIrrlichtIMGUIDriver::CIrrlichtIMGUIDriver ( irr::IrrlichtDevice *const pDevice )

private

The constructor.

Parameters

pDevice is a pointer to the Irrlicht Device.

Definition at line 128 of file CIrrlichtIMGUIDriver.cpp.

Here is the call graph for this function:

IrrIMGUI::Private::Driver::CIrrlichtIMGUIDriver::~CIrrlichtIMGUIDriver ( void )

private

The Destructor.

Definition at line 166 of file CIrrlichtIMGUIDriver.cpp.

Member Function Documentation

IGUITexture * IrrIMGUI::Private::Driver::CIrrlichtIMGUIDriver::createFontTexture ( void )

privatevirtual

Creates a GUI texture out of the currently loaded fonts.

Returns: Returns an GUI texture object.

Implements IrrIMGUI::Private::IIMGUIDriver.

Definition at line 307 of file CIrrlichtIMGUIDriver.cpp.

Here is the call graph for this function:

IGUITexture * IrrIMGUI::Private::Driver::CIrrlichtIMGUIDriver::createTexture	(	EColorFormat	ColorFormat,
		irr::u8 *	pPixelData,
		irr::u32	Width,
		irr::u32	Height
	)

privatevirtual

Creates a GUI texture object out of raw data.

Parameters

ColorFormat	Is the format of the Color of every Pixel.
pPixelData	Is a pointer to the pixel array.
Width	Is the number of Pixels in X direction.
Height	Is the number of Pixels in Y direction.

Returns: Returns an GUI texture object.

Implements IrrIMGUI::Private::IIMGUIDriver.

Definition at line 265 of file CIrrlichtIMGUIDriver.cpp.

Here is the call graph for this function:

IGUITexture * IrrIMGUI::Private::Driver::CIrrlichtIMGUIDriver::createTexture ( irr::video::IImage * pImage )

privatevirtual

Creates a GUI texture object out of an Irrlicht image.

Parameters

pImage Is a pointer to an Irrlicht image object.

Returns: Returns an GUI texture object.

Implements IrrIMGUI::Private::IIMGUIDriver.

Definition at line 279 of file CIrrlichtIMGUIDriver.cpp.

Here is the call graph for this function:

IGUITexture * IrrIMGUI::Private::Driver::CIrrlichtIMGUIDriver::createTexture ( irr::video::ITexture * pTexture )

privatevirtual

Creates a GUI texture object out of an Irrlicht texture.

Parameters

pTexture Is a pointer to an Irrlicht texture object.

Returns: Returns an GUI texture object.

Implements IrrIMGUI::Private::IIMGUIDriver.

Definition at line 293 of file CIrrlichtIMGUIDriver.cpp.

void IrrIMGUI::Private::Driver::CIrrlichtIMGUIDriver::deleteTexture ( IGUITexture * pGUITexture )

privatevirtual

Deletes an texture from graphic memory.

Parameters

pGUITexture Is a pointer to the texture to delete. Do not use it afterwards!

Implements IrrIMGUI::Private::IIMGUIDriver.

Definition at line 463 of file CIrrlichtIMGUIDriver.cpp.

Here is the call graph for this function:

void IrrIMGUI::Private::Driver::CIrrlichtIMGUIDriver::drawCommandList ( ImDrawList * pCommandList )

staticprivate

Renders a single command list.

Parameters

pCommandList is the list of commands to render.

Definition at line 201 of file CIrrlichtIMGUIDriver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void IrrIMGUI::Private::Driver::CIrrlichtIMGUIDriver::drawGUIList ( ImDrawData * pDrawData )

staticprivate

Renders a full IMGUI draw list (called by the IMGUI system).

Parameters

pDrawData is a list of data to draw.

Definition at line 180 of file CIrrlichtIMGUIDriver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void IrrIMGUI::Private::Driver::CIrrlichtIMGUIDriver::setupFunctionPointer ( void )

private

Setups the IMGUI function pointer.

Definition at line 171 of file CIrrlichtIMGUIDriver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void IrrIMGUI::Private::Driver::CIrrlichtIMGUIDriver::updateFontTexture ( IGUITexture * pGUITexture )

privatevirtual

Updates a GUI texture with the currently loaded fonts.

Parameters

pGUITexture Is a pointer to the GUI texture object.

Implements IrrIMGUI::Private::IIMGUIDriver.

Definition at line 426 of file CIrrlichtIMGUIDriver.cpp.

Here is the call graph for this function:

void IrrIMGUI::Private::Driver::CIrrlichtIMGUIDriver::updateTexture	(	IGUITexture *	pGUITexture,
		EColorFormat	ColorFormat,
		irr::u8 *	pPixelData,
		irr::u32	Width,
		irr::u32	Height
	)

privatevirtual

Updates a GUI texture object with raw data.

Parameters

pGUITexture	Is a pointer to the GUI texture object.
ColorFormat	Is the format of the Color of every Pixel.
pPixelData	Is a pointer to the pixel array.
Width	Is the number of Pixels in X direction.
Height	Is the number of Pixels in Y direction.