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.NativeResourceStructure specifying parameters of a newly created image view.Description
Some of the
imagecreation parameters are inherited by the view. In particular, image view creation inherits the implicit parameterusagespecifying the allowed usages of the image view that, by default, takes the value of the correspondingusageparameter specified inVkImageCreateInfoat image creation time. If the image was has a depth-stencil format and was created with an instance ofVkImageStencilUsageCreateInfoEXTin thepNextchain ofVkImageCreateInfo, the usage is calculated based on thesubresource.aspectMaskprovided: IfaspectMaskincludes onlyIMAGE_ASPECT_STENCIL_BIT, the implicitusageis equal toVkImageStencilUsageCreateInfoEXT::stencilUsage. IfaspectMaskincludes onlyIMAGE_ASPECT_DEPTH_BIT, the implicitusageis equal toVkImageCreateInfo::usage. * If both aspects are included inaspectMask, the implicitusageis equal to the intersection ofVkImageCreateInfo::usageandVkImageStencilUsageCreateInfoEXT::stencilUsage. The implicitusagecan be overriden by including an instance ofVkImageViewUsageCreateInfostructure in thepNextchain.If
imagewas created with theIMAGE_CREATE_MUTABLE_FORMAT_BITflag, and if theformatof the image is not multi-planar,formatcan be different from the image's format, but ifimagewas created without theIMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BITflag 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 theformat, 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
-2bmay be changed to-2b + 1as described in Conversion from Normalized Fixed-Point to Floating-Point.If
imagewas created with theIMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BITflag,formatmust 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'CBCR conversion, an identically defined object of type
VkSamplerYcbcrConversionto that used to create the sampler must be passed toCreateImageViewin aVkSamplerYcbcrConversionInfoadded to thepNextchain ofVkImageViewCreateInfo. Conversely, if aVkSamplerYcbcrConversionobject is passed toCreateImageView, an identically definedVkSamplerYcbcrConversionobject must be used when sampling the image.If the image has a multi-planar
formatandsubresourceRange.aspectMaskisIMAGE_ASPECT_COLOR_BIT,formatmust be identical to the imageformat, and the sampler to be used with the image view must enable sampler Y'CBCR conversion.If
imagewas created with theIMAGE_CREATE_MUTABLE_FORMAT_BITand the image has a multi-planarformat, and ifsubresourceRange.aspectMaskisIMAGE_ASPECT_PLANE_0_BIT,IMAGE_ASPECT_PLANE_1_BIT, orIMAGE_ASPECT_PLANE_2_BIT,formatmust be compatible with the corresponding plane of the image, and the sampler to be used with the image view must not enable sampler Y'CBCR conversion. Thewidthandheightof 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 (uplane, vplane) unnormalized coordinates of the reduced-resolution plane, and these coordinates access the same memory locations as the (ucolor, vcolor) unnormalized coordinates of the color aspect for which chroma reconstruction operations operate on the same (uplane, vplane) or (iplane, jplane) coordinates.
Image and image view parameter compatibility requirements
Dim, Arrayed, MS Image parameters View parameters imageType= ci.imageTypewidth= ci.extent.widthheight= ci.extent.heightdepth= ci.extent.deptharrayLayers= ci.arrayLayerssamples= ci.samplesflags= ci.flagswhere ci is theVkImageCreateInfoused to createimage.baseArrayLayer,layerCount, andlevelCountare members of thesubresourceRangemember.1D, 0, 0 imageType=IMAGE_TYPE_1Dwidth≥ 1height= 1depth= 1arrayLayers≥ 1samples= 1viewType=IMAGE_VIEW_TYPE_1DbaseArrayLayer≥ 0layerCount= 11D, 1, 0 imageType=IMAGE_TYPE_1Dwidth≥ 1height= 1depth= 1arrayLayers≥ 1samples= 1viewType=IMAGE_VIEW_TYPE_1D_ARRAYbaseArrayLayer≥ 0layerCount≥ 12D, 0, 0 imageType=IMAGE_TYPE_2Dwidth≥ 1height≥ 1depth= 1arrayLayers≥ 1samples= 1viewType=IMAGE_VIEW_TYPE_2DbaseArrayLayer≥ 0layerCount= 12D, 1, 0 imageType=IMAGE_TYPE_2Dwidth≥ 1height≥ 1depth= 1arrayLayers≥ 1samples= 1viewType=IMAGE_VIEW_TYPE_2D_ARRAYbaseArrayLayer≥ 0layerCount≥ 12D, 0, 1 imageType=IMAGE_TYPE_2Dwidth≥ 1height≥ 1depth= 1arrayLayers≥ 1samples> 1viewType=IMAGE_VIEW_TYPE_2DbaseArrayLayer≥ 0layerCount= 12D, 1, 1 imageType=IMAGE_TYPE_2Dwidth≥ 1height≥ 1depth= 1arrayLayers≥ 1samples> 1viewType=IMAGE_VIEW_TYPE_2D_ARRAYbaseArrayLayer≥ 0layerCount≥ 1CUBE, 0, 0 imageType=IMAGE_TYPE_2Dwidth≥ 1height=widthdepth= 1arrayLayers≥ 6samples= 1flagsincludesIMAGE_CREATE_CUBE_COMPATIBLE_BITviewType=IMAGE_VIEW_TYPE_CUBEbaseArrayLayer≥ 0layerCount= 6CUBE, 1, 0 imageType=IMAGE_TYPE_2Dwidth≥ 1height= widthdepth= 1 N ≥ 1arrayLayers≥ 6 × Nsamples= 1flagsincludesIMAGE_CREATE_CUBE_COMPATIBLE_BITviewType=IMAGE_VIEW_TYPE_CUBE_ARRAYbaseArrayLayer≥ 0layerCount= 6 × N, N ≥ 13D, 0, 0 imageType=IMAGE_TYPE_3Dwidth≥ 1height≥ 1depth≥ 1arrayLayers= 1samples= 1viewType=IMAGE_VIEW_TYPE_3DbaseArrayLayer= 0layerCount= 13D, 0, 0 imageType=IMAGE_TYPE_3Dwidth≥ 1height≥ 1depth≥ 1arrayLayers= 1samples= 1flagsincludesIMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHRflagsdoes not includeIMAGE_CREATE_SPARSE_BINDING_BIT,IMAGE_CREATE_SPARSE_RESIDENCY_BIT, andIMAGE_CREATE_SPARSE_ALIASED_BITviewType=IMAGE_VIEW_TYPE_2DlevelCount= 1baseArrayLayer≥ 0layerCount= 13D, 0, 0 imageType=IMAGE_TYPE_3Dwidth≥ 1height≥ 1depth≥ 1arrayLayers= 1samples= 1flagsincludesIMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHRflagsdoes not includeIMAGE_CREATE_SPARSE_BINDING_BIT,IMAGE_CREATE_SPARSE_RESIDENCY_BIT, andIMAGE_CREATE_SPARSE_ALIASED_BITviewType=IMAGE_VIEW_TYPE_2D_ARRAYlevelCount= 1baseArrayLayer≥ 0layerCount≥ 1Valid Usage
- If
imagewas not created withIMAGE_CREATE_CUBE_COMPATIBLE_BITthenviewTypemust not beIMAGE_VIEW_TYPE_CUBEorIMAGE_VIEW_TYPE_CUBE_ARRAY - If the image cubemap arrays feature is not enabled,
viewTypemust not beIMAGE_VIEW_TYPE_CUBE_ARRAY - If
imagewas created withIMAGE_TYPE_3Dbut withoutIMAGE_CREATE_2D_ARRAY_COMPATIBLE_BITset thenviewTypemust not beIMAGE_VIEW_TYPE_2DorIMAGE_VIEW_TYPE_2D_ARRAY imagemust have been created with ausagevalue containing at least one ofIMAGE_USAGE_SAMPLED_BIT,IMAGE_USAGE_STORAGE_BIT,IMAGE_USAGE_COLOR_ATTACHMENT_BIT,IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT,IMAGE_USAGE_INPUT_ATTACHMENT_BIT,IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, orIMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT- The format features of the resultant image view must contain at least one bit.
- If
usagecontainsIMAGE_USAGE_SAMPLED_BIT, then the format features of the resultant image view must containFORMAT_FEATURE_SAMPLED_IMAGE_BIT. - If
usagecontainsIMAGE_USAGE_STORAGE_BIT, then the image view’s format features must containFORMAT_FEATURE_STORAGE_IMAGE_BIT. - If
usagecontainsIMAGE_USAGE_COLOR_ATTACHMENT_BIT, then the image view’s format features must containFORMAT_FEATURE_COLOR_ATTACHMENT_BIT. - If
usagecontainsIMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, then the image view’s format features must containFORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT. - If
usagecontainsIMAGE_USAGE_INPUT_ATTACHMENT_BIT, then the image view’s format features must contain at least one ofFORMAT_FEATURE_COLOR_ATTACHMENT_BITorFORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT. subresourceRange.baseMipLevelmust be less than themipLevelsspecified inVkImageCreateInfowhenimagewas created- If
subresourceRange.levelCountis notREMAINING_MIP_LEVELS,subresourceRange.baseMipLevel + subresourceRange.levelCountmust be less than or equal to themipLevelsspecified inVkImageCreateInfowhenimagewas created - If
imagewas created withusagecontainingIMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,subresourceRange.levelCountmust be 1 - If
imageis not a 3D image created withIMAGE_CREATE_2D_ARRAY_COMPATIBLE_BITset, orviewTypeis notIMAGE_VIEW_TYPE_2DorIMAGE_VIEW_TYPE_2D_ARRAY,subresourceRange::baseArrayLayermust be less than thearrayLayersspecified inVkImageCreateInfowhenimagewas created - If
subresourceRange::layerCountis notREMAINING_ARRAY_LAYERS,imageis not a 3D image created withIMAGE_CREATE_2D_ARRAY_COMPATIBLE_BITset, orviewTypeis notIMAGE_VIEW_TYPE_2DorIMAGE_VIEW_TYPE_2D_ARRAY,subresourceRange::layerCountmust be non-zero andsubresourceRange::baseArrayLayer subresourceRange::layerCountmust be less than or equal to thearrayLayersspecified inVkImageCreateInfowhenimagewas created - If
imageis a 3D image created withIMAGE_CREATE_2D_ARRAY_COMPATIBLE_BITset, andviewTypeisIMAGE_VIEW_TYPE_2DorIMAGE_VIEW_TYPE_2D_ARRAY,subresourceRange::baseArrayLayermust be less than the depth computed frombaseMipLevelandextent.depthspecified inVkImageCreateInfowhenimagewas created, according to the formula defined in Image Miplevel Sizing. - If
subresourceRange::layerCountis notREMAINING_ARRAY_LAYERS,imageis a 3D image created withIMAGE_CREATE_2D_ARRAY_COMPATIBLE_BITset, andviewTypeisIMAGE_VIEW_TYPE_2DorIMAGE_VIEW_TYPE_2D_ARRAY,subresourceRange::layerCountmust be non-zero andsubresourceRange::baseArrayLayer subresourceRange::layerCountmust be less than or equal to the depth computed frombaseMipLevelandextent.depthspecified inVkImageCreateInfowhenimagewas created, according to the formula defined in Image Miplevel Sizing. - If
imagewas created with theIMAGE_CREATE_MUTABLE_FORMAT_BITflag,formatmust be compatible with theformatused to createimage, as defined in Format Compatibility Classes - If
imagewas created with theIMAGE_CREATE_MUTABLE_FORMAT_BITflag, but without theIMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BITflag, and if theformatof theimageis not a multi-planar format,formatmust be compatible with theformatused to createimage, as defined in Format Compatibility Classes - If
imagewas created with theIMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BITflag,formatmust be compatible with, or must be an uncompressed format that is size-compatible with, theformatused to createimage. - If
imagewas created with theIMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BITflag, thelevelCountandlayerCountmembers ofsubresourceRangemust both be 1. - If a
VkImageFormatListCreateInfoKHRstructure was included in thepNextchain of theVkImageCreateInfostruct used when creatingimageand theviewFormatCountfield ofVkImageFormatListCreateInfoKHRis not zero thenformatmust be one of the formats inVkImageFormatListCreateInfoKHR::pViewFormats. - If
imagewas created with theIMAGE_CREATE_MUTABLE_FORMAT_BITflag, if theformatof theimageis a multi-planar format, and ifsubresourceRange.aspectMaskis one ofIMAGE_ASPECT_PLANE_0_BIT,IMAGE_ASPECT_PLANE_1_BIT, orIMAGE_ASPECT_PLANE_2_BIT, thenformatmust be compatible with theVkFormatfor the plane of theimageformatindicated bysubresourceRange.aspectMask, as defined in Compatible formats of planes of multi-planar formats - If
imagewas not created with theIMAGE_CREATE_MUTABLE_FORMAT_BITflag, or if theformatof theimageis a multi-planar format and ifsubresourceRange.aspectMaskisIMAGE_ASPECT_COLOR_BIT,formatmust be identical to theformatused to createimage - If the
pNextchain contains an instance ofVkSamplerYcbcrConversionInfowith aconversionvalue other thanNULL_HANDLE, all members ofcomponentsmust have the valueCOMPONENT_SWIZZLE_IDENTITY. - If
imageis non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemoryobject subresourceRangeandviewTypemust be compatible with the image, as described in the compatibility table- If
imagewas created withusagecontainingIMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV,viewTypemust beIMAGE_VIEW_TYPE_2DorIMAGE_VIEW_TYPE_2D_ARRAY - If
imagewas created withusagecontainingIMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV,formatmust beFORMAT_R8_UINT - If dynamic fragment density map feature is not enabled,
flagsmust not containIMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT - If dynamic fragment density map feature is not enabled and
imagewas created withusagecontainingIMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,flagsmust not contain any ofIMAGE_CREATE_PROTECTED_BIT,IMAGE_CREATE_SPARSE_BINDING_BIT,IMAGE_CREATE_SPARSE_RESIDENCY_BIT, orIMAGE_CREATE_SPARSE_ALIASED_BIT - If the
pNextchain includes an instance ofVkImageViewUsageCreateInfo, andimagewas not created with an instance ofVkImageStencilUsageCreateInfoEXTin thepNextchain ofVkImageCreateInfo, itsusagemember must not include any bits that were not set in theusagemember of theVkImageCreateInfostructure used to createimage - If the
pNextchain includes an instance ofVkImageViewUsageCreateInfo,imagewas created with an instance ofVkImageStencilUsageCreateInfoEXTin thepNextchain ofVkImageCreateInfo, andsubResourceRange.aspectMaskincludesIMAGE_ASPECT_STENCIL_BIT, theusagemember of theVkImageViewUsageCreateInfoinstance must not include any bits that were not set in theusagemember of theVkImageStencilUsageCreateInfoEXTstructure used to createimage - If the
pNextchain includes an instance ofVkImageViewUsageCreateInfo,imagewas created with an instance ofVkImageStencilUsageCreateInfoEXTin thepNextchain ofVkImageCreateInfo, andsubResourceRange.aspectMaskincludes bits other thanIMAGE_ASPECT_STENCIL_BIT, theusagemember of theVkImageViewUsageCreateInfoinstance must not include any bits that were not set in theusagemember of theVkImageCreateInfostructure used to createimage
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO- Each
pNextmember of any structure (including this one) in thepNextchain must be eitherNULLor a pointer to a valid instance ofVkImageViewASTCDecodeModeEXT,VkImageViewUsageCreateInfo, orVkSamplerYcbcrConversionInfo - Each
sTypemember in thepNextchain must be unique flagsmust be a valid combination ofVkImageViewCreateFlagBitsvaluesimagemust be a validVkImagehandleviewTypemust be a validVkImageViewTypevalueformatmust be a validVkFormatvaluecomponentsmust be a validVkComponentMappingstructuresubresourceRangemust be a validVkImageSubresourceRangestructure
See Also
VkComponentMapping,VkImageSubresourceRange,CreateImageViewMember documentation
sType– the type of this structure.pNext–NULLor a pointer to an extension-specific structure.flags– a bitmask ofVkImageViewCreateFlagBitsdescribing additional parameters of the image view.image– aVkImageon which the view will be created.viewType– aVkImageViewTypevalue specifying the type of the image view.format– aVkFormatdescribing the format and type used to interpret texel blocks in the image.components– aVkComponentMappingspecifies a remapping of color components (or of depth or stencil components after they have been converted into color components).subresourceRange– aVkImageSubresourceRangeselecting 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;VkComponentMappingcomponents;VkImageSubresourceRangesubresourceRange; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkImageViewCreateInfo.BufferAn array ofVkImageViewCreateInfostructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intCOMPONENTS
FLAGS
FORMAT
IMAGE
PNEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPE
SUBRESOURCERANGE
VIEWTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkImageViewCreateInfo(java.nio.ByteBuffer container)Creates aVkImageViewCreateInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkImageViewCreateInfocalloc()Returns a newVkImageViewCreateInfoinstance allocated withmemCalloc.static VkImageViewCreateInfo.Buffercalloc(int capacity)Returns a newVkImageViewCreateInfo.Bufferinstance allocated withmemCalloc.static VkImageViewCreateInfocallocStack()Returns a newVkImageViewCreateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkImageViewCreateInfo.BuffercallocStack(int capacity)Returns a newVkImageViewCreateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkImageViewCreateInfo.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkImageViewCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImageViewCreateInfocallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkImageViewCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.VkComponentMappingcomponents()Returns aVkComponentMappingview of thecomponentsfield.VkImageViewCreateInfocomponents(java.util.function.Consumer<VkComponentMapping> consumer)Passes thecomponentsfield to the specifiedConsumer.VkImageViewCreateInfocomponents(VkComponentMapping value)Copies the specifiedVkComponentMappingto thecomponentsfield.static VkImageViewCreateInfocreate()Returns a newVkImageViewCreateInfoinstance allocated withBufferUtils.static VkImageViewCreateInfo.Buffercreate(int capacity)Returns a newVkImageViewCreateInfo.Bufferinstance allocated withBufferUtils.static VkImageViewCreateInfocreate(long address)Returns a newVkImageViewCreateInfoinstance for the specified memory address.static VkImageViewCreateInfo.Buffercreate(long address, int capacity)Create aVkImageViewCreateInfo.Bufferinstance at the specified memory.static VkImageViewCreateInfocreateSafe(long address)static VkImageViewCreateInfo.BuffercreateSafe(long address, int capacity)intflags()Returns the value of theflagsfield.VkImageViewCreateInfoflags(int value)Sets the specified value to theflagsfield.intformat()Returns the value of theformatfield.VkImageViewCreateInfoformat(int value)Sets the specified value to theformatfield.longimage()Returns the value of theimagefield.VkImageViewCreateInfoimage(long value)Sets the specified value to theimagefield.static VkImageViewCreateInfomalloc()Returns a newVkImageViewCreateInfoinstance allocated withmemAlloc.static VkImageViewCreateInfo.Buffermalloc(int capacity)Returns a newVkImageViewCreateInfo.Bufferinstance allocated withmemAlloc.static VkImageViewCreateInfomallocStack()Returns a newVkImageViewCreateInfoinstance allocated on the thread-localMemoryStack.static VkImageViewCreateInfo.BuffermallocStack(int capacity)Returns a newVkImageViewCreateInfo.Bufferinstance allocated on the thread-localMemoryStack.static VkImageViewCreateInfo.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkImageViewCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkImageViewCreateInfomallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkImageViewCreateInfoinstance allocated on the specifiedMemoryStack.static VkComponentMappingncomponents(long struct)Unsafe version ofcomponents().static voidncomponents(long struct, VkComponentMapping value)Unsafe version ofcomponents.static intnflags(long struct)Unsafe version offlags().static voidnflags(long struct, int value)Unsafe version offlags.static intnformat(long struct)Unsafe version offormat().static voidnformat(long struct, int value)Unsafe version offormat.static longnimage(long struct)Unsafe version ofimage().static voidnimage(long struct, long value)Unsafe version ofimage.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.static VkImageSubresourceRangensubresourceRange(long struct)Unsafe version ofsubresourceRange().static voidnsubresourceRange(long struct, VkImageSubresourceRange value)Unsafe version ofsubresourceRange.static intnviewType(long struct)Unsafe version ofviewType().static voidnviewType(long struct, int value)Unsafe version ofviewType.longpNext()Returns the value of thepNextfield.VkImageViewCreateInfopNext(long value)Sets the specified value to thepNextfield.VkImageViewCreateInfoset(int sType, long pNext, int flags, long image, int viewType, int format, VkComponentMapping components, VkImageSubresourceRange subresourceRange)Initializes this struct with the specified values.VkImageViewCreateInfoset(VkImageViewCreateInfo src)Copies the specified struct data to this struct.intsizeof()intsType()Returns the value of thesTypefield.VkImageViewCreateInfosType(int value)Sets the specified value to thesTypefield.VkImageSubresourceRangesubresourceRange()Returns aVkImageSubresourceRangeview of thesubresourceRangefield.VkImageViewCreateInfosubresourceRange(java.util.function.Consumer<VkImageSubresourceRange> consumer)Passes thesubresourceRangefield to the specifiedConsumer.VkImageViewCreateInfosubresourceRange(VkImageSubresourceRange value)Copies the specifiedVkImageSubresourceRangeto thesubresourceRangefield.intviewType()Returns the value of theviewTypefield.VkImageViewCreateInfoviewType(int value)Sets the specified value to theviewTypefield.
-
-
-
Constructor Detail
-
VkImageViewCreateInfo
public VkImageViewCreateInfo(java.nio.ByteBuffer container)
Creates aVkImageViewCreateInfoinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
flags
public int flags()
Returns the value of theflagsfield.
-
image
public long image()
Returns the value of theimagefield.
-
viewType
public int viewType()
Returns the value of theviewTypefield.
-
format
public int format()
Returns the value of theformatfield.
-
components
public VkComponentMapping components()
Returns aVkComponentMappingview of thecomponentsfield.
-
subresourceRange
public VkImageSubresourceRange subresourceRange()
Returns aVkImageSubresourceRangeview of thesubresourceRangefield.
-
sType
public VkImageViewCreateInfo sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkImageViewCreateInfo pNext(long value)
Sets the specified value to thepNextfield.
-
flags
public VkImageViewCreateInfo flags(int value)
Sets the specified value to theflagsfield.
-
image
public VkImageViewCreateInfo image(long value)
Sets the specified value to theimagefield.
-
viewType
public VkImageViewCreateInfo viewType(int value)
Sets the specified value to theviewTypefield.
-
format
public VkImageViewCreateInfo format(int value)
Sets the specified value to theformatfield.
-
components
public VkImageViewCreateInfo components(VkComponentMapping value)
Copies the specifiedVkComponentMappingto thecomponentsfield.
-
components
public VkImageViewCreateInfo components(java.util.function.Consumer<VkComponentMapping> consumer)
Passes thecomponentsfield to the specifiedConsumer.
-
subresourceRange
public VkImageViewCreateInfo subresourceRange(VkImageSubresourceRange value)
Copies the specifiedVkImageSubresourceRangeto thesubresourceRangefield.
-
subresourceRange
public VkImageViewCreateInfo subresourceRange(java.util.function.Consumer<VkImageSubresourceRange> consumer)
Passes thesubresourceRangefield to the specifiedConsumer.
-
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 newVkImageViewCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkImageViewCreateInfo calloc()
Returns a newVkImageViewCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkImageViewCreateInfo create()
Returns a newVkImageViewCreateInfoinstance allocated withBufferUtils.
-
create
public static VkImageViewCreateInfo create(long address)
Returns a newVkImageViewCreateInfoinstance for the specified memory address.
-
createSafe
@Nullable public static VkImageViewCreateInfo createSafe(long address)
-
malloc
public static VkImageViewCreateInfo.Buffer malloc(int capacity)
Returns a newVkImageViewCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkImageViewCreateInfo.Buffer calloc(int capacity)
Returns a newVkImageViewCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkImageViewCreateInfo.Buffer create(int capacity)
Returns a newVkImageViewCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkImageViewCreateInfo.Buffer create(long address, int capacity)
Create aVkImageViewCreateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkImageViewCreateInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkImageViewCreateInfo mallocStack()
Returns a newVkImageViewCreateInfoinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkImageViewCreateInfo callocStack()
Returns a newVkImageViewCreateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkImageViewCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageViewCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkImageViewCreateInfo callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageViewCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkImageViewCreateInfo.Buffer mallocStack(int capacity)
Returns a newVkImageViewCreateInfo.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkImageViewCreateInfo.Buffer callocStack(int capacity)
Returns a newVkImageViewCreateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkImageViewCreateInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImageViewCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkImageViewCreateInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImageViewCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType().
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext().
-
nflags
public static int nflags(long struct)
Unsafe version offlags().
-
nimage
public static long nimage(long struct)
Unsafe version ofimage().
-
nviewType
public static int nviewType(long struct)
Unsafe version ofviewType().
-
nformat
public static int nformat(long struct)
Unsafe version offormat().
-
ncomponents
public static VkComponentMapping ncomponents(long struct)
Unsafe version ofcomponents().
-
nsubresourceRange
public static VkImageSubresourceRange nsubresourceRange(long struct)
Unsafe version ofsubresourceRange().
-
nsType
public static void nsType(long struct, int value)Unsafe version ofsType.
-
npNext
public static void npNext(long struct, long value)Unsafe version ofpNext.
-
nflags
public static void nflags(long struct, int value)Unsafe version offlags.
-
nimage
public static void nimage(long struct, long value)Unsafe version ofimage.
-
nviewType
public static void nviewType(long struct, int value)Unsafe version ofviewType.
-
nformat
public static void nformat(long struct, int value)Unsafe version offormat.
-
ncomponents
public static void ncomponents(long struct, VkComponentMapping value)Unsafe version ofcomponents.
-
nsubresourceRange
public static void nsubresourceRange(long struct, VkImageSubresourceRange value)Unsafe version ofsubresourceRange.
-
-