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
implements NativeResource

Structure specifying parameters of a newly created image view.

Description

If image was created with the IMAGE_CREATE_MUTABLE_FORMAT_BIT flag, and if the format of the image is not multi-planar, format can be different from the image's format, but if image was created without the IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT flag and they are not equal they must be compatible. Image format compatibility is defined in the Format Compatibility Classes section. Views of compatible formats will have the same mapping between texel coordinates and memory locations irrespective of the format, with only the interpretation of the bit pattern changing.

Note

Values intended to be used with one view format may not be exactly preserved when written or read through a different format. For example, an integer value that happens to have the bit pattern of a floating point denorm or NaN may be flushed or canonicalized when written or read through a view with a floating point format. Similarly, a value written through a signed normalized format that has a bit pattern exactly equal to -2^b may be changed to -2^b + 1 as described in Conversion from Normalized Fixed-Point to Floating-Point.

If image was created with the IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT flag, format must be compatible with the image's format as described above, or must be an uncompressed format in which case it must be size-compatible with the image's format, as defined for copying data between images In this case the resulting image view's texel dimensions equal the dimensions of the selected mip level divided by the compressed texel block size and rounded up.

If the image view is to be used with a sampler which supports sampler Y'C_BC_R conversion, an identically defined object of type VkSamplerYcbcrConversion to that used to create the sampler must be passed to CreateImageView in a VkSamplerYcbcrConversionInfo added to the pNext chain of VkImageViewCreateInfo.

If the image has a multi-planar format and subresourceRange.aspectMask is IMAGE_ASPECT_COLOR_BIT, format must be identical to the image format, and the sampler to be used with the image view must enable sampler Y'C_BC_R conversion.

If image was created with the IMAGE_CREATE_MUTABLE_FORMAT_BIT and the image has a multi-planar format, and if subresourceRange.aspectMask is IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT, or IMAGE_ASPECT_PLANE_2_BIT, format must be compatible with the corresponding plane of the image, and the sampler to be used with the image view must not enable sampler Y'C_BC_R conversion. The width and height of the single-plane image view must be derived from the multi-planar image's dimensions in the manner listed for plane compatibility for the plane.

Any view of an image plane will have the same mapping between texel coordinates and memory locations as used by the channels of the color aspect, subject to the formulae relating texel coordinates to lower-resolution planes as described in Chroma Reconstruction. That is, if an R or B plane has a reduced resolution relative to the G plane of the multi-planar image, the image view operates using the (u_plane, v_plane) unnormalized coordinates of the reduced-resolution plane, and these coordinates access the same memory locations as the (u_color, v_color) unnormalized coordinates of the color aspect for which chroma reconstruction operations operate on the same (u_plane, v_plane) or (i_plane, j_plane) coordinates.

Image and image view parameter compatibility requirements

Dim, Arrayed, MS	Image parameters	View parameters
	`imageType` = ci.`imageType` `width` = ci.`extent.width` `height` = ci.`extent.height` `depth` = ci.`extent.depth` `arrayLayers` = ci.`arrayLayers` `samples` = ci.`samples` `flags` = ci.`flags` where ci is the `VkImageCreateInfo` used to create `image`.	`baseArrayLayer`, `layerCount`, and `levelCount` are members of the `subresourceRange` member.
