Class: ImGuiViewport

Inherits:

FFI::Struct

• Object
• FFI::Struct
• ImGuiViewport

Defined in:

lib/imgui.rb

Overview

• Currently represents the Platform Window created by the application which is hosting our Dear ImGui windows.

• With multi-viewport enabled, we extend this concept to have multiple active viewports.

• In the future we will extend this concept further to also represent Platform Monitor and support a “no main platform window” operation mode.

• About Main Area vs Work Area:

  • Main Area = entire viewport.

  • Work Area = entire viewport minus sections used by main menu bars (for platform windows), or by task bar (for platform monitor).

  • Windows are generally trying to stay within the Work Area of their host viewport.

Class Method Summary

• .create ⇒ Object

Instance Method Summary

• #destroy ⇒ Object
• #GetCenter ⇒ Object
• #GetWorkCenter ⇒ Object

Class Method Details

.create ⇒ Object

# File 'lib/imgui.rb', line 1599

def self.create()
  return ImGuiViewport.new(ImGui::ImGuiViewport_ImGuiViewport())
end

Instance Method Details

#destroy ⇒ Object

# File 'lib/imgui.rb', line 1603

def destroy()
  ImGui::ImGuiViewport_destroy(self)
end

#GetCenter ⇒ Object

# File 'lib/imgui.rb', line 1587

def GetCenter()
  pOut = ImVec2.new
  ImGui::ImGuiViewport_GetCenter(pOut, self)
  return pOut
end

#GetWorkCenter ⇒ Object

# File 'lib/imgui.rb', line 1593

def GetWorkCenter()
  pOut = ImVec2.new
  ImGui::ImGuiViewport_GetWorkCenter(pOut, self)
  return pOut
end