ImGuiViewport (imgui-binding 1.87.4 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 backend 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`.
`ImVec2`	`getCenter()`
`void`	`getCenter(ImVec2 dst)`
`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.
`ImVec2`	`getPos()` Main Area: Position of the viewport (the imgui coordinates are the same as OS desktop/native coordinates).
`void`	`getPos(ImVec2 dst)` 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.
`ImVec2`	`getSize()` Main Area: Size of the viewport.
`void`	`getSize(ImVec2 dst)` Main Area: Size of the viewport.
`float`	`getSizeX()` Main Area: Size of the viewport.
`float`	`getSizeY()` Main Area: Size of the viewport.
`ImVec2`	`getWorkCenter()`
`void`	`getWorkCenter(ImVec2 dst)`
`float`	`getWorkCenterX()`
`float`	`getWorkCenterY()`
`ImVec2`	`getWorkPos()` Work Area: Position of the viewport minus task bars, menus bars, status bars.
`void`	`getWorkPos(ImVec2 dst)` Work Area: Position of the viewport minus task bars, menus bars, status bars.
`float`	`getWorkPosX()` Work Area: Position of the viewport minus task bars, menus bars, status bars.
`float`	`getWorkPosY()` Work Area: Position of the viewport minus task bars, menus bars, status bars.
`ImVec2`	`getWorkSize()` Work Area: Size of the viewport minus task bars, menu bars, status bars.
`void`	`getWorkSize(ImVec2 dst)` Work Area: Size of the viewport minus task bars, menu bars, status bars.
`float`	`getWorkSizeX()` Work Area: Size of the viewport minus task bars, menu bars, status bars.
`float`	`getWorkSizeY()` Work Area: Size of the viewport minus task bars, menu bars, status bars.
`boolean`	`hasFlags(int flags)` See `ImGuiViewportFlags`.
`void`	`removeFlags(int flags)` See `ImGuiViewportFlags`.
`void`	`setDpiScale(float value)` 1.0f = 96 DPI = No extra scale.
`void`	`setDrawData(ImDrawData value)` The ImDrawData corresponding to this viewport.
`void`	`setFlags(int value)` See `ImGuiViewportFlags`.
`void`	`setID(int value)` Unique identifier for the viewport.
`void`	`setParentViewportId(int value)` (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 value)` Platform window requested closure (e.g.
`void`	`setPlatformRequestMove(boolean value)` Platform window requested move (e.g.
`void`	`setPlatformRequestResize(boolean value)` 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 valueX, float valueY)` Main Area: Position of the viewport (the imgui coordinates are the same as OS desktop/native coordinates).
`void`	`setPos(ImVec2 value)` 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`	`setSize(float valueX, float valueY)` Main Area: Size of the viewport.
`void`	`setSize(ImVec2 value)` Main Area: Size of the viewport.
`void`	`setWorkPos(float valueX, float valueY)` Work Area: Position of the viewport minus task bars, menus bars, status bars.
`void`	`setWorkPos(ImVec2 value)` Work Area: Position of the viewport minus task bars, menus bars, status bars.
`void`	`setWorkSize(float valueX, float valueY)` Work Area: Size of the viewport minus task bars, menu bars, status bars.
`void`	`setWorkSize(ImVec2 value)` Work Area: Size of the viewport minus task bars, menu bars, status bars.

Methods inherited from class imgui.binding.ImGuiStruct
isNotValidPtr, isValidPtr

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 value)
```
    Unique identifier for the viewport.
  - getFlags
```
public int getFlags()
```
    See ImGuiViewportFlags.
  - setFlags
```
public void setFlags(int value)
```
    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 ImVec2 getPos()
```
    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).
  - getPos
```
public void getPos(ImVec2 dst)
```
    Main Area: Position of the viewport (the imgui coordinates are the same as OS desktop/native coordinates).
  - setPos
```
public void setPos(ImVec2 value)
```
    Main Area: Position of the viewport (the imgui coordinates are the same as OS desktop/native coordinates).
  - setPos
```
public void setPos(float valueX,
                   float valueY)
```
    Main Area: Position of the viewport (the imgui coordinates are the same as OS desktop/native coordinates).
  - getSize
```
public ImVec2 getSize()
```
    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.
  - getSize
```
public void getSize(ImVec2 dst)
```
    Main Area: Size of the viewport.
  - setSize
```
public void setSize(ImVec2 value)
```
    Main Area: Size of the viewport.
  - setSize
```
public void setSize(float valueX,
                    float valueY)
```
    Main Area: Size of the viewport.
  - getWorkPos
```
public ImVec2 getWorkPos()
```
    Work Area: Position of the viewport minus task bars, menus bars, status bars.
  - getWorkPosX
```
public float getWorkPosX()
```
    Work Area: Position of the viewport minus task bars, menus bars, status bars.
  - getWorkPosY
```
public float getWorkPosY()
```
    Work Area: Position of the viewport minus task bars, menus bars, status bars.
  - getWorkPos
```
public void getWorkPos(ImVec2 dst)
```
    Work Area: Position of the viewport minus task bars, menus bars, status bars.
  - setWorkPos
```
public void setWorkPos(ImVec2 value)
```
    Work Area: Position of the viewport minus task bars, menus bars, status bars.
  - setWorkPos
```
public void setWorkPos(float valueX,
                       float valueY)
```
    Work Area: Position of the viewport minus task bars, menus bars, status bars.
  - getWorkSize
```
public ImVec2 getWorkSize()
```
    Work Area: Size of the viewport minus task bars, menu bars, status bars.
  - getWorkSizeX
```
public float getWorkSizeX()
```
    Work Area: Size of the viewport minus task bars, menu bars, status bars.
  - getWorkSizeY
```
public float getWorkSizeY()
```
    Work Area: Size of the viewport minus task bars, menu bars, status bars.
  - getWorkSize
```
public void getWorkSize(ImVec2 dst)
```
    Work Area: Size of the viewport minus task bars, menu bars, status bars.
  - setWorkSize
```
public void setWorkSize(ImVec2 value)
```
    Work Area: Size of the viewport minus task bars, menu bars, status bars.
  - setWorkSize
```
public void setWorkSize(float valueX,
                        float valueY)
```
    Work Area: Size of the viewport minus task bars, menu bars, status bars.
  - getDpiScale
```
public float getDpiScale()
```
    1.0f = 96 DPI = No extra scale.
  - setDpiScale
```
public void setDpiScale(float value)
```
    1.0f = 96 DPI = No extra scale.
  - getParentViewportId
```
public int getParentViewportId()
```
    (Advanced) 0: no parent. Instruct the platform backend to setup a parent/child relationship between platform windows.
  - setParentViewportId
```
public void setParentViewportId(int value)
```
    (Advanced) 0: no parent. Instruct the platform backend to setup a parent/child relationship between platform windows.
  - getDrawData
```
public ImDrawData getDrawData()
```
    The ImDrawData corresponding to this viewport. Valid after Render() and until the next call to NewFrame().
  - setDrawData
```
public void setDrawData(ImDrawData value)
```
    The ImDrawData corresponding to this viewport. Valid after Render() and until the next call to NewFrame().
  - 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 value)
```
    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 value)
