Package org.lwjgl.vulkan
Class VkImageCopy2
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkImageCopy2
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkImageCopy2KHR
public class VkImageCopy2 extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying an image copy operation.Valid Usage
- The number of slices of the
extent(for 3D) or layers of thesrcSubresource(for non-3D) must match the number of slices of theextent(for 3D) or layers of thedstSubresource(for non-3D)
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_IMAGE_COPY_2pNextmust beNULLsrcSubresourcemust be a validVkImageSubresourceLayersstructuredstSubresourcemust be a validVkImageSubresourceLayersstructure
See Also
VkCopyImageInfo2,VkExtent3D,VkImageSubresourceLayers,VkOffset3DLayout
struct VkImageCopy2 { VkStructureTypesType(); void const *pNext();VkImageSubresourceLayerssrcSubresource();VkOffset3DsrcOffset();VkImageSubresourceLayersdstSubresource();VkOffset3DdstOffset();VkExtent3Dextent(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkImageCopy2.BufferAn array ofVkImageCopy2structs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intDSTOFFSET
DSTSUBRESOURCE
EXTENT
PNEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSRCOFFSET
SRCSUBRESOURCE
STYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkImageCopy2(java.nio.ByteBuffer container)Creates aVkImageCopy2instance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkImageCopy2calloc()Returns a newVkImageCopy2instance allocated withmemCalloc.static VkImageCopy2.Buffercalloc(int capacity)Returns a newVkImageCopy2.Bufferinstance allocated withmemCalloc.static VkImageCopy2.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkImageCopy2.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImageCopy2calloc(org.lwjgl.system.MemoryStack stack)Returns a newVkImageCopy2instance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImageCopy2create()Returns a newVkImageCopy2instance allocated withBufferUtils.static VkImageCopy2.Buffercreate(int capacity)Returns a newVkImageCopy2.Bufferinstance allocated withBufferUtils.static VkImageCopy2create(long address)Returns a newVkImageCopy2instance for the specified memory address.static VkImageCopy2.Buffercreate(long address, int capacity)Create aVkImageCopy2.Bufferinstance at the specified memory.static VkImageCopy2createSafe(long address)static VkImageCopy2.BuffercreateSafe(long address, int capacity)VkOffset3DdstOffset()seesrcOffsetVkImageCopy2dstOffset(java.util.function.Consumer<VkOffset3D> consumer)Passes thedstOffset()field to the specifiedConsumer.VkImageCopy2dstOffset(VkOffset3D value)Copies the specifiedVkOffset3Dto thedstOffset()field.VkImageSubresourceLayersdstSubresource()seesrcSubresourceVkImageCopy2dstSubresource(java.util.function.Consumer<VkImageSubresourceLayers> consumer)Passes thedstSubresource()field to the specifiedConsumer.VkImageCopy2dstSubresource(VkImageSubresourceLayers value)Copies the specifiedVkImageSubresourceLayersto thedstSubresource()field.VkExtent3Dextent()the size in texels of the image to copy inwidth,heightanddepth.VkImageCopy2extent(java.util.function.Consumer<VkExtent3D> consumer)Passes theextent()field to the specifiedConsumer.VkImageCopy2extent(VkExtent3D value)Copies the specifiedVkExtent3Dto theextent()field.static VkImageCopy2malloc()Returns a newVkImageCopy2instance allocated withmemAlloc.static VkImageCopy2.Buffermalloc(int capacity)Returns a newVkImageCopy2.Bufferinstance allocated withmemAlloc.static VkImageCopy2.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkImageCopy2.Bufferinstance allocated on the specifiedMemoryStack.static VkImageCopy2malloc(org.lwjgl.system.MemoryStack stack)Returns a newVkImageCopy2instance allocated on the specifiedMemoryStack.static VkOffset3DndstOffset(long struct)Unsafe version ofdstOffset().static voidndstOffset(long struct, VkOffset3D value)Unsafe version ofdstOffset.static VkImageSubresourceLayersndstSubresource(long struct)Unsafe version ofdstSubresource().static voidndstSubresource(long struct, VkImageSubresourceLayers value)Unsafe version ofdstSubresource.static VkExtent3Dnextent(long struct)Unsafe version ofextent().static voidnextent(long struct, VkExtent3D value)Unsafe version ofextent.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static VkOffset3DnsrcOffset(long struct)Unsafe version ofsrcOffset().static voidnsrcOffset(long struct, VkOffset3D value)Unsafe version ofsrcOffset.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.VkImageCopy2pNext(long value)Sets the specified value to thepNext()field.VkImageCopy2set(int sType, long pNext, VkImageSubresourceLayers srcSubresource, VkOffset3D srcOffset, VkImageSubresourceLayers dstSubresource, VkOffset3D dstOffset, VkExtent3D extent)Initializes this struct with the specified values.VkImageCopy2set(VkImageCopy2 src)Copies the specified struct data to this struct.intsizeof()VkOffset3DsrcOffset()srcOffsetanddstOffsetselect the initialx,y, andzoffsets in texels of the sub-regions of the source and destination image data.VkImageCopy2srcOffset(java.util.function.Consumer<VkOffset3D> consumer)Passes thesrcOffset()field to the specifiedConsumer.VkImageCopy2srcOffset(VkOffset3D value)Copies the specifiedVkOffset3Dto thesrcOffset()field.VkImageSubresourceLayerssrcSubresource()srcSubresourceanddstSubresourceareVkImageSubresourceLayersstructures specifying the image subresources of the images used for the source and destination image data, respectively.VkImageCopy2srcSubresource(java.util.function.Consumer<VkImageSubresourceLayers> consumer)Passes thesrcSubresource()field to the specifiedConsumer.VkImageCopy2srcSubresource(VkImageSubresourceLayers value)Copies the specifiedVkImageSubresourceLayersto thesrcSubresource()field.intsType()the type of this structure.VkImageCopy2sType(int value)Sets the specified value to thesType()field.VkImageCopy2sType$Default()Sets theSTRUCTURE_TYPE_IMAGE_COPY_2value to thesType()field.
-
-
-
Constructor Detail
-
VkImageCopy2
public VkImageCopy2(java.nio.ByteBuffer container)
Creates aVkImageCopy2instance 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()
srcSubresourceanddstSubresourceareVkImageSubresourceLayersstructures specifying the image subresources of the images used for the source and destination image data, respectively.
-
srcOffset
public VkOffset3D srcOffset()
srcOffsetanddstOffsetselect the initialx,y, andzoffsets in texels of the sub-regions of the source and destination image data.
-
dstSubresource
public VkImageSubresourceLayers dstSubresource()
seesrcSubresource
-
dstOffset
public VkOffset3D dstOffset()
seesrcOffset
-
extent
public VkExtent3D extent()
the size in texels of the image to copy inwidth,heightanddepth.
-
sType
public VkImageCopy2 sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkImageCopy2 sType$Default()
Sets theSTRUCTURE_TYPE_IMAGE_COPY_2value to thesType()field.
-
pNext
public VkImageCopy2 pNext(long value)
Sets the specified value to thepNext()field.
-
srcSubresource
public VkImageCopy2 srcSubresource(VkImageSubresourceLayers value)
Copies the specifiedVkImageSubresourceLayersto thesrcSubresource()field.
-
srcSubresource
public VkImageCopy2 srcSubresource(java.util.function.Consumer<VkImageSubresourceLayers> consumer)
Passes thesrcSubresource()field to the specifiedConsumer.
-
srcOffset
public VkImageCopy2 srcOffset(VkOffset3D value)
Copies the specifiedVkOffset3Dto thesrcOffset()field.
-
srcOffset
public VkImageCopy2 srcOffset(java.util.function.Consumer<VkOffset3D> consumer)
Passes thesrcOffset()field to the specifiedConsumer.
-
dstSubresource
public VkImageCopy2 dstSubresource(VkImageSubresourceLayers value)
Copies the specifiedVkImageSubresourceLayersto thedstSubresource()field.
-
dstSubresource
public VkImageCopy2 dstSubresource(java.util.function.Consumer<VkImageSubresourceLayers> consumer)
Passes thedstSubresource()field to the specifiedConsumer.
-
dstOffset
public VkImageCopy2 dstOffset(VkOffset3D value)
Copies the specifiedVkOffset3Dto thedstOffset()field.
-
dstOffset
public VkImageCopy2 dstOffset(java.util.function.Consumer<VkOffset3D> consumer)
Passes thedstOffset()field to the specifiedConsumer.
-
extent
public VkImageCopy2 extent(VkExtent3D value)
Copies the specifiedVkExtent3Dto theextent()field.
-
extent
public VkImageCopy2 extent(java.util.function.Consumer<VkExtent3D> consumer)
Passes theextent()field to the specifiedConsumer.
-
set
public VkImageCopy2 set(int sType, long pNext, VkImageSubresourceLayers srcSubresource, VkOffset3D srcOffset, VkImageSubresourceLayers dstSubresource, VkOffset3D dstOffset, VkExtent3D extent)
Initializes this struct with the specified values.
-
set
public VkImageCopy2 set(VkImageCopy2 src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkImageCopy2 malloc()
Returns a newVkImageCopy2instance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkImageCopy2 calloc()
Returns a newVkImageCopy2instance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkImageCopy2 create()
Returns a newVkImageCopy2instance allocated withBufferUtils.
-
create
public static VkImageCopy2 create(long address)
Returns a newVkImageCopy2instance for the specified memory address.
-
createSafe
@Nullable public static VkImageCopy2 createSafe(long address)
-
malloc
public static VkImageCopy2.Buffer malloc(int capacity)
Returns a newVkImageCopy2.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkImageCopy2.Buffer calloc(int capacity)
Returns a newVkImageCopy2.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkImageCopy2.Buffer create(int capacity)
Returns a newVkImageCopy2.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkImageCopy2.Buffer create(long address, int capacity)
Create aVkImageCopy2.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkImageCopy2.Buffer createSafe(long address, int capacity)
-
malloc
public static VkImageCopy2 malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageCopy2instance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkImageCopy2 calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageCopy2instance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkImageCopy2.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImageCopy2.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkImageCopy2.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImageCopy2.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().
-
nsrcOffset
public static VkOffset3D nsrcOffset(long struct)
Unsafe version ofsrcOffset().
-
ndstSubresource
public static VkImageSubresourceLayers ndstSubresource(long struct)
Unsafe version ofdstSubresource().
-
ndstOffset
public static VkOffset3D ndstOffset(long struct)
Unsafe version ofdstOffset().
-
nextent
public static VkExtent3D nextent(long struct)
Unsafe version ofextent().
-
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.
-
nsrcOffset
public static void nsrcOffset(long struct, VkOffset3D value)Unsafe version ofsrcOffset.
-
ndstSubresource
public static void ndstSubresource(long struct, VkImageSubresourceLayers value)Unsafe version ofdstSubresource.
-
ndstOffset
public static void ndstOffset(long struct, VkOffset3D value)Unsafe version ofdstOffset.
-
nextent
public static void nextent(long struct, VkExtent3D value)Unsafe version ofextent.
-
-