Enum Class VulkanCompareOp

java.lang.Object

java.lang.Enum<VulkanCompareOp>

com.io7m.jcoronado.api.VulkanCompareOp

All Implemented Interfaces:

VulkanEnumIntegerType, Serializable, Comparable<VulkanCompareOp>, Constable

public enum VulkanCompareOp
extends Enum<VulkanCompareOp>
implements VulkanEnumIntegerType

See Also:

• "VkCompareOp"

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
VK_COMPARE_OP_ALWAYS	Specifies that the test always passes.
VK_COMPARE_OP_EQUAL	Specifies that the test passes when R = S.
VK_COMPARE_OP_GREATER	Specifies that the test passes when R > S.
VK_COMPARE_OP_GREATER_OR_EQUAL	Specifies that the test passes when R ≥ S.
VK_COMPARE_OP_LESS	Specifies that the test passes when R < S.
VK_COMPARE_OP_LESS_OR_EQUAL	Specifies that the test passes when R ≤ S.
VK_COMPARE_OP_NEVER	Specifies that the test never passes.
VK_COMPARE_OP_NOT_EQUAL	Specifies that the test passes when R ≠ S.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

VK_COMPARE_OP_NEVER

public static final VulkanCompareOp VK_COMPARE_OP_NEVER

Specifies that the test never passes.

VK_COMPARE_OP_LESS

public static final VulkanCompareOp VK_COMPARE_OP_LESS

Specifies that the test passes when R < S.

VK_COMPARE_OP_EQUAL

public static final VulkanCompareOp VK_COMPARE_OP_EQUAL

Specifies that the test passes when R = S.

VK_COMPARE_OP_LESS_OR_EQUAL

public static final VulkanCompareOp VK_COMPARE_OP_LESS_OR_EQUAL

Specifies that the test passes when R ≤ S.

VK_COMPARE_OP_GREATER

public static final VulkanCompareOp VK_COMPARE_OP_GREATER

Specifies that the test passes when R > S.

VK_COMPARE_OP_NOT_EQUAL

public static final VulkanCompareOp VK_COMPARE_OP_NOT_EQUAL

Specifies that the test passes when R ≠ S.

VK_COMPARE_OP_GREATER_OR_EQUAL

public static final VulkanCompareOp VK_COMPARE_OP_GREATER_OR_EQUAL

Specifies that the test passes when R ≥ S.

VK_COMPARE_OP_ALWAYS

public static final VulkanCompareOp VK_COMPARE_OP_ALWAYS

Specifies that the test always passes.

Method Details

values

public static VulkanCompareOp[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static VulkanCompareOp valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

value

public int value()

Specified by:

value in interface VulkanEnumIntegerType

Returns:

The integer value of the constant