Run a Hello ImGui app from a Jupyter notebook. Import it as hello_imgui.nb.
run(): runs the app and waits until its window closes, ashello_imgui.rundoes.start(): runs the app without blocking the notebook, which stays usable while the app runs. It returns anasyncio.Task.stop(),is_running(): stop the app started bystart(), or query it.
immapp.nb does the same with the add-ons (ImPlot, markdown...), and its run() shows a screenshot of the app in
the notebook.
The module imgui_bundle.hello_imgui_nb, the Python API of Hello ImGui, from bindings/imgui_bundle/hello_imgui_nb.pyi: 4 functions, 0 classes, 0 enums. Each entry gives the Python signature, then the C++ one, then the doc of the C++ header. The sections are the header’s.
run() - Blocking mode¶
run¶
@overload
def run(runner_params: RunnerParams) -> None
@overload
def run(simple_params: SimpleRunnerParams) -> None
@overload
def run(gui_function: Callable[[], None], *, window_title: str = '', window_size_auto: bool = False, window_restore_previous_geometry: bool = False, window_size: Optional[tuple[int, int]] = None, fps_idle: float = 10.0, top_most: bool = False) -> Nonestart() - Non-blocking async mode¶
start¶
@overload
def start(runner_params: RunnerParams) -> asyncio.Task[None]
@overload
def start(simple_params: SimpleRunnerParams) -> asyncio.Task[None]
@overload
def start(gui_function: Callable[[], None], *, window_title: str = '', window_size_auto: bool = True, window_restore_previous_geometry: bool = False, window_size: Optional[tuple[int, int]] = None, fps_idle: float = 10.0, top_most: bool = True) -> asyncio.Task[None]stop() and is_running()¶
stop¶
def stop() -> Noneis_running¶
def is_running() -> bool