- java.lang.Object
-
- java.lang.Enum<VulkanComponentSwizzle>
-
- com.io7m.jcoronado.api.VulkanComponentSwizzle
-
- All Implemented Interfaces:
VulkanEnumIntegerType
,java.io.Serializable
,java.lang.Comparable<VulkanComponentSwizzle>
public enum VulkanComponentSwizzle extends java.lang.Enum<VulkanComponentSwizzle> implements VulkanEnumIntegerType
Specify how a component is swizzled.- See Also:
- "VkComponentSwizzle"
-
-
Enum Constant Summary
Enum Constants Enum Constant Description VK_COMPONENT_SWIZZLE_A
Specifies that the component is set to the value of the A component of the image.VK_COMPONENT_SWIZZLE_B
Specifies that the component is set to the value of the B component of the image.VK_COMPONENT_SWIZZLE_G
Specifies that the component is set to the value of the G component of the image.VK_COMPONENT_SWIZZLE_IDENTITY
Specifies that the component is set to the identity swizzle.VK_COMPONENT_SWIZZLE_ONE
Specifies that the component is set to either 1 or 1.0, depending on whether the type of the image view format is integer or floating-point respectively, as determined by the Format Definition section for each VkFormat.VK_COMPONENT_SWIZZLE_R
Specifies that the component is set to the value of the R component of the image.VK_COMPONENT_SWIZZLE_ZERO
Specifies that the component is set to zero.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
value()
static VulkanComponentSwizzle
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static VulkanComponentSwizzle[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
VK_COMPONENT_SWIZZLE_IDENTITY
public static final VulkanComponentSwizzle VK_COMPONENT_SWIZZLE_IDENTITY
Specifies that the component is set to the identity swizzle.
-
VK_COMPONENT_SWIZZLE_ZERO
public static final VulkanComponentSwizzle VK_COMPONENT_SWIZZLE_ZERO
Specifies that the component is set to zero.
-
VK_COMPONENT_SWIZZLE_ONE
public static final VulkanComponentSwizzle VK_COMPONENT_SWIZZLE_ONE
Specifies that the component is set to either 1 or 1.0, depending on whether the type of the image view format is integer or floating-point respectively, as determined by the Format Definition section for each VkFormat.
-
VK_COMPONENT_SWIZZLE_R
public static final VulkanComponentSwizzle VK_COMPONENT_SWIZZLE_R
Specifies that the component is set to the value of the R component of the image.
-
VK_COMPONENT_SWIZZLE_G
public static final VulkanComponentSwizzle VK_COMPONENT_SWIZZLE_G
Specifies that the component is set to the value of the G component of the image.
-
VK_COMPONENT_SWIZZLE_B
public static final VulkanComponentSwizzle VK_COMPONENT_SWIZZLE_B
Specifies that the component is set to the value of the B component of the image.
-
VK_COMPONENT_SWIZZLE_A
public static final VulkanComponentSwizzle VK_COMPONENT_SWIZZLE_A
Specifies that the component is set to the value of the A component of the image.
-
-
Method Detail
-
values
public static VulkanComponentSwizzle[] 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 (VulkanComponentSwizzle c : VulkanComponentSwizzle.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static VulkanComponentSwizzle 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 namejava.lang.NullPointerException
- if the argument is null
-
value
public int value()
- Specified by:
value
in interfaceVulkanEnumIntegerType
- Returns:
- The integer value of the constant
-
-