java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkImageViewCreateInfo

All Implemented Interfaces:

java.lang.AutoCloseable, NativeResource, Pointer
```
public class VkImageViewCreateInfo
extends Struct
```
Khronos Reference Page
Vulkan Specification
Valid Usage
- sType must be STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO
- pNext must be NULL
- flags must be 0
- image must be a valid VkImage handle
- viewType must be a valid VkImageViewType value
- format must be a valid VkFormat value
- components must be a valid VkComponentMapping structure
- subresourceRange must be a valid VkImageSubresourceRange structure
- If image was not created with IMAGE_CREATE_CUBE_COMPATIBLE_BIT then viewType must not be IMAGE_VIEW_TYPE_CUBE or IMAGE_VIEW_TYPE_CUBE_ARRAY
- If the image cubemap arrays feature is not enabled, viewType must not be IMAGE_VIEW_TYPE_CUBE_ARRAY
- If the ETC2 texture compression feature is not enabled, format must not be FORMAT_ETC2_R8G8B8_UNORM_BLOCK, FORMAT_ETC2_R8G8B8_SRGB_BLOCK, FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK, FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK, FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK, FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK, FORMAT_EAC_R11_UNORM_BLOCK, FORMAT_EAC_R11_SNORM_BLOCK, FORMAT_EAC_R11G11_UNORM_BLOCK, or FORMAT_EAC_R11G11_SNORM_BLOCK
- If the ASTC LDR texture compression feature is not enabled, format must not be FORMAT_ASTC_4x4_UNORM_BLOCK, FORMAT_ASTC_4x4_SRGB_BLOCK, FORMAT_ASTC_5x4_UNORM_BLOCK, FORMAT_ASTC_5x4_SRGB_BLOCK, FORMAT_ASTC_5x5_UNORM_BLOCK, FORMAT_ASTC_5x5_SRGB_BLOCK, FORMAT_ASTC_6x5_UNORM_BLOCK, FORMAT_ASTC_6x5_SRGB_BLOCK, FORMAT_ASTC_6x6_UNORM_BLOCK, FORMAT_ASTC_6x6_SRGB_BLOCK, FORMAT_ASTC_8x5_UNORM_BLOCK, FORMAT_ASTC_8x5_SRGB_BLOCK, FORMAT_ASTC_8x6_UNORM_BLOCK, FORMAT_ASTC_8x6_SRGB_BLOCK, FORMAT_ASTC_8x8_UNORM_BLOCK, FORMAT_ASTC_8x8_SRGB_BLOCK, FORMAT_ASTC_10x5_UNORM_BLOCK, FORMAT_ASTC_10x5_SRGB_BLOCK, FORMAT_ASTC_10x6_UNORM_BLOCK, FORMAT_ASTC_10x6_SRGB_BLOCK, FORMAT_ASTC_10x8_UNORM_BLOCK, FORMAT_ASTC_10x8_SRGB_BLOCK, FORMAT_ASTC_10x10_UNORM_BLOCK, FORMAT_ASTC_10x10_SRGB_BLOCK, FORMAT_ASTC_12x10_UNORM_BLOCK, FORMAT_ASTC_12x10_SRGB_BLOCK, FORMAT_ASTC_12x12_UNORM_BLOCK, or FORMAT_ASTC_12x12_SRGB_BLOCK
- If the BC texture compression feature is not enabled, format must not be FORMAT_BC1_RGB_UNORM_BLOCK, FORMAT_BC1_RGB_SRGB_BLOCK, FORMAT_BC1_RGBA_UNORM_BLOCK, FORMAT_BC1_RGBA_SRGB_BLOCK, FORMAT_BC2_UNORM_BLOCK, FORMAT_BC2_SRGB_BLOCK, FORMAT_BC3_UNORM_BLOCK, FORMAT_BC3_SRGB_BLOCK, FORMAT_BC4_UNORM_BLOCK, FORMAT_BC4_SNORM_BLOCK, FORMAT_BC5_UNORM_BLOCK, FORMAT_BC5_SNORM_BLOCK, FORMAT_BC6H_UFLOAT_BLOCK, FORMAT_BC6H_SFLOAT_BLOCK, FORMAT_BC7_UNORM_BLOCK, or FORMAT_BC7_SRGB_BLOCK
- If image was created with IMAGE_TILING_LINEAR and usage containing IMAGE_USAGE_SAMPLED_BIT, format must be supported for sampled images, as specified by the FORMAT_FEATURE_SAMPLED_IMAGE_BIT flag in VkFormatProperties::linearTilingFeatures returned by GetPhysicalDeviceFormatProperties
- If image was created with IMAGE_TILING_LINEAR and usage containing IMAGE_USAGE_STORAGE_BIT, format must be supported for storage images, as specified by the FORMAT_FEATURE_STORAGE_IMAGE_BIT flag in VkFormatProperties::linearTilingFeatures returned by GetPhysicalDeviceFormatProperties
- If image was created with IMAGE_TILING_LINEAR and usage containing IMAGE_USAGE_COLOR_ATTACHMENT_BIT, format must be supported for color attachments, as specified by the FORMAT_FEATURE_COLOR_ATTACHMENT_BIT flag in VkFormatProperties::linearTilingFeatures returned by GetPhysicalDeviceFormatProperties
- If image was created with IMAGE_TILING_LINEAR and usage containing IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, format must be supported for depth/stencil attachments, as specified by the FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT flag in VkFormatProperties::linearTilingFeatures returned by GetPhysicalDeviceFormatProperties
- If image was created with IMAGE_TILING_OPTIMAL and usage containing IMAGE_USAGE_SAMPLED_BIT, format must be supported for sampled images, as specified by the FORMAT_FEATURE_SAMPLED_IMAGE_BIT flag in VkFormatProperties::optimalTilingFeatures returned by GetPhysicalDeviceFormatProperties
- If image was created with IMAGE_TILING_OPTIMAL and usage containing IMAGE_USAGE_STORAGE_BIT, format must be supported for storage images, as specified by the FORMAT_FEATURE_STORAGE_IMAGE_BIT flag in VkFormatProperties::optimalTilingFeatures returned by GetPhysicalDeviceFormatProperties
- If image was created with IMAGE_TILING_OPTIMAL and usage containing IMAGE_USAGE_COLOR_ATTACHMENT_BIT, format must be supported for color attachments, as specified by the FORMAT_FEATURE_COLOR_ATTACHMENT_BIT flag in VkFormatProperties::optimalTilingFeatures returned by GetPhysicalDeviceFormatProperties
- If image was created with IMAGE_TILING_OPTIMAL and usage containing IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, format must be supported for depth/stencil attachments, as specified by the FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT flag in VkFormatProperties::optimalTilingFeatures returned by GetPhysicalDeviceFormatProperties
- subresourceRange must be a valid image subresource range for image
- If image was created with the IMAGE_CREATE_MUTABLE_FORMAT_BIT flag, format must be compatible with the format used to create image, as defined in Format Compatibility Classes
- If image was not created with the IMAGE_CREATE_MUTABLE_FORMAT_BIT flag, format must be identical to the format used to create image
- subResourceRange and viewType must be compatible with the image, as described in the table below
Member documentation
- sType – the type of this structure. Must be: STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO
- pNext – reserved for use by extensions
- flags – reserved for future use
- image – a VkImage on which the view will be created
- viewType – the type of the image view. One of:
  IMAGE_VIEW_TYPE_1D IMAGE_VIEW_TYPE_1D_ARRAY IMAGE_VIEW_TYPE_2D
  IMAGE_VIEW_TYPE_2D_ARRAY IMAGE_VIEW_TYPE_3D IMAGE_VIEW_TYPE_CUBE
  IMAGE_VIEW_TYPE_CUBE_ARRAY
