Package org.lwjgl.vulkan
Class VkResolveImageInfo2
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkResolveImageInfo2
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkResolveImageInfo2KHR
public class VkResolveImageInfo2 extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying parameters of resolve image command.Valid Usage
- The union of all source regions, and the union of all destination regions, specified by the elements of
pRegions, must not overlap in memory - If
srcImageis non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemoryobject srcImagemust have a sample count equal to any valid sample count value other thanSAMPLE_COUNT_1_BIT- If
dstImageis non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemoryobject dstImagemust have a sample count equal toSAMPLE_COUNT_1_BITsrcImageLayoutmust specify the layout of the image subresources ofsrcImagespecified inpRegionsat the time this command is executed on aVkDevicesrcImageLayoutmust beIMAGE_LAYOUT_SHARED_PRESENT_KHR,IMAGE_LAYOUT_TRANSFER_SRC_OPTIMALorIMAGE_LAYOUT_GENERALdstImageLayoutmust specify the layout of the image subresources ofdstImagespecified inpRegionsat the time this command is executed on aVkDevicedstImageLayoutmust beIMAGE_LAYOUT_SHARED_PRESENT_KHR,IMAGE_LAYOUT_TRANSFER_DST_OPTIMALorIMAGE_LAYOUT_GENERAL- The format features of
dstImagemust containFORMAT_FEATURE_COLOR_ATTACHMENT_BIT - If the
linearColorAttachmentfeature is enabled and the image is created withIMAGE_TILING_LINEAR, the format features ofdstImagemust containFORMAT_FEATURE_2_LINEAR_COLOR_ATTACHMENT_BIT_NV srcImageanddstImagemust have been created with the same image format- The
srcSubresource.mipLevelmember of each element ofpRegionsmust be less than themipLevelsspecified inVkImageCreateInfowhensrcImagewas created - The
dstSubresource.mipLevelmember of each element ofpRegionsmust be less than themipLevelsspecified inVkImageCreateInfowhendstImagewas created - The
srcSubresource.baseArrayLayer + srcSubresource.layerCountof each element ofpRegionsmust be less than or equal to thearrayLayersspecified inVkImageCreateInfowhensrcImagewas created - The
dstSubresource.baseArrayLayer + dstSubresource.layerCountof each element ofpRegionsmust be less than or equal to thearrayLayersspecified inVkImageCreateInfowhendstImagewas created dstImageandsrcImagemust not have been created withflagscontainingIMAGE_CREATE_SUBSAMPLED_BIT_EXT- If either
srcImageordstImageare of typeIMAGE_TYPE_3D, then for each element ofpRegions,srcSubresource.baseArrayLayermust be 0 andsrcSubresource.layerCountmust be 1 - If either
srcImageordstImageare of typeIMAGE_TYPE_3D, then for each element ofpRegions,dstSubresource.baseArrayLayermust be 0 anddstSubresource.layerCountmust be 1 - For each element of
pRegions,srcOffset.xand(extent.width + srcOffset.x)must both be greater than or equal to 0 and less than or equal to the width of the specifiedsrcSubresourceofsrcImage - For each element of
pRegions,srcOffset.yand(extent.height + srcOffset.y)must both be greater than or equal to 0 and less than or equal to the height of the specifiedsrcSubresourceofsrcImage - If
srcImageis of typeIMAGE_TYPE_1D, then for each element ofpRegions,srcOffset.ymust be 0 andextent.heightmust be 1 - For each element of
pRegions,srcOffset.zand(extent.depth + srcOffset.z)must both be greater than or equal to 0 and less than or equal to the depth of the specifiedsrcSubresourceofsrcImage - If
srcImageis of typeIMAGE_TYPE_1DorIMAGE_TYPE_2D, then for each element ofpRegions,srcOffset.zmust be 0 andextent.depthmust be 1 - For each element of
pRegions,dstOffset.xand(extent.width + dstOffset.x)must both be greater than or equal to 0 and less than or equal to the width of the specifieddstSubresourceofdstImage - For each element of
pRegions,dstOffset.yand(extent.height + dstOffset.y)must both be greater than or equal to 0 and less than or equal to the height of the specifieddstSubresourceofdstImage - If
dstImageis of typeIMAGE_TYPE_1D, then for each element ofpRegions,dstOffset.ymust be 0 andextent.heightmust be 1 - For each element of
pRegions,dstOffset.zand(extent.depth + dstOffset.z)must both be greater than or equal to 0 and less than or equal to the depth of the specifieddstSubresourceofdstImage - If
dstImageis of typeIMAGE_TYPE_1DorIMAGE_TYPE_2D, then for each element ofpRegions,dstOffset.zmust be 0 andextent.depthmust be 1
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_RESOLVE_IMAGE_INFO_2pNextmust beNULLsrcImagemust be a validVkImagehandlesrcImageLayoutmust be a validVkImageLayoutvaluedstImagemust be a validVkImagehandledstImageLayoutmust be a validVkImageLayoutvaluepRegionsmust be a valid pointer to an array ofregionCountvalidVkImageResolve2structuresregionCountmust be greater than 0- Both of
dstImage, andsrcImagemust have been created, allocated, or retrieved from the sameVkDevice
See Also
VkImageResolve2,CmdResolveImage2,CmdResolveImage2KHRLayout
struct VkResolveImageInfo2 { VkStructureTypesType(); void const *pNext(); VkImagesrcImage(); VkImageLayoutsrcImageLayout(); VkImagedstImage(); VkImageLayoutdstImageLayout(); uint32_tregionCount();VkImageResolve2const *pRegions(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkResolveImageInfo2.BufferAn array ofVkResolveImageInfo2structs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intDSTIMAGE
DSTIMAGELAYOUT
PNEXT
PREGIONS
REGIONCOUNTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSRCIMAGE
SRCIMAGELAYOUT
STYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkResolveImageInfo2(java.nio.ByteBuffer container)Creates aVkResolveImageInfo2instance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkResolveImageInfo2calloc()Returns a newVkResolveImageInfo2instance allocated withmemCalloc.static VkResolveImageInfo2.Buffercalloc(int capacity)Returns a newVkResolveImageInfo2.Bufferinstance allocated withmemCalloc.static VkResolveImageInfo2.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkResolveImageInfo2.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkResolveImageInfo2calloc(org.lwjgl.system.MemoryStack stack)Returns a newVkResolveImageInfo2instance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkResolveImageInfo2create()Returns a newVkResolveImageInfo2instance allocated withBufferUtils.static VkResolveImageInfo2.Buffercreate(int capacity)Returns a newVkResolveImageInfo2.Bufferinstance allocated withBufferUtils.static VkResolveImageInfo2create(long address)Returns a newVkResolveImageInfo2instance for the specified memory address.static VkResolveImageInfo2.Buffercreate(long address, int capacity)Create aVkResolveImageInfo2.Bufferinstance at the specified memory.static VkResolveImageInfo2createSafe(long address)static VkResolveImageInfo2.BuffercreateSafe(long address, int capacity)longdstImage()the destination image.VkResolveImageInfo2dstImage(long value)Sets the specified value to thedstImage()field.intdstImageLayout()the layout of the destination image subresources for the resolve.VkResolveImageInfo2dstImageLayout(int value)Sets the specified value to thedstImageLayout()field.static VkResolveImageInfo2malloc()Returns a newVkResolveImageInfo2instance allocated withmemAlloc.static VkResolveImageInfo2.Buffermalloc(int capacity)Returns a newVkResolveImageInfo2.Bufferinstance allocated withmemAlloc.static VkResolveImageInfo2.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkResolveImageInfo2.Bufferinstance allocated on the specifiedMemoryStack.static VkResolveImageInfo2malloc(org.lwjgl.system.MemoryStack stack)Returns a newVkResolveImageInfo2instance allocated on the specifiedMemoryStack.static longndstImage(long struct)Unsafe version ofdstImage().static voidndstImage(long struct, long value)Unsafe version ofdstImage.static intndstImageLayout(long struct)Unsafe version ofdstImageLayout().static voidndstImageLayout(long struct, int value)Unsafe version ofdstImageLayout.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static VkImageResolve2.BuffernpRegions(long struct)Unsafe version ofpRegions().static voidnpRegions(long struct, VkImageResolve2.Buffer value)Unsafe version ofpRegions.static intnregionCount(long struct)Unsafe version ofregionCount().static voidnregionCount(long struct, int value)Sets the specified value to theregionCountfield of the specifiedstruct.static longnsrcImage(long struct)Unsafe version ofsrcImage().static voidnsrcImage(long struct, long value)Unsafe version ofsrcImage.static intnsrcImageLayout(long struct)Unsafe version ofsrcImageLayout().static voidnsrcImageLayout(long struct, int value)Unsafe version ofsrcImageLayout.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.longpNext()NULLor a pointer to a structure extending this structure.VkResolveImageInfo2pNext(long value)Sets the specified value to thepNext()field.VkImageResolve2.BufferpRegions()a pointer to an array ofVkImageResolve2structures specifying the regions to resolve.VkResolveImageInfo2pRegions(VkImageResolve2.Buffer value)Sets the address of the specifiedVkImageResolve2.Bufferto thepRegions()field.intregionCount()the number of regions to resolve.VkResolveImageInfo2set(int sType, long pNext, long srcImage, int srcImageLayout, long dstImage, int dstImageLayout, VkImageResolve2.Buffer pRegions)Initializes this struct with the specified values.VkResolveImageInfo2set(VkResolveImageInfo2 src)Copies the specified struct data to this struct.intsizeof()longsrcImage()the source image.VkResolveImageInfo2srcImage(long value)Sets the specified value to thesrcImage()field.intsrcImageLayout()the layout of the source image subresources for the resolve.VkResolveImageInfo2srcImageLayout(int value)Sets the specified value to thesrcImageLayout()field.intsType()the type of this structure.VkResolveImageInfo2sType(int value)Sets the specified value to thesType()field.VkResolveImageInfo2sType$Default()Sets theSTRUCTURE_TYPE_RESOLVE_IMAGE_INFO_2value to thesType()field.static voidvalidate(long struct)Validates pointer members that should not beNULL.
-
-
-
Constructor Detail
-
VkResolveImageInfo2
public VkResolveImageInfo2(java.nio.ByteBuffer container)
Creates aVkResolveImageInfo2instance 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()
the type of this structure.
-
pNext
public long pNext()
NULLor a pointer to a structure extending this structure.
-
srcImage
public long srcImage()
the source image.
-
srcImageLayout
public int srcImageLayout()
the layout of the source image subresources for the resolve.
-
dstImage
public long dstImage()
the destination image.
-
dstImageLayout
public int dstImageLayout()
the layout of the destination image subresources for the resolve.
-
regionCount
public int regionCount()
the number of regions to resolve.
-
pRegions
public VkImageResolve2.Buffer pRegions()
a pointer to an array ofVkImageResolve2structures specifying the regions to resolve.
-
sType
public VkResolveImageInfo2 sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkResolveImageInfo2 sType$Default()
Sets theSTRUCTURE_TYPE_RESOLVE_IMAGE_INFO_2value to thesType()field.
-
pNext
public VkResolveImageInfo2 pNext(long value)
Sets the specified value to thepNext()field.
-
srcImage
public VkResolveImageInfo2 srcImage(long value)
Sets the specified value to thesrcImage()field.
-
srcImageLayout
public VkResolveImageInfo2 srcImageLayout(int value)
Sets the specified value to thesrcImageLayout()field.
-
dstImage
public VkResolveImageInfo2 dstImage(long value)
Sets the specified value to thedstImage()field.
-
dstImageLayout
public VkResolveImageInfo2 dstImageLayout(int value)
Sets the specified value to thedstImageLayout()field.
-
pRegions
public VkResolveImageInfo2 pRegions(VkImageResolve2.Buffer value)
Sets the address of the specifiedVkImageResolve2.Bufferto thepRegions()field.
-
set
public VkResolveImageInfo2 set(int sType, long pNext, long srcImage, int srcImageLayout, long dstImage, int dstImageLayout, VkImageResolve2.Buffer pRegions)
Initializes this struct with the specified values.
-
set
public VkResolveImageInfo2 set(VkResolveImageInfo2 src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkResolveImageInfo2 malloc()
Returns a newVkResolveImageInfo2instance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkResolveImageInfo2 calloc()
Returns a newVkResolveImageInfo2instance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkResolveImageInfo2 create()
Returns a newVkResolveImageInfo2instance allocated withBufferUtils.
-
create
public static VkResolveImageInfo2 create(long address)
Returns a newVkResolveImageInfo2instance for the specified memory address.
-
createSafe
@Nullable public static VkResolveImageInfo2 createSafe(long address)
-
malloc
public static VkResolveImageInfo2.Buffer malloc(int capacity)
Returns a newVkResolveImageInfo2.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkResolveImageInfo2.Buffer calloc(int capacity)
Returns a newVkResolveImageInfo2.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkResolveImageInfo2.Buffer create(int capacity)
Returns a newVkResolveImageInfo2.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkResolveImageInfo2.Buffer create(long address, int capacity)
Create aVkResolveImageInfo2.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkResolveImageInfo2.Buffer createSafe(long address, int capacity)
-
malloc
public static VkResolveImageInfo2 malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkResolveImageInfo2instance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkResolveImageInfo2 calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkResolveImageInfo2instance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkResolveImageInfo2.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkResolveImageInfo2.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkResolveImageInfo2.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkResolveImageInfo2.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().
-
nsrcImage
public static long nsrcImage(long struct)
Unsafe version ofsrcImage().
-
nsrcImageLayout
public static int nsrcImageLayout(long struct)
Unsafe version ofsrcImageLayout().
-
ndstImage
public static long ndstImage(long struct)
Unsafe version ofdstImage().
-
ndstImageLayout
public static int ndstImageLayout(long struct)
Unsafe version ofdstImageLayout().
-
nregionCount
public static int nregionCount(long struct)
Unsafe version ofregionCount().
-
npRegions
public static VkImageResolve2.Buffer npRegions(long struct)
Unsafe version ofpRegions().
-
nsType
public static void nsType(long struct, int value)Unsafe version ofsType.
-
npNext
public static void npNext(long struct, long value)Unsafe version ofpNext.
-
nsrcImage
public static void nsrcImage(long struct, long value)Unsafe version ofsrcImage.
-
nsrcImageLayout
public static void nsrcImageLayout(long struct, int value)Unsafe version ofsrcImageLayout.
-
ndstImage
public static void ndstImage(long struct, long value)Unsafe version ofdstImage.
-
ndstImageLayout
public static void ndstImageLayout(long struct, int value)Unsafe version ofdstImageLayout.
-
nregionCount
public static void nregionCount(long struct, int value)Sets the specified value to theregionCountfield of the specifiedstruct.
-
npRegions
public static void npRegions(long struct, VkImageResolve2.Buffer value)Unsafe version ofpRegions.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
-