org.lwjgl.glfw

Class GLFWVulkan

java.lang.Object

org.lwjgl.glfw.GLFWVulkan

public class GLFWVulkan
extends java.lang.Object

Native bindings to the GLFW library's Vulkan functions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GLFWVulkan.Functions Contains the function pointers loaded from GLFW.getLibrary().

Method Summary

Modifier and Type	Method and Description
static int	glfwCreateWindowSurface(org.lwjgl.vulkan.VkInstance instance, long window, org.lwjgl.vulkan.VkAllocationCallbacks allocator, long[] surface) Array version of: CreateWindowSurface
static int	glfwCreateWindowSurface(org.lwjgl.vulkan.VkInstance instance, long window, org.lwjgl.vulkan.VkAllocationCallbacks allocator, java.nio.LongBuffer surface) Creates a Vulkan surface for the specified window.
static long	glfwGetInstanceProcAddress(org.lwjgl.vulkan.VkInstance instance, java.nio.ByteBuffer procname) Returns the address of the specified Vulkan core or extension function for the specified instance.
static long	glfwGetInstanceProcAddress(org.lwjgl.vulkan.VkInstance instance, java.lang.CharSequence procname) Returns the address of the specified Vulkan core or extension function for the specified instance.
static boolean	glfwGetPhysicalDevicePresentationSupport(org.lwjgl.vulkan.VkInstance instance, org.lwjgl.vulkan.VkPhysicalDevice device, int queuefamily) Returns whether the specified queue family of the specified physical device supports presentation to the platform GLFW was built for.
static org.lwjgl.PointerBuffer	glfwGetRequiredInstanceExtensions() Returns an array of names of Vulkan instance extensions required by GLFW for creating Vulkan surfaces for GLFW windows.
static boolean	glfwVulkanSupported() Returns whether the Vulkan loader has been found.
static int	nglfwCreateWindowSurface(long instance, long window, long allocator, long surface) Unsafe version of: CreateWindowSurface
static long	nglfwGetInstanceProcAddress(long instance, long procname) Unsafe version of: GetInstanceProcAddress
static long	nglfwGetRequiredInstanceExtensions(long count) Unsafe version of: GetRequiredInstanceExtensions
static void	setPath(java.lang.String path) Overrides the Vulkan shared library that GLFW loads internally.
static void	setPathLWJGL() Calls setPath(String) with the path of the Vulkan shared library loaded by LWJGL.

Methods inherited from class java.lang.Object

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

Method Detail

glfwVulkanSupported

public static boolean glfwVulkanSupported()

Returns whether the Vulkan loader has been found. This check is performed by Init.

The availability of a Vulkan loader does not by itself guarantee that window surface creation or even device creation is possible. Call GetRequiredInstanceExtensions to check whether the extensions necessary for Vulkan surface creation are available and GetPhysicalDevicePresentationSupport to check whether a queue family of a physical device supports image presentation.

Possible errors include NOT_INITIALIZED.

This function may be called from any thread.

Returns:

TRUE if Vulkan is available, or FALSE otherwise

Since:

version 3.2

nglfwGetRequiredInstanceExtensions

public static long nglfwGetRequiredInstanceExtensions(long count)

Unsafe version of: GetRequiredInstanceExtensions

Parameters:

count - where to store the number of extensions in the returned array. This is set to zero if an error occurred.

glfwGetRequiredInstanceExtensions

@Nullable
public static org.lwjgl.PointerBuffer glfwGetRequiredInstanceExtensions()

Returns an array of names of Vulkan instance extensions required by GLFW for creating Vulkan surfaces for GLFW windows. If successful, the list will always contain VK_KHR_surface, so if you don't require any additional extensions you can pass this list directly to the VkInstanceCreateInfo struct.

If Vulkan is not available on the machine, this function returns NULL and generates a API_UNAVAILABLE error. Call VulkanSupported to check whether Vulkan is available.

If Vulkan is available but no set of extensions allowing window surface creation was found, this function returns NULL. You may still use Vulkan for off-screen rendering and compute work.

Additional extensions may be required by future versions of GLFW. You should check if any extensions you wish to enable are already in the returned array, as it is an error to specify an extension more than once in the VkInstanceCreateInfo struct.

