jsimgui

https://jsr.io/@mori2003/jsimgui/doc
Admin
JavaScript/TypeScript bindings for Dear ImGui with support for WebGL, WebGL2, and WebGPU rendering...
Tokens:303,578
Snippets:1,237
Trust Score:9.3
Update:6 months ago
Show doc for...
Tokens:
Raw
### jsimgui Quick Start Example

Source: https://jsr.io/@mori2003/jsimgui

A single-file HTML example demonstrating how to initialize and render a basic ImGui window using jsimgui with a canvas element. Ensure the canvas element is present in the HTML body.

```html
<!DOCTYPE html>
<html>
    <head>
        <style>
            body {
                margin: 0;
            }

            canvas {
                display: block;
                width: 100vw;
                height: 100vh;
            }
        </style>
        <script type="module">
            import { ImGui, ImGuiImplWeb } from "https://esm.sh/@mori2003/jsimgui";

            const canvas = document.querySelector("#render-canvas");

            await ImGuiImplWeb.Init({ canvas: canvas });

            function render() {
                canvas.width = canvas.clientWidth;
                canvas.height = canvas.clientHeight;

                ImGuiImplWeb.BeginRender();

                ImGui.Begin("New Window");
                ImGui.Text("Hello, World!");
                ImGui.End();
                ImGui.ShowDemoWindow();

                ImGuiImplWeb.EndRender();
                requestAnimationFrame(render);
            }
            requestAnimationFrame(render);
        </script>
    </head>
    <body>
        <canvas id="render-canvas"></canvas>
    </body>
</html>

```

--------------------------------

### Install npm Dependencies

Source: https://jsr.io/@mori2003/jsimgui

Installs the necessary Node.js dependencies for building jsimgui. This is a prerequisite for manual builds.

```bash
npm install

```

--------------------------------

### Package Installation and Import

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImGuiID

Instructions on how to add the jsimgui package to your project and import its symbols.

```APIDOC
## Package Management

### Add Package
```
deno add jsr:@mori2003/jsimgui
```

### Import Symbol
```
import { type ImGuiID } from "@mori2003/jsimgui";
```

### Import Directly
```
import { type ImGuiID } from "jsr:@mori2003/jsimgui";
```
```

--------------------------------

### ImGuiListClipper Usage Example

Source: https://jsr.io/%40mori2003/jsimgui/doc/all_symbols

Demonstrates how to use ImGuiListClipper for manually clipping large lists of items to improve performance. Call Step() until it returns false, then iterate from DisplayStart to DisplayEnd.

```cpp
ImGuiListClipper clipper;
clipper.Begin(1000); // We have 1000 elements, evenly spaced.
while (clipper.Step()) 
    for (int i = clipper.DisplayStart; i < clipper.DisplayEnd; i++)
        ImGui::Text("line number %d", i);
```

--------------------------------

### Build jsimgui with Docker

Source: https://jsr.io/@mori2003/jsimgui

Builds the jsimgui Docker image and then runs a container to install dependencies and build the library. Mounts the current directory into the container for build artifacts.

```bash
docker build -t jsimgui -f .github/Dockerfile .
docker run -v "$PWD:/workspace" jsimgui bash -c "npm install && node build.ts"

```

--------------------------------

### GET /io/config

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImDrawIdx

Retrieves various configuration settings for window behavior, input handling, and viewport management.

```APIDOC
## GET /io/config

### Description
Accesses configuration flags that control window behavior, such as resizing, movement, and taskbar icons.

### Method
GET

### Endpoint
/io/config

### Response
#### Success Response (200)
- **ConfigViewportsNoTaskBarIcon** (boolean) - Disable default OS task bar icon flag for secondary viewports.
- **ConfigViewportsPlatformFocusSetsImGuiFocus** (boolean) - When a platform window is focused, apply corresponding focus on imgui windows.
- **ConfigWindowsCopyContentsWithCtrlC** (boolean) - [EXPERIMENTAL] Ctrl+C copy the contents of focused window into the clipboard.
- **ConfigWindowsMoveFromTitleBarOnly** (boolean) - Enable allowing to move windows only when clicking on their title bar.
- **ConfigWindowsResizeFromEdges** (boolean) - Enable resizing of windows from their edges and from the lower-left corner.
```

--------------------------------

### GET /io/config

Source: https://jsr.io/%40mori2003/jsimgui/doc/all_symbols

Retrieves or defines the configuration properties for ImGui IO, including viewport, window, and input settings.

