ImDrawData (imgui-binding 1.86.6 API)

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

```
public final class ImDrawData
extends ImGuiStruct
```
All draw data to render Dear ImGui frame (NB: the style and the naming convention here is a little inconsistent, we currently preserve them for backward compatibility purpose, as this is one of the oldest structure exposed by the library! Basically, ImDrawList == CmdList)
BINDING NOTICE: Since it's impossible to do a 1:1 mapping with JNI, current class provides "getCmdList*()" methods. Those are used to get the data needed to do a rendering.

Field Summary

Fields
Modifier and Type Field and Description

static int SIZEOF_IM_DRAW_IDX

static int SIZEOF_IM_DRAW_VERT
- Fields inherited from class imgui.binding.ImGuiStruct
  ptr

Fields
Modifier and Type	Field and Description
`static int`	`SIZEOF_IM_DRAW_IDX`
`static int`	`SIZEOF_IM_DRAW_VERT`

Constructor Summary

Constructors
Constructor and Description

ImDrawData(long ptr)

Constructors
Constructor and Description
`ImDrawData(long ptr)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`deIndexAllBuffers()` Helper to convert all buffers from indexed to non-indexed, in case you cannot render indexed.
`ImVec4`	`getCmdListCmdBufferClipRect(int cmdListIdx, int cmdBufferIdx)` Clipping rectangle (x1, y1, x2, y2).
`void`	`getCmdListCmdBufferClipRect(int cmdListIdx, int cmdBufferIdx, ImVec4 dstImVec4)` Clipping rectangle (x1, y1, x2, y2).
`int`	`getCmdListCmdBufferElemCount(int cmdListIdx, int cmdBufferIdx)` Number of indices (multiple of 3) to be rendered as triangles.
`int`	`getCmdListCmdBufferIdxOffset(int cmdListIdx, int cmdBufferIdx)` Start offset in index buffer.
`int`	`getCmdListCmdBufferSize(int cmdListIdx)` Draw commands.
`int`	`getCmdListCmdBufferTextureId(int cmdListIdx, int cmdBufferIdx)` User-provided texture ID.
`int`	`getCmdListCmdBufferVtxOffset(int cmdListIdx, int cmdBufferIdx)` Start offset in vertex buffer.
`java.nio.ByteBuffer`	`getCmdListIdxBufferData(int cmdListIdx)`
`int`	`getCmdListIdxBufferSize(int cmdListIdx)` Index buffer.
`int`	`getCmdListsCount()` Number of ImDrawList* to render
`java.nio.ByteBuffer`	`getCmdListVtxBufferData(int cmdListIdx)`
`int`	`getCmdListVtxBufferSize(int cmdListIdx)` Vertex buffer.
`ImVec2`	`getDisplayPos()` Upper-left position of the viewport to render (== upper-left of the orthogonal projection matrix to use)
`void`	`getDisplayPos(ImVec2 dstImVec2)` Upper-left position of the viewport to render (== upper-left of the orthogonal projection matrix to use)
`float`	`getDisplayPosX()` Upper-left position of the viewport to render (== upper-left of the orthogonal projection matrix to use)
`float`	`getDisplayPosY()` Upper-left position of the viewport to render (== upper-left of the orthogonal projection matrix to use)
`ImVec2`	`getDisplaySize()` Size of the viewport to render (== io.DisplaySize for the main viewport) (DisplayPos + DisplaySize == lower-right of the orthogonal projection matrix to use)
`void`	`getDisplaySize(ImVec2 dstImVec2)` Size of the viewport to render (== io.DisplaySize for the main viewport) (DisplayPos + DisplaySize == lower-right of the orthogonal projection matrix to use)
`float`	`getDisplaySizeX()` Size of the viewport to render (== io.DisplaySize for the main viewport) (DisplayPos + DisplaySize == lower-right of the orthogonal projection matrix to use)
`float`	`getDisplaySizeY()` Size of the viewport to render (== io.DisplaySize for the main viewport) (DisplayPos + DisplaySize == lower-right of the orthogonal projection matrix to use)
`ImVec2`	`getFramebufferScale()` Amount of pixels for each unit of DisplaySize.
`void`	`getFramebufferScale(ImVec2 dstImVec2)` Amount of pixels for each unit of DisplaySize.
`float`	`getFramebufferScaleX()` Amount of pixels for each unit of DisplaySize.
`float`	`getFramebufferScaleY()` Amount of pixels for each unit of DisplaySize.
`ImGuiViewport`	`getOwnerViewport()` Viewport carrying the ImDrawData instance, might be of use to the renderer (generally not).
`int`	`getTotalIdxCount()` For convenience, sum of all ImDrawList's IdxBuffer.Size
`int`	`getTotalVtxCount()` For convenience, sum of all ImDrawList's VtxBuffer.Size
`boolean`	`getValid()` Only valid after Render() is called and before the next NewFrame() is called.
`void`	`scaleClipRects(float fbScaleX, float fbScaleY)` Helper to scale the ClipRect field of each ImDrawCmd.
`static int`	`sizeOfImDrawIdx()`
`static int`	`sizeOfImDrawVert()`

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

- Field Detail
  - SIZEOF_IM_DRAW_IDX
```
public static final int SIZEOF_IM_DRAW_IDX
```
    See Also:
    
    Constant Field Values
  - SIZEOF_IM_DRAW_VERT
```
public static final int SIZEOF_IM_DRAW_VERT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ImDrawData
```
public ImDrawData(long ptr)
```
- Method Detail
  - getCmdListCmdBufferSize
