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

All Implemented Interfaces:

VulkanEnumIntegerType, java.io.Serializable, java.lang.Comparable<VulkanImageLayout>
```
public enum VulkanImageLayout
extends java.lang.Enum<VulkanImageLayout>
implements VulkanEnumIntegerType
```
See Also:

"VkImageLayout"

Enum Constant Summary

Enum Constants
Enum Constant	Description
`VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL`	VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL must only be used as a color or resolve attachment in a VkFramebuffer.
`VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL`	VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL
`VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL`	VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL
`VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL`	VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL must only be used as a depth/stencil attachment in a VkFramebuffer.
`VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL`	VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL must only be used as a read-only depth/stencil attachment in a VkFramebuffer and/or as a read-only image in a shader (which can be read as a sampled image, combined image/sampler and/or input attachment).
`VK_IMAGE_LAYOUT_GENERAL`	VK_IMAGE_LAYOUT_PREINITIALIZED does not support device access.
`VK_IMAGE_LAYOUT_PREINITIALIZED`	VK_IMAGE_LAYOUT_PREINITIALIZED does not support device access.
`VK_IMAGE_LAYOUT_PRESENT_SRC_KHR`	VK_IMAGE_LAYOUT_PRESENT_SRC_KHR must only be used for presenting a presentable image for display.
`VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL`	VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL must only be used as a read-only image in a shader (which can be read as a sampled image, combined image/sampler and/or input attachment).
`VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR`	VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR is valid only for shared presentable images, and must be used for any usage the image supports.
`VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL`	VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL must only be used as a destination image of a transfer command.
`VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL`	VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL must only be used as a source image of a transfer command (see the definition of VK_PIPELINE_STAGE_TRANSFER_BIT).
`VK_IMAGE_LAYOUT_UNDEFINED`	VK_IMAGE_LAYOUT_UNDEFINED does not support device access.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`value()`
`static VulkanImageLayout`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static VulkanImageLayout[]`	`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_LAYOUT_UNDEFINED
```
public static final VulkanImageLayout VK_IMAGE_LAYOUT_UNDEFINED
```
    VK_IMAGE_LAYOUT_UNDEFINED does not support device access. This layout must only be used as the initialLayout member of VkImageCreateInfo or VkAttachmentDescription, or as the oldLayout in an image transition. When transitioning out of this layout, the contents of the memory are not guaranteed to be preserved.
  - VK_IMAGE_LAYOUT_GENERAL
```
public static final VulkanImageLayout VK_IMAGE_LAYOUT_GENERAL
```
    VK_IMAGE_LAYOUT_PREINITIALIZED does not support device access. This layout must only be used as the initialLayout member of VkImageCreateInfo or VkAttachmentDescription, or as the oldLayout in an image transition. When transitioning out of this layout, the contents of the memory are preserved. This layout is intended to be used as the initial layout for an image whose contents are written by the host, and hence the data can be written to memory immediately, without first executing a layout transition. Currently, VK_IMAGE_LAYOUT_PREINITIALIZED is only useful with VK_IMAGE_TILING_LINEAR images because there is not a standard layout defined for VK_IMAGE_TILING_OPTIMAL images.
  - VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
```
public static final VulkanImageLayout VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
```
    VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL must only be used as a color or resolve attachment in a VkFramebuffer. This layout is valid only for image subresources of images created with the VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT usage bit enabled.
  - VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL
```
public static final VulkanImageLayout VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL
```
    VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL must only be used as a depth/stencil attachment in a VkFramebuffer. This layout is valid only for image subresources of images created with the VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT usage bit enabled.
  - VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL
```
public static final VulkanImageLayout VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL
```
    VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL must only be used as a read-only depth/stencil attachment in a VkFramebuffer and/or as a read-only image in a shader (which can be read as a sampled image, combined image/sampler and/or input attachment). This layout is valid only for image subresources of images created with the VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT usage bit enabled. Only image subresources of images created with VK_IMAGE_USAGE_SAMPLED_BIT can be used as a sampled image or combined image/sampler in a shader. Similarly, only image subresources of images created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT can be used as input attachments.
  - VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL
```
public static final VulkanImageLayout VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL
```
    VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL must only be used as a read-only image in a shader (which can be read as a sampled image, combined image/sampler and/or input attachment). This layout is valid only for image subresources of images created with the VK_IMAGE_USAGE_SAMPLED_BIT or VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT usage bit enabled.
  - VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL
```
public static final VulkanImageLayout VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL
```
    VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL must only be used as a source image of a transfer command (see the definition of VK_PIPELINE_STAGE_TRANSFER_BIT). This layout is valid only for image subresources of images created with the VK_IMAGE_USAGE_TRANSFER_SRC_BIT usage bit enabled.
  - VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL
```
public static final VulkanImageLayout VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL
```
    VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL must only be used as a destination image of a transfer command. This layout is valid only for image subresources of images created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT usage bit enabled.
  - VK_IMAGE_LAYOUT_PREINITIALIZED
```
public static final VulkanImageLayout VK_IMAGE_LAYOUT_PREINITIALIZED
```
    VK_IMAGE_LAYOUT_PREINITIALIZED does not support device access. This layout must only be used as the initialLayout member of VkImageCreateInfo or VkAttachmentDescription, or as the oldLayout in an image transition. When transitioning out of this layout, the contents of the memory are preserved. This layout is intended to be used as the initial layout for an image whose contents are written by the host, and hence the data can be written to memory immediately, without first executing a layout transition. Currently, VK_IMAGE_LAYOUT_PREINITIALIZED is only useful with VK_IMAGE_TILING_LINEAR images because there is not a standard layout defined for VK_IMAGE_TILING_OPTIMAL images.
  - VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL
```
public static final VulkanImageLayout VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL
```
    VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL
  - VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL
```
public static final VulkanImageLayout VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL
```
    VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL
  - VK_IMAGE_LAYOUT_PRESENT_SRC_KHR
```
public static final VulkanImageLayout VK_IMAGE_LAYOUT_PRESENT_SRC_KHR
```
    VK_IMAGE_LAYOUT_PRESENT_SRC_KHR must only be used for presenting a presentable image for display. A swapchain’s image must be transitioned to this layout before calling vkQueuePresentKHR, and must be transitioned away from this layout after calling vkAcquireNextImageKHR.
  - VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
```
public static final VulkanImageLayout VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
```
    VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR is valid only for shared presentable images, and must be used for any usage the image supports.
- Method Detail
  - values
```
public static VulkanImageLayout[] 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 (VulkanImageLayout c : VulkanImageLayout.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static VulkanImageLayout 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 VulkanEnumIntegerType
    
    Returns:
    
    The integer value of the constant

Enum VulkanImageLayout

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

VK_IMAGE_LAYOUT_UNDEFINED

VK_IMAGE_LAYOUT_GENERAL

VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL

VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL

VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL

VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL

VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL

VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL

VK_IMAGE_LAYOUT_PREINITIALIZED

VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL

VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL

VK_IMAGE_LAYOUT_PRESENT_SRC_KHR

VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR

Method Detail

values

valueOf

value