```APIDOC
## GET /io/config

### Description
Access various configuration flags and properties for the ImGui IO context, such as viewport behavior, window interaction, and input modifiers.

### Properties
- **ConfigViewportsNoTaskBarIcon** (boolean) - Disable default OS task bar icon flag for secondary viewports.
- **ConfigViewportsPlatformFocusSetsImGuiFocus** (boolean) - When a platform window is focused, apply corresponding focus on imgui windows.
- **ConfigWindowsCopyContentsWithCtrlC** (boolean) - [EXPERIMENTAL] Ctrl+C copy the contents of focused window into the clipboard.
- **ConfigWindowsMoveFromTitleBarOnly** (boolean) - Enable allowing to move windows only when clicking on their title bar.
- **ConfigWindowsResizeFromEdges** (boolean) - Enable resizing of windows from their edges and from the lower-left corner.
- **DeltaTime** (number) - Time elapsed since last frame, in seconds.
- **DisplaySize** (ImVec2) - Main display size, in pixels.
- **IniFilename** (string) - Path to .ini file for settings persistence.
- **KeyCtrl** (boolean) - Keyboard modifier: Ctrl (non-macOS), Cmd (macOS).
- **KeyShift** (boolean) - Keyboard modifier: Shift.
- **KeyAlt** (boolean) - Keyboard modifier: Alt.
- **KeySuper** (boolean) - Keyboard modifier: Windows/Super (non-macOS), Ctrl (macOS).

### Response Example
{
  "ConfigViewportsNoTaskBarIcon": false,
  "ConfigWindowsResizeFromEdges": true,
  "DeltaTime": 0.0166,
  "IniFilename": "imgui.ini"
}
```

--------------------------------

### Begin

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImDrawIdx

Initializes a new window.

```typescript
Begin(
name: string,
p_open?: [boolean] | null,
flags?: ImGuiWindowFlags
): boolean
```

--------------------------------

### ImGuiListClipper Begin Method

Source: https://jsr.io/@mori2003/jsimgui

Initializes the ImGuiListClipper. Specify the total number of items and optionally the height of each item if they are evenly spaced.

```cpp
clipper.Begin(items_count: number, items_height?: number)
```

--------------------------------

### Start New WebGPU Frame

Source: https://jsr.io/@mori2003/jsimgui

Starts a new WebGPU frame. This function is part of the WebGPU backend implementation for jsimgui.

```javascript
NewFrame(): void
```

--------------------------------

### Initialization and Lifecycle

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImU8

Functions for initializing the Dear ImGui environment and managing the render loop lifecycle.

```APIDOC
## Init(options)

### Description
Initialize Dear ImGui with the specified configuration. This is an asynchronous operation as it waits for the WASM file to be loaded.

### Parameters
#### Request Body
- **options** (InitOptions) - Required - Configuration object for initialization.

### Response
#### Success Response (200)
- **Promise<void>** - Resolves when initialization is complete.

## BeginRender()

### Description
Begins a new ImGui frame. Call this at the beginning of your render loop.

## EndRender(passEncoder?)

### Description
Ends the current ImGui frame. Call this at the end of your render loop.

### Parameters
#### Request Body
- **passEncoder** (GPURenderPassEncoder) - Optional - Required only when using the WebGPU backend.
```

--------------------------------

### RadioButton Usage Example

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImU8

Use RadioButton to create a selectable option. The example shows how to manage the selection state with an integer variable.

```javascript
if (RadioButton("one", my_value==1)) { my_value = 1; }
```

--------------------------------

### BeginGroup

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImDrawIdx

Locks the horizontal starting position.

```typescript
BeginGroup(): void
```

--------------------------------

### Get Clipboard Text

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImS8

Clipboard Utilities.

```javascript
GetClipboardText(): string
```

--------------------------------

### Get Background Draw List

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImS8

Get background draw list for the given viewport or viewport associated to the current window. This draw list will be the first rendering one. Useful to quickly draw shapes/text behind dear ImGui contents.

```javascript
GetBackgroundDrawList(viewport?: ImGuiViewport | null): ImDrawList
```

--------------------------------

### Begin ImGui Frame

Source: https://jsr.io/@mori2003/jsimgui

Begins a new ImGui frame. Call this at the beginning of your render loop.

```javascript
BeginRender(): void
```

--------------------------------

### GET /table/sort-specs

Source: https://jsr.io/@mori2003/jsimgui

Retrieves the sorting specifications for a table.

```APIDOC
## GET /table/sort-specs

### Description
Obtains sorting specifications for a table. When SpecsDirty is true, the data should be re-sorted.

### Method
GET

### Endpoint
/table/sort-specs

### Response
#### Success Response (200)
- **Specs** (ImGuiTableColumnSortSpecs) - Pointer to sort spec array.
- **SpecsCount** (number) - Sort spec count.
- **SpecsDirty** (boolean) - Flag indicating if specs have changed.
```