1D, 0, 0	`imageType` = `IMAGE_TYPE_1D` `width` ≥ 1 `height` = 1 `depth` = 1 `arrayLayers` ≥ 1 `samples` = 1	`viewType` = `IMAGE_VIEW_TYPE_1D` `baseArrayLayer` ≥ 0 `layerCount` = 1
1D, 1, 0	`imageType` = `IMAGE_TYPE_1D` `width` ≥ 1 `height` = 1 `depth` = 1 `arrayLayers` ≥ 1 `samples` = 1	`viewType` = `IMAGE_VIEW_TYPE_1D_ARRAY` `baseArrayLayer` ≥ 0 `layerCount` ≥ 1
2D, 0, 0	`imageType` = `IMAGE_TYPE_2D` `width` ≥ 1 `height` ≥ 1 `depth` = 1 `arrayLayers` ≥ 1 `samples` = 1	`viewType` = `IMAGE_VIEW_TYPE_2D` `baseArrayLayer` ≥ 0 `layerCount` = 1
2D, 1, 0	`imageType` = `IMAGE_TYPE_2D` `width` ≥ 1 `height` ≥ 1 `depth` = 1 `arrayLayers` ≥ 1 `samples` = 1	`viewType` = `IMAGE_VIEW_TYPE_2D_ARRAY` `baseArrayLayer` ≥ 0 `layerCount` ≥ 1
2D, 0, 1	`imageType` = `IMAGE_TYPE_2D` `width` ≥ 1 `height` ≥ 1 `depth` = 1 `arrayLayers` ≥ 1 `samples` > 1	`viewType` = `IMAGE_VIEW_TYPE_2D` `baseArrayLayer` ≥ 0 `layerCount` = 1
2D, 1, 1	`imageType` = `IMAGE_TYPE_2D` `width` ≥ 1 `height` ≥ 1 `depth` = 1 `arrayLayers` ≥ 1 `samples` > 1	`viewType` = `IMAGE_VIEW_TYPE_2D_ARRAY` `baseArrayLayer` ≥ 0 `layerCount` ≥ 1
CUBE, 0, 0	`imageType` = `IMAGE_TYPE_2D` `width` ≥ 1 `height` = `width` `depth` = 1 `arrayLayers` ≥ 6 `samples` = 1 `flags` includes `IMAGE_CREATE_CUBE_COMPATIBLE_BIT`	`viewType` = `IMAGE_VIEW_TYPE_CUBE` `baseArrayLayer` ≥ 0 `layerCount` = 6
CUBE, 1, 0	`imageType` = `IMAGE_TYPE_2D` `width` ≥ 1 `height` = width `depth` = 1 N ≥ 1 `arrayLayers` ≥ 6 × N `samples` = 1 `flags` includes `IMAGE_CREATE_CUBE_COMPATIBLE_BIT`	`viewType` = `IMAGE_VIEW_TYPE_CUBE_ARRAY` `baseArrayLayer` ≥ 0 `layerCount` = 6 × N, N ≥ 1
3D, 0, 0	`imageType` = `IMAGE_TYPE_3D` `width` ≥ 1 `height` ≥ 1 `depth` ≥ 1 `arrayLayers` = 1 `samples` = 1	`viewType` = `IMAGE_VIEW_TYPE_3D` `baseArrayLayer` = 0 `layerCount` = 1
3D, 0, 0	`imageType` = `IMAGE_TYPE_3D` `width` ≥ 1 `height` ≥ 1 `depth` ≥ 1 `arrayLayers` = 1 `samples` = 1 `flags` includes `IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR` `flags` does not include `IMAGE_CREATE_SPARSE_BINDING_BIT`, `IMAGE_CREATE_SPARSE_RESIDENCY_BIT`, and `IMAGE_CREATE_SPARSE_ALIASED_BIT`	`viewType` = `IMAGE_VIEW_TYPE_2D` `levelCount` = 1 `baseArrayLayer` ≥ 0 `layerCount` = 1
3D, 0, 0	`imageType` = `IMAGE_TYPE_3D` `width` ≥ 1 `height` ≥ 1 `depth` ≥ 1 `arrayLayers` = 1 `samples` = 1 `flags` includes `IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR` `flags` does not include `IMAGE_CREATE_SPARSE_BINDING_BIT`, `IMAGE_CREATE_SPARSE_RESIDENCY_BIT`, and `IMAGE_CREATE_SPARSE_ALIASED_BIT`	`viewType` = `IMAGE_VIEW_TYPE_2D_ARRAY` `levelCount` = 1 `baseArrayLayer` ≥ 0 `layerCount` ≥ 1

