Unravel Engine C++ Reference
Loading...
Searching...
No Matches
Classes | Functions | Variables
ImGui Namespace Reference

Classes

struct  ContextMenuStyleScope
 
struct  Font
 
union  ImTexture
 

Functions

auto GetTintedStyleColor (ImGuiCol idx, float multiplier=1.0f) -> ImVec4
 
auto GetStyleColor (ImGuiCol idx, float multiplier=1.0f) -> ImVec4
 
void PushFont (Font::Enum _font)
 
ImFont * GetFont (Font::Enum _font)
 
void PushEnabled (bool _enabled)
 
void PopEnabled ()
 
bool IsReadonly ()
 
void PushReadonly (bool _enabled)
 
void PopReadonly ()
 
void PushWindowFontSize (int size)
 
void PopWindowFontSize ()
 
void PushWindowFontScale (float scale)
 
void PopWindowFontScale ()
 
uint64_t GetDrawCalls ()
 
void KeepAliveOneFrame (const gfx::texture::ptr &tex)
 
ImTexture ToTex (gfx::texture_handle _handle, uint8_t _index, gfx::program_handle _phandle, uint8_t _mip=0, uint8_t _flags=IMGUI_FLAGS_ALPHA_BLEND)
 
ImTextureID ToId (gfx::texture_handle _handle, uint8_t _mip=0, uint8_t _flags=IMGUI_FLAGS_ALPHA_BLEND)
 
ImTexture FromId (ImTextureID _id)
 
ImTextureID ToId (const gfx::texture &_handle, uint8_t _mip=0, uint8_t _flags=IMGUI_FLAGS_ALPHA_BLEND)
 
ImTextureID ToId (const gfx::texture::ptr &_handle, uint8_t _mip=0, uint8_t _flags=IMGUI_FLAGS_ALPHA_BLEND)
 
ImTextureID ToId (const asset_handle< gfx::texture > &_handle, uint8_t _mip=0, uint8_t _flags=IMGUI_FLAGS_ALPHA_BLEND)
 
ImVec2 GetSize (const gfx::texture &tex, const ImVec2 &fallback={})
 
ImVec2 GetSize (const gfx::texture::ptr &tex, const ImVec2 &fallback={})
 
ImVec2 GetSize (const asset_handle< gfx::texture > &_handle, const ImVec2 &fallback={})
 
void Image (gfx::texture_handle _handle, uint8_t _mip, uint8_t _flags, const ImVec2 &_size, const ImVec2 &_uv0=ImVec2(0.0f, 0.0f), const ImVec2 &_uv1=ImVec2(1.0f, 1.0f))
 
void Image (gfx::texture_handle _handle, const ImVec2 &_size, const ImVec2 &_uv0=ImVec2(0.0f, 0.0f), const ImVec2 &_uv1=ImVec2(1.0f, 1.0f))
 
bool ImageButton (gfx::texture_handle _handle, uint8_t _mip, uint8_t _flags, const ImVec2 &_size, const ImVec2 &_uv0=ImVec2(0.0f, 0.0f), const ImVec2 &_uv1=ImVec2(1.0f, 1.0f), const ImVec4 &_bgCol=ImVec4(0.0f, 0.0f, 0.0f, 0.0f), const ImVec4 &_tintCol=ImVec4(1.0f, 1.0f, 1.0f, 1.0f))
 
bool ImageButton (gfx::texture_handle _handle, const ImVec2 &_size, const ImVec2 &_uv0=ImVec2(0.0f, 0.0f), const ImVec2 &_uv1=ImVec2(1.0f, 1.0f), const ImVec4 &_bgCol=ImVec4(0.0f, 0.0f, 0.0f, 0.0f), const ImVec4 &_tintCol=ImVec4(1.0f, 1.0f, 1.0f, 1.0f))
 
void NextLine ()
 
bool MouseOverArea ()
 
void PushContextMenuStyle ()
 
void PopContextMenuStyle ()
 
auto MenuItemIcon (const char *icon, const char *label, const char *shortcut, bool enabled) -> bool
 
auto BeginMenuIcon (const char *icon, const char *label, bool enabled) -> bool
 
NOTIFY_INLINE ImGuiToast * GetNotification (uint64_t unique_id)
 
NOTIFY_INLINE void PushNotification (const ImGuiToast &toast)
 Insert a new toast in the list.
 
NOTIFY_INLINE void PushNotification (uint64_t unique_id, const ImGuiToast &toast)
 Insert or update a notification with a unique ID If the notification already exists, it updates the content and refreshes timing:
 