--------------------------------

### Demo and Utility Windows

Source: https://jsr.io/%40mori2003/jsimgui/doc/all_symbols

Functions to display various ImGui demo and utility windows.

```APIDOC
## Demo and Utility Windows

### Description
Functions to display built-in ImGui windows for demonstration and debugging purposes.

### Functions

- **ShowDemoWindow**(p_open?: [boolean] | null): void
  Shows the ImGui demo window.
- **ShowMetricsWindow**(p_open?: [boolean] | null): void
  Shows the ImGui metrics window.
- **ShowDebugLogWindow**(p_open?: [boolean] | null): void
  Shows the ImGui debug log window.
- **ShowIDStackToolWindow**(p_open?: [boolean] | null): void
  Shows the ImGui ID stack tool window.
- **ShowAboutWindow**(p_open?: [boolean] | null): void
  Shows the ImGui about window.
- **ShowStyleEditor**(ref?: ImGuiStyle | null): void
  Shows the ImGui style editor.
- **ShowStyleSelector**(label: string): boolean
  Shows a style selector widget.
- **ShowFontSelector**(label: string): void
  Shows a font selector widget.
- **ShowUserGuide**(): void
  Shows the ImGui user guide.
```

--------------------------------

### GET /config/viewports

Source: https://jsr.io/@mori2003/jsimgui

Configuration settings for multi-viewport management.

```APIDOC
## GET /config/viewports

### Description
Controls the behavior of secondary viewports and OS window decorations.

### Parameters
#### Request Body
- **ConfigViewportsNoAutoMerge** (boolean) - Optional - Force floating windows to create their own viewport.
- **ConfigViewportsNoDecoration** (boolean) - Optional - Disable default OS window decoration for secondary viewports.
```

--------------------------------

### Initialization and Lifecycle

Source: https://jsr.io/@mori2003/jsimgui

Methods for initializing the library and managing the render loop frames.

```APIDOC
## Init(options)

### Description
Initialize Dear ImGui with the specified configuration. This is an asynchronous operation as it waits for the WASM file to be loaded.

### Parameters
#### Request Body
- **options** (InitOptions) - Required - Configuration object for initialization.

## BeginRender()

### Description
Begins a new ImGui frame. Call this at the beginning of your render loop.

## EndRender(passEncoder?)

### Description
Ends the current ImGui frame. Call this at the end of your render loop.

### Parameters
#### Request Body
- **passEncoder** (GPURenderPassEncoder) - Optional - Required only when using the WebGPU backend.
```

--------------------------------

### Demo and Utility Windows API

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImS8

Functions to display various ImGui demo and utility windows.

```APIDOC
## Demo and Utility Windows API

### Description
Functions to display various ImGui demo and utility windows.

### Functions

- **ShowDemoWindow**(p_open?: [boolean] | null): void
  Shows the ImGui demo window.

- **ShowMetricsWindow**(p_open?: [boolean] | null): void
  Shows the ImGui metrics window.

- **ShowDebugLogWindow**(p_open?: [boolean] | null): void
  Shows the ImGui debug log window.

- **ShowIDStackToolWindow**(p_open?: [boolean] | null): void
  Shows the ImGui ID stack tool window.

- **ShowAboutWindow**(p_open?: [boolean] | null): void
  Shows the ImGui about window.
```

--------------------------------

### BeginPopup

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImDrawIdx

Returns true if the popup is open and output can be started.

```typescript
BeginPopup(
str_id: string,
flags?: ImGuiWindowFlags
): boolean
```

--------------------------------

### jsimgui Initialization and Rendering

Source: https://jsr.io/%40mori2003/jsimgui/doc/all_symbols

Core functions for initializing the library and managing the render loop.

```APIDOC
## Init(options)

### Description
Initialize Dear ImGui with the specified configuration. This is an asynchronous operation that waits for the WASM file to be loaded.

### Parameters
#### Request Body
- **options** (InitOptions) - Required - Configuration object for initialization.

## BeginRender()

### Description
Begins a new ImGui frame. Call this at the beginning of your render loop.

## EndRender(passEncoder?)

### Description
Ends the current ImGui frame. Call this at the end of your render loop.

### Parameters
#### Request Body
- **passEncoder** (GPURenderPassEncoder) - Optional - Required only when using the WebGPU backend.
```

--------------------------------

### GET /viewport

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImDrawIdx

Retrieves properties related to the current viewport.

```APIDOC
## GET /viewport

### Description
Retrieves viewport information including DPI scale and draw data.

### Method
GET

### Endpoint
/viewport

### Response
#### Success Response (200)
- **DpiScale** (number) - 1.0f = 96 DPI = No extra scale.
- **DrawData** (ImDrawData) - Draw data for the viewport.
```

