Module com.io7m.jcoronado.api

Package com.io7m.jcoronado.api

Enum VulkanMemoryHeapFlag

java.lang.Object

java.lang.Enum<VulkanMemoryHeapFlag>

com.io7m.jcoronado.api.VulkanMemoryHeapFlag

All Implemented Interfaces:

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

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

See Also:

"VkMemoryHeapFlagBits"

Enum Constant Summary

Enum Constants

Enum Constant	Description
VK_MEMORY_HEAP_DEVICE_LOCAL_BIT	Specifies that the heap corresponds to device local memory.
VK_MEMORY_HEAP_MULTI_INSTANCE_BIT	Specifies that in a logical device representing more than one physical device, there is a per-physical device instance of the heap memory.

Method Summary

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

public static final VulkanMemoryHeapFlag VK_MEMORY_HEAP_DEVICE_LOCAL_BIT

Specifies that the heap corresponds to device local memory.

VK_MEMORY_HEAP_MULTI_INSTANCE_BIT

public static final VulkanMemoryHeapFlag VK_MEMORY_HEAP_MULTI_INSTANCE_BIT

Specifies that in a logical device representing more than one physical device, there is a per-physical device instance of the heap memory. By default, an allocation from such a heap will be replicated to each physical device’s instance of the heap.

Method Detail

values

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

Returns:

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

valueOf

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