NOTIFY_INLINE void RemoveNotification (int index)
 Remove a toast from the list by its index.
 
NOTIFY_INLINE void RenderNotifications ()
 Render toasts, call at the end of your rendering!
 

Variables

NOTIFY_INLINE std::vector< ImGuiToast > notifications
 

Function Documentation

◆ BeginMenuIcon()

auto ImGui::BeginMenuIcon ( const char * icon,
const char * label,
bool enabled ) -> bool

Definition at line 60 of file imgui_context_menu_style.cpp.

◆ FromId()

ImTexture ImGui::FromId ( ImTextureID _id)
inline

Definition at line 109 of file imgui.h.

◆ GetDrawCalls()

uint64_t ImGui::GetDrawCalls ( )

Definition at line 744 of file imgui.cpp.

◆ GetFont()

ImFont * ImGui::GetFont ( Font::Enum _font)

Definition at line 652 of file imgui.cpp.

◆ GetNotification()

NOTIFY_INLINE ImGuiToast * ImGui::GetNotification ( uint64_t unique_id)

Definition at line 342 of file imgui_notify.h.

◆ GetSize() [1/3]

ImVec2 ImGui::GetSize ( const asset_handle< gfx::texture > & _handle,
const ImVec2 & fallback = {} )
inline

Definition at line 164 of file imgui.h.

◆ GetSize() [2/3]

ImVec2 ImGui::GetSize ( const gfx::texture & tex,
const ImVec2 & fallback = {} )
inline

Definition at line 149 of file imgui.h.

◆ GetSize() [3/3]

ImVec2 ImGui::GetSize ( const gfx::texture::ptr & tex,
const ImVec2 & fallback = {} )
inline

Definition at line 154 of file imgui.h.

◆ GetStyleColor()

auto ImGui::GetStyleColor ( ImGuiCol idx,
float multiplier = 1.0f ) -> ImVec4

Definition at line 33 of file inspectors.cpp.

◆ GetTintedStyleColor()

auto ImGui::GetTintedStyleColor ( ImGuiCol idx,
float multiplier = 1.0f ) -> ImVec4

Definition at line 14 of file inspector.cpp.

◆ Image() [1/2]

void ImGui::Image ( gfx::texture_handle _handle,
const ImVec2 & _size,
const ImVec2 & _uv0 = ImVec2(0.0f, 0.0f),
const ImVec2 & _uv1 = ImVec2(1.0f, 1.0f) )
inline

Definition at line 186 of file imgui.h.

◆ Image() [2/2]

void ImGui::Image ( gfx::texture_handle _handle,
uint8_t _mip,
uint8_t _flags,
const ImVec2 & _size,
const ImVec2 & _uv0 = ImVec2(0.0f, 0.0f),
const ImVec2 & _uv1 = ImVec2(1.0f, 1.0f) )
inline

Definition at line 175 of file imgui.h.

◆ ImageButton() [1/2]

bool ImGui::ImageButton ( gfx::texture_handle _handle,
const ImVec2 & _size,
const ImVec2 & _uv0 = ImVec2(0.0f, 0.0f),
const ImVec2 & _uv1 = ImVec2(1.0f, 1.0f),
const ImVec4 & _bgCol = ImVec4(0.0f, 0.0f, 0.0f, 0.0f),
const ImVec4 & _tintCol = ImVec4(1.0f, 1.0f, 1.0f, 1.0f) )
inline

Definition at line 208 of file imgui.h.

◆ ImageButton() [2/2]

bool ImGui::ImageButton ( gfx::texture_handle _handle,
uint8_t _mip,
uint8_t _flags,
const ImVec2 & _size,
const ImVec2 & _uv0 = ImVec2(0.0f, 0.0f),
const ImVec2 & _uv1 = ImVec2(1.0f, 1.0f),
const ImVec4 & _bgCol = ImVec4(0.0f, 0.0f, 0.0f, 0.0f),
const ImVec4 & _tintCol = ImVec4(1.0f, 1.0f, 1.0f, 1.0f) )
inline

Definition at line 195 of file imgui.h.

◆ IsReadonly()

bool ImGui::IsReadonly ( )

Definition at line 672 of file imgui.cpp.

◆ KeepAliveOneFrame()

void ImGui::KeepAliveOneFrame ( const gfx::texture::ptr & tex)

Definition at line 749 of file imgui.cpp.

◆ MenuItemIcon()

auto ImGui::MenuItemIcon ( const char * icon,
const char * label,
const char * shortcut,
bool enabled ) -> bool

