ImGui.SetDragDropPayload

SetDragDropPayload(
    type: string | Uint8Array,
    data: null | bigint,
    sz: number,
    cond?: number,
): boolean
Set the drag-and-drop payload data.

Parameters
type
string | Uint8Array
Drag/drop payload type identifier (at most 32 characters); names starting with _ are reserved.

data
null | bigint
Address of payload bytes to copy into ImGui-owned storage; sz specifies the byte count.

sz
number
Number of payload bytes copied from data.

cond
number = 0
Copy condition: ImGuiCond.Always (or 0) copies each call; ImGuiCond.Once copies only when the payload is first created.

Returns
boolean
True if a target accepted the payload in this frame or the previous frame; not necessarily final delivery.

Remarks
type is a user defined string of maximum 32 characters.

Strings starting with '_' are reserved for dear imgui internal types.

Data is copied and held by imgui.

Return true when payload has been accepted.
Source & inheritance
- Defined in src/imgui/drag-drop.ts:156

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0