--------------------------------

### GET /style/scrollbar

Source: https://jsr.io/@mori2003/jsimgui

Retrieves or configures the styling properties for scrollbars.

```APIDOC
## GET /style/scrollbar

### Description
Retrieves the radius of grab corners for scrollbars.

### Method
GET

### Endpoint
/style/scrollbar

### Response
#### Success Response (200)
- **ScrollbarSize** (number) - Radius of grab corners for scrollbar.
```

--------------------------------

### Initialize WebGPU Backend

Source: https://jsr.io/@mori2003/jsimgui

Initializes the WebGPU backend. This function is part of the WebGPU backend implementation for jsimgui.

```javascript
Init(handle: number): boolean
```

--------------------------------

### GET /GetContentRegionAvail

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImU8

Retrieves the available space from the current position.

```APIDOC
## GET /GetContentRegionAvail

### Description
Retrieves the available space from the current position.

### Response
#### Success Response (200)
- **size** (ImVec2) - The available space dimensions.
```

--------------------------------

### Begin / BeginChild

Source: https://jsr.io/@mori2003/jsimgui

Functions for creating and managing windows and child regions.

```APIDOC
## Begin

### Description
Creates a new window.

### Parameters
- **name** (string) - Required - Window name
- **p_open** ([boolean]) - Optional - Pointer to boolean to show/hide window
- **flags** (ImGuiWindowFlags) - Optional - Window flags

## BeginChild

### Description
Creates a child window region.

### Parameters
- **str_id** (string) - Required - Unique ID for the child
- **size** (ImVec2) - Optional - Size of the child region
- **child_flags** (ImGuiChildFlags) - Optional - Child flags
- **window_flags** (ImGuiWindowFlags) - Optional - Window flags
```

--------------------------------

### Build jsimgui with Custom Configuration

Source: https://jsr.io/@mori2003/jsimgui

Builds the jsimgui library with specified configurations for the backend, font loader, and whether to include demos. Use `--help` to see all available options.

```bash
node build.ts --backend=webgpu --font-loader=freetype --demos

```

```bash
node build.ts --help # To see all options

```

--------------------------------

### Time and Frame API

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImS8

Functions for getting time and frame information.

```APIDOC
## GetTime / GetFrameCount

### Description
Gets the current application time and frame count.

### Method
- `GetTime(): number`
- `GetFrameCount(): number`

### Response
- Returns the time in seconds or the current frame count.
```

--------------------------------

### ImGuiWindowFlags

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImU8

Flags for Begin(), BeginChild().

```APIDOC
## Type Alias: ImGuiWindowFlags

### Description
Flags for Begin(), BeginChild().

### Type
number

### Enum
ImGuiWindowFlags_
```

--------------------------------

### GET /style/table

Source: https://jsr.io/@mori2003/jsimgui

Retrieves styling properties for table headers and layout.

```APIDOC
## GET /style/table

### Description
Retrieves configuration for table angled headers.

### Method
GET

### Endpoint
/style/table

### Response
#### Success Response (200)
- **TableAngledHeadersAngle** (number) - Angle of angled headers (-50.0f to +50.0f).
- **TableAngledHeadersTextAlign** (ImVec2) - Alignment of angled headers within the cell.
```

--------------------------------

### Configuration and Context

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImU8

Functions for managing ImGui context and configuration.

```APIDOC
## CreateContext /websites/jsr_io_mori2003_jsimgui_doc

### Description
Creates a new ImGui context.

### Method
CreateContext

### Endpoint
N/A (Function Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **shared_font_atlas** (ImFontAtlas | null) - Optional - A font atlas to share with the new context.

### Request Example
```json
{
  "shared_font_atlas": null
}
```

### Response
#### Success Response (200)
- **return value** (ImGuiContext) - The newly created ImGui context.

#### Response Example
```json
{
  "return_value": "<ImGuiContext Object>"
}
```
```

```APIDOC
## DestroyContext /websites/jsr_io_mori2003_jsimgui_doc

### Description
Destroys the current ImGui context.

### Method
DestroyContext

### Endpoint
N/A (Function Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **ctx** (ImGuiContext | null) - Optional - The context to destroy. If null, the current context is destroyed.

### Request Example
```json
{
  "ctx": null
}
```

### Response
#### Success Response (200)
This function does not return a value.

#### Response Example
```json
{
  "message": "Context destroyed successfully."
}
```
```

```APIDOC
## DestroyPlatformWindows /websites/jsr_io_mori2003_jsimgui_doc

### Description
Destroys all platform windows associated with viewports. This should be called from the backend's Shutdown function if platform windows need to be closed before ImGui shutdown.

### Method
DestroyPlatformWindows

### Endpoint
N/A (Function Call)

### Parameters
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
This function does not return a value.

#### Response Example
```json
{
  "message": "Platform windows destroyed."
}
```
```

