java.lang.Object
- java.lang.Enum<VulkanImageCreateFlag>
- - com.io7m.jcoronado.api.VulkanImageCreateFlag

All Implemented Interfaces:

VulkanEnumBitmaskType, java.io.Serializable, java.lang.Comparable<VulkanImageCreateFlag>
```
public enum VulkanImageCreateFlag
extends java.lang.Enum<VulkanImageCreateFlag>
implements VulkanEnumBitmaskType
```
Flags specified when creating images.

See Also:

"VkImageCreateFlagBits"

Enum Constant Summary

Enum Constants
Enum Constant	Description
`VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT`	Specifies that the image can be used to create a VkImageView of type VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.
`VK_IMAGE_CREATE_ALIAS_BIT`	Specifies that two images created with the same creation parameters and aliased to the same memory can interpret the contents of the memory consistently with each other, subject to the rules described in the Memory Aliasing section.
`VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT`	Specifies that the image having a compressed format can be used to create a VkImageView with an uncompressed format where each texel in the image view corresponds to a compressed texel block of the image.
`VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV`	Specifies that the image is a corner-sampled image.
`VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT`	Specifies that the image can be used to create a VkImageView of type VK_IMAGE_VIEW_TYPE_CUBE or VK_IMAGE_VIEW_TYPE_CUBE_ARRAY.
`VK_IMAGE_CREATE_DISJOINT_BIT`	Specifies that an image with a multi-planar format must have each plane separately bound to memory, rather than having a single memory binding for the whole image; the presence of this bit distinguishes a disjoint image from an image without this bit set.
`VK_IMAGE_CREATE_EXTENDED_USAGE_BIT`	Specifies that the image can be created with usage flags that are not supported for the format the image is created with but are supported for at least one format a VkImageView created from the image can have.
`VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT`	Specifies that the image can be used to create a VkImageView with a different format from the image.
`VK_IMAGE_CREATE_PROTECTED_BIT`	Specifies that the image is a protected image.
`VK_IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT`	Specifies that an image with a depth or depth/stencil format can be used with custom sample locations when used as a depth/stencil attachment.
`VK_IMAGE_CREATE_SPARSE_ALIASED_BIT`	Specifies that the image will be backed using sparse memory binding with memory ranges that might also simultaneously be backing another image (or another portion of the same image).
`VK_IMAGE_CREATE_SPARSE_BINDING_BIT`	Specifies that the image will be backed using sparse memory binding.
`VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT`	Specifies that the image can be partially backed using sparse memory binding.
`VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT`	Specifies that the image can be used with a non-zero value of the splitInstanceBindRegionCount member of a VkBindImageMemoryDeviceGroupInfo structure passed into vkBindImageMemory2.
`VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT`	Specifies that an image can be in a subsampled format which may be more optimal when written as an attachment by a render pass that has a fragment density map attachment.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`value()`
`static VulkanImageCreateFlag`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static VulkanImageCreateFlag[]`	`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_IMAGE_CREATE_SPARSE_BINDING_BIT
```
public static final VulkanImageCreateFlag VK_IMAGE_CREATE_SPARSE_BINDING_BIT
```
    Specifies that the image will be backed using sparse memory binding.
  - VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT
```
public static final VulkanImageCreateFlag VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT
```
    Specifies that the image can be partially backed using sparse memory binding. Images created with this flag must also be created with the VK_IMAGE_CREATE_SPARSE_BINDING_BIT flag.
  - VK_IMAGE_CREATE_SPARSE_ALIASED_BIT
```
public static final VulkanImageCreateFlag VK_IMAGE_CREATE_SPARSE_ALIASED_BIT
```
    Specifies that the image will be backed using sparse memory binding with memory ranges that might also simultaneously be backing another image (or another portion of the same image). Images created with this flag must also be created with the VK_IMAGE_CREATE_SPARSE_BINDING_BIT flag.
  - VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT
