IrrIMGUI  0.3.1
Friends | List of all members
IrrIMGUI::Private::Driver::COpenGLIMGUIDriver Class Reference

A driver that uses native OpenGL functions for rendering. More...

#include <COpenGLIMGUIDriver.h>

Inheritance diagram for IrrIMGUI::Private::Driver::COpenGLIMGUIDriver:
Inheritance graph
[legend]
Collaboration diagram for IrrIMGUI::Private::Driver::COpenGLIMGUIDriver:
Collaboration graph
[legend]

Private Member Functions

Constructor and Destructor
 COpenGLIMGUIDriver (irr::IrrlichtDevice *const pDevice)
 The constructor. More...
 
 ~COpenGLIMGUIDriver (void)
 The Destructor. More...
 
Methods used for setup.
void setupFunctionPointer (void)
 Setups the IMGUI function pointer. More...
 
Image/Texture and Font related methods.
virtual IGUITexturecreateTexture (EColorFormat ColorFormat, irr::u8 *pPixelData, irr::u32 Width, irr::u32 Height)
 Creates a GUI texture object out of raw data. More...
 
virtual IGUITexturecreateTexture (irr::video::IImage *pImage)
 Creates a GUI texture object out of an Irrlicht image. More...
 
virtual IGUITexturecreateTexture (irr::video::ITexture *pTexture)
 Creates a GUI texture object out of an Irrlicht texture. More...
 
virtual IGUITexturecreateFontTexture (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...
 

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 IIMGUIDrivergetInstance (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 native OpenGL functions for rendering.

Attention
This is a test- and fallback-implementation and is not officially supported by the Irrlicht IMGUI binding.

Definition at line 62 of file COpenGLIMGUIDriver.h.

Constructor & Destructor Documentation

IrrIMGUI::Private::Driver::COpenGLIMGUIDriver::COpenGLIMGUIDriver ( irr::IrrlichtDevice *const  pDevice)
private

The constructor.

Parameters
pDeviceis a pointer to the Irrlicht Device.

Definition at line 132 of file COpenGLIMGUIDriver.cpp.

Here is the call graph for this function:

IrrIMGUI::Private::Driver::COpenGLIMGUIDriver::~COpenGLIMGUIDriver ( void  )
private

The Destructor.

Definition at line 140 of file COpenGLIMGUIDriver.cpp.

Member Function Documentation

IGUITexture * IrrIMGUI::Private::Driver::COpenGLIMGUIDriver::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 326 of file COpenGLIMGUIDriver.cpp.

Here is the call graph for this function:

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

Creates a GUI texture object out of raw data.

Parameters
ColorFormatIs the format of the Color of every Pixel.
pPixelDataIs a pointer to the pixel array.
WidthIs the number of Pixels in X direction.
HeightIs the number of Pixels in Y direction.
Returns
Returns an GUI texture object.

Implements IrrIMGUI::Private::IIMGUIDriver.

Definition at line 245 of file COpenGLIMGUIDriver.cpp.

Here is the call graph for this function:

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

Creates a GUI texture object out of an Irrlicht image.

Parameters
pImageIs a pointer to an Irrlicht image object.
Returns
Returns an GUI texture object.

Implements IrrIMGUI::Private::IIMGUIDriver.

Definition at line 304 of file COpenGLIMGUIDriver.cpp.

Here is the call graph for this function:

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

Creates a GUI texture object out of an Irrlicht texture.

Parameters
pTextureIs a pointer to an Irrlicht texture object.
Returns
Returns an GUI texture object.

Implements IrrIMGUI::Private::IIMGUIDriver.

Definition at line 267 of file COpenGLIMGUIDriver.cpp.

Here is the call graph for this function:

void IrrIMGUI::Private::Driver::COpenGLIMGUIDriver::deleteTexture ( IGUITexture pGUITexture)
privatevirtual

Deletes an texture from graphic memory.

Parameters
pGUITextureIs a pointer to the texture to delete. Do not use it afterwards!

Implements IrrIMGUI::Private::IIMGUIDriver.

Definition at line 548 of file COpenGLIMGUIDriver.cpp.

Here is the call graph for this function:

void IrrIMGUI::Private::Driver::COpenGLIMGUIDriver::drawCommandList ( ImDrawList *  pCommandList)
staticprivate

Renders a single command list.

Parameters
pCommandListis the list of commands to render.

Definition at line 164 of file COpenGLIMGUIDriver.cpp.

Here is the caller graph for this function:

void IrrIMGUI::Private::Driver::COpenGLIMGUIDriver::drawGUIList ( ImDrawData *  pDrawData)
staticprivate

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

Parameters
pDrawDatais a list of data to draw.

Definition at line 202 of file COpenGLIMGUIDriver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void IrrIMGUI::Private::Driver::COpenGLIMGUIDriver::setupFunctionPointer ( void  )
private

Setups the IMGUI function pointer.

Definition at line 145 of file COpenGLIMGUIDriver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void IrrIMGUI::Private::Driver::COpenGLIMGUIDriver::updateFontTexture ( IGUITexture pGUITexture)
privatevirtual

Updates a GUI texture with the currently loaded fonts.

Parameters
pGUITextureIs a pointer to the GUI texture object.

Implements IrrIMGUI::Private::IIMGUIDriver.

Definition at line 513 of file COpenGLIMGUIDriver.cpp.

Here is the call graph for this function:

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

Updates a GUI texture object with raw data.

Parameters
pGUITextureIs a pointer to the GUI texture object.
ColorFormatIs the format of the Color of every Pixel.
pPixelDataIs a pointer to the pixel array.
WidthIs the number of Pixels in X direction.
HeightIs the number of Pixels in Y direction.

Implements IrrIMGUI::Private::IIMGUIDriver.

Definition at line 359 of file COpenGLIMGUIDriver.cpp.

Here is the call graph for this function:

void IrrIMGUI::Private::Driver::COpenGLIMGUIDriver::updateTexture ( IGUITexture pGUITexture,
irr::video::IImage *  pImage 
)
privatevirtual

Updates a GUI texture object with an Irrlicht image.

Parameters
pGUITextureIs a pointer to the GUI texture object.
pImageIs a pointer to an Irrlicht image object.

Implements IrrIMGUI::Private::IIMGUIDriver.

Definition at line 467 of file COpenGLIMGUIDriver.cpp.

Here is the call graph for this function:

void IrrIMGUI::Private::Driver::COpenGLIMGUIDriver::updateTexture ( IGUITexture pGUITexture,
irr::video::ITexture *  pTexture 
)
privatevirtual

Updates a GUI texture object with an Irrlicht texture.

Parameters
pGUITextureIs a pointer to the GUI texture object.
pTextureIs a pointer to an Irrlicht image object.

Implements IrrIMGUI::Private::IIMGUIDriver.

Definition at line 405 of file COpenGLIMGUIDriver.cpp.

Here is the call graph for this function:

Friends And Related Function Documentation

friend class IrrIMGUI::Private::IIMGUIDriver
friend

Definition at line 64 of file COpenGLIMGUIDriver.h.


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