```
    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 value)
```
    Platform window requested closure (e.g. window was moved by the OS / host window manager, e.g. pressing ALT-F4).
  - getCenter
```
public ImVec2 getCenter()
```
  - getCenterX
```
public float getCenterX()
```
  - getCenterY
```
public float getCenterY()
```
  - getCenter
```
public void getCenter(ImVec2 dst)
```
  - getWorkCenter
```
public ImVec2 getWorkCenter()
```
  - getWorkCenterX
```
public float getWorkCenterX()
```
  - getWorkCenterY
```
public float getWorkCenterY()
```
  - getWorkCenter
```
public void getWorkCenter(ImVec2 dst)
```

Class ImGuiViewport

Field Summary

Fields inherited from class imgui.binding.ImGuiStruct

Constructor Summary

Method Summary

Methods inherited from class imgui.binding.ImGuiStruct

Methods inherited from class java.lang.Object

Constructor Detail

ImGuiViewport

Method Detail

getID

setID

getFlags

setFlags

addFlags

removeFlags

hasFlags

getPos

getPosX

getPosY

getPos

setPos

setPos

getSize

getSizeX

getSizeY

getSize

setSize

setSize

getWorkPos

getWorkPosX

getWorkPosY

getWorkPos

setWorkPos

setWorkPos

getWorkSize

getWorkSizeX

getWorkSizeY

getWorkSize

setWorkSize

setWorkSize

getDpiScale

setDpiScale

getParentViewportId

setParentViewportId

getDrawData

setDrawData

setRendererUserData

getRendererUserData

setPlatformUserData

getPlatformUserData

setPlatformHandle

getPlatformHandle

setPlatformHandleRaw

getPlatformHandleRaw

getPlatformRequestMove

setPlatformRequestMove

getPlatformRequestResize

setPlatformRequestResize

getPlatformRequestClose

setPlatformRequestClose

getCenter

getCenterX

getCenterY

getCenter

getWorkCenter

getWorkCenterX

getWorkCenterY

getWorkCenter