MCPcopy Create free account
hub / github.com/cinder/Cinder / SetKeyOwner

Method SetKeyOwner

src/imgui/imgui.cpp:10439–10453  ·  view source on GitHub ↗

_LockXXX flags are useful to lock keys away from code which is not input-owner aware. When using _LockXXX flags, you can use ImGuiKeyOwner_Any to lock keys from everyone. - SetKeyOwner(..., None) : clears owner - SetKeyOwner(..., Any, !Lock) : illegal (assert) - SetKeyOwner(..., Any or None, Lock) : set lock

Source from the content-addressed store, hash-verified

10437// - SetKeyOwner(..., Any, !Lock) : illegal (assert)
10438// - SetKeyOwner(..., Any or None, Lock) : set lock
10439void ImGui::SetKeyOwner(ImGuiKey key, ImGuiID owner_id, ImGuiInputFlags flags)
10440{
10441 ImGuiContext& g = *GImGui;
10442 IM_ASSERT(IsNamedKeyOrMod(key) && (owner_id != ImGuiKeyOwner_Any || (flags & (ImGuiInputFlags_LockThisFrame | ImGuiInputFlags_LockUntilRelease)))); // Can only use _Any with _LockXXX flags (to eat a key away without an ID to retrieve it)
10443 IM_ASSERT((flags & ~ImGuiInputFlags_SupportedBySetKeyOwner) == 0); // Passing flags not supported by this function!
10444 //IMGUI_DEBUG_LOG("SetKeyOwner(%s, owner_id=0x%08X, flags=%08X)\n", GetKeyName(key), owner_id, flags);
10445
10446 ImGuiKeyOwnerData* owner_data = GetKeyOwnerData(&g, key);
10447 owner_data->OwnerCurr = owner_data->OwnerNext = owner_id;
10448
10449 // We cannot lock by default as it would likely break lots of legacy code.
10450 // In the case of using LockUntilRelease while key is not down we still lock during the frame (no key_data->Down test)
10451 owner_data->LockUntilRelease = (flags & ImGuiInputFlags_LockUntilRelease) != 0;
10452 owner_data->LockThisFrame = (flags & ImGuiInputFlags_LockThisFrame) != 0 || (owner_data->LockUntilRelease);
10453}
10454
10455// Rarely used helper
10456void ImGui::SetKeyOwnersForKeyChord(ImGuiKeyChord key_chord, ImGuiID owner_id, ImGuiInputFlags flags)

Callers

nothing calls this directly

Calls 2

IsNamedKeyOrModFunction · 0.85
GetKeyOwnerDataFunction · 0.85

Tested by

no test coverage detected