Module com.io7m.jcoronado.api

Package com.io7m.jcoronado.api

Enum VulkanCommandPoolCreateFlag

java.lang.Object

java.lang.Enum<VulkanCommandPoolCreateFlag>

com.io7m.jcoronado.api.VulkanCommandPoolCreateFlag

All Implemented Interfaces:

VulkanEnumBitmaskType, java.io.Serializable, java.lang.Comparable<VulkanCommandPoolCreateFlag>

public enum VulkanCommandPoolCreateFlag
extends java.lang.Enum<VulkanCommandPoolCreateFlag>
implements VulkanEnumBitmaskType

Bitmask controlling how a command pool is created.

See Also:

"VkCommandPoolCreateFlags"

Enum Constant Summary

Enum Constants

Enum Constant	Description
VK_COMMAND_POOL_CREATE_PROTECTED_BIT	Specifies that command buffers allocated from the pool are protected command buffers.
VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT	Allows any command buffer allocated from a pool to be individually reset to the initial state; either by calling vkResetCommandBuffer, or via the implicit reset when calling vkBeginCommandBuffer.
VK_COMMAND_POOL_CREATE_TRANSIENT_BIT	Specifies that command buffers allocated from the pool will be short-lived, meaning that they will be reset or freed in a relatively short timeframe.

Method Summary

Modifier and Type	Method	Description
int	value()
static VulkanCommandPoolCreateFlag	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static VulkanCommandPoolCreateFlag[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

VK_COMMAND_POOL_CREATE_TRANSIENT_BIT

public static final VulkanCommandPoolCreateFlag VK_COMMAND_POOL_CREATE_TRANSIENT_BIT

Specifies that command buffers allocated from the pool will be short-lived, meaning that they will be reset or freed in a relatively short timeframe. This flag may be used by the implementation to control memory allocation behavior within the pool.

VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT

public static final VulkanCommandPoolCreateFlag VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT

Allows any command buffer allocated from a pool to be individually reset to the initial state; either by calling vkResetCommandBuffer, or via the implicit reset when calling vkBeginCommandBuffer. If this flag is not set on a pool, then vkResetCommandBuffer must not be called for any command buffer allocated from that pool.

VK_COMMAND_POOL_CREATE_PROTECTED_BIT

public static final VulkanCommandPoolCreateFlag VK_COMMAND_POOL_CREATE_PROTECTED_BIT

Specifies that command buffers allocated from the pool are protected command buffers. If the protected memory feature is not enabled, the VK_COMMAND_POOL_CREATE_PROTECTED_BIT bit of flags must not be set.

Method Detail

values

public static VulkanCommandPoolCreateFlag[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (VulkanCommandPoolCreateFlag c : VulkanCommandPoolCreateFlag.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static VulkanCommandPoolCreateFlag valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

value

public int value()

Specified by:

value in interface VulkanEnumBitmaskType

Returns:

The integer value of the constant