Struct in ldk_ui.h

LDKUIWindow

typedef struct LDKUIWindow LDKUIWindow;
Enum in ldk_ui.h

LDKUIWindowFlags

typedef enum LDKUIWindowFlags{
  LDK_UI_WINDOW_NONE=0,
  LDK_UI_WINDOW_TITLE_BAR=1<<0,
  LDK_UI_WINDOW_DRAGGABLE=1<<1,
  LDK_UI_WINDOW_RESIZABLE=1<<2,
  LDK_UI_WINDOW_BORDER=1<<3,
  LDK_UI_WINDOW_NO_BG=1<<4,
  LDK_UI_WINDOW_CLOSE_BUTTON=1<<5,
  LDK_UI_WINDOW_NO_PADDING=1<<6,
  LDK_UI_WINDOW_CACHEABLE=1<<7,
  LDK_UI_WINDOW_TOOL=LDK_UI_WINDOW_CLOSE_BUTTON|LDK_UI_WINDOW_TITLE_BAR|LDK_UI_WINDOW_DRAGGABLE|LDK_UI_WINDOW_RESIZABLE|LDK_UI_WINDOW_BORDER,
}LDKUIWindowFlags;
Struct in ldk_ui.h

LDKUIWindowStackEntry

typedef struct LDKUIWindowStackEntry LDKUIWindowStackEntry;
Macro in ldk_ui.h

LDK_UI_MIN_WINDOW_HEIGHT

#define LDK_UI_MIN_WINDOW_HEIGHT 1
Macro in ldk_ui.h

LDK_UI_MIN_WINDOW_WIDTH

#define LDK_UI_MIN_WINDOW_WIDTH 64.0f
Macro in ldk_ui.h

LDK_UI_WINDOW_CAPACITY

#define LDK_UI_WINDOW_CAPACITY 16
Macro in ldk_ui.h

LDK_UI_WINDOW_STACK_CAPACITY

#define LDK_UI_WINDOW_STACK_CAPACITY 16
Function in ldk_ui.h

ldk_ui_begin_window

Begin a UI window.

LDK_API LDKUIRect ldk_ui_begin_window(
 LDKUIContext *ctx,
 char const *title,
 LDKUIRect rect,
 u32 flags
);

Parameters

LDKUIContext *ctx
UI context used by this operation.
char const *title
Title shown by the window or dialog.
LDKUIRect rect
UI or geometry rectangle.
u32 flags
Bitmask of options controlling this operation.

Returns

The resulting rectangle.

Function in ldk_ui.h

ldk_ui_begin_window_fixed

Begin a UI window with fixed placement.

LDK_API LDKUIRect ldk_ui_begin_window_fixed(
 LDKUIContext *ctx,
 char const *title,
 LDKUIRect rect,
 u32 flags
);

Parameters

LDKUIContext *ctx
UI context used by this operation.
char const *title
Title shown by the window or dialog.
LDKUIRect rect
UI or geometry rectangle.
u32 flags
Bitmask of options controlling this operation.

Returns

The resulting rectangle.

Function in ldk_ui.h

ldk_ui_begin_window_open

Begin an optionally closable window with editable geometry.

LDK_API bool ldk_ui_begin_window_open(
 LDKUIContext *ctx,
 char const *title,
 LDKUIRect *rect,
 bool *open,
 u32 flags
);

Parameters

LDKUIContext *ctx
UI context used by this operation.
char const *title
Title shown by the window or dialog.
LDKUIRect *rect
UI or geometry rectangle.
bool *open
In/out flag indicating whether the window remains open.
u32 flags
Bitmask of options controlling this operation.

Returns

True when the UI condition or interaction is active; false otherwise.

Function in ldk_ui.h

ldk_ui_window_close_requested

Report whether the current window has requested closure.

LDK_API bool ldk_ui_window_close_requested(LDKUIContext *ctx);

Parameters

LDKUIContext *ctx
UI context used by this operation.

Returns

True when the UI condition or interaction is active; false otherwise.

Function in ldk_ui.h

ldk_ui_window_content_should_build

Determine whether cached window content needs rebuilding.

LDK_API bool ldk_ui_window_content_should_build(LDKUIContext *ctx);

Parameters

LDKUIContext *ctx
UI context used by this operation.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_ui.h

ldk_ui_window_focus

Request focus for the specified UI window.

LDK_API bool ldk_ui_window_focus(
 LDKUIContext *ctx,
 LDKUIId id
);

Parameters

LDKUIContext *ctx
UI context used by this operation.
LDKUIId id
Identifier of the target object.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_ui.h

ldk_ui_window_invalidate

Invalidate cached contents of one UI window.

LDK_API void ldk_ui_window_invalidate(
 LDKUIContext *ctx,
 LDKUIId id
);

Parameters

LDKUIContext *ctx
UI context used by this operation.
LDKUIId id
Identifier of the target object.
Function in ldk_ui.h

ldk_ui_windows_invalidate

Invalidate cached contents of all UI windows.

LDK_API void ldk_ui_windows_invalidate(LDKUIContext *ctx);

Parameters

LDKUIContext *ctx
UI context used by this operation.