- format – a VkFormat describing the format and type used to interpret data elements in the image
- components – a remapping of color components (or of depth or stencil components after they have been converted into color components)
- subresourceRange – selects the set of mipmap levels and array layers to be accessible to the view
Layout
```
struct VkImageViewCreateInfo {
    VkStructureType sType;
    const void * pNext;
    VkImageViewCreateFlags flags;
    VkImage image;
    VkImageViewType viewType;
    VkFormat format;
    VkComponentMapping components;
    VkImageSubresourceRange subresourceRange;
}
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkImageViewCreateInfo.Buffer
An array of VkImageViewCreateInfo structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  Pointer.Default

Field Summary

Fields
Modifier and Type Field and Description

static int SIZEOF
The struct size in bytes.
- Fields inherited from interface org.lwjgl.system.Pointer
  POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkImageViewCreateInfo(java.nio.ByteBuffer container)` Creates a `VkImageViewCreateInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VkImageViewCreateInfo`	`calloc()` Returns a new `VkImageViewCreateInfo` instance allocated with `memCalloc`.
`static VkImageViewCreateInfo.Buffer`	`calloc(int capacity)` Returns a new `VkImageViewCreateInfo.Buffer` instance allocated with `memCalloc`.
`static VkImageViewCreateInfo`	`callocStack()` Returns a new `VkImageViewCreateInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkImageViewCreateInfo.Buffer`	`callocStack(int capacity)` Returns a new `VkImageViewCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkImageViewCreateInfo.Buffer`	`callocStack(int capacity, MemoryStack stack)` Returns a new `VkImageViewCreateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkImageViewCreateInfo`	`callocStack(MemoryStack stack)` Returns a new `VkImageViewCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`VkComponentMapping`	`components()` Returns a `VkComponentMapping` view of the `components` field.
`VkImageViewCreateInfo`	`components(VkComponentMapping value)` Copies the specified `VkComponentMapping` to the `components` field.
`static VkImageViewCreateInfo`	`create()` Returns a new `VkImageViewCreateInfo` instance allocated with `BufferUtils`.
`static VkImageViewCreateInfo.Buffer`	`create(int capacity)` Returns a new `VkImageViewCreateInfo.Buffer` instance allocated with `BufferUtils`.
`static VkImageViewCreateInfo`	`create(long address)` Returns a new `VkImageViewCreateInfo` instance for the specified memory address or `null` if the address is `NULL`.
`static VkImageViewCreateInfo.Buffer`	`create(long address, int capacity)` Create a `VkImageViewCreateInfo.Buffer` instance at the specified memory.
`int`	`flags()` Returns the value of the `flags` field.
`VkImageViewCreateInfo`	`flags(int value)` Sets the specified value to the `flags` field.
`int`	`format()` Returns the value of the `format` field.
`VkImageViewCreateInfo`	`format(int value)` Sets the specified value to the `format` field.
`long`	`image()` Returns the value of the `image` field.
`VkImageViewCreateInfo`	`image(long value)` Sets the specified value to the `image` field.
`static VkImageViewCreateInfo`	`malloc()` Returns a new `VkImageViewCreateInfo` instance allocated with `memAlloc`.
`static VkImageViewCreateInfo.Buffer`	`malloc(int capacity)` Returns a new `VkImageViewCreateInfo.Buffer` instance allocated with `memAlloc`.
`static VkImageViewCreateInfo`	`mallocStack()` Returns a new `VkImageViewCreateInfo` instance allocated on the thread-local `MemoryStack`.
`static VkImageViewCreateInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VkImageViewCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkImageViewCreateInfo.Buffer`	`mallocStack(int capacity, MemoryStack stack)` Returns a new `VkImageViewCreateInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkImageViewCreateInfo`	`mallocStack(MemoryStack stack)` Returns a new `VkImageViewCreateInfo` instance allocated on the specified `MemoryStack`.
`VkImageViewCreateInfo`	`nset(long struct)` Unsafe version of `set`.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkImageViewCreateInfo`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkImageViewCreateInfo`	`set(int sType, long pNext, int flags, long image, int viewType, int format, VkComponentMapping components, VkImageSubresourceRange subresourceRange)` Initializes this struct with the specified values.
`VkImageViewCreateInfo`	`set(VkImageViewCreateInfo src)` Copies the specified struct data to this struct.
`int`	`sizeof()` Returns the `sizeof(struct)`.
`int`	`sType()` Returns the value of the `sType` field.
`VkImageViewCreateInfo`	`sType(int value)` Sets the specified value to the `sType` field.
`VkImageSubresourceRange`	`subresourceRange()` Returns a `VkImageSubresourceRange` view of the `subresourceRange` field.
`VkImageViewCreateInfo`	`subresourceRange(VkImageSubresourceRange value)` Copies the specified `VkImageSubresourceRange` to the `subresourceRange` field.
`int`	`viewType()` Returns the value of the `viewType` field.
`VkImageViewCreateInfo`	`viewType(int value)` Sets the specified value to the `viewType` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
- Constructor Detail
  - VkImageViewCreateInfo
```
public VkImageViewCreateInfo(java.nio.ByteBuffer container)
```
    Creates a VkImageViewCreateInfo instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.
    The created instance holds a strong reference to the container object.
- Method Detail
  - sizeof
```
public int sizeof()
```
    Description copied from class: Struct
    
    Returns the sizeof(struct).
    
    Specified by:
    
    sizeof in class Struct
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - flags
```
public int flags()
```
    Returns the value of the flags field.
  - image
```
public long image()
```
    Returns the value of the image field.
  - viewType
```
public int viewType()
```
    Returns the value of the viewType field.
  - format
```
public int format()
```
    Returns the value of the format field.
  - components
```
public VkComponentMapping components()
```
    Returns a VkComponentMapping view of the components field.
  - subresourceRange
```
public VkImageSubresourceRange subresourceRange()
```
    Returns a VkImageSubresourceRange view of the subresourceRange field.
  - sType
```
public VkImageViewCreateInfo sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkImageViewCreateInfo pNext(long value)
```
    Sets the specified value to the pNext field.
  - flags
```
public VkImageViewCreateInfo flags(int value)
```
    Sets the specified value to the flags field.
  - image
```
public VkImageViewCreateInfo image(long value)
```
    Sets the specified value to the image field.
  - viewType
```
public VkImageViewCreateInfo viewType(int value)
```
    Sets the specified value to the viewType field.
  - format
```
public VkImageViewCreateInfo format(int value)
```
    Sets the specified value to the format field.
  - components
```
public VkImageViewCreateInfo components(VkComponentMapping value)
```
    Copies the specified VkComponentMapping to the components field.
  - subresourceRange
```
public VkImageViewCreateInfo subresourceRange(VkImageSubresourceRange value)
```
    Copies the specified VkImageSubresourceRange to the subresourceRange field.
  - set
```
public VkImageViewCreateInfo set(int sType,
                                 long pNext,
                                 int flags,
                                 long image,
                                 int viewType,
                                 int format,
                                 VkComponentMapping components,
                                 VkImageSubresourceRange subresourceRange)
