Class VulkanCommandPoolHandler

java.lang.Object

com.io7m.jcoronado.utility.command_pools.VulkanCommandPoolHandler

All Implemented Interfaces:

AutoCloseable

public final class VulkanCommandPoolHandler
extends Object
implements AutoCloseable

A command-pool handler that provides per-frame command pools and enforces a correct reset and free discipline for command buffers.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VulkanCommandPoolHandler.VulkanPoolFrameType	A command pool frame.

Method Summary

Modifier and Type	Method	Description
VulkanCommandPoolHandler.VulkanPoolFrameType	beginFrame(int frameIndex)	Begin a frame.
void	close()
static VulkanCommandPoolHandler	create(VulkanLogicalDeviceType device, Function<Integer,String> poolNamer, Set<VulkanCommandPoolCreateFlag> poolFlags, VulkanQueueFamilyIndex poolQueueIndex, int framesInFlight)	Create a new pool handler.

Methods inherited from class Object

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

Method Details

create

public static VulkanCommandPoolHandler create(VulkanLogicalDeviceType device,
 Function<Integer,String> poolNamer,
 Set<VulkanCommandPoolCreateFlag> poolFlags,
 VulkanQueueFamilyIndex poolQueueIndex,
 int framesInFlight)
                                       throws VulkanException

Create a new pool handler.

Parameters:

device - The device

poolNamer - A function that returns a pool name given a frame index

poolFlags - The pool creation flags

poolQueueIndex - The pool queue index

framesInFlight - The number of frames in flight

Returns:

The pool handler

Throws:

VulkanException - On errors

beginFrame

public VulkanCommandPoolHandler.VulkanPoolFrameType beginFrame(int frameIndex)
                                                        throws VulkanException

Begin a frame. This will reset the command pool and free any unused command buffers.

Parameters:

frameIndex - The frame index

Returns:

The frame

Throws:

VulkanException - On errors

close

public void close()
           throws VulkanException

Specified by:

close in interface AutoCloseable

Throws:

VulkanException