Valid Usage

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 image was created with IMAGE_TYPE_3D but without IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT set then viewType must not be IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY
image must have been created with a usage value containing at least one of IMAGE_USAGE_SAMPLED_BIT, IMAGE_USAGE_STORAGE_BIT, IMAGE_USAGE_COLOR_ATTACHMENT_BIT, IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, IMAGE_USAGE_INPUT_ATTACHMENT_BIT, or IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV
The format features of the resultant image view must contain at least one bit.
If usage contains IMAGE_USAGE_SAMPLED_BIT, then the format features of the resultant image view must contain FORMAT_FEATURE_SAMPLED_IMAGE_BIT.
If usage contains IMAGE_USAGE_STORAGE_BIT, then the image view’s format features must contain FORMAT_FEATURE_STORAGE_IMAGE_BIT.
If usage contains IMAGE_USAGE_COLOR_ATTACHMENT_BIT, then the image view’s format features must contain FORMAT_FEATURE_COLOR_ATTACHMENT_BIT.
If usage contains IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, then the image view’s format features must contain FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.
subresourceRange.baseMipLevel must be less than the mipLevels specified in VkImageCreateInfo when image was created
If subresourceRange.levelCount is not REMAINING_MIP_LEVELS, subresourceRange.baseMipLevel + subresourceRange.levelCount must be less than or equal to the mipLevels specified in VkImageCreateInfo when image was created
If image is not a 3D image created with IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT set, or viewType is not IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY, subresourceRange::baseArrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when image was created
If subresourceRange::layerCount is not REMAINING_ARRAY_LAYERS, image is not a 3D image created with IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT set, or viewType is not IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY, subresourceRange::layerCount must be non-zero and subresourceRange::baseArrayLayer subresourceRange::layerCount must be less than or equal to the arrayLayers specified in VkImageCreateInfo when image was created
If image is a 3D image created with IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT set, and viewType is IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY, subresourceRange::baseArrayLayer must be less than the extent.depth specified in VkImageCreateInfo when image was created
If subresourceRange::layerCount is not REMAINING_ARRAY_LAYERS, image is a 3D image created with IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT set, and viewType is IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY, subresourceRange::layerCount must be non-zero and subresourceRange::baseArrayLayer subresourceRange::layerCount must be less than or equal to the extent.depth specified in VkImageCreateInfo when image was created
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 created with the IMAGE_CREATE_MUTABLE_FORMAT_BIT flag, but without the IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT flag, and if the format of the image is not a multi-planar format, format must be compatible with the format used to create image, as defined in Format Compatibility Classes
If image was created with the IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT flag, format must be compatible with, or must be an uncompressed format that is size-compatible with, the format used to create image.
If image was created with the IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT flag, the levelCount and layerCount members of subresourceRange must both be 1.
If a VkImageFormatListCreateInfoKHR structure was included in the pNext chain of the VkImageCreateInfo struct used when creating image and the viewFormatCount field of VkImageFormatListCreateInfoKHR is not zero then format must be one of the formats in VkImageFormatListCreateInfoKHR::pViewFormats.
If image was created with the IMAGE_CREATE_MUTABLE_FORMAT_BIT flag, if the format of the image is a multi-planar format, and if subresourceRange.aspectMask is one of IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT, or IMAGE_ASPECT_PLANE_2_BIT, then format must be compatible with the VkFormat for the plane of the image format indicated by subresourceRange.aspectMask, as defined in the “Compatible formats of planes of multi-planar formats” section
If image was not created with the IMAGE_CREATE_MUTABLE_FORMAT_BIT flag, or if the format of the image is a multi-planar format and if subresourceRange.aspectMask is IMAGE_ASPECT_COLOR_BIT, format must be identical to the format used to create image
If the pNext chain contains an instance of VkSamplerYcbcrConversionInfo with a conversion value other than NULL_HANDLE, all members of components must have the value COMPONENT_SWIZZLE_IDENTITY.
If image is non-sparse then it must be bound completely and contiguously to a single VkDeviceMemory object
subresourceRange and viewType must be compatible with the image, as described in the compatibility table
If image was created with usage containing IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY
If image was created with usage containing IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be FORMAT_R8_UINT

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO
Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkImageViewASTCDecodeModeEXT, VkImageViewUsageCreateInfo, or VkSamplerYcbcrConversionInfo
Each sType member in the pNext chain must be unique
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

Member documentation

sType – the type of this structure.
pNext – NULL or a pointer to an extension-specific structure.
flags – reserved for future use.
image – a VkImage on which the view will be created.
viewType – a VkImageViewType value specifying the type of the image view.
format – a VkFormat describing the format and type used to interpret data elements in the image.
components – a VkComponentMapping specifies a remapping of color components (or of depth or stencil components after they have been converted into color components).
subresourceRange – a VkImageSubresourceRange selecting the set of mipmap levels and array layers to be accessible to the view.

Layout


 struct VkImageViewCreateInfo {
     VkStructureType sType;
     void const * pNext;
     VkImageViewCreateFlags flags;
     VkImage image;
     VkImageViewType viewType;
     VkFormat format;
     VkComponentMapping components;
     VkImageSubresourceRange subresourceRange;
 }

Nested Class Summary

