C# Class ImGuiNET.NativeIO

显示文件 Open project: mellinoe/ImGui.NET Class Usage Examples

Public Properties

Property Type Description
DeltaTime float
DisplayFramebufferScale Vector2
DisplaySize Vector2
DisplayVisibleMax Vector2
DisplayVisibleMin Vector2
FontAllowUserScaling byte
FontAtlas NativeFontAtlas*
FontGlobalScale float
Framerate float
GetClipboardTextFn System.IntPtr
ImeSetInputScreenPosFn System.IntPtr
ImeWindowHandle System.IntPtr
IniFilename System.IntPtr
IniSavingRate float
KeyAlt byte
KeyCtrl byte
KeyRepeatDelay float
KeyRepeatRate float
KeyShift byte
LogFilename System.IntPtr
MemAllocFn System.IntPtr
MemFreeFn System.IntPtr
MetricsActiveWindows int
MetricsAllocs int
MetricsRenderIndices int
MetricsRenderVertices int
MouseClickedPos0 Vector2
MouseClickedPos1 Vector2
MouseClickedPos2 Vector2
MouseClickedPos3 Vector2
MouseClickedPos4 Vector2
MouseDelta Vector2
MouseDoubleClickMaxDist float
MouseDoubleClickTime float
MouseDragThreshold float
MouseDrawCursor byte
MousePos Vector2
MousePosPrev Vector2
MouseWheel float
RenderDrawListsFn System.IntPtr
SetClipboardTextFn System.IntPtr
UserData System.IntPtr
WantCaptureKeyboard byte
WantCaptureMouse byte
WantTextInput byte

Property Details

DeltaTime public_oe property

Time elapsed since last frame, in seconds. Default value: 1.0f / 10.0f.
public float DeltaTime
return float

DisplayFramebufferScale public_oe property

For retina display or other situations where window coordinates are different from framebuffer coordinates. User storage only, presently not used by ImGui. Default value: (1.0f, 1.0f).
public Vector2 DisplayFramebufferScale
return Vector2

DisplaySize public_oe property

Display size, in pixels. For clamping windows positions. Default value: [unset]
public Vector2 DisplaySize
return Vector2

DisplayVisibleMax public_oe property

If the values are the same, we defaults to Min=0.0f) and Max=DisplaySize. Default value: (0.0f, 0.0f).
public Vector2 DisplayVisibleMax
return Vector2

DisplayVisibleMin public_oe property

If you use DisplaySize as a virtual space larger than your screen, set DisplayVisibleMin/Max to the visible area. Default value: (0.0f, 0.0f)
public Vector2 DisplayVisibleMin
return Vector2

FontAllowUserScaling public_oe property

Allow user scaling text of individual window with CTRL+Wheel. Default value: false.
public byte FontAllowUserScaling
return byte

FontAtlas public_oe property

Load and assemble one or more fonts into a single tightly packed texture. Output to Fonts array. Default value: [auto]
public NativeFontAtlas* FontAtlas
return NativeFontAtlas*

FontGlobalScale public_oe property

Global scale all fonts. Default value: 1.0f.
public float FontGlobalScale
return float

Framerate public_oe property

Framerate estimation, in frame per second. Rolling average estimation based on IO.DeltaTime over 120 frames.
public float Framerate
return float

GetClipboardTextFn public_oe property

Optional: access OS clipboard (default to use native Win32 clipboard on Windows, otherwise uses a private clipboard. Override to access OS clipboard on other architectures)
public IntPtr,System GetClipboardTextFn
return System.IntPtr

ImeSetInputScreenPosFn public_oe property

Optional: notify OS Input Method Editor of the screen position of your cursor for text input position (e.g. when using Japanese/Chinese IME in Windows) (default to use native imm32 api on Windows)
public IntPtr,System ImeSetInputScreenPosFn
return System.IntPtr

ImeWindowHandle public_oe property

(Windows) Set this to your HWND to get automatic IME cursor positioning.
public IntPtr,System ImeWindowHandle
return System.IntPtr

IniFilename public_oe property

Path to .ini file. NULL to disable .ini saving. Default value: "imgui.ini"
public IntPtr,System IniFilename
return System.IntPtr

IniSavingRate public_oe property

Maximum time between saving positions/sizes to .ini file, in seconds. Default value: 5.0f.
public float IniSavingRate
return float

KeyAlt public_oe property

Keyboard modifier pressed: Alt
public byte KeyAlt
return byte

KeyCtrl public_oe property