```
    Initializes this struct with the specified values.
  - nset
```
public VkImageViewCreateInfo nset(long struct)
```
    Unsafe version of set.
  - set
```
public VkImageViewCreateInfo set(VkImageViewCreateInfo src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkImageViewCreateInfo malloc()
```
    Returns a new VkImageViewCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkImageViewCreateInfo calloc()
```
    Returns a new VkImageViewCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkImageViewCreateInfo create()
```
    Returns a new VkImageViewCreateInfo instance allocated with BufferUtils.
  - create
```
public static VkImageViewCreateInfo create(long address)
```
    Returns a new VkImageViewCreateInfo instance for the specified memory address or null if the address is NULL.
  - malloc
```
public static VkImageViewCreateInfo.Buffer malloc(int capacity)
```
    Returns a new VkImageViewCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkImageViewCreateInfo.Buffer calloc(int capacity)
```
    Returns a new VkImageViewCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkImageViewCreateInfo.Buffer create(int capacity)
```
    Returns a new VkImageViewCreateInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkImageViewCreateInfo.Buffer create(long address,
                                                  int capacity)
```
    Create a VkImageViewCreateInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkImageViewCreateInfo mallocStack()
```
    Returns a new VkImageViewCreateInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkImageViewCreateInfo callocStack()
```
    Returns a new VkImageViewCreateInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkImageViewCreateInfo mallocStack(MemoryStack stack)
```
    Returns a new VkImageViewCreateInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkImageViewCreateInfo callocStack(MemoryStack stack)
```
    Returns a new VkImageViewCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkImageViewCreateInfo.Buffer mallocStack(int capacity)
```
    Returns a new VkImageViewCreateInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkImageViewCreateInfo.Buffer callocStack(int capacity)
```
    Returns a new VkImageViewCreateInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkImageViewCreateInfo.Buffer mallocStack(int capacity,
                                                       MemoryStack stack)
```
    Returns a new VkImageViewCreateInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkImageViewCreateInfo.Buffer callocStack(int capacity,
                                                       MemoryStack stack)
```
    Returns a new VkImageViewCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity

`IMAGE_VIEW_TYPE_1D`	`IMAGE_VIEW_TYPE_1D_ARRAY`	`IMAGE_VIEW_TYPE_2D`
`IMAGE_VIEW_TYPE_2D_ARRAY`	`IMAGE_VIEW_TYPE_3D`	`IMAGE_VIEW_TYPE_CUBE`
`IMAGE_VIEW_TYPE_CUBE_ARRAY`

Class VkImageViewCreateInfo

Valid Usage

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

Constructor Detail

VkImageViewCreateInfo

Method Detail

sizeof

sType

pNext

flags

image

viewType

format

components

subresourceRange

sType

pNext

flags

image

viewType

format

components

subresourceRange

set

nset

set

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack