Package org.lwjgl.vulkan

Class VkImageViewCreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct

org.lwjgl.vulkan.VkImageViewCreateInfo

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkImageViewCreateInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource

Structure specifying parameters of a newly created image view.

Description

Some of the image creation parameters are inherited by the view. In particular, image view creation inherits the implicit parameter usage specifying the allowed usages of the image view that, by default, takes the value of the corresponding usage parameter specified in VkImageCreateInfo at image creation time. The implicit usage can be overriden by adding a VkImageViewUsageCreateInfo structure to the pNext chain, but the view usage must be a subset of the image usage. If image has a depth-stencil format and was created with a VkImageStencilUsageCreateInfo structure included in the pNext chain of VkImageCreateInfo, the usage is calculated based on the subresource.aspectMask provided:

• If aspectMask includes only IMAGE_ASPECT_STENCIL_BIT, the implicit usage is equal to VkImageStencilUsageCreateInfo::stencilUsage.
• If aspectMask includes only IMAGE_ASPECT_DEPTH_BIT, the implicit usage is equal to VkImageCreateInfo::usage.
• If both aspects are included in aspectMask, the implicit usage is equal to the intersection of VkImageCreateInfo::usage and VkImageStencilUsageCreateInfo::stencilUsage.

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 -2b may be changed to -2b + 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.

The VkComponentMapping components member describes a remapping from components of the image to components of the vector returned by shader image instructions. This remapping must be the identity swizzle for storage image descriptors, input attachment descriptors, framebuffer attachments, and any VkImageView used with a combined image sampler that enables sampler Y’C_BC_R conversion.

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 included in the pNext chain of VkImageViewCreateInfo. Conversely, if a VkSamplerYcbcrConversion object is passed to CreateImageView, an identically defined VkSamplerYcbcrConversion object must be used when sampling the image.

If the image has a multi-planar format and subresourceRange.aspectMask is IMAGE_ASPECT_COLOR_BIT, and image has been created with a usage value not containing any of the IMAGE_USAGE_VIDEO_DECODE_DST_BIT_KHR, IMAGE_USAGE_VIDEO_DECODE_SRC_BIT_KHR, IMAGE_USAGE_VIDEO_DECODE_DPB_BIT_KHR, IMAGE_USAGE_VIDEO_ENCODE_DST_BIT_KHR, IMAGE_USAGE_VIDEO_ENCODE_SRC_BIT_KHR, and IMAGE_USAGE_VIDEO_ENCODE_DPB_BIT_KHR flags, then the 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 the image has a multi-planar format and the image has been created with a usage value containing any of the IMAGE_USAGE_VIDEO_DECODE_DST_BIT_KHR, IMAGE_USAGE_VIDEO_DECODE_SRC_BIT_KHR, and IMAGE_USAGE_VIDEO_DECODE_DPB_BIT_KHR flags, then all of the video decode operations would ignore the VkSamplerYcbcrConversionInfo structure and/or sampler Y’C_BC_R conversion object, associated with the image view. If the image has a multi-planar format and the image has been created with a usage value containing any of the IMAGE_USAGE_VIDEO_ENCODE_DST_BIT_KHR, IMAGE_USAGE_VIDEO_ENCODE_SRC_BIT_KHR, and IMAGE_USAGE_VIDEO_ENCODE_DPB_BIT_KHR flags, then all of the video encode operations would ignore the VkSamplerYcbcrConversionInfo structure and/or sampler Y’C_BC_R conversion object, associated with the image view.

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 components 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 type and image view type compatibility requirements

