Module com.io7m.jcoronado.api

Package com.io7m.jcoronado.api

Enum VulkanBufferCreateFlag

java.lang.Object

java.lang.Enum<VulkanBufferCreateFlag>

com.io7m.jcoronado.api.VulkanBufferCreateFlag

All Implemented Interfaces:

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

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

See Also:

"VkBufferCreateFlagBits"

Enum Constant Summary

Enum Constants

Enum Constant	Description
VK_BUFFER_CREATE_PROTECTED_BIT	Specifies that the buffer is a protected buffer.
VK_BUFFER_CREATE_SPARSE_ALIASED_BIT	Specifies that the buffer will be backed using sparse memory binding with memory ranges that might also simultaneously be backing another buffer (or another portion of the same buffer).
VK_BUFFER_CREATE_SPARSE_BINDING_BIT	Specifies that the buffer will be backed using sparse memory binding.
VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT	Specifies that the buffer can be partially backed using sparse memory binding.

Method Summary

Modifier and Type	Method	Description
int	value()
static VulkanBufferCreateFlag	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static VulkanBufferCreateFlag[]	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_BUFFER_CREATE_SPARSE_BINDING_BIT

public static final VulkanBufferCreateFlag VK_BUFFER_CREATE_SPARSE_BINDING_BIT

Specifies that the buffer will be backed using sparse memory binding.

VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT

public static final VulkanBufferCreateFlag VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT

Specifies that the buffer can be partially backed using sparse memory binding. Buffers created with this flag must also be created with the VK_BUFFER_CREATE_SPARSE_BINDING_BIT flag.

VK_BUFFER_CREATE_SPARSE_ALIASED_BIT

public static final VulkanBufferCreateFlag VK_BUFFER_CREATE_SPARSE_ALIASED_BIT

Specifies that the buffer will be backed using sparse memory binding with memory ranges that might also simultaneously be backing another buffer (or another portion of the same buffer). Buffers created with this flag must also be created with the VK_BUFFER_CREATE_SPARSE_BINDING_BIT flag.

VK_BUFFER_CREATE_PROTECTED_BIT

public static final VulkanBufferCreateFlag VK_BUFFER_CREATE_PROTECTED_BIT

Specifies that the buffer is a protected buffer.

Method Detail

values

public static VulkanBufferCreateFlag[] 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 (VulkanBufferCreateFlag c : VulkanBufferCreateFlag.values())
    System.out.println(c);

Returns:

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

valueOf

public static VulkanBufferCreateFlag 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