--------------------------------

### GET /config/error-recovery

Source: https://jsr.io/@mori2003/jsimgui

Configuration settings for error handling and recovery mechanisms.

```APIDOC
## GET /config/error-recovery

### Description
Settings to manage how the application handles and reports recoverable errors.

### Parameters
#### Request Body
- **ConfigErrorRecovery** (boolean) - Optional - Enable error recovery support.
- **ConfigErrorRecoveryEnableAssert** (boolean) - Optional - Enable asserts on recoverable error.
- **ConfigErrorRecoveryEnableDebugLog** (boolean) - Optional - Enable debug log output on recoverable errors.
- **ConfigErrorRecoveryEnableTooltip** (boolean) - Optional - Enable tooltip on recoverable errors.
```

--------------------------------

### Frame Management API

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImS8

Functions to manage the start and end of an ImGui frame.

```APIDOC
## Frame Management API

### Description
Functions to manage the start and end of an ImGui frame.

### Functions

- **NewFrame**(): void
  Starts a new ImGui frame.

- **EndFrame**(): void
  Ends the current ImGui frame and prepares for rendering.
```

--------------------------------

### Demo and Tool Windows API

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImDrawIdx

Functions to display various ImGui demo and utility windows.

```APIDOC
## Demo and Tool Windows API

### Description
Functions to display various ImGui demo and utility windows.

### Functions
- **ShowDemoWindow**(p_open?: [boolean] | null): void
- **ShowMetricsWindow**(p_open?: [boolean] | null): void
- **ShowDebugLogWindow**(p_open?: [boolean] | null): void
- **ShowIDStackToolWindow**(p_open?: [boolean] | null): void
- **ShowAboutWindow**(p_open?: [boolean] | null): void
```

--------------------------------

### GET /config/dpi

Source: https://jsr.io/%40mori2003/jsimgui/doc/all_symbols

Retrieves or sets configuration flags related to DPI scaling.

```APIDOC
## GET /config/dpi

### Description
Provides access to DPI scaling configuration settings.

### Method
GET

### Endpoint
/config/dpi

### Parameters
#### Request Body
- **ConfigDpiScaleFonts** (boolean) - Optional - Automatically overwrite style.FontScaleDpi when Monitor DPI changes.
- **ConfigDpiScaleViewports** (boolean) - Optional - Scale Dear ImGui and Platform Windows when Monitor DPI changes.
```

--------------------------------

### Window and Viewport Information

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImS8

Functions to get information about the current window and its viewport.

```APIDOC
## GET /api/imgui/window/dock/id

### Description
Retrieves the dock ID of the current window.

### Method
GET

### Endpoint
/api/imgui/window/dock/id

### Response
#### Success Response (200)
- **dock_id** (ImGuiID) - The dock identifier for the current window.

#### Response Example
```json
{
  "dock_id": "0x12345678"
}
```
```

```APIDOC
## GET /api/imgui/window/dpi/scale

### Description
Gets the DPI scale currently associated with the current window's viewport.

### Method
GET

### Endpoint
/api/imgui/window/dpi/scale

### Response
#### Success Response (200)
- **dpi_scale** (number) - The DPI scale factor.

#### Response Example
```json
{
  "dpi_scale": 1.0
}
```
```

```APIDOC
## GET /api/imgui/window/draw/list

### Description
Retrieves the draw list associated with the current window, allowing for custom drawing primitives.

### Method
GET

### Endpoint
/api/imgui/window/draw/list

### Response
#### Success Response (200)
- **draw_list** (ImDrawList) - The ImDrawList object for the current window.

#### Response Example
```json
{
  "draw_list": { ... }
}
```
```

```APIDOC
## GET /api/imgui/window/height

### Description
Gets the current height of the window. Consider using GetWindowSize().y instead.

### Method
GET

### Endpoint
/api/imgui/window/height

### Response
#### Success Response (200)
- **height** (number) - The current height of the window in pixels.

#### Response Example
```json
{
  "height": 600.0
}
```
```

```APIDOC
## GET /api/imgui/window/pos

### Description
Gets the current position of the window in screen space. Consider using GetCursorScreenPos() and GetContentRegionAvail() instead.

### Method
GET

### Endpoint
/api/imgui/window/pos

### Response
#### Success Response (200)
- **x** (number) - The X-coordinate of the window's position.
- **y** (number) - The Y-coordinate of the window's position.

#### Response Example
```json
{
  "x": 100.0,
  "y": 100.0
}
```
```