Image View Type	Compatible Image Types
IMAGE_VIEW_TYPE_1D	IMAGE_TYPE_1D
IMAGE_VIEW_TYPE_1D_ARRAY	IMAGE_TYPE_1D
IMAGE_VIEW_TYPE_2D	IMAGE_TYPE_2D , IMAGE_TYPE_3D
IMAGE_VIEW_TYPE_2D_ARRAY	IMAGE_TYPE_2D , IMAGE_TYPE_3D
IMAGE_VIEW_TYPE_CUBE	IMAGE_TYPE_2D
IMAGE_VIEW_TYPE_CUBE_ARRAY	IMAGE_TYPE_2D
IMAGE_VIEW_TYPE_3D	IMAGE_TYPE_3D

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 cube map 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
• If image was created with IMAGE_TYPE_3D and viewType is IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY then subresourceRange.levelCount must be 1
• If image was created with IMAGE_TYPE_3D and viewType is IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY then VkImageCreateInfo::flags must not contain any of IMAGE_CREATE_SPARSE_BINDING_BIT, IMAGE_CREATE_SPARSE_RESIDENCY_BIT, and IMAGE_CREATE_SPARSE_ALIASED_BIT
• If image was created with a samples value not equal to SAMPLE_COUNT_1_BIT then viewType must be either IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY
• image must have been created with a usage value containing at least one of the usages defined in the valid image usage list for image views
• 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
• If usage contains IMAGE_USAGE_COLOR_ATTACHMENT_BIT, then the image view’s format features must contain FORMAT_FEATURE_2_LINEAR_COLOR_ATTACHMENT_BIT_NV, if the image is created with IMAGE_TILING_LINEAR and the linearColorAttachment feature is enabled
• If usage contains IMAGE_USAGE_INPUT_ATTACHMENT_BIT, then the image view’s format features must contain FORMAT_FEATURE_2_LINEAR_COLOR_ATTACHMENT_BIT_NV, if the image is created with IMAGE_TILING_LINEAR and the linearColorAttachment feature is enabled
• If usage contains IMAGE_USAGE_INPUT_ATTACHMENT_BIT, then the image view’s format features must contain at least one of FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or 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 was created with usage containing IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount must be 1
• 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 depth computed from baseMipLevel and extent.depth specified in VkImageCreateInfo when image was created, according to the formula defined in Image Miplevel Sizing
• 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 depth computed from baseMipLevel and extent.depth specified in VkImageCreateInfo when image was created, according to the formula defined in Image Miplevel Sizing
• 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 image was created with the IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT flag and format is a non-compressed format, viewType must not be IMAGE_VIEW_TYPE_3D
• If a VkImageFormatListCreateInfo structure was included in the pNext chain of the VkImageCreateInfo structure used when creating image and VkImageFormatListCreateInfo::viewFormatCount is not zero then format must be one of the formats in VkImageFormatListCreateInfo::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 Compatible formats of planes of multi-planar formats
• 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 image format is one of the formats that require a sampler Y’C_BC_R conversion, then the pNext chain must include a VkSamplerYcbcrConversionInfo structure with a conversion value other than NULL_HANDLE
• If format has a _422 or _420 suffix then image must have been created with a width that is a multiple of 2
• If format has a _420 suffix then image must have been created with a height that is a multiple of 2
• If the pNext chain includes a VkSamplerYcbcrConversionInfo structure with a conversion value other than NULL_HANDLE, all members of components must have the identity swizzle
• If image is non-sparse then it must be bound completely and contiguously to a single VkDeviceMemory object
• viewType must be compatible with the type of image as shown in the view type compatibility table
• If image was created with usage containing IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY
• If the shadingRateImage feature is enabled, and If image was created with usage containing IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be FORMAT_R8_UINT
• If the attachmentFragmentShadingRate feature is enabled, and the usage for the image view includes IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, then the image view’s format features must contain FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR
• If the attachmentFragmentShadingRate feature is enabled, the usage for the image view includes IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, and layeredShadingRateAttachments is FALSE, subresourceRange.layerCount must be 1
• If dynamic fragment density map feature is not enabled, flags must not contain IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT
• If deferred fragment density map feature is not enabled, flags must not contain IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT
• If flags contains IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, flags must not contain IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT
• If image was created with flags containing IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing IMAGE_USAGE_SAMPLED_BIT, subresourceRange.layerCount must be less than or equal to VkPhysicalDeviceFragmentDensityMap2PropertiesEXT::maxSubsampledArrayLayers
• If the invocationMask feature is enabled, and if image was created with usage containing IMAGE_USAGE_INVOCATION_MASK_BIT_HUAWEI, format must be FORMAT_R8_UINT
• If flags does not contain IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT and image was created with usage containing IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, its flags must not contain any of IMAGE_CREATE_PROTECTED_BIT, IMAGE_CREATE_SPARSE_BINDING_BIT, IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or IMAGE_CREATE_SPARSE_ALIASED_BIT
• If the pNext chain includes a VkImageViewUsageCreateInfo structure, and image was not created with a VkImageStencilUsageCreateInfo structure included in the pNext chain of VkImageCreateInfo, its usage member must not include any bits that were not set in the usage member of the VkImageCreateInfo structure used to create image
• If the pNext chain includes a VkImageViewUsageCreateInfo structure, image was created with a VkImageStencilUsageCreateInfo structure included in the pNext chain of VkImageCreateInfo, and subresourceRange.aspectMask includes IMAGE_ASPECT_STENCIL_BIT, the usage member of the VkImageViewUsageCreateInfo structure must not include any bits that were not set in the usage member of the VkImageStencilUsageCreateInfo structure used to create image
• If the pNext chain includes a VkImageViewUsageCreateInfo structure, image was created with a VkImageStencilUsageCreateInfo structure included in the pNext chain of VkImageCreateInfo, and subresourceRange.aspectMask includes bits other than IMAGE_ASPECT_STENCIL_BIT, the usage member of the VkImageViewUsageCreateInfo structure must not include any bits that were not set in the usage member of the VkImageCreateInfo structure used to create image
• If viewType is IMAGE_VIEW_TYPE_1D, IMAGE_VIEW_TYPE_2D, or IMAGE_VIEW_TYPE_3D; and subresourceRange.layerCount is not REMAINING_ARRAY_LAYERS, then subresourceRange.layerCount must be 1
• If viewType is IMAGE_VIEW_TYPE_1D, IMAGE_VIEW_TYPE_2D, or IMAGE_VIEW_TYPE_3D; and subresourceRange.layerCount is REMAINING_ARRAY_LAYERS, then the remaining number of layers must be 1
• If viewType is IMAGE_VIEW_TYPE_CUBE and subresourceRange.layerCount is not REMAINING_ARRAY_LAYERS, subresourceRange.layerCount must be 6
• If viewType is IMAGE_VIEW_TYPE_CUBE_ARRAY and subresourceRange.layerCount is not REMAINING_ARRAY_LAYERS, subresourceRange.layerCount must be a multiple of 6
• If viewType is IMAGE_VIEW_TYPE_CUBE and subresourceRange.layerCount is REMAINING_ARRAY_LAYERS, the remaining number of layers must be 6
• If viewType is IMAGE_VIEW_TYPE_CUBE_ARRAY and subresourceRange.layerCount is REMAINING_ARRAY_LAYERS, the remaining number of layers must be a multiple of 6
• If the VK_KHR_portability_subset extension is enabled, and VkPhysicalDevicePortabilitySubsetFeaturesKHR::imageViewFormatSwizzle is FALSE, all elements of components must have the identity swizzle
• If the VK_KHR_portability_subset extension is enabled, and VkPhysicalDevicePortabilitySubsetFeaturesKHR::imageViewFormatReinterpretation is FALSE, the VkFormat in format must not contain a different number of components, or a different number of bits in each component, than the format of the VkImage in image
• If image was created with usage containing IMAGE_USAGE_VIDEO_DECODE_DST_BIT_KHR, IMAGE_USAGE_VIDEO_DECODE_SRC_BIT_KHR, IMAGE_USAGE_VIDEO_DECODE_DPB_BIT_KHR, then the viewType must be IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY and all members of components must have the identity swizzle
• If image was created with usage containing IMAGE_USAGE_VIDEO_ENCODE_DST_BIT_KHR, IMAGE_USAGE_VIDEO_ENCODE_SRC_BIT_KHR, IMAGE_USAGE_VIDEO_ENCODE_DPB_BIT_KHR, then the viewType must be IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY and all members of components must have the identity swizzle

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, VkImageViewMinLodCreateInfoEXT, VkImageViewUsageCreateInfo, VkSamplerYcbcrConversionInfo, VkVideoDecodeH264ProfileEXT, VkVideoDecodeH265ProfileEXT, VkVideoEncodeH264ProfileEXT, VkVideoEncodeH265ProfileEXT, VkVideoProfileKHR, or VkVideoProfilesKHR
• The sType value of each struct in the pNext chain must be unique
• flags must be a valid combination of VkImageViewCreateFlagBits values
• 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

