Class VulkanGLFWRenderModuleRenderModuleSurface

java.lang.Object

io.codetoil.curved_spacetime.render.vulkan.VulkanRenderModuleSurface

io.codetoil.curved_spacetime.render.vulkan_glfw.VulkanGLFWRenderModuleRenderModuleSurface

public class VulkanGLFWRenderModuleRenderModuleSurface
extends VulkanRenderModuleSurface

A Vulkan surface created from a GLFW window.

GLFW handles the platform-specific part of surface creation, so this class does not need to know whether it is running on X11, Wayland, Win32, or Cocoa. Capabilities and format are queried once at construction, which means the surface must be recreated if the window is resized.

Nested Class Summary

Nested classes/interfaces inherited from class VulkanRenderModuleSurface

VulkanRenderModuleSurface.SurfaceFormat

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.lwjgl.vulkan.VkSurfaceCapabilitiesKHR	surfaceCaps	What this surface supports, queried at construction.
protected final VulkanRenderModuleSurface.SurfaceFormat	surfaceFormat	The pixel format and colour space negotiated for this surface.
protected final long	vkSurface	The underlying Vulkan surface handle.

Fields inherited from class VulkanRenderModuleSurface

logger, vulkanModulePhysicalDevice

Constructor Summary

Constructors

Constructor	Description
VulkanGLFWRenderModuleRenderModuleSurface(VulkanModuleVulkanInstance vulkanModuleVulkanInstance, VulkanModulePhysicalDevice vulkanModulePhysicalDevice, long windowHandle, Logger logger)	Creates a Vulkan surface onto the given GLFW window.

Method Summary

Modifier and Type	Method	Description
void	cleanup()	Destroys the surface and releases the platform resources behind it.
org.lwjgl.vulkan.VkSurfaceCapabilitiesKHR	getSurfaceCaps()	Returns what this surface supports: image count bounds, extent bounds, and transforms.
VulkanRenderModuleSurface.SurfaceFormat	getSurfaceFormat()	Returns the pixel format and colour space chosen for this surface.
long	getVkSurface()	Returns the underlying Vulkan handle.

Methods inherited from class VulkanRenderModuleSurface

calcSurfaceFormat

Methods inherited from class Object

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

Field Details

surfaceCaps

protected final org.lwjgl.vulkan.VkSurfaceCapabilitiesKHR surfaceCaps

What this surface supports, queried at construction.

surfaceFormat

protected final VulkanRenderModuleSurface.SurfaceFormat surfaceFormat

The pixel format and colour space negotiated for this surface.

vkSurface

protected final long vkSurface

The underlying Vulkan surface handle.

Constructor Details

VulkanGLFWRenderModuleRenderModuleSurface

public VulkanGLFWRenderModuleRenderModuleSurface(VulkanModuleVulkanInstance vulkanModuleVulkanInstance,
 VulkanModulePhysicalDevice vulkanModulePhysicalDevice,
 long windowHandle,
 Logger logger)

Creates a Vulkan surface onto the given GLFW window.

Parameters:

vulkanModuleVulkanInstance - the instance to create the surface against

vulkanModulePhysicalDevice - the device to query surface support on

windowHandle - the GLFW window to present into

logger - the logger to write surface diagnostics to

Throws:

AssertionError - if the surface capabilities or formats cannot be queried

Method Details

cleanup

public void cleanup()

Description copied from class: VulkanRenderModuleSurface

Destroys the surface and releases the platform resources behind it.

Specified by:

cleanup in class VulkanRenderModuleSurface

getSurfaceCaps

public org.lwjgl.vulkan.VkSurfaceCapabilitiesKHR getSurfaceCaps()

Description copied from class: VulkanRenderModuleSurface

Returns what this surface supports: image count bounds, extent bounds, and transforms.

A swap chain must be built within these limits.

Specified by:

getSurfaceCaps in class VulkanRenderModuleSurface

Returns:

the surface capabilities

getSurfaceFormat

public VulkanRenderModuleSurface.SurfaceFormat getSurfaceFormat()

Description copied from class: VulkanRenderModuleSurface

Returns the pixel format and colour space chosen for this surface.

Specified by:

getSurfaceFormat in class VulkanRenderModuleSurface

Returns:

the negotiated surface format

getVkSurface

public long getVkSurface()

Description copied from class: VulkanRenderModuleSurface

Returns the underlying Vulkan handle.

Specified by:

getVkSurface in class VulkanRenderModuleSurface

Returns:

the VkSurfaceKHR handle