```
public static final VulkanImageCreateFlag VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT
```
    Specifies that the image can be used to create a VkImageView with a different format from the image. For multi-planar formats, VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT specifies that a VkImageView can be created of a plane of the image.
  - VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT
```
public static final VulkanImageCreateFlag VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT
```
    Specifies that the image can be used to create a VkImageView of type VK_IMAGE_VIEW_TYPE_CUBE or VK_IMAGE_VIEW_TYPE_CUBE_ARRAY.
  - VK_IMAGE_CREATE_ALIAS_BIT
```
public static final VulkanImageCreateFlag VK_IMAGE_CREATE_ALIAS_BIT
```
    Specifies that two images created with the same creation parameters and aliased to the same memory can interpret the contents of the memory consistently with each other, subject to the rules described in the Memory Aliasing section. This flag further specifies that each plane of a disjoint image can share an in-memory non-linear representation with single-plane images, and that a single-plane image can share an in-memory non-linear representation with a plane of a multi-planar disjoint image.
  - VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT
```
public static final VulkanImageCreateFlag VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT
```
    Specifies that the image can be used with a non-zero value of the splitInstanceBindRegionCount member of a VkBindImageMemoryDeviceGroupInfo structure passed into vkBindImageMemory2. This flag also has the effect of making the image use the standard sparse image block dimensions.
  - VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT
```
public static final VulkanImageCreateFlag VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT
```
    Specifies that the image can be used to create a VkImageView of type VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.
  - VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT
```
public static final VulkanImageCreateFlag VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT
```
    Specifies that the image having a compressed format can be used to create a VkImageView with an uncompressed format where each texel in the image view corresponds to a compressed texel block of the image.
  - VK_IMAGE_CREATE_EXTENDED_USAGE_BIT
```
public static final VulkanImageCreateFlag VK_IMAGE_CREATE_EXTENDED_USAGE_BIT
```
    Specifies that the image can be created with usage flags that are not supported for the format the image is created with but are supported for at least one format a VkImageView created from the image can have.
  - VK_IMAGE_CREATE_PROTECTED_BIT
```
public static final VulkanImageCreateFlag VK_IMAGE_CREATE_PROTECTED_BIT
```
    Specifies that the image is a protected image.
  - VK_IMAGE_CREATE_DISJOINT_BIT
```
public static final VulkanImageCreateFlag VK_IMAGE_CREATE_DISJOINT_BIT
```
    Specifies that an image with a multi-planar format must have each plane separately bound to memory, rather than having a single memory binding for the whole image; the presence of this bit distinguishes a disjoint image from an image without this bit set.
  - VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV
```
public static final VulkanImageCreateFlag VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV
```
    Specifies that the image is a corner-sampled image.
  - VK_IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT
```
public static final VulkanImageCreateFlag VK_IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT
```
    Specifies that an image with a depth or depth/stencil format can be used with custom sample locations when used as a depth/stencil attachment.
  - VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT
```
public static final VulkanImageCreateFlag VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT
```
    Specifies that an image can be in a subsampled format which may be more optimal when written as an attachment by a render pass that has a fragment density map attachment.
- Method Detail
  - values
```
public static VulkanImageCreateFlag[] 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 (VulkanImageCreateFlag c : VulkanImageCreateFlag.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static VulkanImageCreateFlag 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

Enum VulkanImageCreateFlag

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

VK_IMAGE_CREATE_SPARSE_BINDING_BIT

VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT

VK_IMAGE_CREATE_SPARSE_ALIASED_BIT

VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT

VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT

VK_IMAGE_CREATE_ALIAS_BIT

VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT

VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT

VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT

VK_IMAGE_CREATE_EXTENDED_USAGE_BIT

VK_IMAGE_CREATE_PROTECTED_BIT

VK_IMAGE_CREATE_DISJOINT_BIT

VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV

VK_IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT

VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT

Method Detail

values

valueOf

value