See Also

VkComponentMapping, VkImageSubresourceRange, CreateImageView

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

org.lwjgl.system.Pointer.Default

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

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, CLONG_SHIFT, CLONG_SIZE, 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

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.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImageViewCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageViewCreateInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImageViewCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageViewCreateInfo	callocStack()	Deprecated.
static VkImageViewCreateInfo.Buffer	callocStack(int capacity)	Deprecated.
static VkImageViewCreateInfo.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkImageViewCreateInfo	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
VkComponentMapping	components()	a VkComponentMapping structure specifying a remapping of color components (or of depth or stencil components after they have been converted into color components).
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()	a bitmask of VkImageViewCreateFlagBits describing additional parameters of the image view.
VkImageViewCreateInfo	flags(int value)	Sets the specified value to the flags() field.
int	format()	a VkFormat describing the format and type used to interpret texel blocks in the image.
VkImageViewCreateInfo	format(int value)	Sets the specified value to the format() field.
long	image()	a VkImage on which the view will be created.
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.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImageViewCreateInfo.Buffer instance allocated on the specified MemoryStack.
static VkImageViewCreateInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImageViewCreateInfo instance allocated on the specified MemoryStack.
static VkImageViewCreateInfo	mallocStack()	Deprecated.
static VkImageViewCreateInfo.Buffer	mallocStack(int capacity)	Deprecated.
static VkImageViewCreateInfo.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkImageViewCreateInfo	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
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()	NULL or a pointer to a structure extending this structure.
VkImageViewCreateInfo	pNext(long value)	Sets the specified value to the pNext() field.
VkImageViewCreateInfo	pNext(VkImageViewASTCDecodeModeEXT value)	Prepends the specified VkImageViewASTCDecodeModeEXT value to the pNext chain.
VkImageViewCreateInfo	pNext(VkImageViewMinLodCreateInfoEXT value)	Prepends the specified VkImageViewMinLodCreateInfoEXT value to the pNext chain.
VkImageViewCreateInfo	pNext(VkImageViewUsageCreateInfo value)	Prepends the specified VkImageViewUsageCreateInfo value to the pNext chain.
VkImageViewCreateInfo	pNext(VkImageViewUsageCreateInfoKHR value)	Prepends the specified VkImageViewUsageCreateInfoKHR value to the pNext chain.
VkImageViewCreateInfo	pNext(VkSamplerYcbcrConversionInfo value)	Prepends the specified VkSamplerYcbcrConversionInfo value to the pNext chain.
VkImageViewCreateInfo	pNext(VkSamplerYcbcrConversionInfoKHR value)	Prepends the specified VkSamplerYcbcrConversionInfoKHR value to the pNext chain.
VkImageViewCreateInfo	pNext(VkVideoDecodeH264ProfileEXT value)	Prepends the specified VkVideoDecodeH264ProfileEXT value to the pNext chain.
VkImageViewCreateInfo	pNext(VkVideoDecodeH265ProfileEXT value)	Prepends the specified VkVideoDecodeH265ProfileEXT value to the pNext chain.
VkImageViewCreateInfo	pNext(VkVideoEncodeH264ProfileEXT value)	Prepends the specified VkVideoEncodeH264ProfileEXT value to the pNext chain.
VkImageViewCreateInfo	pNext(VkVideoEncodeH265ProfileEXT value)	Prepends the specified VkVideoEncodeH265ProfileEXT value to the pNext chain.
VkImageViewCreateInfo	pNext(VkVideoProfileKHR value)	Prepends the specified VkVideoProfileKHR value to the pNext chain.
VkImageViewCreateInfo	pNext(VkVideoProfilesKHR value)	Prepends the specified VkVideoProfilesKHR value to the pNext chain.
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()
int	sType()	the type of this structure.
VkImageViewCreateInfo	sType(int value)	Sets the specified value to the sType() field.
VkImageViewCreateInfo	sType$Default()	Sets the STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO value to the sType() field.
VkImageSubresourceRange	subresourceRange()	a VkImageSubresourceRange structure selecting the set of mipmap levels and array layers to be accessible to the view.
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()	a VkImageViewType value specifying the type of the image view.
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, validate

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()