Definition at line 48 of file imgui_context_menu_style.cpp.

◆ MouseOverArea()

bool ImGui::MouseOverArea ( )
inline

Definition at line 225 of file imgui.h.

◆ NextLine()

void ImGui::NextLine ( )
inline

Definition at line 219 of file imgui.h.

◆ PopContextMenuStyle()

void ImGui::PopContextMenuStyle ( )

Definition at line 42 of file imgui_context_menu_style.cpp.

◆ PopEnabled()

void ImGui::PopEnabled ( )

Definition at line 664 of file imgui.cpp.

◆ PopReadonly()

void ImGui::PopReadonly ( )

Definition at line 687 of file imgui.cpp.

◆ PopWindowFontScale()

void ImGui::PopWindowFontScale ( )

Definition at line 734 of file imgui.cpp.

◆ PopWindowFontSize()

void ImGui::PopWindowFontSize ( )

Definition at line 711 of file imgui.cpp.

◆ PushContextMenuStyle()

void ImGui::PushContextMenuStyle ( )

Definition at line 15 of file imgui_context_menu_style.cpp.

◆ PushEnabled()

void ImGui::PushEnabled ( bool _enabled)

Definition at line 657 of file imgui.cpp.

◆ PushFont()

void ImGui::PushFont ( Font::Enum _font)

Definition at line 646 of file imgui.cpp.

◆ PushNotification() [1/2]

NOTIFY_INLINE void ImGui::PushNotification ( const ImGuiToast & toast)

Insert a new toast in the list.

Definition at line 357 of file imgui_notify.h.

◆ PushNotification() [2/2]

NOTIFY_INLINE void ImGui::PushNotification ( uint64_t unique_id,
const ImGuiToast & toast )

Insert or update a notification with a unique ID If the notification already exists, it updates the content and refreshes timing:

  • If still fading in: preserves current fade-in progress
  • If in wait/fade-out phase: resets to start of wait phase (fully visible)
  • If expired: starts fresh with fade-in

Definition at line 369 of file imgui_notify.h.

◆ PushReadonly()

void ImGui::PushReadonly ( bool _enabled)

Definition at line 678 of file imgui.cpp.

◆ PushWindowFontScale()

void ImGui::PushWindowFontScale ( float scale)

Definition at line 721 of file imgui.cpp.

◆ PushWindowFontSize()

void ImGui::PushWindowFontSize ( int size)

Definition at line 695 of file imgui.cpp.

◆ RemoveNotification()

NOTIFY_INLINE void ImGui::RemoveNotification ( int index)

Remove a toast from the list by its index.

Parameters
indexindex of the toast to remove

Definition at line 410 of file imgui_notify.h.

◆ RenderNotifications()

NOTIFY_INLINE void ImGui::RenderNotifications ( )

Render toasts, call at the end of your rendering!

Definition at line 418 of file imgui_notify.h.

◆ ToId() [1/4]

ImTextureID ImGui::ToId ( const asset_handle< gfx::texture > & _handle,
uint8_t _mip = 0,
uint8_t _flags = IMGUI_FLAGS_ALPHA_BLEND )
inline

Definition at line 142 of file imgui.h.

◆ ToId() [2/4]

ImTextureID ImGui::ToId ( const gfx::texture & _handle,
uint8_t _mip = 0,
uint8_t _flags = IMGUI_FLAGS_ALPHA_BLEND )
inline

Definition at line 116 of file imgui.h.

◆ ToId() [3/4]

ImTextureID ImGui::ToId ( const gfx::texture::ptr & _handle,
uint8_t _mip = 0,
uint8_t _flags = IMGUI_FLAGS_ALPHA_BLEND )
inline

Definition at line 131 of file imgui.h.

◆ ToId() [4/4]

ImTextureID ImGui::ToId ( gfx::texture_handle _handle,
uint8_t _mip = 0,
uint8_t _flags = IMGUI_FLAGS_ALPHA_BLEND )
inline

Definition at line 103 of file imgui.h.

◆ ToTex()

ImTexture ImGui::ToTex ( gfx::texture_handle _handle,
uint8_t _index,
gfx::program_handle _phandle,
uint8_t _mip = 0,
uint8_t _flags = IMGUI_FLAGS_ALPHA_BLEND )
inline

Definition at line 88 of file imgui.h.

Variable Documentation

◆ notifications

NOTIFY_INLINE std::vector<ImGuiToast> ImGui::notifications

Definition at line 339 of file imgui_notify.h.