Integration

These pages are for programs that already have some of their own setup: their own build, Vulkan device, windows or main loop. In them, the host is your program and the GUI is TachyonUI running inside it.

• Read only the pages that apply to you.

• With the defaults, Initialize and Run are enough. The GUI then makes its own device, windows and loop:

  MyApp app;
  tachyon::Result<void> result = app.Initialize();
  if (result)
      result = app.Run();   // until the last window closes
  app.Cleanup();

• How a frame works is in the Overview.

Page	Covers
Adding the library to a build	Subproject or installed package; CMake options; resources.
Using your own Vulkan device	Device requirements, handing it over, showing your own image.
Your own window and input	Writing a window backend; running SDL's event loop yourself.
Your own loop	Per-frame calls; errors and device loss.
Rendering the UI into a host image	Windows without an OS window: copy to your image, read pixels, inject input.
Allocation hooks and headless backends	Your own allocator; running without GPU or display.

Adding the library to a build Using your own Vulkan device Your own window and input Your own loop Rendering the UI into a host image Allocation hooks and headless backends