Struct TestEngine 

pub struct TestEngine { /* private fields */ }

Dear ImGui Test Engine context.

The upstream engine is not thread-safe; create and use it on the same thread as the target ImGui context.

Implementations

impl TestEngine

pub fn try_create() -> ImGuiResult<Self>

Creates a new test engine context.

pub fn create() -> Self

Creates a new test engine context.

Panics

Panics if the underlying context creation fails.

pub fn as_raw(&self) -> *mut ImGuiTestEngine

pub fn is_bound(&self) -> bool

pub fn is_started(&self) -> bool

pub fn try_start(&mut self, imgui_ctx: &Context) -> ImGuiResult<()>

Tries to start (bind) the test engine to an ImGui context.

Calling this multiple times with the same context is a no-op.

Returns an error if the engine is already bound to a different context, or if the engine was previously stopped but is still bound (call shutdown() to detach first).

pub fn start(&mut self, imgui_ctx: &Context)

Starts (binds) the test engine to an ImGui context.

Calling this multiple times with the same context is a no-op.

Panics

Panics if called while already started with a different ImGui context.

pub fn stop(&mut self)

Stops the test coroutine and exports results, but keeps the engine bound to the ImGui context.

pub fn shutdown(&mut self)

Stops (if needed) and detaches the engine from the bound ImGui context.

This is the most ergonomic shutdown path for Rust applications: it avoids relying on drop order between Context and TestEngine.

pub fn post_swap(&mut self)

pub fn show_windows(&mut self, _ui: &Ui, opened: Option<&mut bool>)

pub fn register_default_tests(&mut self)

Registers a small set of built-in demo tests (useful to validate integration).

pub fn add_script_test<F>( &mut self, category: &str, name: &str, build: F, ) -> ImGuiResult<()>

where F: FnOnce(&mut ScriptTest<'_>) -> ImGuiResult<()>,

Registers a script-driven test.

Script tests do not provide a GUI function: they are meant to drive your application’s existing UI.

pub fn queue_tests( &mut self, group: TestGroup, filter: Option<&str>, run_flags: RunFlags, ) -> ImGuiResult<()>

pub fn queue_all_tests(&mut self)

pub fn result_summary(&self) -> ResultSummary

Returns a best-effort snapshot of test results.

Note: upstream asserts if queried while a test is running; our sys shim intentionally avoids aborting and will count Running tests as “remaining”.

pub fn is_test_queue_empty(&self) -> bool

pub fn is_running_tests(&self) -> bool

pub fn is_requesting_max_app_speed(&self) -> bool

pub fn try_abort_engine(&mut self) -> bool

pub fn abort_current_test(&mut self)

pub fn set_run_speed(&mut self, speed: RunSpeed)

pub fn set_verbose_level(&mut self, level: VerboseLevel)

pub fn set_capture_enabled(&mut self, enabled: bool)

pub fn install_default_crash_handler()

Trait Implementations

impl Drop for TestEngine

fn drop(&mut self)

Executes the destructor for this type.