imgui.app

Class Window

java.lang.Object

imgui.app.Window

Direct Known Subclasses:

Application

public abstract class Window
extends java.lang.Object

Low-level abstraction, which creates application window and starts the main loop. It's recommended to use Application, but this class could be extended directly as well. When extended, life-cycle methods should be called manually.

Field Summary

Fields

Modifier and Type	Field and Description
protected Color	colorBg Background color of the window.
protected long	handle Pointer to the native GLFW window.

Constructor Summary

Constructors

Constructor and Description
Window()

Method Summary

Modifier and Type	Method and Description
protected void	dispose() Method to dispose all used application resources and destroy its window.
protected void	disposeImGui() Method to destroy Dear ImGui context.
protected void	disposeWindow() Method to destroy GLFW window.
protected void	endFrame() Method called in the end of the main cycle.
Color	getColorBg()
long	getHandle()
protected void	init(Configuration config) Method to initialize application.
protected void	initImGui(Configuration config) Method to initialize Dear ImGui context.
protected void	initWindow(Configuration config) Method to create and initialize GLFW window.
protected void	postProcess() Method called every frame, after calling process() method.
protected void	preProcess() Method called every frame, before calling process() method.
abstract void	process() Method to be overridden by user to provide main application logic.
protected void	run() Main application loop.
protected void	runFrame() Method used to run the next frame.
protected void	startFrame() Method called at the beginning of the main cycle.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

handle

protected long handle

Pointer to the native GLFW window.

colorBg

protected final Color colorBg

Background color of the window.

Constructor Detail

Window

public Window()

Method Detail

init

protected void init(Configuration config)

Method to initialize application.

Parameters:

config - configuration object with basic window information

dispose

protected void dispose()

Method to dispose all used application resources and destroy its window.

initWindow

protected void initWindow(Configuration config)

Method to create and initialize GLFW window.

Parameters:

config - configuration object with basic window information

initImGui

protected void initImGui(Configuration config)

Method to initialize Dear ImGui context. Could be overridden to do custom Dear ImGui setup before application start.

Parameters:

config - configuration object with basic window information

preProcess

protected void preProcess()

Method called every frame, before calling process() method.

postProcess

protected void postProcess()

Method called every frame, after calling process() method.

run

protected void run()

Main application loop.

runFrame

protected void runFrame()

Method used to run the next frame.

process

public abstract void process()

Method to be overridden by user to provide main application logic.

startFrame

protected void startFrame()

Method called at the beginning of the main cycle. It clears OpenGL buffer and starts an ImGui frame.

endFrame

protected void endFrame()

Method called in the end of the main cycle. It renders ImGui and swaps GLFW buffers to show an updated frame.

disposeImGui

protected void disposeImGui()

Method to destroy Dear ImGui context.

disposeWindow

protected void disposeWindow()

Method to destroy GLFW window.

getHandle

public final long getHandle()

Returns:

pointer to the native GLFW window

getColorBg

public final Color getColorBg()

Returns:

Color instance, which represents background color for the window