Nested Classes
Modifier and Type Class 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	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`COMPONENTS FLAGS FORMAT IMAGE PNEXT`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`STYPE SUBRESOURCERANGE VIEWTYPE`	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor	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	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(java.util.function.Consumer<VkComponentMapping> consumer)`	Passes the `components` field to the specified `Consumer`.
`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.
`static VkImageViewCreateInfo.Buffer`	`create(long address, int capacity)`	Create a `VkImageViewCreateInfo.Buffer` instance at the specified memory.
`static VkImageViewCreateInfo`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkImageViewCreateInfo.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`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`.
`static VkComponentMapping`	`ncomponents(long struct)`	Unsafe version of `components()`.
`static void`	`ncomponents(long struct, VkComponentMapping value)`	Unsafe version of `components`.
`static int`	`nflags(long struct)`	Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)`	Unsafe version of `flags`.
`static int`	`nformat(long struct)`	Unsafe version of `format()`.
`static void`	`nformat(long struct, int value)`	Unsafe version of `format`.
`static long`	`nimage(long struct)`	Unsafe version of `image()`.
`static void`	`nimage(long struct, long value)`	Unsafe version of `image`.
`static long`	`npNext(long struct)`	Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)`	Unsafe version of `pNext`.
`static int`	`nsType(long struct)`	Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)`	Unsafe version of `sType`.
`static VkImageSubresourceRange`	`nsubresourceRange(long struct)`	Unsafe version of `subresourceRange()`.
`static void`	`nsubresourceRange(long struct, VkImageSubresourceRange value)`	Unsafe version of `subresourceRange`.
`static int`	`nviewType(long struct)`	Unsafe version of `viewType()`.
`static void`	`nviewType(long struct, int value)`	Unsafe version of `viewType`.
`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 `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(java.util.function.Consumer<VkImageSubresourceRange> consumer)`	Passes the `subresourceRange` field to the specified `Consumer`.
`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 interface org.lwjgl.system.NativeResource
close, free

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

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

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

- Field Detail
  - SIZEOF
    
    The struct size in bytes.
  - ALIGNOF
    
    The struct alignment in bytes.
  - STYPE, PNEXT, FLAGS, IMAGE, VIEWTYPE, FORMAT, COMPONENTS, SUBRESOURCERANGE
    
    The struct member offsets.
- 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 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.
  - components
```
public VkImageViewCreateInfo components(java.util.function.Consumer<VkComponentMapping> consumer)
```
    Passes the components field to the specified Consumer.
  - subresourceRange
```
public VkImageSubresourceRange subresourceRange()
```
    Returns a VkImageSubresourceRange view of the subresourceRange field.
  - subresourceRange
```
public VkImageViewCreateInfo subresourceRange(java.util.function.Consumer<VkImageSubresourceRange> consumer)
```
    Passes the subresourceRange field to the specified Consumer.
  - 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.
  - 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.
  - createSafe
```
@Nullable
public static VkImageViewCreateInfo createSafe(long address)
```
    Like create, but returns null if 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
  - createSafe
```
@Nullable
public static VkImageViewCreateInfo.Buffer createSafe(long address,
                                                      int capacity)
```
    Like create, but returns null if address is NULL.
  - 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
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - nflags
```
public static int nflags(long struct)
```
    Unsafe version of flags().
  - nimage
```
public static long nimage(long struct)
```
    Unsafe version of image().
  - nviewType
```
public static int nviewType(long struct)
```
    Unsafe version of viewType().
  - nformat
```
public static int nformat(long struct)
```
    Unsafe version of format().
  - ncomponents
```
public static VkComponentMapping ncomponents(long struct)
```
    Unsafe version of components().
  - nsubresourceRange
```
public static VkImageSubresourceRange nsubresourceRange(long struct)
```
    Unsafe version of subresourceRange().
  - nsType
```
public static void nsType(long struct,
                          int value)
```
    Unsafe version of sType.
  - npNext
```
public static void npNext(long struct,
                          long value)
```
    Unsafe version of pNext.
  - nflags
```
public static void nflags(long struct,
                          int value)
```
    Unsafe version of flags.
  - nimage
```
public static void nimage(long struct,
                          long value)
```
    Unsafe version of image.
  - nviewType
```
public static void nviewType(long struct,
                             int value)
```
    Unsafe version of viewType.
  - nformat
```
public static void nformat(long struct,
                           int value)
```
    Unsafe version of format.
  - ncomponents
```
public static void ncomponents(long struct,
                               VkComponentMapping value)
```
    Unsafe version of components.
  - nsubresourceRange
```
public static void nsubresourceRange(long struct,
                                     VkImageSubresourceRange value)
```
    Unsafe version of subresourceRange.

Class VkImageViewCreateInfo

Description

Note

Image and image view parameter compatibility requirements

Valid Usage

Valid Usage (Implicit)

See Also

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 interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

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

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

STYPE, PNEXT, FLAGS, IMAGE, VIEWTYPE, FORMAT, COMPONENTS, SUBRESOURCERANGE

Constructor Detail

VkImageViewCreateInfo

Method Detail

sizeof

sType

pNext

flags

image

viewType

format

components

components

subresourceRange

subresourceRange

sType

pNext

flags

image

viewType

format

components

subresourceRange

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nflags

nimage

nviewType

nformat

ncomponents

nsubresourceRange

nsType

npNext

nflags

nimage

nviewType

nformat

ncomponents