IrrIMGUI  0.3.1
Functions | Variables
IrrIMGUI::Private::Driver::IrrlichtHelper Namespace Reference

Functions that help adapting Irrlicht logic to IMGUI. More...

Functions

irr::video::SColor getColorFromImGuiColor (irr::u32 ImGuiColor)
 Translates an IMGUI Color to an Irrlicht Color. More...
 
void copyImGuiVertices2IrrlichtVertices (ImVector< ImDrawVert > &rIMGUIVertexBuffer, irr::video::S3DVertex *pIrrlichtVertex, irr::core::vector3df const &rOffset)
 Copies a list of IMGUI vertices to a list of Irrlicht Vertices. More...
 
ImTextureID copyTextureIDFromGUIFont (irr::video::IVideoDriver *pIrrDriver)
 Creates a Texture object from the currently loaded Fonts. More...
 
ImTextureID copyTextureIDFromRawData (irr::video::IVideoDriver *pIrrDriver, EColorFormat ColorFormat, irr::u8 *pPixelData, irr::u32 Width, irr::u32 Height)
 Created a Texture object from raw data. More...
 
ImTextureID copyTextureIDFromImage (irr::video::IVideoDriver *pIrrDriver, irr::video::IImage *pImage)
 Creates a Texture object from the currently loaded Fonts. More...
 
void deleteTextureID (irr::video::IVideoDriver *pIrrDriver, CGUITexture *pGUITexture)
 Deleted the memory from this texture ID. More...
 
void applyMovingClippingPlaneWorkaround (irr::video::IVideoDriver *pIrrDriver)
 Applies a workaround for an Irrlicht issue with moving clipping planes. More...
 
void setupStandardGUIMaterial (irr::video::SMaterial &rMaterial, irr::video::ITexture *pTexture)
 Sets the standard GUI material settings. More...
 
void applyClippingRect (irr::video::IVideoDriver *pIrrDriver, ImVec4 &rClippingRect)
 Apples a clipping rectangle. Outside of this rectangle nothing is rendered. More...
 
void disableClippingRect (irr::video::IVideoDriver *pIrrDriver)
 Disables the clipping rectangle. More...
 

Variables

static irr::u8 *const IMGUI_FONT_ID = nullptr
 A magic number for the default font ID IMGUI. More...
 
static irr::u32 TextureCreationID = 0
 This is used to create an unique texture name. More...
 
static bool IsTrilinearFilterEnabled = false
 Indicates, if trilinear filter should be enabled for textures. More...
 

Detailed Description

Functions that help adapting Irrlicht logic to IMGUI.

Function Documentation

void IrrIMGUI::Private::Driver::IrrlichtHelper::applyClippingRect ( irr::video::IVideoDriver *  pIrrDriver,
ImVec4 &  rClippingRect 
)

Apples a clipping rectangle. Outside of this rectangle nothing is rendered.

Parameters
pIrrDriverIs a pointer to the Irrlicht driver object.
rClippingRectIs the IMGUI clipping rect to apply.

Definition at line 710 of file CIrrlichtIMGUIDriver.cpp.

Here is the caller graph for this function:

void IrrIMGUI::Private::Driver::IrrlichtHelper::applyMovingClippingPlaneWorkaround ( irr::video::IVideoDriver *  pIrrDriver)

Applies a workaround for an Irrlicht issue with moving clipping planes.

Parameters
pIrrDriverIs a pointer to the Irrlicht driver object.

Definition at line 635 of file CIrrlichtIMGUIDriver.cpp.

Here is the caller graph for this function:

void IrrIMGUI::Private::Driver::IrrlichtHelper::copyImGuiVertices2IrrlichtVertices ( ImVector< ImDrawVert > &  rIMGUIVertexBuffer,
irr::video::S3DVertex *  pIrrlichtVertex,
irr::core::vector3df const &  rOffset 
)

Copies a list of IMGUI vertices to a list of Irrlicht Vertices.

Parameters
rIMGUIVertexBufferIs an IMGUI Vertex-Buffer object.
pIrrlichtVertexIs a pointer to an Irrlicht Vertex Array.
rOffsetIs an offset that is applied to every vertex.

