Package org.lwjgl.vulkan
Class VkImageBlit2
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkImageBlit2
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkImageBlit2KHR
public class VkImageBlit2 extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying an image blit operation.Description
For each element of the
pRegionsarray, a blit operation is performed for the specified source and destination regions.Valid Usage
- The
aspectMaskmember ofsrcSubresourceanddstSubresourcemust match - The
layerCountmember ofsrcSubresourceanddstSubresourcemust match
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_IMAGE_BLIT_2pNextmust beNULLor a pointer to a valid instance ofVkCopyCommandTransformInfoQCOM- The
sTypevalue of each struct in thepNextchain must be unique srcSubresourcemust be a validVkImageSubresourceLayersstructuredstSubresourcemust be a validVkImageSubresourceLayersstructure
See Also
VkBlitImageInfo2,VkImageSubresourceLayers,VkOffset3DLayout
struct VkImageBlit2 { VkStructureTypesType(); void const *pNext();VkImageSubresourceLayerssrcSubresource();VkOffset3DsrcOffsets()[2];VkImageSubresourceLayersdstSubresource();VkOffset3DdstOffsets()[2]; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkImageBlit2.BufferAn array ofVkImageBlit2structs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intDSTOFFSETS
DSTSUBRESOURCE
PNEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSRCOFFSETS
SRCSUBRESOURCE
STYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkImageBlit2(java.nio.ByteBuffer container)Creates aVkImageBlit2instance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkImageBlit2calloc()Returns a newVkImageBlit2instance allocated withmemCalloc.static VkImageBlit2.Buffercalloc(int capacity)Returns a newVkImageBlit2.Bufferinstance allocated withmemCalloc.static VkImageBlit2.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkImageBlit2.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImageBlit2calloc(org.lwjgl.system.MemoryStack stack)Returns a newVkImageBlit2instance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImageBlit2create()Returns a newVkImageBlit2instance allocated withBufferUtils.static VkImageBlit2.Buffercreate(int capacity)Returns a newVkImageBlit2.Bufferinstance allocated withBufferUtils.static VkImageBlit2create(long address)Returns a newVkImageBlit2instance for the specified memory address.static VkImageBlit2.Buffercreate(long address, int capacity)Create aVkImageBlit2.Bufferinstance at the specified memory.static VkImageBlit2createSafe(long address)static VkImageBlit2.BuffercreateSafe(long address, int capacity)VkOffset3D.BufferdstOffsets()a pointer to an array of twoVkOffset3Dstructures specifying the bounds of the destination region withindstSubresource.VkOffset3DdstOffsets(int index)a pointer to an array of twoVkOffset3Dstructures specifying the bounds of the destination region withindstSubresource.VkImageBlit2dstOffsets(int index, java.util.function.Consumer<VkOffset3D> consumer)VkImageBlit2dstOffsets(int index, VkOffset3D value)Copies the specifiedVkOffset3Dat the specified index of thedstOffsets()field.VkImageBlit2dstOffsets(java.util.function.Consumer<VkOffset3D.Buffer> consumer)Passes thedstOffsets()field to the specifiedConsumer.VkImageBlit2dstOffsets(VkOffset3D.Buffer value)Copies the specifiedVkOffset3D.Bufferto thedstOffsets()field.VkImageSubresourceLayersdstSubresource()the subresource to blit into.VkImageBlit2dstSubresource(java.util.function.Consumer<VkImageSubresourceLayers> consumer)Passes thedstSubresource()field to the specifiedConsumer.VkImageBlit2dstSubresource(VkImageSubresourceLayers value)Copies the specifiedVkImageSubresourceLayersto thedstSubresource()field.static VkImageBlit2malloc()Returns a newVkImageBlit2instance allocated withmemAlloc.static VkImageBlit2.Buffermalloc(int capacity)Returns a newVkImageBlit2.Bufferinstance allocated withmemAlloc.static VkImageBlit2.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkImageBlit2.Bufferinstance allocated on the specifiedMemoryStack.static VkImageBlit2malloc(org.lwjgl.system.MemoryStack stack)Returns a newVkImageBlit2instance allocated on the specifiedMemoryStack.static VkOffset3D.BufferndstOffsets(long struct)Unsafe version ofdstOffsets().static VkOffset3DndstOffsets(long struct, int index)Unsafe version ofdstOffsets.static voidndstOffsets(long struct, int index, VkOffset3D value)Unsafe version ofdstOffsets.static voidndstOffsets(long struct, VkOffset3D.Buffer value)Unsafe version ofdstOffsets.static VkImageSubresourceLayersndstSubresource(long struct)Unsafe version ofdstSubresource().static voidndstSubresource(long struct, VkImageSubresourceLayers value)Unsafe version ofdstSubresource.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static VkOffset3D.BuffernsrcOffsets(long struct)Unsafe version ofsrcOffsets().static VkOffset3DnsrcOffsets(long struct, int index)Unsafe version ofsrcOffsets.static voidnsrcOffsets(long struct, int index, VkOffset3D value)Unsafe version ofsrcOffsets.static voidnsrcOffsets(long struct, VkOffset3D.Buffer value)Unsafe version ofsrcOffsets.static VkImageSubresourceLayersnsrcSubresource(long struct)Unsafe version ofsrcSubresource().static voidnsrcSubresource(long struct, VkImageSubresourceLayers value)Unsafe version ofsrcSubresource.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.VkImageBlit2pNext(long value)Sets the specified value to thepNext()field.VkImageBlit2pNext(VkCopyCommandTransformInfoQCOM value)Prepends the specifiedVkCopyCommandTransformInfoQCOMvalue to thepNextchain.VkImageBlit2set(int sType, long pNext, VkImageSubresourceLayers srcSubresource, VkOffset3D.Buffer srcOffsets, VkImageSubresourceLayers dstSubresource, VkOffset3D.Buffer dstOffsets)Initializes this struct with the specified values.VkImageBlit2set(VkImageBlit2 src)Copies the specified struct data to this struct.intsizeof()VkOffset3D.BuffersrcOffsets()a pointer to an array of twoVkOffset3Dstructures specifying the bounds of the source region withinsrcSubresource.VkOffset3DsrcOffsets(int index)a pointer to an array of twoVkOffset3Dstructures specifying the bounds of the source region withinsrcSubresource.VkImageBlit2srcOffsets(int index, java.util.function.Consumer<VkOffset3D> consumer)VkImageBlit2srcOffsets(int index, VkOffset3D value)Copies the specifiedVkOffset3Dat the specified index of thesrcOffsets()field.VkImageBlit2srcOffsets(java.util.function.Consumer<VkOffset3D.Buffer> consumer)Passes thesrcOffsets()field to the specifiedConsumer.VkImageBlit2srcOffsets(VkOffset3D.Buffer value)Copies the specifiedVkOffset3D.Bufferto thesrcOffsets()field.VkImageSubresourceLayerssrcSubresource()the subresource to blit from.VkImageBlit2srcSubresource(java.util.function.Consumer<VkImageSubresourceLayers> consumer)Passes thesrcSubresource()field to the specifiedConsumer.VkImageBlit2srcSubresource(VkImageSubresourceLayers value)Copies the specifiedVkImageSubresourceLayersto thesrcSubresource()field.intsType()the type of this structure.VkImageBlit2sType(int value)Sets the specified value to thesType()field.VkImageBlit2sType$Default()Sets theSTRUCTURE_TYPE_IMAGE_BLIT_2value to thesType()field.
-
-
-
Constructor Detail
-
VkImageBlit2
public VkImageBlit2(java.nio.ByteBuffer container)
Creates aVkImageBlit2instance 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.
-
srcSubresource
public VkImageSubresourceLayers srcSubresource()
the subresource to blit from.
-
srcOffsets
public VkOffset3D.Buffer srcOffsets() public VkOffset3D srcOffsets(int index)
a pointer to an array of twoVkOffset3Dstructures specifying the bounds of the source region withinsrcSubresource.
-
dstSubresource
public VkImageSubresourceLayers dstSubresource()
the subresource to blit into.
-
dstOffsets
public VkOffset3D.Buffer dstOffsets() public VkOffset3D dstOffsets(int index)
a pointer to an array of twoVkOffset3Dstructures specifying the bounds of the destination region withindstSubresource.
-
sType
public VkImageBlit2 sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkImageBlit2 sType$Default()
Sets theSTRUCTURE_TYPE_IMAGE_BLIT_2value to thesType()field.
-
pNext
public VkImageBlit2 pNext(long value)
Sets the specified value to thepNext()field.
-
pNext
public VkImageBlit2 pNext(VkCopyCommandTransformInfoQCOM value)
Prepends the specifiedVkCopyCommandTransformInfoQCOMvalue to thepNextchain.
-
srcSubresource
public VkImageBlit2 srcSubresource(VkImageSubresourceLayers value)
Copies the specifiedVkImageSubresourceLayersto thesrcSubresource()field.
-
srcSubresource
public VkImageBlit2 srcSubresource(java.util.function.Consumer<VkImageSubresourceLayers> consumer)
Passes thesrcSubresource()field to the specifiedConsumer.
-
srcOffsets
public VkImageBlit2 srcOffsets(VkOffset3D.Buffer value)
Copies the specifiedVkOffset3D.Bufferto thesrcOffsets()field.
-
srcOffsets
public VkImageBlit2 srcOffsets(int index, VkOffset3D value)
Copies the specifiedVkOffset3Dat the specified index of thesrcOffsets()field.
-
srcOffsets
public VkImageBlit2 srcOffsets(java.util.function.Consumer<VkOffset3D.Buffer> consumer)
Passes thesrcOffsets()field to the specifiedConsumer.
-
srcOffsets
public VkImageBlit2 srcOffsets(int index, java.util.function.Consumer<VkOffset3D> consumer)
-
dstSubresource
public VkImageBlit2 dstSubresource(VkImageSubresourceLayers value)
Copies the specifiedVkImageSubresourceLayersto thedstSubresource()field.
-
dstSubresource
public VkImageBlit2 dstSubresource(java.util.function.Consumer<VkImageSubresourceLayers> consumer)
Passes thedstSubresource()field to the specifiedConsumer.
-
dstOffsets
public VkImageBlit2 dstOffsets(VkOffset3D.Buffer value)
Copies the specifiedVkOffset3D.Bufferto thedstOffsets()field.
-
dstOffsets
public VkImageBlit2 dstOffsets(int index, VkOffset3D value)
Copies the specifiedVkOffset3Dat the specified index of thedstOffsets()field.
-
dstOffsets
public VkImageBlit2 dstOffsets(java.util.function.Consumer<VkOffset3D.Buffer> consumer)
Passes thedstOffsets()field to the specifiedConsumer.
-
dstOffsets
public VkImageBlit2 dstOffsets(int index, java.util.function.Consumer<VkOffset3D> consumer)
-
set
public VkImageBlit2 set(int sType, long pNext, VkImageSubresourceLayers srcSubresource, VkOffset3D.Buffer srcOffsets, VkImageSubresourceLayers dstSubresource, VkOffset3D.Buffer dstOffsets)
Initializes this struct with the specified values.
-
set
public VkImageBlit2 set(VkImageBlit2 src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkImageBlit2 malloc()
Returns a newVkImageBlit2instance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkImageBlit2 calloc()
Returns a newVkImageBlit2instance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkImageBlit2 create()
Returns a newVkImageBlit2instance allocated withBufferUtils.
-
create
public static VkImageBlit2 create(long address)
Returns a newVkImageBlit2instance for the specified memory address.
-
createSafe
@Nullable public static VkImageBlit2 createSafe(long address)
-
malloc
public static VkImageBlit2.Buffer malloc(int capacity)
Returns a newVkImageBlit2.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkImageBlit2.Buffer calloc(int capacity)
Returns a newVkImageBlit2.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkImageBlit2.Buffer create(int capacity)
Returns a newVkImageBlit2.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkImageBlit2.Buffer create(long address, int capacity)
Create aVkImageBlit2.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkImageBlit2.Buffer createSafe(long address, int capacity)
-
malloc
public static VkImageBlit2 malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageBlit2instance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkImageBlit2 calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageBlit2instance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkImageBlit2.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImageBlit2.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkImageBlit2.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImageBlit2.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().
-
nsrcSubresource
public static VkImageSubresourceLayers nsrcSubresource(long struct)
Unsafe version ofsrcSubresource().
-
nsrcOffsets
public static VkOffset3D.Buffer nsrcOffsets(long struct)
Unsafe version ofsrcOffsets().
-
nsrcOffsets
public static VkOffset3D nsrcOffsets(long struct, int index)
Unsafe version ofsrcOffsets.
-
ndstSubresource
public static VkImageSubresourceLayers ndstSubresource(long struct)
Unsafe version ofdstSubresource().
-
ndstOffsets
public static VkOffset3D.Buffer ndstOffsets(long struct)
Unsafe version ofdstOffsets().
-
ndstOffsets
public static VkOffset3D ndstOffsets(long struct, int index)
Unsafe version ofdstOffsets.
-
nsType
public static void nsType(long struct, int value)Unsafe version ofsType.
-
npNext
public static void npNext(long struct, long value)Unsafe version ofpNext.
-
nsrcSubresource
public static void nsrcSubresource(long struct, VkImageSubresourceLayers value)Unsafe version ofsrcSubresource.
-
nsrcOffsets
public static void nsrcOffsets(long struct, VkOffset3D.Buffer value)Unsafe version ofsrcOffsets.
-
nsrcOffsets
public static void nsrcOffsets(long struct, int index, VkOffset3D value)Unsafe version ofsrcOffsets.
-
ndstSubresource
public static void ndstSubresource(long struct, VkImageSubresourceLayers value)Unsafe version ofdstSubresource.
-
ndstOffsets
public static void ndstOffsets(long struct, VkOffset3D.Buffer value)Unsafe version ofdstOffsets.
-
ndstOffsets
public static void ndstOffsets(long struct, int index, VkOffset3D value)Unsafe version ofdstOffsets.
-
-