The returned array is allocated and freed by GLFW. You should not free it yourself. It is guaranteed to be valid only until the library is terminated.

This function may be called from any thread.

Possible errors include NOT_INITIALIZED and API_UNAVAILABLE.

Returns:

an array of ASCII encoded extension names, or NULL if an error occurred

Since:

version 3.2

nglfwGetInstanceProcAddress

public static long nglfwGetInstanceProcAddress(long instance,
                                               long procname)

Unsafe version of: GetInstanceProcAddress

glfwGetInstanceProcAddress

public static long glfwGetInstanceProcAddress(@Nullable
                                              org.lwjgl.vulkan.VkInstance instance,
                                              java.nio.ByteBuffer procname)

Returns the address of the specified Vulkan core or extension function for the specified instance. If instance is set to NULL it can return any function exported from the Vulkan loader, including at least the following functions:

• VK10.vkEnumerateInstanceExtensionProperties(java.nio.ByteBuffer, java.nio.IntBuffer, org.lwjgl.vulkan.VkExtensionProperties.Buffer)
• VK10.vkEnumerateInstanceLayerProperties(java.nio.IntBuffer, org.lwjgl.vulkan.VkLayerProperties.Buffer)
• VK10.vkCreateInstance(org.lwjgl.vulkan.VkInstanceCreateInfo, org.lwjgl.vulkan.VkAllocationCallbacks, org.lwjgl.PointerBuffer)
• VK10.vkGetInstanceProcAddr(org.lwjgl.vulkan.VkInstance, java.nio.ByteBuffer)

If Vulkan is not available on the machine, this function returns NULL and generates a API_UNAVAILABLE error. Call VulkanSupported to check whether Vulkan is available.

This function is equivalent to calling VK10.vkGetInstanceProcAddr(org.lwjgl.vulkan.VkInstance, java.nio.ByteBuffer) with a platform-specific query of the Vulkan loader as a fallback.

Possible errors include NOT_INITIALIZED and API_UNAVAILABLE.

The returned function pointer is valid until the library is terminated.

This function may be called from any thread.

Parameters:

instance - the Vulkan instance to query, or NULL to retrieve functions related to instance creation

procname - the ASCII encoded name of the function

Returns:

the address of the function, or NULL if an error occurred

Since:

version 3.2

glfwGetInstanceProcAddress

public static long glfwGetInstanceProcAddress(@Nullable
                                              org.lwjgl.vulkan.VkInstance instance,
                                              java.lang.CharSequence procname)

Returns the address of the specified Vulkan core or extension function for the specified instance. If instance is set to NULL it can return any function exported from the Vulkan loader, including at least the following functions:

• VK10.vkEnumerateInstanceExtensionProperties(java.nio.ByteBuffer, java.nio.IntBuffer, org.lwjgl.vulkan.VkExtensionProperties.Buffer)
• VK10.vkEnumerateInstanceLayerProperties(java.nio.IntBuffer, org.lwjgl.vulkan.VkLayerProperties.Buffer)
• VK10.vkCreateInstance(org.lwjgl.vulkan.VkInstanceCreateInfo, org.lwjgl.vulkan.VkAllocationCallbacks, org.lwjgl.PointerBuffer)
• VK10.vkGetInstanceProcAddr(org.lwjgl.vulkan.VkInstance, java.nio.ByteBuffer)

If Vulkan is not available on the machine, this function returns NULL and generates a API_UNAVAILABLE error. Call VulkanSupported to check whether Vulkan is available.

This function is equivalent to calling VK10.vkGetInstanceProcAddr(org.lwjgl.vulkan.VkInstance, java.nio.ByteBuffer) with a platform-specific query of the Vulkan loader as a fallback.

Possible errors include NOT_INITIALIZED and API_UNAVAILABLE.

The returned function pointer is valid until the library is terminated.

This function may be called from any thread.

Parameters:

instance - the Vulkan instance to query, or NULL to retrieve functions related to instance creation

procname - the ASCII encoded name of the function

Returns:

the address of the function, or NULL if an error occurred

Since:

version 3.2

glfwGetPhysicalDevicePresentationSupport

public static boolean glfwGetPhysicalDevicePresentationSupport(org.lwjgl.vulkan.VkInstance instance,
                                                               org.lwjgl.vulkan.VkPhysicalDevice device,
                                                               int queuefamily)