Definition at line 493 of file CIrrlichtIMGUIDriver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

ImTextureID IrrIMGUI::Private::Driver::IrrlichtHelper::copyTextureIDFromGUIFont ( irr::video::IVideoDriver *  pIrrDriver)

Creates a Texture object from the currently loaded Fonts.

Parameters
pIrrDriverIs a pointer to the Irrlicht driver object.
Returns
Returns ITexture object as IMGUI Texture ID.

Definition at line 583 of file CIrrlichtIMGUIDriver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

ImTextureID IrrIMGUI::Private::Driver::IrrlichtHelper::copyTextureIDFromImage ( irr::video::IVideoDriver *  pIrrDriver,
irr::video::IImage *  pImage 
)

Creates a Texture object from the currently loaded Fonts.

Parameters
pIrrDriverIs a pointer to the Irrlicht driver object.
pImageIs a pointer to an Irrlicht IImage object.
Returns
Returns ITexture object as IMGUI Texture ID.

Definition at line 598 of file CIrrlichtIMGUIDriver.cpp.

Here is the caller graph for this function:

ImTextureID IrrIMGUI::Private::Driver::IrrlichtHelper::copyTextureIDFromRawData ( irr::video::IVideoDriver *  pIrrDriver,
EColorFormat  ColorFormat,
irr::u8 *  pPixelData,
irr::u32  Width,
irr::u32  Height 
)

Created a Texture object from raw data.

Parameters
pIrrDriverIs a pointer to the Irrlicht driver 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.

Definition at line 508 of file CIrrlichtIMGUIDriver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void IrrIMGUI::Private::Driver::IrrlichtHelper::deleteTextureID ( irr::video::IVideoDriver *  pIrrDriver,
CGUITexture pGUITexture 
)

Deleted the memory from this texture ID.

Parameters
pIrrDriverIs a pointer to the Irrlicht driver object.
pGUITextureis a pointer to the texture object.

Definition at line 616 of file CIrrlichtIMGUIDriver.cpp.

Here is the caller graph for this function:

void IrrIMGUI::Private::Driver::IrrlichtHelper::disableClippingRect ( irr::video::IVideoDriver *  pIrrDriver)

Disables the clipping rectangle.

Parameters
pIrrDriverIs a pointer to the Irrlicht driver object.

Definition at line 724 of file CIrrlichtIMGUIDriver.cpp.

Here is the caller graph for this function:

irr::video::SColor IrrIMGUI::Private::Driver::IrrlichtHelper::getColorFromImGuiColor ( irr::u32  ImGuiColor)

Translates an IMGUI Color to an Irrlicht Color.

Parameters
ImGuiColoris the u32 Color value from IMGUI.
Returns
Returns a SColor object for Irrlicht.

Definition at line 481 of file CIrrlichtIMGUIDriver.cpp.

Here is the caller graph for this function:

void IrrIMGUI::Private::Driver::IrrlichtHelper::setupStandardGUIMaterial ( irr::video::SMaterial &  rMaterial,
irr::video::ITexture *  pTexture 
)

Sets the standard GUI material settings.

Parameters
rMaterialIs a reference to the material where the settings should be applied to.
pTextureIs the texture, that should be used.

Definition at line 692 of file CIrrlichtIMGUIDriver.cpp.

Here is the caller graph for this function:

Variable Documentation

irr::u8* const IrrIMGUI::Private::Driver::IrrlichtHelper::IMGUI_FONT_ID = nullptr
static

A magic number for the default font ID IMGUI.

Definition at line 64 of file CIrrlichtIMGUIDriver.cpp.

bool IrrIMGUI::Private::Driver::IrrlichtHelper::IsTrilinearFilterEnabled = false
static

Indicates, if trilinear filter should be enabled for textures.

Definition at line 70 of file CIrrlichtIMGUIDriver.cpp.

irr::u32 IrrIMGUI::Private::Driver::IrrlichtHelper::TextureCreationID = 0
static

This is used to create an unique texture name.

Definition at line 67 of file CIrrlichtIMGUIDriver.cpp.