```
public int getCmdListCmdBufferSize(int cmdListIdx)
```
    Draw commands. Typically 1 command = 1 GPU draw call, unless the command is a callback.
  - getCmdListCmdBufferElemCount
```
public int getCmdListCmdBufferElemCount(int cmdListIdx,
                                        int cmdBufferIdx)
```
    Number of indices (multiple of 3) to be rendered as triangles. Vertices are stored in the callee ImDrawList's vtx_buffer[] array, indices in idx_buffer[].
  - getCmdListCmdBufferClipRect
```
public ImVec4 getCmdListCmdBufferClipRect(int cmdListIdx,
                                          int cmdBufferIdx)
```
    Clipping rectangle (x1, y1, x2, y2). Subtract ImDrawData.DisplayPos to get clipping rectangle in "viewport" coordinates
  - getCmdListCmdBufferClipRect
```
public void getCmdListCmdBufferClipRect(int cmdListIdx,
                                        int cmdBufferIdx,
                                        ImVec4 dstImVec4)
```
    Clipping rectangle (x1, y1, x2, y2). Subtract ImDrawData.DisplayPos to get clipping rectangle in "viewport" coordinates
  - getCmdListCmdBufferTextureId
```
public int getCmdListCmdBufferTextureId(int cmdListIdx,
                                        int cmdBufferIdx)
```
    User-provided texture ID. Set by user in ImfontAtlas::SetTexID() for fonts or passed to Image*() functions. Ignore if never using images or multiple fonts atlas.
  - getCmdListCmdBufferVtxOffset
```
public int getCmdListCmdBufferVtxOffset(int cmdListIdx,
                                        int cmdBufferIdx)
```
    Start offset in vertex buffer. Pre-1.71 or without ImGuiBackendFlags_RendererHasVtxOffset: always 0. With ImGuiBackendFlags_RendererHasVtxOffset: may be >0 to support meshes larger than 64K vertices with 16-bit indices.
  - getCmdListCmdBufferIdxOffset
```
public int getCmdListCmdBufferIdxOffset(int cmdListIdx,
                                        int cmdBufferIdx)
```
    Start offset in index buffer. Always equal to sum of ElemCount drawn so far.
  - getCmdListIdxBufferSize
```
public int getCmdListIdxBufferSize(int cmdListIdx)
```
    Index buffer. Each command consume ImDrawCmd::ElemCount of those
  - getCmdListIdxBufferData
```
public java.nio.ByteBuffer getCmdListIdxBufferData(int cmdListIdx)
```
  - getCmdListVtxBufferSize
```
public int getCmdListVtxBufferSize(int cmdListIdx)
```
    Vertex buffer.
  - getCmdListVtxBufferData
```
public java.nio.ByteBuffer getCmdListVtxBufferData(int cmdListIdx)
```
  - sizeOfImDrawVert
```
public static int sizeOfImDrawVert()
```
  - sizeOfImDrawIdx
```
public static int sizeOfImDrawIdx()
```
  - getValid
```
public boolean getValid()
```
    Only valid after Render() is called and before the next NewFrame() is called.
  - getCmdListsCount
```
public int getCmdListsCount()
```
    Number of ImDrawList* to render
  - getTotalIdxCount
```
public int getTotalIdxCount()
```
    For convenience, sum of all ImDrawList's IdxBuffer.Size
  - getTotalVtxCount
