Package org.lwjgl.vulkan
Class VkBlitImageInfo2
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkBlitImageInfo2
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkBlitImageInfo2KHR
public class VkBlitImageInfo2 extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying parameters of blit image command.Valid Usage
- The source region specified by each element of
pRegionsmust be a region that is contained withinsrcImage - The destination region specified by each element of
pRegionsmust be a region that is contained withindstImage - The union of all destination regions, specified by the elements of
pRegions, must not overlap in memory with any texel that may be sampled during the blit operation - The format features of
srcImagemust containFORMAT_FEATURE_BLIT_SRC_BIT srcImagemust not use a format that requires a sampler Y’CBCR conversionsrcImagemust have been created withIMAGE_USAGE_TRANSFER_SRC_BITusage flag- If
srcImageis non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemoryobject srcImageLayoutmust 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_GENERAL- The format features of
dstImagemust containFORMAT_FEATURE_BLIT_DST_BIT dstImagemust not use a format that requires a sampler Y’CBCR conversiondstImagemust have been created withIMAGE_USAGE_TRANSFER_DST_BITusage flag- If
dstImageis non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemoryobject dstImageLayoutmust 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- If either of
srcImageordstImagewas created with a signed integerVkFormat, the other must also have been created with a signed integerVkFormat - If either of
srcImageordstImagewas created with an unsigned integerVkFormat, the other must also have been created with an unsigned integerVkFormat - If either of
srcImageordstImagewas created with a depth/stencil format, the other must have exactly the same format - If
srcImagewas created with a depth/stencil format,filtermust beFILTER_NEAREST srcImagemust have been created with asamplesvalue ofSAMPLE_COUNT_1_BITdstImagemust have been created with asamplesvalue ofSAMPLE_COUNT_1_BIT- If
filterisFILTER_LINEAR, then the format features ofsrcImagemust containFORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT - If
filterisFILTER_CUBIC_EXT, then the format features ofsrcImagemust containFORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT - If
filterisFILTER_CUBIC_EXT,srcImagemust be of typeIMAGE_TYPE_2D - 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
srcImageordstImageis of typeIMAGE_TYPE_3D, then for each element ofpRegions,srcSubresource.baseArrayLayeranddstSubresource.baseArrayLayermust each be 0, andsrcSubresource.layerCountanddstSubresource.layerCountmust each be 1 - For each element of
pRegions,srcSubresource.aspectMaskmust specify aspects present insrcImage - For each element of
pRegions,dstSubresource.aspectMaskmust specify aspects present indstImage - For each element of
pRegions,srcOffsets[0].x andsrcOffsets[1].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,srcOffsets[0].y andsrcOffsets[1].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,srcOffsets[0].y must be 0 andsrcOffsets[1].y must be 1 - For each element of
pRegions,srcOffsets[0].z andsrcOffsets[1].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,srcOffsets[0].z must be 0 andsrcOffsets[1].z must be 1 - For each element of
pRegions,dstOffsets[0].x anddstOffsets[1].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,dstOffsets[0].y anddstOffsets[1].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,dstOffsets[0].y must be 0 anddstOffsets[1].y must be 1 - For each element of
pRegions,dstOffsets[0].z anddstOffsets[1].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,dstOffsets[0].z must be 0 anddstOffsets[1].z must be 1 - If any element of
pRegionscontainsVkCopyCommandTransformInfoQCOMin itspNextchain, thensrcImageanddstImagemust not be block-compressed images - If any element of
pRegionscontainsVkCopyCommandTransformInfoQCOMin itspNextchain, thensrcImagemust be of typeIMAGE_TYPE_2D - If any element of
pRegionscontainsVkCopyCommandTransformInfoQCOMin itspNextchain, thensrcImagemust not have a multi-planar format
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_BLIT_IMAGE_INFO_2pNextmust beNULLsrcImagemust be a validVkImagehandlesrcImageLayoutmust be a validVkImageLayoutvaluedstImagemust be a validVkImagehandledstImageLayoutmust be a validVkImageLayoutvaluepRegionsmust be a valid pointer to an array ofregionCountvalidVkImageBlit2structuresfiltermust be a validVkFiltervalueregionCountmust be greater than 0- Both of
dstImage, andsrcImagemust have been created, allocated, or retrieved from the sameVkDevice
See Also
VkImageBlit2,CmdBlitImage2,CmdBlitImage2KHRLayout
struct VkBlitImageInfo2 { VkStructureTypesType(); void const *pNext(); VkImagesrcImage(); VkImageLayoutsrcImageLayout(); VkImagedstImage(); VkImageLayoutdstImageLayout(); uint32_tregionCount();VkImageBlit2const *pRegions(); VkFilterfilter(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkBlitImageInfo2.BufferAn array ofVkBlitImageInfo2structs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intDSTIMAGE
DSTIMAGELAYOUT
FILTER
PNEXT
PREGIONS
REGIONCOUNTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSRCIMAGE
SRCIMAGELAYOUT
STYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkBlitImageInfo2(java.nio.ByteBuffer container)Creates aVkBlitImageInfo2instance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkBlitImageInfo2calloc()Returns a newVkBlitImageInfo2instance allocated withmemCalloc.static VkBlitImageInfo2.Buffercalloc(int capacity)Returns a newVkBlitImageInfo2.Bufferinstance allocated withmemCalloc.static VkBlitImageInfo2.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkBlitImageInfo2.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkBlitImageInfo2calloc(org.lwjgl.system.MemoryStack stack)Returns a newVkBlitImageInfo2instance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkBlitImageInfo2create()Returns a newVkBlitImageInfo2instance allocated withBufferUtils.static VkBlitImageInfo2.Buffercreate(int capacity)Returns a newVkBlitImageInfo2.Bufferinstance allocated withBufferUtils.static VkBlitImageInfo2create(long address)Returns a newVkBlitImageInfo2instance for the specified memory address.static VkBlitImageInfo2.Buffercreate(long address, int capacity)Create aVkBlitImageInfo2.Bufferinstance at the specified memory.static VkBlitImageInfo2createSafe(long address)static VkBlitImageInfo2.BuffercreateSafe(long address, int capacity)longdstImage()the destination image.VkBlitImageInfo2dstImage(long value)Sets the specified value to thedstImage()field.intdstImageLayout()the layout of the destination image subresources for the blit.VkBlitImageInfo2dstImageLayout(int value)Sets the specified value to thedstImageLayout()field.intfilter()aVkFilterspecifying the filter to apply if the blits require scaling.VkBlitImageInfo2filter(int value)Sets the specified value to thefilter()field.static VkBlitImageInfo2malloc()Returns a newVkBlitImageInfo2instance allocated withmemAlloc.static VkBlitImageInfo2.Buffermalloc(int capacity)Returns a newVkBlitImageInfo2.Bufferinstance allocated withmemAlloc.static VkBlitImageInfo2.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkBlitImageInfo2.Bufferinstance allocated on the specifiedMemoryStack.static VkBlitImageInfo2malloc(org.lwjgl.system.MemoryStack stack)Returns a newVkBlitImageInfo2instance 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 intnfilter(long struct)Unsafe version offilter().static voidnfilter(long struct, int value)Unsafe version offilter.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static VkImageBlit2.BuffernpRegions(long struct)Unsafe version ofpRegions().static voidnpRegions(long struct, VkImageBlit2.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.VkBlitImageInfo2pNext(long value)Sets the specified value to thepNext()field.VkImageBlit2.BufferpRegions()a pointer to an array ofVkImageBlit2structures specifying the regions to blit.VkBlitImageInfo2pRegions(VkImageBlit2.Buffer value)Sets the address of the specifiedVkImageBlit2.Bufferto thepRegions()field.intregionCount()the number of regions to blit.VkBlitImageInfo2set(int sType, long pNext, long srcImage, int srcImageLayout, long dstImage, int dstImageLayout, VkImageBlit2.Buffer pRegions, int filter)Initializes this struct with the specified values.VkBlitImageInfo2set(VkBlitImageInfo2 src)Copies the specified struct data to this struct.intsizeof()longsrcImage()the source image.VkBlitImageInfo2srcImage(long value)Sets the specified value to thesrcImage()field.intsrcImageLayout()the layout of the source image subresources for the blit.VkBlitImageInfo2srcImageLayout(int value)Sets the specified value to thesrcImageLayout()field.intsType()the type of this structure.VkBlitImageInfo2sType(int value)Sets the specified value to thesType()field.VkBlitImageInfo2sType$Default()Sets theSTRUCTURE_TYPE_BLIT_IMAGE_INFO_2value to thesType()field.static voidvalidate(long struct)Validates pointer members that should not beNULL.
-
-
-
Constructor Detail
-
VkBlitImageInfo2
public VkBlitImageInfo2(java.nio.ByteBuffer container)
Creates aVkBlitImageInfo2instance 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 blit.
-
dstImage
public long dstImage()
the destination image.
-
dstImageLayout
public int dstImageLayout()
the layout of the destination image subresources for the blit.
-
regionCount
public int regionCount()
the number of regions to blit.
-
pRegions
public VkImageBlit2.Buffer pRegions()
a pointer to an array ofVkImageBlit2structures specifying the regions to blit.
-
filter
public int filter()
aVkFilterspecifying the filter to apply if the blits require scaling.
-
sType
public VkBlitImageInfo2 sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkBlitImageInfo2 sType$Default()
Sets theSTRUCTURE_TYPE_BLIT_IMAGE_INFO_2value to thesType()field.
-
pNext
public VkBlitImageInfo2 pNext(long value)
Sets the specified value to thepNext()field.
-
srcImage
public VkBlitImageInfo2 srcImage(long value)
Sets the specified value to thesrcImage()field.
-
srcImageLayout
public VkBlitImageInfo2 srcImageLayout(int value)
Sets the specified value to thesrcImageLayout()field.
-
dstImage
public VkBlitImageInfo2 dstImage(long value)
Sets the specified value to thedstImage()field.
-
dstImageLayout
public VkBlitImageInfo2 dstImageLayout(int value)
Sets the specified value to thedstImageLayout()field.
-
pRegions
public VkBlitImageInfo2 pRegions(VkImageBlit2.Buffer value)
Sets the address of the specifiedVkImageBlit2.Bufferto thepRegions()field.
-
filter
public VkBlitImageInfo2 filter(int value)
Sets the specified value to thefilter()field.
-
set
public VkBlitImageInfo2 set(int sType, long pNext, long srcImage, int srcImageLayout, long dstImage, int dstImageLayout, VkImageBlit2.Buffer pRegions, int filter)
Initializes this struct with the specified values.
-
set
public VkBlitImageInfo2 set(VkBlitImageInfo2 src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkBlitImageInfo2 malloc()
Returns a newVkBlitImageInfo2instance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkBlitImageInfo2 calloc()
Returns a newVkBlitImageInfo2instance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkBlitImageInfo2 create()
Returns a newVkBlitImageInfo2instance allocated withBufferUtils.
-
create
public static VkBlitImageInfo2 create(long address)
Returns a newVkBlitImageInfo2instance for the specified memory address.
-
createSafe
@Nullable public static VkBlitImageInfo2 createSafe(long address)
-
malloc
public static VkBlitImageInfo2.Buffer malloc(int capacity)
Returns a newVkBlitImageInfo2.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkBlitImageInfo2.Buffer calloc(int capacity)
Returns a newVkBlitImageInfo2.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkBlitImageInfo2.Buffer create(int capacity)
Returns a newVkBlitImageInfo2.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkBlitImageInfo2.Buffer create(long address, int capacity)
Create aVkBlitImageInfo2.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkBlitImageInfo2.Buffer createSafe(long address, int capacity)
-
malloc
public static VkBlitImageInfo2 malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkBlitImageInfo2instance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkBlitImageInfo2 calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkBlitImageInfo2instance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkBlitImageInfo2.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkBlitImageInfo2.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkBlitImageInfo2.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkBlitImageInfo2.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 VkImageBlit2.Buffer npRegions(long struct)
Unsafe version ofpRegions().
-
nfilter
public static int nfilter(long struct)
Unsafe version offilter().
-
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, VkImageBlit2.Buffer value)Unsafe version ofpRegions.
-
nfilter
public static void nfilter(long struct, int value)Unsafe version offilter.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
-