Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public final Class VK

extends Object
Class Inheritance
Imports
org.lwjgl.*, org.lwjgl.system.*, javax.annotation.*, java.nio.*, java.util.*

This class loads the Vulkan library into the JVM process.
See Also
Configuration#VULKAN_LIBRARY_NAME, Configuration#VULKAN_EXPLICIT_INIT

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static class

Field Summary

Modifier and TypeField and Description
private static FunctionProvider
private static VK.GlobalCommands

Constructor Summary

AccessConstructor and Description
private
VK()

Method Summary

Modifier and TypeMethod and Description
private static <T> T
check(T t)

public static void
create()

Loads the Vulkan shared library, using the default library name.

public static void
create(String
the shared library name
libName
)

Loads the Vulkan shared library, using the specified library name.

public static void
create(FunctionProvider
the provider of Vulkan function addresses
functionProvider
)

Initializes Vulkan with the specified FunctionProvider.

public static void
destroy()

Unloads the Vulkan shared library.

pack-priv static Set<String>
getEnabledExtensionSet(int apiVersion, PointerBuffer extensionNames)

public static FunctionProvider
getFunctionProvider()

Returns the FunctionProvider for the Vulkan shared library.

pack-priv static VK.GlobalCommands
getGlobalCommands()

Returns the Vulkan global commands.

public static int
getInstanceVersionSupported()

Returns a uint32_t, which is the version of Vulkan supported by instance-level functionality, encoded as described in the Version Numbers section.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

functionProviderback to summary
private static FunctionProvider functionProvider
Annotations
@Nullable
globalCommandsback to summary
private static VK.GlobalCommands globalCommands
Annotations
@Nullable

Constructor Detail

VKback to summary
private VK()

Method Detail

checkback to summary
private static <T> T check(T t)
createback to summary
public static void create()

Loads the Vulkan shared library, using the default library name.

See Also
create(String)
createback to summary
public static void create(String libName)

Loads the Vulkan shared library, using the specified library name.

The FunctionProvider instance created by this method can only be used to retrieve global commands and commands exposed statically by the Vulkan shared library.

Parameters
libName:String

the shared library name

See Also
create(FunctionProvider)
createback to summary
public static void create(FunctionProvider functionProvider)

Initializes Vulkan with the specified FunctionProvider. This method can be used to implement custom Vulkan library loading.

Parameters
functionProvider:FunctionProvider

the provider of Vulkan function addresses

destroyback to summary
public static void destroy()

Unloads the Vulkan shared library.

getEnabledExtensionSetback to summary
pack-priv static Set<String> getEnabledExtensionSet(int apiVersion, PointerBuffer extensionNames)
getFunctionProviderback to summary
public static FunctionProvider getFunctionProvider()

Returns the FunctionProvider for the Vulkan shared library.

getGlobalCommandsback to summary
pack-priv static VK.GlobalCommands getGlobalCommands()

Returns the Vulkan global commands.

getInstanceVersionSupportedback to summary
public static int getInstanceVersionSupported()

Returns a uint32_t, which is the version of Vulkan supported by instance-level functionality, encoded as described in the Version Numbers section.

This method can be called before creating a Vulkan instance. The returned value can be used to set the VkApplicationInfo::apiVersion member.

org.lwjgl.vulkan back to summary

pack-priv Class VK.GlobalCommands

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
pack-priv final long
pack-priv final long
pack-priv final long
pack-priv final long
pack-priv final long

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
private long
private long
getFunctionAddress(String name, boolean required)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

vkCreateInstanceback to summary
pack-priv final long vkCreateInstance
vkEnumerateInstanceExtensionPropertiesback to summary
pack-priv final long vkEnumerateInstanceExtensionProperties
vkEnumerateInstanceLayerPropertiesback to summary
pack-priv final long vkEnumerateInstanceLayerProperties
vkEnumerateInstanceVersionback to summary
pack-priv final long vkEnumerateInstanceVersion
vkGetInstanceProcAddrback to summary
pack-priv final long vkGetInstanceProcAddr

Constructor Detail

GlobalCommandsback to summary
pack-priv GlobalCommands(FunctionProvider library)

Method Detail

getFunctionAddressback to summary
private long getFunctionAddress(String name)
getFunctionAddressback to summary
private long getFunctionAddress(String name, boolean required)