Specified by:

sizeof in class org.lwjgl.system.Struct

sType

public int sType()

the type of this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

flags

public int flags()

a bitmask of VkImageViewCreateFlagBits describing additional parameters of the image view.

image

public long image()

a VkImage on which the view will be created.

viewType

public int viewType()

a VkImageViewType value specifying the type of the image view.

format

public int format()

a VkFormat describing the format and type used to interpret texel blocks in the image.

components

public VkComponentMapping components()

a VkComponentMapping structure specifying a remapping of color components (or of depth or stencil components after they have been converted into color components).

subresourceRange

public VkImageSubresourceRange subresourceRange()

a VkImageSubresourceRange structure selecting the set of mipmap levels and array layers to be accessible to the view.

sType

public VkImageViewCreateInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkImageViewCreateInfo sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO value to the sType() field.

pNext

public VkImageViewCreateInfo pNext(long value)

Sets the specified value to the pNext() field.

pNext

public VkImageViewCreateInfo pNext(VkImageViewASTCDecodeModeEXT value)

Prepends the specified VkImageViewASTCDecodeModeEXT value to the pNext chain.

pNext

public VkImageViewCreateInfo pNext(VkImageViewMinLodCreateInfoEXT value)

Prepends the specified VkImageViewMinLodCreateInfoEXT value to the pNext chain.

