Class VulkanGLFWRenderModuleWindow

java.lang.Object

io.codetoil.curved_spacetime.render.RenderModuleWindow

io.codetoil.curved_spacetime.render.glfw.GLFWRenderModuleWindow

io.codetoil.curved_spacetime.render.vulkan_glfw.VulkanGLFWRenderModuleWindow

public class VulkanGLFWRenderModuleWindow
extends GLFWRenderModuleWindow

A GLFW window configured for Vulkan rather than OpenGL.

Supplies the two API-specific pieces GLFWRenderModuleWindow leaves open: checking that a Vulkan driver is present, and setting GLFW_CLIENT_API to GLFW_NO_API so GLFW does not create an OpenGL context for a window Vulkan will render into.

Field Summary

Fields inherited from class GLFWRenderModuleWindow

height, initialized, width, windowHandle

Fields inherited from class RenderModuleWindow

logger, mainModuleEngine, renderModuleKeyboardInput, renderModuleMouseInput, shouldClose, title

Constructor Summary

Constructors

Constructor	Description
VulkanGLFWRenderModuleWindow(MainModuleEngine mainModuleEngine, String title, Logger logger)	Creates a Vulkan-capable GLFW window.

Method Summary

Modifier and Type	Method	Description
boolean	doesDriverExist()	Returns whether a driver for the subclass's graphics API is present.
protected void	setWindowHints()	Applies the GLFW window hints the subclass's graphics API requires.
protected void	throwDriverNotFoundException()	Fails with a message naming the graphics API that could not be found.

Methods inherited from class GLFWRenderModuleWindow

clean, getHeight, getWidth, getWindowHandle, init, isInitialized, loop, setShouldClose, shouldClose

Methods inherited from class RenderModuleWindow

getKeyboardInput, getMouseInput, pollEvents, resetInput

Methods inherited from class Object

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

Constructor Details

VulkanGLFWRenderModuleWindow

public VulkanGLFWRenderModuleWindow(MainModuleEngine mainModuleEngine,
 String title,
 Logger logger)

Creates a Vulkan-capable GLFW window.

Nothing is opened until GLFWRenderModuleWindow.init() is called.

Parameters:

mainModuleEngine - the engine this window belongs to

title - the window's title bar text

logger - the logger to write window diagnostics to

Method Details

doesDriverExist

public boolean doesDriverExist()

Description copied from class: GLFWRenderModuleWindow

Returns whether a driver for the subclass's graphics API is present.

Checked during GLFWRenderModuleWindow.init(), before the window is created, so that an unusable environment is reported before any resource is acquired.

Specified by:

doesDriverExist in class GLFWRenderModuleWindow

Returns:

true if the graphics API can be used on this machine

throwDriverNotFoundException

protected void throwDriverNotFoundException()

Description copied from class: GLFWRenderModuleWindow

Fails with a message naming the graphics API that could not be found.

Called when GLFWRenderModuleWindow.doesDriverExist() returns false; implementations are expected to throw rather than return.

Specified by:

throwDriverNotFoundException in class GLFWRenderModuleWindow

setWindowHints

protected void setWindowHints()

Description copied from class: GLFWRenderModuleWindow

Applies the GLFW window hints the subclass's graphics API requires.

Called before the window is created. A Vulkan implementation, for example, sets GLFW_CLIENT_API to GLFW_NO_API so GLFW does not create an OpenGL context.

Specified by:

setWindowHints in class GLFWRenderModuleWindow