-
- All Superinterfaces:
java.lang.AutoCloseable
,VulkanHandleDispatchableType
,VulkanHandleType
- All Known Implementing Classes:
VulkanLWJGLInstance
public interface VulkanInstanceType extends VulkanHandleDispatchableType
An initialized instance.- See Also:
- "VkInstance"
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description void
close()
Destroy the object.java.util.Map<java.lang.String,VulkanExtensionType>
enabledExtensions()
java.util.stream.Stream<VulkanPhysicalDeviceType>
enumeratePhysicalDevices()
default <T extends VulkanExtensionType>
java.util.Optional<T>findEnabledExtension(java.lang.String name, java.lang.Class<T> clazz)
Find and cast an extension with a given name to the correct API type.default java.util.List<VulkanPhysicalDeviceType>
physicalDevices()
-
Methods inherited from interface com.io7m.jcoronado.api.VulkanHandleType
isClosed
-
-
-
-
Method Detail
-
close
void close() throws VulkanException
Description copied from interface:VulkanHandleType
Destroy the object.- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfaceVulkanHandleType
- Throws:
VulkanException
- On errors
-
enumeratePhysicalDevices
java.util.stream.Stream<VulkanPhysicalDeviceType> enumeratePhysicalDevices() throws VulkanException
- Returns:
- The available physical devices
- Throws:
VulkanException
- On errors
-
physicalDevices
default java.util.List<VulkanPhysicalDeviceType> physicalDevices() throws VulkanException
- Returns:
- The available physical devices
- Throws:
VulkanException
- On errors
-
enabledExtensions
java.util.Map<java.lang.String,VulkanExtensionType> enabledExtensions() throws VulkanException
- Returns:
- The enabled extensions for the instance
- Throws:
VulkanException
- On errors
-
findEnabledExtension
default <T extends VulkanExtensionType> java.util.Optional<T> findEnabledExtension(java.lang.String name, java.lang.Class<T> clazz) throws VulkanException
Find and cast an extension with a given name to the correct API type.- Type Parameters:
T
- The precise type- Parameters:
name
- The extension nameclazz
- The intended extension type- Returns:
- The extension with the correct type, or nothing if the extension either did not exist or did not have the right type
- Throws:
VulkanException
- On errors
-
-