pNext

public VkImageViewCreateInfo pNext(VkImageViewUsageCreateInfo value)

Prepends the specified VkImageViewUsageCreateInfo value to the pNext chain.

pNext

public VkImageViewCreateInfo pNext(VkImageViewUsageCreateInfoKHR value)

Prepends the specified VkImageViewUsageCreateInfoKHR value to the pNext chain.

pNext

public VkImageViewCreateInfo pNext(VkSamplerYcbcrConversionInfo value)

Prepends the specified VkSamplerYcbcrConversionInfo value to the pNext chain.

pNext

public VkImageViewCreateInfo pNext(VkSamplerYcbcrConversionInfoKHR value)

Prepends the specified VkSamplerYcbcrConversionInfoKHR value to the pNext chain.

pNext

public VkImageViewCreateInfo pNext(VkVideoDecodeH264ProfileEXT value)

Prepends the specified VkVideoDecodeH264ProfileEXT value to the pNext chain.

pNext

public VkImageViewCreateInfo pNext(VkVideoDecodeH265ProfileEXT value)

Prepends the specified VkVideoDecodeH265ProfileEXT value to the pNext chain.

pNext

public VkImageViewCreateInfo pNext(VkVideoEncodeH264ProfileEXT value)

Prepends the specified VkVideoEncodeH264ProfileEXT value to the pNext chain.

pNext

public VkImageViewCreateInfo pNext(VkVideoEncodeH265ProfileEXT value)

Prepends the specified VkVideoEncodeH265ProfileEXT value to the pNext chain.

pNext

public VkImageViewCreateInfo pNext(VkVideoProfileKHR value)

Prepends the specified VkVideoProfileKHR value to the pNext chain.

pNext

public VkImageViewCreateInfo pNext(VkVideoProfilesKHR value)

Prepends the specified VkVideoProfilesKHR value to the pNext chain.

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.

components

public VkImageViewCreateInfo components(java.util.function.Consumer<VkComponentMapping> consumer)

Passes the components() field to the specified Consumer.

subresourceRange

public VkImageViewCreateInfo subresourceRange(VkImageSubresourceRange value)

Copies the specified VkImageSubresourceRange to the subresourceRange() field.

subresourceRange

public VkImageViewCreateInfo subresourceRange(java.util.function.Consumer<VkImageSubresourceRange> consumer)

Passes the subresourceRange() field to the specified Consumer.

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

@Deprecated
public static VkImageViewCreateInfo mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkImageViewCreateInfo callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkImageViewCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkImageViewCreateInfo callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkImageViewCreateInfo.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkImageViewCreateInfo.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VkImageViewCreateInfo.Buffer mallocStack(int capacity,
                                                       org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkImageViewCreateInfo.Buffer callocStack(int capacity,
                                                       org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static VkImageViewCreateInfo malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkImageViewCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkImageViewCreateInfo calloc(org.lwjgl.system.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

malloc

public static VkImageViewCreateInfo.Buffer malloc(int capacity,
                                                  org.lwjgl.system.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

calloc

public static VkImageViewCreateInfo.Buffer calloc(int capacity,
                                                  org.lwjgl.system.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.