Returns whether the specified queue family of the specified physical device supports presentation to the platform GLFW was built for.

If Vulkan or the required window surface creation instance extensions are not available on the machine, or if the specified instance was not created with the required extensions, this function returns FALSE and generates a API_UNAVAILABLE error. Call VulkanSupported to check whether Vulkan is available and GetRequiredInstanceExtensions to check what instance extensions are required.

Possible errors include NOT_INITIALIZED, API_UNAVAILABLE and PLATFORM_ERROR.

This function may be called from any thread. For synchronization details of Vulkan objects, see the Vulkan specification.

Parameters:

instance - the instance that the physical device belongs to

device - the physical device that the queue family belongs to

queuefamily - the index of the queue family to query

Returns:

TRUE if the queue family supports presentation, or FALSE otherwise

Since:

version 3.2

nglfwCreateWindowSurface

public static int nglfwCreateWindowSurface(long instance,
                                           long window,
                                           long allocator,
                                           long surface)

Unsafe version of: CreateWindowSurface

glfwCreateWindowSurface

public static int glfwCreateWindowSurface(org.lwjgl.vulkan.VkInstance instance,
                                          long window,
                                          @Nullable
                                          org.lwjgl.vulkan.VkAllocationCallbacks allocator,
                                          java.nio.LongBuffer surface)

Creates a Vulkan surface for the specified window.

If the Vulkan loader was not found at initialization, this function returns VK10.VK_ERROR_INITIALIZATION_FAILED and generates a API_UNAVAILABLE error. Call VulkanSupported to check whether the Vulkan loader was found.

If the required window surface creation instance extensions are not available or if the specified instance was not created with these extensions enabled, this function returns VK10.VK_ERROR_EXTENSION_NOT_PRESENT and generates a API_UNAVAILABLE error. Call GetRequiredInstanceExtensions to check what instance extensions are required.

The window surface cannot be shared with another API so the window must have been created with the client api hint set to NO_API otherwise it generates a INVALID_VALUE error and returns KHRSurface.VK_ERROR_NATIVE_WINDOW_IN_USE_KHR.

The window surface must be destroyed before the specified Vulkan instance. It is the responsibility of the caller to destroy the window surface. GLFW does not destroy it for you. Call KHRSurface.vkDestroySurfaceKHR(org.lwjgl.vulkan.VkInstance, long, org.lwjgl.vulkan.VkAllocationCallbacks) to destroy the surface.

Possible errors include NOT_INITIALIZED, API_UNAVAILABLE, PLATFORM_ERROR and INVALID_VALUE.

If an error occurs before the creation call is made, GLFW returns the Vulkan error code most appropriate for the error. Appropriate use of VulkanSupported and GetRequiredInstanceExtensions should eliminate almost all occurrences of these errors.

This function may be called from any thread. For synchronization details of Vulkan objects, see the Vulkan specification.

Parameters:

instance - the Vulkan instance to create the surface in

window - the window to create the surface for

allocator - the allocator to use, or NULL to use the default allocator.

surface - where to store the handle of the surface. This is set to VK10.VK_NULL_HANDLE if an error occurred.

Returns:

VK10.VK_SUCCESS if successful, or a Vulkan error code if an error occurred

Since:

version 3.2

glfwCreateWindowSurface

public static int glfwCreateWindowSurface(org.lwjgl.vulkan.VkInstance instance,
                                          long window,
                                          @Nullable
                                          org.lwjgl.vulkan.VkAllocationCallbacks allocator,
                                          long[] surface)

Array version of: CreateWindowSurface

setPathLWJGL

public static void setPathLWJGL()

Calls setPath(String) with the path of the Vulkan shared library loaded by LWJGL.

setPath

public static void setPath(@Nullable
                           java.lang.String path)

Overrides the Vulkan shared library that GLFW loads internally.

This is useful when there's a mismatch between the shared libraries loaded by LWJGL and GLFW.

This method must be called before GLFW initializes Vulkan. The override is available only in the default GLFW build bundled with LWJGL. Using the override with a custom GLFW build will produce a warning in DEBUG mode (but not an error).

Parameters:

path - the Vulkan shared library path, or null to remove the override.