=====cImGui=====

====Fields====

cImGui has no public fields.

====Functions====

^ Return Type ^ Function Name ^ Parameters ^ Description ^
| void | Begin | float afTimeStep |   |
| void | End |     |   |
| void | DestroyAssets |     |   |
| void | ClearStates |     |   |
| void | SendMousePosition | const [[cVector2l]] &in avPos, \\ const [[cVector2l]] &in avRel |   |
| void | SendMouseVirtualPosition | const [[cVector2f]] &in avPos, \\ const [[cVector2f]] &in avRel |   |
| void | SendAction | [[eImGuiAction]] aAction, \\ bool abDown, \\ bool abTriggered |   |
| bool | ActionTriggered | [[eImGuiAction]] aAction, \\ //bool abCheckIfUsed = false// |   |
| bool | ActionIsDown | [[eImGuiAction]] aAction, \\ //bool abCheckIfUsed = false// |   |
| const [[cVector2f]]& | GetMouseRel |     |   |
| [[cVector3f]] | GetMouseRel3D |     |   |
| const [[cVector2f]]& | GetMousePosition |     |   |
| [[cVector3f]] | GetMousePosition3D |     |   |
| bool | CheckMouseHasMoved |     |   |
| void | SetFocus | const [[tString]] &in asWidgetName |   |
| void | SetAlignment | [[eImGuiAlign]] aAlign |   |
| void | SetUIMoveGroupFlags | int alGroupFlags |   |
| void | SetUIMoveWrapMode | [[eImGuiWrap]] aWrap |   |
| int | GetStateInt | uint64 alId, \\ //int alDefault = 0// |   |
| int | GetStateInt | const [[tString]] &in asVarName, \\ //int alDefault = 0// |   |
| float | GetStateFloat | uint64 alId, \\ //float afDefault = 0.0f// |   |
| float | GetStateFloat | const [[tString]] &in asVarName, \\ //float afDefault = 0.0f// |   |
| [[cVector3f]] | GetStateVector3f | uint64 alId, \\ //const [[cVector3f]] &in avDefault = 0.0f// |   |
| [[cVector3f]] | GetStateVector3f | const [[tString]] &in asVarName, \\ //const [[cVector3f]] &in avDefault = cVector3f//, \\  0.0f |   |
| [[cColor]] | GetStateColor | uint64 alId, \\ //const [[cColor]] &in aDefault = cColor//, \\  1, \\  1 |   |
| [[cColor]] | GetStateColor | const [[tString]] &in asVarName, \\ //const [[cColor]] &in aDefault = cColor//, \\  1, \\  1 |   |
| void | SetStateInt | uint64 alId, \\ int alVal |   |
| void | SetStateInt | const [[tString]] &in, \\ int alVal |   |
| void | SetStateFloat | uint64 alId, \\ float afVal |   |
| void | SetStateFloat | const [[tString]] &in, \\ float afVal |   |
| void | SetStateVector3f | uint64 alId, \\ const [[cVector3f]] &in avVal |   |
| void | SetStateVector3f | const [[tString]] &in, \\ const [[cVector3f]] &in avVal |   |
| void | SetStateColor | uint64 alId, \\ const [[cColor]] &in aVal |   |
| void | SetStateColor | const [[tString]] &in, \\ const [[cColor]] &in aVal |   |
| void | IncStateInt | uint64 alId, \\ int alVal |   |
| void | IncStateInt | const [[tString]] &in, \\ int alVal |   |
| void | IncStateFloat | uint64 alId, \\ float afVal |   |
| void | IncStateFloat | const [[tString]] &in, \\ float afVal |   |
| void | IncStateVector3f | uint64 alId, \\ const [[cVector3f]] &in avVal |   |
| void | IncStateVector3f | const [[tString]] &in, \\ const [[cVector3f]] &in avVal |   |
| void | IncStateColor | uint64 alId, \\ const [[cColor]] &in aVal |   |
| void | IncStateColor | const [[tString]] &in, \\ const [[cColor]] &in aVal |   |
| void | FadeStateFloat | const [[tString]] &in asVarName, \\ float afGoalVal, \\ float afTime, \\ //[[eEasing]] aType = eEasing_QuadInOut//, \\ //bool abReplaceIfExist = true// |   |
| void | FadeStateVector3f | const [[tString]] &in asVarName, \\ const [[cVector3f]] &in avGoalVal, \\ float afTime, \\ //[[eEasing]] aType = eEasing_QuadInOut//, \\ //bool abReplaceIfExist = true// |   |
| void | FadeStateColor | const [[tString]] &in asVarName, \\ const [[cColor]] &in aGoalVal, \\ float afTime, \\ //[[eEasing]] aType = eEasing_QuadInOut//, \\ //bool abReplaceIfExist = true// |   |
| void | StopFade | const [[tString]] &in asVarName |   |
| bool | FadeOver | const [[tString]] &in asVarName |   |
| bool | IsFading | const [[tString]] &in asVarName |   |
| float | FadeOscillateFloat | const [[tString]] &in asVarName, \\ float afStart, \\ float afGoal, \\ float afTime, \\ //[[eEasing]] aType = eEasing_QuadInOut// |   |
| [[cVector3f]] | FadeOscillateVector3f | const [[tString]] &in asVarName, \\ const [[cVector3f]] &in avStart, \\ const [[cVector3f]] &in avGoal, \\ float afTime, \\ //[[eEasing]] aType = eEasing_QuadInOut// |   |
| [[cColor]] | FadeOscillateColor | const [[tString]] &in asVarName, \\ const [[cColor]] &in aStart, \\ const [[cColor]] &in aGoal, \\ float afTime, \\ //[[eEasing]] aType = eEasing_QuadInOut// |   |
| void | AddTimer | const [[tString]] &in asName, \\ float afTime |   |
| bool | RepeatTimer | const [[tString]] &in asName, \\ float afTime |   |
| void | StopTimer | const [[tString]] &in asName |   |
| bool | TimerOver | const [[tString]] &in asName |   |
| bool | TimerExists | const [[tString]] &in asName |   |
| void | SetModColorMul | const [[cColor]] &in aCol |   |
| void | SetModTextColorMul | const [[cColor]] &in aCol |   |
| void | SetModUseUIPos | bool abX |   |
| void | SetModUseInput | bool abX |   |
| void | SetModUISizeHoriExpansion | float afNeg, \\ float afPos |   |
| void | SetModUISizeVertExpansion | float afNeg, \\ float afPos |   |
| void | SetModRotateAngle | float afX |   |
| void | SetModRotateCustomPivot | bool abX |   |
| void | SetModRotatePivot | const [[cVector2f]] &in avPivot |   |
| void | SetModGfx | const [[cImGuiGfx]] &in aGfx |   |
| void | ResetModifiers |     |   |
| void | PushModifiers |     |   |
| void | PopModifiers |     |   |
| bool | PrevPressed |     |   |
| bool | PrevBecamePressed |     |   |
| bool | PrevInFocus |     |   |
| const [[cVector3f]]& | PrevPosition |     |   |
| const [[cVector2f]]& | PrevSize |     |   |
| bool | PrevBecameInFocus |     |   |
| bool | PrevWasInFocus |     |   |
| bool | PrevMouseOver |     |   |
| bool | PrevUpdated |     |   |
| void | ClearPrevData |     |   |
| void | GroupBegin | const [[cVector3f]] &in avPos, \\ //const [[cVector2f]] &in avSize = 0//, \\ //bool abClip = false// |   |
| void | GroupEnd |     |   |
| const [[cVector3f]]& | GetCurrentGroupPos |     |   |
| const [[cVector2f]]& | GetCurrentGroupSize |     |   |
| void | ClipAreaBegin | const [[cVector3f]] &in avPos, \\ const [[cVector2f]] &in avSize |   |
| void | ClipAreaEnd |     |   |
| void | LayoutBegin | [[eImGuiLayout]] aType, \\ //const [[cVector3f]] &in avPos = 0//, \\ //const [[cVector2f]] &in avSize = -1//, \\ //const [[cVector2f]] &in avSpacing = 0// |   |
| void | LayoutEnd |     |   |
| void | AddLayoutHorizontalSpace | float afWidth, \\ //float afHeight = 0// |   |
| void | AddLayoutVerticalSpace | float afHeight |   |
| void | AddItemString | const [[tWString]] &in asStr |   |
| void | AddItemStringList | const [[tWString]] &in asStrList |   |
| void | AddItemGfx | const [[cImGuiGfx]] &in aGfx |   |
| void | ClearItems |     |   |
| void | DoMouse | const [[cImGuiGfx]]& aGfx, \\ //const [[cVector3f]] &in avOffset = 0//, \\ //const [[cVector2f]] &in avSize = -1// |   |
| bool | DoButton | const [[tString]] &in asName, \\ const [[tWString]] &in asText, \\ const [[cImGuiButtonData]]& aData, \\ //const [[cVector3f]] &in avPos = 0//, \\ //const [[cVector2f]] &in avSize = -1// |   |
| bool | DoButton | const [[tString]] &in asName, \\ const [[tWString]] &in asText, \\ //const [[cVector3f]] &in avPos = 0//, \\ //const [[cVector2f]] &in avSize = -1// |   |
| bool | DoRepeatButton | const [[tString]] &in asName, \\ const [[tWString]] &in asText, \\ const [[cImGuiButtonData]]& aData, \\ //const [[cVector3f]] &in avPos = 0//, \\ //const [[cVector2f]] &in avSize = -1// |   |
| bool | DoRepeatButton | const [[tString]] &in asName, \\ const [[tWString]] &in asText, \\ //const [[cVector3f]] &in avPos = 0//, \\ //const [[cVector2f]] &in avSize = -1// |   |
| bool | DoToggleButton | const [[tString]] &in asName, \\ const [[tWString]] &in asText, \\ bool abDefaultChecked, \\ const [[cImGuiButtonData]]& aData, \\ //const [[cVector3f]] &in avPos = 0//, \\ //const [[cVector2f]] &in avSize = -1// |   |
| bool | DoToggleButton | const [[tString]] &in asName, \\ const [[tWString]] &in asText, \\ bool abDefaultChecked, \\ //const [[cVector3f]] &in avPos = 0//, \\ //const [[cVector2f]] &in avSize = -1// |   |
| float | DoSliderHorizontal | const [[tString]] &in asName, \\ float afDefaultValue, \\ float afMin, \\ float afMax, \\ float afStepSize, \\ const [[cImGuiSliderData]]& aData, \\ //const [[cVector3f]] &in avPos = 0//, \\ //const [[cVector2f]] &in avSize = -1// |   |
| float | DoSliderHorizontal | const [[tString]] &in asName, \\ float afDefaultValue, \\ float afMin, \\ float afMax, \\ //float afStepSize = -1//, \\ //const [[cVector3f]] &in avPos = 0//, \\ //const [[cVector2f]] &in avSize = -1// |   |
| float | DoSliderVertical | const [[tString]] &in asName, \\ float afDefaultValue, \\ float afMin, \\ float afMax, \\ float afStepSize, \\ const [[cImGuiSliderData]]& aData, \\ //const [[cVector3f]] &in avPos = 0//, \\ //const [[cVector2f]] &in avSize = -1// |   |
| float | DoSliderVertical | const [[tString]] &in asName, \\ float afDefaultValue, \\ float afMin, \\ float afMax, \\ //float afStepSize = -1//, \\ //const [[cVector3f]] &in avPos = 0//, \\ //const [[cVector2f]] &in avSize = -1// |   |
| void | DoLabel | const [[tWString]] &in asText, \\ const [[cImGuiLabelData]]& aData, \\ //const [[cVector3f]] &in avPos = 0//, \\ //const [[cVector2f]] &in avSize = -1//, \\ //float afFontSizeMul = 1// |   |
| void | DoLabel | const [[tWString]] &in asText, \\ //const [[cVector3f]] &in avPos = 0//, \\ //const [[cVector2f]] &in avSize = -1//, \\ //float afFontSizeMul = 1// |   |
| void | DoImage | const [[cImGuiGfx]] &in aGfxImage, \\ //const [[cVector3f]] &in avPos = 0//, \\ //const [[cVector2f]] &in avSize = -1// |   |
| int | DoMultiToggle | const [[tString]] &in asName, \\ int alDefaultSelectedItem, \\ uint alColumnNum, \\ const [[cVector2f]] &in avSpacing, \\ const [[cImGuiButtonData]]& aData, \\ const [[cVector3f]] &in avPos, \\ const [[cVector2f]] &in avSize |   |
| int | DoMultiToggle | const [[tString]] &in asName, \\ int alDefaultSelectedItem, \\ uint alColumnNum, \\ const [[cVector2f]] &in avSpacing, \\ const [[cVector3f]] &in avPos, \\ const [[cVector2f]] &in avSize |   |
| bool | DoCheckBox | const [[tString]] &in asName, \\ const [[tWString]] &in asText, \\ bool abDefaultChecked, \\ const [[cImGuiCheckBoxData]]& aData, \\ //const [[cVector3f]] &in avPos = 0//, \\ //const [[cVector2f]] &in avSize = -1// |   |
| bool | DoCheckBox | const [[tString]] &in asName, \\ const [[tWString]] &in asText, \\ bool abDefaultChecked, \\ //const [[cVector3f]] &in avPos = 0//, \\ //const [[cVector2f]] &in avSize = -1// |   |
| float | DoTextFrame | const [[tWString]] &in asText, \\ const [[cVector2f]] &in avEdgeSpacing, \\ float afRowSpace, \\ float afStartRowOffset, \\ const [[cImGuiTextFrameData]]& aData, \\ const [[cVector3f]] &in avPos, \\ const [[cVector2f]] &in avSize |   |
| float | DoTextFrame | const [[tWString]] &in asText, \\ const [[cVector2f]] &in avEdgeSpacing, \\ float afRowSpace, \\ float afStartRowOffset, \\ const [[cVector3f]] &in avPos, \\ const [[cVector2f]] &in avSize |   |
| int | DoMultiSelect | const [[tString]] &in asName, \\ int alDefaultSelectedItem, \\ const [[cImGuiMultiSelectData]]& aData, \\ //const [[cVector3f]] &in avPos = 0//, \\ //const [[cVector2f]] &in avSize = -1// |   |
| int | DoMultiSelect | const [[tString]] &in asName, \\ int alDefaultSelectedItem, \\ //const [[cVector3f]] &in avPos = 0//, \\ //const [[cVector2f]] &in avSize = -1// |   |
| void | DoFrame | const [[cImGuiFrameData]]& aData, \\ //const [[cVector3f]]& avPos = 0//, \\ //const [[cVector2f]]& avSize = -1// |   |
| void | DoFrame | //const [[cVector3f]]& avPos = 0//, \\ //const [[cVector2f]]& avSize = -1// |   |
| void | DoWindowStart | const [[tWString]]& asCaption, \\ const [[cImGuiWindowData]]& aData, \\ //const [[cVector3f]]& avPos = 0//, \\ //const [[cVector2f]]& avSize = -1//, \\ //bool abClip = true// |   |
| void | DoWindowStart | const [[tWString]]& asCaption, \\ //const [[cVector3f]]& avPos = 0//, \\ //const [[cVector2f]]& avSize = -1//, \\ //bool abClip = true// |   |
| void | DoWindowEnd |     |   |
| void | DoGauge | const [[cImGuiGaugeData]]& aData, \\ float afFillAmount, \\ //const [[cVector3f]]& avPos = 0//, \\ //const [[cVector2f]]& avSize = -1// |   |
| void | DoGauge | float afFillAmount, \\ //const [[cVector3f]]& avPos = 0//, \\ //const [[cVector2f]]& avSize = -1// |   |
| void | SetDefaultButton | const [[cImGuiButtonData]]& aData |   |
| const [[cImGuiButtonData]]& | GetDefaultButton |     |   |
| void | SetDefaultSliderHorizontal | const [[cImGuiSliderData]]& aData |   |
| const [[cImGuiSliderData]]& | GetDefaultSliderHorizontal |     |   |
| void | SetDefaultSliderVertical | const [[cImGuiSliderData]]& aData |   |
| const [[cImGuiSliderData]]& | GetDefaultSliderVertical |     |   |
| void | SetDefaultLabel | const [[cImGuiLabelData]]& aData |   |
| const [[cImGuiLabelData]]& | GetDefaultLabel |     |   |
| void | SetDefaultCheckBox | const [[cImGuiCheckBoxData]]& aData |   |
| const [[cImGuiCheckBoxData]]& | GetDefaultCheckBox |     |   |
| void | SetDefaultTextFrame | const [[cImGuiTextFrameData]]& aData |   |
| const [[cImGuiTextFrameData]]& | GetDefaultTextFrame |     |   |
| void | SetDefaultMultiSelect | const [[cImGuiMultiSelectData]]& aData |   |
| const [[cImGuiMultiSelectData]]& | GetDefaultMultiSelect |     |   |
| void | SetDefaultFrame | const [[cImGuiFrameData]]& aData |   |
| const [[cImGuiFrameData]]& | GetDefaultFrame |     |   |
| void | SetDefaultWindow | const [[cImGuiWindowData]]& aData |   |
| const [[cImGuiWindowData]]& | GetDefaultWindow |     |   |
| void | SetDefaultGauge | const [[cImGuiGaugeData]]& aData |   |
| const [[cImGuiGaugeData]]& | GetDefaultGauge |     |   |
| const [[tString]]& | GetName |     |   |
| [[cGuiSet]]@ | GetSet |     |   |
| void | SetShowMouseAutomatically | bool abX |   |
| bool | GetShowMouseAutomatically |     |   |
| void | SetShowMouse | bool abX |   |
| bool | GetShowMouse |     |   |
| bool | IsFirstRun |     |   |
| void | SetDefaultMouse | const [[cImGuiGfx]] &in aGfx |   |
| void | SetDefaultFont | const [[cImGuiFont]] &in aFont |   |
| float | GetTimeStep |     |   |
| float | GetTimeCount |     |   |
| void | SetDrawUIDebugBoxes | bool abX |   |
| void | DrawLine | const [[cVector2f]] &in avStart, \\ const [[cVector2f]] &in avEnd, \\ float afZ, \\ //float afThickness = 1.0f//, \\ //const [[cColor]] &in aCol = cColor//, \\  1, \\  1, \\ //const [[cImGuiGfx]]& aGfx = cImGuiGfx// |   |
| void | DrawGfx | const [[cImGuiGfx]]& aGfx, \\ const [[cVector3f]] &in avPos, \\ //const [[cVector2f]] &in avSize = -1//, \\ //const [[cColor]] &in aCol = cColor//, \\  1, \\  1, \\ //const [[cColor]] &in aColTopLeft = cColor//, \\  1, \\  1, \\ //const [[cColor]] &in aColTopRight = cColor//, \\  1, \\  1, \\ //const [[cColor]] &in aColBotRight = cColor//, \\  1, \\  1, \\ //const [[cColor]] &in aColBotLeft = cColor//, \\  1, \\  1 |   |
| void | DrawAlignedGfx | const [[cImGuiGfx]]& aGfx, \\ const [[cVector3f]]& avPos, \\ [[eImGuiAlign]] aAlignment, \\ //const [[cVector2f]] &in avSize = -1//, \\ //const [[cColor]]& aCol = cColor//, \\  1, \\  1, \\ //const [[cColor]] &in aColTopLeft = cColor//, \\  1, \\  1, \\ //const [[cColor]] &in aColTopRight = cColor//, \\  1, \\  1, \\ //const [[cColor]] &in aColBotRight = cColor//, \\  1, \\  1, \\ //const [[cColor]] &in aColBotLeft = cColor//, \\  1, \\  1 |   |
| void | DrawFont | const [[tWString]] &in asText, \\ const [[cImGuiFont]]& aFont, \\ const [[cVector3f]] &in avPos, \\ [[eFontAlign]] aAlign, \\ //const [[cVector2f]] &in avSizeMul = 1//, \\ //const [[cColor]] &in aColMul = cColor//, \\  1, \\  1 |   |
| void | DrawFrame | const [[cImGuiFrameGfx]]& aGfx, \\ const [[cVector3f]] &in avPos, \\ //const [[cVector2f]] &in avSize = -1//, \\ //const [[cColor]] &in aCol = cColor//, \\  1, \\  1 |   |
| void | AddLineStripVertex | const [[cVector2f]]& avVertex |   |
| void | DrawAndClearLineStrip | float afZ, \\ float afThickness, \\ //const [[cColor]]& aCol = cColor_White//, \\ //const [[cImGuiGfx]]& aGfx = cImGuiGfx// |   |
| bool | CheckCurrentWidgetBecamePressed | const [[tString]] &in asName, \\ bool abCheckConfirm, \\ bool abCheckMouseLeft |   |
| bool | CheckCurrentWidgetIsPressed | const [[tString]] &in asName, \\ bool abCheckConfirm, \\ bool abCheckMouseLeft |   |
| bool | CheckIsPressedAction | bool abCheckConfirm, \\ bool abCheckMouseLeft |   |
| bool | CheckBecamePressedAction | bool abCheckConfirm, \\ bool abCheckMouseLeft |   |
| int | GetDefaultOrCurrentInt | uint64 alDefaultVarId, \\ uint64 alCurrentVarId, \\ int alDefaultValue |   |
| float | GetDefaultOrCurrentFloat | uint64 alDefaultVarId, \\ uint64 alCurrentVarId, \\ float afDefaultValue |   |
| void | LockMouseFocus |     |   |
| bool | MouseFocusIsLocked |     |   |
| [[cVector2f]] | CalcWidgetSize | const [[cVector2f]] &in avArgSize, \\ const [[cVector2f]] &in avDefaultSize |   |
| void | SetupWidgetRect | const [[cVector3f]] &in avInPos, \\ const [[cVector2f]] &in avInSize, \\ [[cVector3f]] &out avOutPos, \\ [[cVector2f]] &out avOutSize, \\ const [[cVector2f]] &in avDefaultSize, \\ const [[cImGuiGfx]]& aGfx |   |
| void | SetUpAlignment | const [[cVector3f]]& avPos, \\ const [[cVector2f]]& avSize, \\ [[cVector3f]]& avAlignedPos, \\ [[eImGuiAlign]] aAlignment |   |
| bool | CheckMouseOver | const [[cVector3f]] &in avPos, \\ const [[cVector2f]]& avSize |   |
| [[cVector2f]] | GetUsedGfxSize | const [[cImGuiGfx]] &in aGfx, \\ const [[cVector2f]] &in avCustomSize |   |
| [[cVector2f]] | GetGfxSize | const [[cImGuiGfx]] &in aGfx |   |
| float | GetFontLength | const [[cImGuiFont]] &in aFont, \\ float afSizeMul, \\ const [[tWString]] &in asText |   |
| void | GetFontWordWrapRows | const [[cImGuiFont]] &in aFont, \\ float afSizeMul, \\ const [[tWString]] &in asText, \\ float afLineWidth, \\  avLines, \\ // avRowEndedWithNewLine = array<bool>// |   |
| const [[cVector2f]]& | GetUsedFontSize | const [[cImGuiFont]] &in aFont |   |
| uint64 | GetIdFromNameAndCheckCollision | const [[tString]] &in asName, \\ int alTableIdx |   |
| void | DrawAll |     |   |

====Remarks====

A reference to the cImGui object controlling the current GUI can be obtained through the [[hpl3:game:scripting:function_reference:hps_api#cLux_GetCurrentImGui|cLux_GetCurrentImGui]] function.