```APIDOC
## GET /api/imgui/window/size

### Description
Gets the current size of the window. Consider using GetCursorScreenPos() and GetContentRegionAvail() instead.

### Method
GET

### Endpoint
/api/imgui/window/size

### Response
#### Success Response (200)
- **width** (number) - The current width of the window in pixels.
- **height** (number) - The current height of the window in pixels.

#### Response Example
```json
{
  "width": 800.0,
  "height": 600.0
}
```
```

```APIDOC
## GET /api/imgui/window/viewport

### Description
Retrieves the viewport currently associated with the current window.

### Method
GET

### Endpoint
/api/imgui/window/viewport

### Response
#### Success Response (200)
- **viewport** (ImGuiViewport) - The ImGuiViewport object for the current window.

#### Response Example
```json
{
  "viewport": { ... }
}
```
```

```APIDOC
## GET /api/imgui/window/width

### Description
Gets the current width of the window. Consider using GetWindowSize().x instead.

### Method
GET

### Endpoint
/api/imgui/window/width

### Response
#### Success Response (200)
- **width** (number) - The current width of the window in pixels.

#### Response Example
```json
{
  "width": 800.0
}
```
```

--------------------------------

### BeginMainMenuBar

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImDrawIdx

Creates and appends to a full-screen menu bar.

```typescript
BeginMainMenuBar(): boolean
```

--------------------------------

### Column Management Functions

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImS8

Functions to get information about columns within a window.

```APIDOC
## GetColumnIndex

### Description
Get current column index.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## GetColumnOffset

### Description
Get position of column line (in pixels, from the left side of the contents region). Pass -1 to use current column, otherwise 0..GetColumnsCount() inclusive. Column 0 is typically 0.0f.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
#### Path Parameters
- **column_index** (number) - Optional - Index of the column.

### Request Example
N/A

### Response
N/A

## GetColumnWidth

### Description
Get column width (in pixels). Pass -1 to use current column.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
#### Path Parameters
- **column_index** (number) - Optional - Index of the column.

### Request Example
N/A

### Response
N/A

## GetColumnsCount

### Description
No documentation available.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### InitOptions Interface

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImU8

Initialization options for jsimgui used in `ImGuiImplWeb.Init`.

```APIDOC
## InitOptions

Initialization options for jsimgui used in `ImGuiImplWeb.Init`.

### Fields
- **backend** ("webgl" | "webgl2" | "webgpu") - Specify the rendering backend to use. If not specified, will be inferred from the canvas or from `device`.
- **canvas** (HTMLCanvasElement) - The canvas element to render Dear ImGui on.
- **device** (GPUDevice) - The WebGPU device used for rendering. This is only required when using the WebGPU backend.
- **fontLoader** ("truetype" | "freetype") - The font loader and rasterizer to use for loading fonts. Can be one of the following:
- **loaderPath** (string) - Custom path to the emscripten loader script. If not provided, will be constructed automatically. If you use jsimgui via a package manager or CDN, you will most likely not need to worry about this.
```

--------------------------------

### GET /style/tabs

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImS8

Retrieves styling properties for tab bars and individual tabs.

```APIDOC
## GET /style/tabs

### Description
Returns the configuration for tab bar borders, rounding, and close button behavior.

### Method
GET

### Endpoint
/style/tabs

### Response
#### Success Response (200)
- **TabBarBorderSize** (number) - Thickness of tab-bar separator.
- **TabRounding** (number) - Radius of upper corners of a tab.
- **TabCloseButtonMinWidthSelected** (number) - Visibility threshold for close button when selected.
```

--------------------------------

### BeginChild

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImDrawIdx

Initializes a child window.

```typescript
BeginChild(
str_id: string,
size?: ImVec2,
child_flags?: ImGuiChildFlags,
window_flags?: ImGuiWindowFlags
): boolean
```

--------------------------------

### GET /io/metrics

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImDrawIdx

Retrieves current performance and rendering metrics for the ImGui application.

```APIDOC
## GET /io/metrics

### Description
Provides real-time metrics regarding active windows, rendering vertices, and indices.

### Method
GET

### Endpoint
/io/metrics

### Response
#### Success Response (200)
- **MetricsActiveWindows** (number) - Number of active windows.
- **MetricsRenderIndices** (number) - Indices output during last call to Render().
- **MetricsRenderVertices** (number) - Vertices output during last call to Render().
- **MetricsRenderWindows** (number) - Number of visible windows.
```

--------------------------------

### Initialize jsimgui

Source: https://jsr.io/@mori2003/jsimgui

Initialize Dear ImGui with the specified configuration. This is asynchronous because it waits for the WASM file to be loaded.

```javascript
Init(options: InitOptions): Promise<void>
```

--------------------------------

### ImGui IO Configuration Parameters

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImU8

This section lists and describes various configuration parameters available in ImGui's IO structure that affect UI rendering and behavior.

```APIDOC
## ImGui IO Configuration Parameters

