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