```
public int getTotalVtxCount()
```
    For convenience, sum of all ImDrawList's VtxBuffer.Size
  - getDisplayPos
```
public ImVec2 getDisplayPos()
```
    Upper-left position of the viewport to render (== upper-left of the orthogonal projection matrix to use)
  - getDisplayPos
```
public void getDisplayPos(ImVec2 dstImVec2)
```
    Upper-left position of the viewport to render (== upper-left of the orthogonal projection matrix to use)
  - getDisplayPosX
```
public float getDisplayPosX()
```
    Upper-left position of the viewport to render (== upper-left of the orthogonal projection matrix to use)
  - getDisplayPosY
```
public float getDisplayPosY()
```
    Upper-left position of the viewport to render (== upper-left of the orthogonal projection matrix to use)
  - getDisplaySize
```
public ImVec2 getDisplaySize()
```
    Size of the viewport to render (== io.DisplaySize for the main viewport) (DisplayPos + DisplaySize == lower-right of the orthogonal projection matrix to use)
  - getDisplaySize
```
public void getDisplaySize(ImVec2 dstImVec2)
```
    Size of the viewport to render (== io.DisplaySize for the main viewport) (DisplayPos + DisplaySize == lower-right of the orthogonal projection matrix to use)
  - getDisplaySizeX
```
public float getDisplaySizeX()
```
    Size of the viewport to render (== io.DisplaySize for the main viewport) (DisplayPos + DisplaySize == lower-right of the orthogonal projection matrix to use)
  - getDisplaySizeY
```
public float getDisplaySizeY()
```
    Size of the viewport to render (== io.DisplaySize for the main viewport) (DisplayPos + DisplaySize == lower-right of the orthogonal projection matrix to use)
  - getFramebufferScale
```
public ImVec2 getFramebufferScale()
```
    Amount of pixels for each unit of DisplaySize. Based on io.DisplayFramebufferScale. Generally (1,1) on normal display, (2,2) on OSX with Retina display.
  - getFramebufferScale
```
public void getFramebufferScale(ImVec2 dstImVec2)
```
    Amount of pixels for each unit of DisplaySize. Based on io.DisplayFramebufferScale. Generally (1,1) on normal display, (2,2) on OSX with Retina display.
  - getFramebufferScaleX
```
public float getFramebufferScaleX()
```
    Amount of pixels for each unit of DisplaySize. Based on io.DisplayFramebufferScale. Generally (1,1) on normal display, (2,2) on OSX with Retina display.
  - getFramebufferScaleY
```
public float getFramebufferScaleY()
```
    Amount of pixels for each unit of DisplaySize. Based on io.DisplayFramebufferScale. Generally (1,1) on normal display, (2,2) on OSX with Retina display.
  - getOwnerViewport
```
public ImGuiViewport getOwnerViewport()
```
    Viewport carrying the ImDrawData instance, might be of use to the renderer (generally not).
  - deIndexAllBuffers
```
public void deIndexAllBuffers()
```
    Helper to convert all buffers from indexed to non-indexed, in case you cannot render indexed. Note: this is slow and most likely a waste of resources. Always prefer indexed rendering!
  - scaleClipRects
```
public void scaleClipRects(float fbScaleX,
                           float fbScaleY)
```
    Helper to scale the ClipRect field of each ImDrawCmd. Use if your final output buffer is at a different scale than Dear ImGui expects, or if there is a difference between your window resolution and framebuffer resolution.

Class ImDrawData

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

Field Detail

SIZEOF_IM_DRAW_IDX

SIZEOF_IM_DRAW_VERT

Constructor Detail

ImDrawData

Method Detail

getCmdListCmdBufferSize

getCmdListCmdBufferElemCount

getCmdListCmdBufferClipRect

getCmdListCmdBufferClipRect

getCmdListCmdBufferTextureId

getCmdListCmdBufferVtxOffset

getCmdListCmdBufferIdxOffset

getCmdListIdxBufferSize

getCmdListIdxBufferData

getCmdListVtxBufferSize

getCmdListVtxBufferData

sizeOfImDrawVert

sizeOfImDrawIdx

getValid

getCmdListsCount

getTotalIdxCount

getTotalVtxCount

getDisplayPos

getDisplayPos

getDisplayPosX

getDisplayPosY

getDisplaySize

getDisplaySize

getDisplaySizeX

getDisplaySizeY

getFramebufferScale

getFramebufferScale

getFramebufferScaleX

getFramebufferScaleY

getOwnerViewport

deIndexAllBuffers

scaleClipRects