This section details various configuration parameters available in ImGui's IO structure that affect UI rendering and behavior.

### Border Thickness and Rounding

- **ChildBorderSize()**: number
  Thickness of border around child windows. Generally set to 0.0f or 1.0f. (Other values are not well tested and more CPU/GPU costly).
- **ChildRounding()**: number
  Radius of child window corners rounding. Set to 0.0f to have rectangular windows.
- **DragDropTargetBorderSize()**: number
  Thickness of the drag and drop target border.
- **DragDropTargetRounding()**: number
  Radius of the drag and drop target frame.
- **FrameBorderSize()**: number
  Thickness of border around frames. Generally set to 0.0f or 1.0f. (Other values are not well tested and more CPU/GPU costly).
- **FrameRounding()**: number
  Radius of frame corners rounding. Set to 0.0f to have rectangular frame (used by most widgets).
- **ImageBorderSize()**: number
  Thickness of border around Image() calls.
- **PopupBorderSize()**: number
  Thickness of border around popup/tooltip windows. Generally set to 0.0f or 1.0f. (Other values are not well tested and more CPU/GPU costly).
- **PopupRounding()**: number
  Radius of popup window corners rounding. (Note that tooltip windows use WindowRounding)
- **ScrollbarRounding()**: number
  Radius of grabs corners rounding. Set to 0.0f to have rectangular slider grabs.

### Spacing and Padding

- **ColumnsMinSpacing()**: number
  Minimum horizontal spacing between two columns. Preferably > (FramePadding.x + 1).
- **DisplaySafeAreaPadding()**: ImVec2
  Apply to every windows, menus, popups, tooltips: amount where we avoid displaying contents. Adjust if you cannot see the edges of your screen (e.g. on a TV where scaling has not been configured).
- **DisplayWindowPadding()**: ImVec2
  Apply to regular windows: amount which we enforce to keep visible when moving near edges of your screen.
- **FramePadding()**: ImVec2
  Padding within a framed rectangle (used by most widgets).
- **IndentSpacing()**: number
  Horizontal indentation when e.g. entering a tree node. Generally == (FontSize + FramePadding.x*2).
- **ItemInnerSpacing()**: ImVec2
  Horizontal and vertical spacing between within elements of a composed widget (e.g. a slider and its label).
- **ItemSpacing()**: ImVec2
  Horizontal and vertical spacing between widgets/lines.
- **ScrollbarPadding()**: number
  Padding of scrollbar grab within its frame (same for both axes).

### Tesselation and Quality

- **CircleTessellationMaxError()**: number
  Maximum error (in pixels) allowed when using AddCircle()/AddCircleFilled() or drawing rounded corner rectangles with no explicit segment count specified. Decrease for higher quality but more geometry.
- **CurveTessellationTol()**: number
  Tessellation tolerance when using PathBezierCurveTo() without a specific number of segments. Decrease for highly tessellated curves (higher quality, more polygons), increase to reduce quality.

### Alpha and Scaling

- **DisabledAlpha()**: number
  Additional alpha multiplier applied by BeginDisabled(). Multiply over current value of Alpha.
- **FontScaleDpi()**: number
  Additional global scale factor from viewport/monitor contents scale. When io.ConfigDpiScaleFonts is enabled, this is automatically overwritten when changing monitor DPI. May be removed later.
- **FontScaleMain()**: number
  Main global scale factor. May be set by application once, or exposed to end-user.
- **FontSizeBase()**: number
  Current base font size before external global factors are applied. Use PushFont(NULL, size) to modify. Use ImGui::GetFontSize() to obtain scaled value.
- **MouseCursorScale()**: number
  Scale software rendered mouse cursor (when io.MouseDrawCursor is enabled). We apply per-monitor DPI scaling over this scale. May be removed later.

### Widget Specific Settings

- **ColorButtonPosition()**: ImGuiDir
  Side of the color button in the ColorEdit4 widget (left/right). Defaults to ImGuiDir_Right.
- **Colors()**: ImVec4[]
  No documentation available.
- **DockingNodeHasCloseButton()**: boolean
  Docking node has their own CloseButton() to close all docked windows.
- **DockingSeparatorSize()**: number
  Thickness of resizing border between docked windows
- **DragDropTargetPadding()**: number
  Size to expand the drag and drop target from actual target item size.
- **GrabMinSize()**: number
  Minimum width/height of a grab box for slider/scrollbar.
