doc.go 1.1 KB

12345678910111213141516171819202122
  1. // Package imgui contains all the functions to create an immediate mode graphical user interface based on Dear ImGui.
  2. //
  3. // Setup
  4. //
  5. // For integration, please refer to the dedicated repository
  6. // https://github.com/inkyblackness/imgui-go-examples ,
  7. // which contains ported examples of the C++ version, available to Go.
  8. //
  9. // Conventions
  10. //
  11. // The exported functions and constants are named closely to that of the wrapped library.
  12. // If a function has optional parameters, it will be available in two versions:
  13. // A verbose one, which has all optional parameters listed, and a terse one, with only the mandatory parameters in its signature.
  14. // The verbose variant will have the suffix V in its name. For example, there are
  15. // func Button(id string) bool
  16. // and
  17. // func ButtonV(id string, size Vec2) bool
  18. // The terse variant will list the default parameters it uses to call the verbose variant.
  19. //
  20. // There are several types which are based on uintptr. These are references to the wrapped instances in C++.
  21. // You will always get to such a reference via some function - you never "instantiate" such an instance on your own.
  22. package imgui