ImGuiViewport (imgui-binding 1.78-1.2.0 API)

java.lang.Object
- imgui.binding.ImGuiStruct
- - imgui.ImGuiViewport

```
public final class ImGuiViewport
extends ImGuiStruct
```
The viewports created and managed by Dear ImGui. The role of the platform back-end is to create the platform/OS windows corresponding to each viewport. - Main Area = entire viewport. - Work Area = entire viewport minus sections optionally used by menu bars, status bars. Some positioning code will prefer to use this. Window are also trying to stay within this area.

Field Summary
- Fields inherited from class imgui.binding.ImGuiStruct
  ptr

Constructor Summary

Constructors
Constructor and Description

ImGuiViewport(long ptr)

Constructors
Constructor and Description
`ImGuiViewport(long ptr)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFlags(int flags)` See `ImGuiViewportFlags`.
`void`	`getCenter(ImVec2 dstImVec2)`
`float`	`getCenterX()`
`float`	`getCenterY()`
`float`	`getDpiScale()` 1.0f = 96 DPI = No extra scale.
`ImDrawData`	`getDrawData()` The ImDrawData corresponding to this viewport.
`int`	`getFlags()` See `ImGuiViewportFlags`.
`int`	`getID()` Unique identifier for the viewport.
`int`	`getParentViewportId()` (Advanced) 0: no parent.
`long`	`getPlatformHandle()` void* for FindViewportByPlatformHandle().
`long`	`getPlatformHandleRaw()` void* to hold lower-level, platform-native window handle (e.g.
`boolean`	`getPlatformRequestClose()` Platform window requested closure (e.g.
`boolean`	`getPlatformRequestMove()` Platform window requested move (e.g.
`boolean`	`getPlatformRequestResize()` Platform window requested resize (e.g.
`java.lang.Object`	`getPlatformUserData()` void* to hold custom data structure for the OS / platform (e.g.
`void`	`getPos(ImVec2 dstImVec2)` Main Area: Position of the viewport (the imgui coordinates are the same as OS desktop/native coordinates).
`float`	`getPosX()` Main Area: Position of the viewport (the imgui coordinates are the same as OS desktop/native coordinates).
`float`	`getPosY()` Main Area: Position of the viewport (the imgui coordinates are the same as OS desktop/native coordinates).
`java.lang.Object`	`getRendererUserData()` void* to hold custom data structure for the renderer (e.g.
`void`	`getSize(ImVec2 dstImVec2)` Main Area: Size of the viewport.
`float`	`getSizeX()` Main Area: Size of the viewport.
`float`	`getSizeY()` Main Area: Size of the viewport.
`void`	`getWorkOffsetMax(ImVec2 dstImVec2)` Work Area: Offset from Pos+Size to bottom-right corner of Work Area.
`float`	`getWorkOffsetMaxX()` Work Area: Offset from Pos+Size to bottom-right corner of Work Area.
`float`	`getWorkOffsetMaxY()` Work Area: Offset from Pos+Size to bottom-right corner of Work Area.
`void`	`getWorkOffsetMin(ImVec2 dstImVec2)` Work Area: Offset from Pos to top-left corner of Work Area.
`float`	`getWorkOffsetMinX()` Work Area: Offset from Pos to top-left corner of Work Area.
`float`	`getWorkOffsetMinY()` Work Area: Offset from Pos to top-left corner of Work Area.
`void`	`getWorkPos(ImVec2 dstImVec2)`
`float`	`getWorkPosX()`
`float`	`getWorkPosY()`
`void`	`getWorkSize(ImVec2 dstImVec2)`
`float`	`getWorkSizeX()`
`float`	`getWorkSizeY()`
`boolean`	`hasFlags(int flags)` See `ImGuiViewportFlags`.
`void`	`removeFlags(int flags)` See `ImGuiViewportFlags`.
`void`	`seSize(float x, float y)` Main Area: Size of the viewport.
`void`	`setDpiScale(float dpiScale)` 1.0f = 96 DPI = No extra scale.
`void`	`setFlags(int flags)` See `ImGuiViewportFlags`.
`void`	`setID(int imGuiID)` Unique identifier for the viewport.
`void`	`setParentViewportId(int parentViewportId)` (Advanced) 0: no parent.
`void`	`setPlatformHandle(long data)` void* for FindViewportByPlatformHandle().
`void`	`setPlatformHandleRaw(long data)` void* to hold lower-level, platform-native window handle (e.g.
`void`	`setPlatformRequestClose(boolean platformRequestClose)` Platform window requested closure (e.g.
`void`	`setPlatformRequestMove(boolean platformRequestMove)` Platform window requested move (e.g.
`void`	`setPlatformRequestResize(boolean platformRequestResize)` Platform window requested resize (e.g.
`void`	`setPlatformUserData(java.lang.Object data)` void* to hold custom data structure for the OS / platform (e.g.
`void`	`setPos(float x, float y)` Main Area: Position of the viewport (the imgui coordinates are the same as OS desktop/native coordinates).
`void`	`setRendererUserData(java.lang.Object data)` void* to hold custom data structure for the renderer (e.g.
`void`	`seWorkOffsetMax(float x, float y)` Work Area: Offset from Pos+Size to bottom-right corner of Work Area.
`void`	`seWorkOffsetMin(float x, float y)` Work Area: Offset from Pos to top-left corner of Work Area.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ImGuiViewport
```
public ImGuiViewport(long ptr)
```
- Method Detail
  - getID
```
public int getID()
```
    Unique identifier for the viewport.
  - setID
```
public void setID(int imGuiID)
```
    Unique identifier for the viewport.
  - getFlags
```
public int getFlags()
```
    See ImGuiViewportFlags.
  - setFlags
```
public void setFlags(int flags)
```
    See ImGuiViewportFlags.
  - addFlags
```
public void addFlags(int flags)
```
    See ImGuiViewportFlags.
  - removeFlags
```
public void removeFlags(int flags)
```
    See ImGuiViewportFlags.
  - hasFlags
```
public boolean hasFlags(int flags)
```
    See ImGuiViewportFlags.
  - getPos
```
public void getPos(ImVec2 dstImVec2)
```
    Main Area: Position of the viewport (the imgui coordinates are the same as OS desktop/native coordinates).
  - getPosX
```
public float getPosX()
```
    Main Area: Position of the viewport (the imgui coordinates are the same as OS desktop/native coordinates).
  - getPosY
```
public float getPosY()
```
    Main Area: Position of the viewport (the imgui coordinates are the same as OS desktop/native coordinates).
  - setPos
```
public void setPos(float x,
                   float y)
```
    Main Area: Position of the viewport (the imgui coordinates are the same as OS desktop/native coordinates).
  - getSize
```
public void getSize(ImVec2 dstImVec2)
```
    Main Area: Size of the viewport.
  - getSizeX
```
public float getSizeX()
```
    Main Area: Size of the viewport.
  - getSizeY
```
public float getSizeY()
```
    Main Area: Size of the viewport.
  - seSize
```
public void seSize(float x,
                   float y)
```
    Main Area: Size of the viewport.
  - getWorkOffsetMin
```
public void getWorkOffsetMin(ImVec2 dstImVec2)
```
    Work Area: Offset from Pos to top-left corner of Work Area. Generally (0,0) or (0,+main_menu_bar_height). Work Area is Full Area but without menu-bars/status-bars (so WorkArea always fit inside Pos/Size!)
  - getWorkOffsetMinX
```
public float getWorkOffsetMinX()
```
    Work Area: Offset from Pos to top-left corner of Work Area. Generally (0,0) or (0,+main_menu_bar_height). Work Area is Full Area but without menu-bars/status-bars (so WorkArea always fit inside Pos/Size!)
  - getWorkOffsetMinY
```
public float getWorkOffsetMinY()
```
    Work Area: Offset from Pos to top-left corner of Work Area. Generally (0,0) or (0,+main_menu_bar_height). Work Area is Full Area but without menu-bars/status-bars (so WorkArea always fit inside Pos/Size!)
  - seWorkOffsetMin
```
public void seWorkOffsetMin(float x,
                            float y)
```
    Work Area: Offset from Pos to top-left corner of Work Area. Generally (0,0) or (0,+main_menu_bar_height). Work Area is Full Area but without menu-bars/status-bars (so WorkArea always fit inside Pos/Size!)
  - getWorkOffsetMax
```
public void getWorkOffsetMax(ImVec2 dstImVec2)
```
    Work Area: Offset from Pos+Size to bottom-right corner of Work Area. Generally (0,0) or (0,-status_bar_height).
  - getWorkOffsetMaxX
```
public float getWorkOffsetMaxX()
```
    Work Area: Offset from Pos+Size to bottom-right corner of Work Area. Generally (0,0) or (0,-status_bar_height).
  - getWorkOffsetMaxY
```
public float getWorkOffsetMaxY()
```
    Work Area: Offset from Pos+Size to bottom-right corner of Work Area. Generally (0,0) or (0,-status_bar_height).
  - seWorkOffsetMax
```
public void seWorkOffsetMax(float x,
                            float y)
```
    Work Area: Offset from Pos+Size to bottom-right corner of Work Area. Generally (0,0) or (0,-status_bar_height).
  - getDpiScale
```
public float getDpiScale()
```
    1.0f = 96 DPI = No extra scale.
  - setDpiScale
```
public void setDpiScale(float dpiScale)
```
    1.0f = 96 DPI = No extra scale.
  - getDrawData
```
public ImDrawData getDrawData()
```
    The ImDrawData corresponding to this viewport. Valid after Render() and until the next call to NewFrame().
  - getParentViewportId
```
public int getParentViewportId()
```
    (Advanced) 0: no parent. Instruct the platform back-end to setup a parent/child relationship between platform windows.
  - setParentViewportId
```
public void setParentViewportId(int parentViewportId)
```
    (Advanced) 0: no parent. Instruct the platform back-end to setup a parent/child relationship between platform windows.
  - setRendererUserData
```
public void setRendererUserData(java.lang.Object data)
```
    void* to hold custom data structure for the renderer (e.g. swap chain, framebuffers etc.). generally set by your Renderer_CreateWindow function.
  - getRendererUserData
```
public java.lang.Object getRendererUserData()
```
    void* to hold custom data structure for the renderer (e.g. swap chain, framebuffers etc.). generally set by your Renderer_CreateWindow function.
  - setPlatformUserData
```
public void setPlatformUserData(java.lang.Object data)
```
    void* to hold custom data structure for the OS / platform (e.g. windowing info, render context). generally set by your Platform_CreateWindow function.
  - getPlatformUserData
```
public java.lang.Object getPlatformUserData()
```
    void* to hold custom data structure for the OS / platform (e.g. windowing info, render context). generally set by your Platform_CreateWindow function.
  - setPlatformHandle
```
public void setPlatformHandle(long data)
```
    void* for FindViewportByPlatformHandle(). (e.g. suggested to use natural platform handle such as HWND, GLFWWindow*, SDL_Window*)
  - getPlatformHandle
```
public long getPlatformHandle()
```
    void* for FindViewportByPlatformHandle(). (e.g. suggested to use natural platform handle such as HWND, GLFWWindow*, SDL_Window*)
  - setPlatformHandleRaw
```
public void setPlatformHandleRaw(long data)
```
    void* to hold lower-level, platform-native window handle (e.g. the HWND) when using an abstraction layer like GLFW or SDL (where PlatformHandle would be a SDL_Window*)
  - getPlatformHandleRaw
```
public long getPlatformHandleRaw()
```
    void* to hold lower-level, platform-native window handle (e.g. the HWND) when using an abstraction layer like GLFW or SDL (where PlatformHandle would be a SDL_Window*)
  - getPlatformRequestMove
```
public boolean getPlatformRequestMove()
```
    Platform window requested move (e.g. window was moved by the OS / host window manager, authoritative position will be OS window position).
  - setPlatformRequestMove
```
public void setPlatformRequestMove(boolean platformRequestMove)
```
    Platform window requested move (e.g. window was moved by the OS / host window manager, authoritative position will be OS window position).
  - getPlatformRequestResize
```
public boolean getPlatformRequestResize()
```
    Platform window requested resize (e.g. window was resized by the OS / host window manager, authoritative size will be OS window size).
  - setPlatformRequestResize
```
public void setPlatformRequestResize(boolean platformRequestResize)
```
    Platform window requested resize (e.g. window was resized by the OS / host window manager, authoritative size will be OS window size).
  - getPlatformRequestClose
```
public boolean getPlatformRequestClose()
```
    Platform window requested closure (e.g. window was moved by the OS / host window manager, e.g. pressing ALT-F4).
  - setPlatformRequestClose
```
public void setPlatformRequestClose(boolean platformRequestClose)
```
    Platform window requested closure (e.g. window was moved by the OS / host window manager, e.g. pressing ALT-F4).
  - getCenter
```
public void getCenter(ImVec2 dstImVec2)
```
  - getCenterX
```
public float getCenterX()
```
  - getCenterY
```
public float getCenterY()
```
  - getWorkPos
```
public void getWorkPos(ImVec2 dstImVec2)
```
  - getWorkPosX
```
public float getWorkPosX()
```
  - getWorkPosY
```
public float getWorkPosY()
```
  - getWorkSize
```
public void getWorkSize(ImVec2 dstImVec2)
```
  - getWorkSizeX
```
public float getWorkSizeX()
```
  - getWorkSizeY
```
public float getWorkSizeY()
```

Class ImGuiViewport

Field Summary

Fields inherited from class imgui.binding.ImGuiStruct

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ImGuiViewport

Method Detail

getID

setID

getFlags

setFlags

addFlags

removeFlags

hasFlags

getPos

getPosX

getPosY

setPos

getSize

getSizeX

getSizeY

seSize

getWorkOffsetMin

getWorkOffsetMinX

getWorkOffsetMinY

seWorkOffsetMin

getWorkOffsetMax

getWorkOffsetMaxX

getWorkOffsetMaxY

seWorkOffsetMax

getDpiScale

setDpiScale

getDrawData

getParentViewportId

setParentViewportId

setRendererUserData

getRendererUserData

setPlatformUserData

getPlatformUserData

setPlatformHandle

getPlatformHandle

setPlatformHandleRaw

getPlatformHandleRaw

getPlatformRequestMove

setPlatformRequestMove

getPlatformRequestResize

setPlatformRequestResize

getPlatformRequestClose

setPlatformRequestClose

getCenter

getCenterX

getCenterY

getWorkPos

getWorkPosX

getWorkPosY

getWorkSize

getWorkSizeX

getWorkSizeY