- **GrabRounding()**: number
  Radius of grabs corners rounding. Set to 0.0f to have rectangular slider grabs.
- **HoverDelayNormal()**: number
  Delay for IsItemHovered(ImGuiHoveredFlags_DelayNormal).
- **HoverDelayShort()**: number
  Delay for IsItemHovered(ImGuiHoveredFlags_DelayShort). Usually used along with HoverStationaryDelay.
- **HoverFlagsForTooltipMouse()**: ImGuiHoveredFlags
  Default flags when using IsItemHovered(ImGuiHoveredFlags_ForTooltip) or BeginItemTooltip()/SetItemTooltip() while using mouse.
- **HoverFlagsForTooltipNav()**: ImGuiHoveredFlags
  Default flags when using IsItemHovered(ImGuiHoveredFlags_ForTooltip) or BeginItemTooltip()/SetItemTooltip() while using keyboard/gamepad.
- **HoverStationaryDelay()**: number
  Delay for IsItemHovered(ImGuiHoveredFlags_Stationary). Time required to consider mouse stationary.
- **LogSliderDeadzone()**: number
  The size in pixels of the dead-zone around zero on logarithmic sliders that cross zero.

### Utility Functions

- **ScaleAllSizes(scale_factor: number): void**
  Scale all spacing/padding/thickness values. Do not scale fonts.
```

--------------------------------

### GET /GetCursorScreenPos

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImU8

Retrieves the current cursor position in absolute screen coordinates.

```APIDOC
## GET /GetCursorScreenPos

### Description
Retrieves the current cursor position in absolute screen coordinates. This is preferred for working with the ImDrawList API.

### Response
#### Success Response (200)
- **position** (ImVec2) - The absolute screen coordinates.
```

--------------------------------

### InitOptions Backend Configuration

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImGuiID

Specifies the rendering backend for jsimgui initialization. Options include 'webgl', 'webgl2', or 'webgpu'. If not specified, it will be inferred.

```typescript
backend: "webgl" | "webgl2" | "webgpu"
```

--------------------------------

### GET /io/metrics

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImU8

Retrieves current performance and state metrics for the ImGui context.

```APIDOC
## GET /io/metrics

### Description
Provides read-only access to current rendering and window metrics.

### Response
#### Success Response (200)
- **MetricsActiveWindows** (number) - Number of active windows
- **MetricsRenderIndices** (number) - Indices output during last call to Render()
- **MetricsRenderVertices** (number) - Vertices output during last call to Render()
- **MetricsRenderWindows** (number) - Number of visible windows
- **Framerate** (number) - Estimate of application framerate
```

--------------------------------

### ImGuiComboFlags

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImU8

Flags for BeginCombo().

```APIDOC
## Type Alias: ImGuiComboFlags

### Description
Flags for BeginCombo().

### Type
number

### Enum
ImGuiComboFlags_
```

--------------------------------

### Initialization Functions

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImGuiID

Functions for initializing jsimgui settings.

```APIDOC
## Initialization Functions

### Description
Functions related to the initial setup and loading of Dear ImGui settings.

### Functions
#### LoadIniSettingsFromMemory(ini_data: string, ini_size?: number)
- **Description**: Loads Dear ImGui settings from a memory buffer. This function should be called after `CreateContext()` and before the first `NewFrame()` call.
- **Method**: N/A (Function Call)
- **Endpoint**: N/A
- **Parameters**:
  - **ini_data** (string) - Required - A string containing the INI data.
  - **ini_size** (number) - Optional - The size of the INI data. If not provided, the length of the string is used.

### Example
```javascript
// Example: Loading settings from a string
// const iniData = "[Window]
x=100\ny=100\nwidth=200\nheight=300";
// io.LoadIniSettingsFromMemory(iniData);
```
```

--------------------------------

### BeginTabBar

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImDrawIdx

Starts a tab bar and returns true if the modal is open, allowing output to it.

```typescript
BeginTabBar(
str_id: string,
flags?: ImGuiTabBarFlags
): boolean
```

--------------------------------

### Frame and Layout Management

Source: https://jsr.io/%40mori2003/jsimgui/doc/~/ImU8

Functions for starting a new frame, managing lines, and columns.

```APIDOC
## Frame and Layout Management

### NewFrame()

### Description
Start a new Dear ImGui frame. You can submit any command from this point until Render()/EndFrame().

### Method
`void NewFrame()`

### NewLine()

### Description
Undo a SameLine() or force a new line when in a horizontal-layout context.

### Method
`void NewLine()`

### NextColumn()

### Description
Move to the next column. Defaults to the current row or the next row if the current row is finished.

### Method
`void NextColumn()`
```
Tokens:
Raw