Keyboard modifier pressed: Control.
public byte KeyCtrl
return byte

KeyRepeatDelay public_oe property

When holding a key/button, time before it starts repeating, in seconds. (for actions where 'repeat' is active). Default value: 0.250f.
public float KeyRepeatDelay
return float

KeyRepeatRate public_oe property

When holding a key/button, rate at which it repeats, in seconds. Default value: 0.020f.
public float KeyRepeatRate
return float

KeyShift public_oe property

Keyboard modifier pressed: Shift
public byte KeyShift
return byte

LogFilename public_oe property

Path to .log file (default parameter to ImGui::LogToFile when no file is specified). Default value: "imgui_log.txt"
public IntPtr,System LogFilename
return System.IntPtr

MemAllocFn public_oe property

Optional: override memory allocations. MemFreeFn() may be called with a NULL pointer. (default to posix malloc/free)
public IntPtr,System MemAllocFn
return System.IntPtr

MemFreeFn public_oe property

Optional: override memory allocations. MemFreeFn() may be called with a NULL pointer. (default to posix malloc/free)
public IntPtr,System MemFreeFn
return System.IntPtr

MetricsActiveWindows public_oe property

Number of visible windows (exclude child windows)
public int MetricsActiveWindows
return int

MetricsAllocs public_oe property

Number of active memory allocations.
public int MetricsAllocs
return int

MetricsRenderIndices public_oe property

Indices output during last call to Render() = number of triangles * 3
public int MetricsRenderIndices
return int

MetricsRenderVertices public_oe property

Vertices output during last call to Render().
public int MetricsRenderVertices
return int

MouseClickedPos0 public_oe property

Position at time of clicking
public Vector2 MouseClickedPos0
return Vector2

MouseClickedPos1 public_oe property

Position at time of clicking
public Vector2 MouseClickedPos1
return Vector2

MouseClickedPos2 public_oe property

Position at time of clicking
public Vector2 MouseClickedPos2
return Vector2

MouseClickedPos3 public_oe property

Position at time of clicking
public Vector2 MouseClickedPos3
return Vector2

MouseClickedPos4 public_oe property

Position at time of clicking
public Vector2 MouseClickedPos4
return Vector2

MouseDelta public_oe property

Mouse delta. Note that this is zero if either current or previous position are negative to allow mouse enabling/disabling.
public Vector2 MouseDelta
return Vector2

MouseDoubleClickMaxDist public_oe property

Distance threshold to stay in to validate a double-click, in pixels. Default Value: 6.0f.
public float MouseDoubleClickMaxDist
return float

MouseDoubleClickTime public_oe property

Time for a double-click, in seconds. Default value: 0.30f.
public float MouseDoubleClickTime
return float

MouseDragThreshold public_oe property

Distance threshold before considering we are dragging. Default Value: 6.0f.
public float MouseDragThreshold
return float

MouseDrawCursor public_oe property

Request ImGui to draw a mouse cursor for you (if you are on a platform without a mouse cursor).
public byte MouseDrawCursor
return byte

MousePos public_oe property

Mouse position, in pixels (set to -1,-1 if no mouse / on another screen, etc.).
public Vector2 MousePos
return Vector2

MousePosPrev public_oe property

Previous mouse position
public Vector2 MousePosPrev
return Vector2

MouseWheel public_oe property

Mouse wheel: 1 unit scrolls about 5 lines text.
public float MouseWheel
return float

RenderDrawListsFn public_oe property

Rendering function, will be called in Render(). Alternatively you can keep this to NULL and call GetDrawData() after Render() to get the same pointer.
public IntPtr,System RenderDrawListsFn
return System.IntPtr

SetClipboardTextFn public_oe property

Optional: access OS clipboard (default to use native Win32 clipboard on Windows, otherwise uses a private clipboard. Override to access OS clipboard on other architectures)
public IntPtr,System SetClipboardTextFn
return System.IntPtr

UserData public_oe property

Store your own data for retrieval by callbacks. Default value: IntPtr.Zero.
public IntPtr,System UserData
return System.IntPtr

WantCaptureKeyboard public_oe property

Widget is active (= ImGui will use your keyboard input).
public byte WantCaptureKeyboard
return byte

WantCaptureMouse public_oe property

Mouse is hovering a window or widget is active (= ImGui will use your mouse input).
public byte WantCaptureMouse
return byte

WantTextInput public_oe property

Some text input widget is active, which will read input characters from the InputCharacters array.
public byte WantTextInput
return byte