Package org.lwjgl.vulkan
Class VkImageBlit
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkImageBlit
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkImageBlit extends Struct
Khronos Reference Page
Vulkan SpecificationSpecifies an image region to blit.
Valid Usage
srcSubresourcemust be a validVkImageSubresourceLayersstructuredstSubresourcemust be a validVkImageSubresourceLayersstructure- The
aspectMaskmember ofsrcSubresourceanddstSubresourcemust match - The
layerCountmember ofsrcSubresourceanddstSubresourcemust match - If either of the calling command's
srcImageordstImageparameters are ofVkImageTypeIMAGE_TYPE_3D, thebaseArrayLayerandlayerCountmembers of bothsrcSubresourceanddstSubresourcemust be 0 and 1, respectively - The
aspectMaskmember ofsrcSubresourcemust specify aspects present in the calling command'ssrcImage - The
aspectMaskmember ofdstSubresourcemust specify aspects present in the calling command'sdstImage srcOffset[0].x andsrcOffset[1].x must both be greater than or equal to 0 and less than or equal to the source image subresource widthsrcOffset[0].y andsrcOffset[1].y must both be greater than or equal to 0 and less than or equal to the source image subresource heightsrcOffset[0].z andsrcOffset[1].z must both be greater than or equal to 0 and less than or equal to the source image subresource depthdstOffset[0].x anddstOffset[1].x must both be greater than or equal to 0 and less than or equal to the destination image subresource widthdstOffset[0].y anddstOffset[1].y must both be greater than or equal to 0 and less than or equal to the destination image subresource heightdstOffset[0].z anddstOffset[1].z must both be greater than or equal to 0 and less than or equal to the destination image subresource depth
Member documentation
srcSubresource– the source image subresourcesrcOffsets– the source regiondstSubresource– the destination image subresourcedstOffsets– the destination region
Layout
struct VkImageBlit {VkImageSubresourceLayerssrcSubresource;VkOffset3D[2] srcOffsets;VkImageSubresourceLayersdstSubresource;VkOffset3D[2] dstOffsets; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classVkImageBlit.BufferAn array ofVkImageBlitstructs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static intSIZEOFThe struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and Description VkImageBlit(java.nio.ByteBuffer container)Creates aVkImageBlitinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static VkImageBlitcalloc()Returns a newVkImageBlitinstance allocated withmemCalloc.static VkImageBlit.Buffercalloc(int capacity)Returns a newVkImageBlit.Bufferinstance allocated withmemCalloc.static VkImageBlitcallocStack()Returns a newVkImageBlitinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkImageBlit.BuffercallocStack(int capacity)Returns a newVkImageBlit.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkImageBlit.BuffercallocStack(int capacity, MemoryStack stack)Returns a newVkImageBlit.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImageBlitcallocStack(MemoryStack stack)Returns a newVkImageBlitinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImageBlitcreate()Returns a newVkImageBlitinstance allocated withBufferUtils.static VkImageBlit.Buffercreate(int capacity)Returns a newVkImageBlit.Bufferinstance allocated withBufferUtils.static VkImageBlitcreate(long address)static VkImageBlit.Buffercreate(long address, int capacity)Create aVkImageBlit.Bufferinstance at the specified memory.VkOffset3D.BufferdstOffsets()Returns aVkOffset3D.Buffer view of thedstOffsetsfield.VkOffset3DdstOffsets(int index)Returns aVkOffset3Dview of the struct at the specified index of thedstOffsetsfield.VkImageBlitdstOffsets(int index, VkOffset3D value)Copies the specifiedVkOffset3Dat the specified index of thedstOffsetsfield.VkImageBlitdstOffsets(VkOffset3D.Buffer value)Copies the specifiedVkOffset3D.Bufferto thedstOffsetsfield.VkImageSubresourceLayersdstSubresource()Returns aVkImageSubresourceLayersview of thedstSubresourcefield.VkImageBlitdstSubresource(VkImageSubresourceLayers value)Copies the specifiedVkImageSubresourceLayersto thedstSubresourcefield.static VkImageBlitmalloc()Returns a newVkImageBlitinstance allocated withmemAlloc.static VkImageBlit.Buffermalloc(int capacity)Returns a newVkImageBlit.Bufferinstance allocated withmemAlloc.static VkImageBlitmallocStack()Returns a newVkImageBlitinstance allocated on the thread-localMemoryStack.static VkImageBlit.BuffermallocStack(int capacity)Returns a newVkImageBlit.Bufferinstance allocated on the thread-localMemoryStack.static VkImageBlit.BuffermallocStack(int capacity, MemoryStack stack)Returns a newVkImageBlit.Bufferinstance allocated on the specifiedMemoryStack.static VkImageBlitmallocStack(MemoryStack stack)Returns a newVkImageBlitinstance allocated on the specifiedMemoryStack.VkImageBlitnset(long struct)Unsafe version ofset.VkImageBlitset(VkImageBlit src)Copies the specified struct data to this struct.VkImageBlitset(VkImageSubresourceLayers srcSubresource, VkOffset3D.Buffer srcOffsets, VkImageSubresourceLayers dstSubresource, VkOffset3D.Buffer dstOffsets)Initializes this struct with the specified values.intsizeof()Returns thesizeof(struct).VkOffset3D.BuffersrcOffsets()Returns aVkOffset3D.Buffer view of thesrcOffsetsfield.VkOffset3DsrcOffsets(int index)Returns aVkOffset3Dview of the struct at the specified index of thesrcOffsetsfield.VkImageBlitsrcOffsets(int index, VkOffset3D value)Copies the specifiedVkOffset3Dat the specified index of thesrcOffsetsfield.VkImageBlitsrcOffsets(VkOffset3D.Buffer value)Copies the specifiedVkOffset3D.Bufferto thesrcOffsetsfield.VkImageSubresourceLayerssrcSubresource()Returns aVkImageSubresourceLayersview of thesrcSubresourcefield.VkImageBlitsrcSubresource(VkImageSubresourceLayers value)Copies the specifiedVkImageSubresourceLayersto thesrcSubresourcefield.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkImageBlit
public VkImageBlit(java.nio.ByteBuffer container)
Creates aVkImageBlitinstance 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()
Description copied from class:StructReturns thesizeof(struct).
-
srcSubresource
public VkImageSubresourceLayers srcSubresource()
Returns aVkImageSubresourceLayersview of thesrcSubresourcefield.
-
srcOffsets
public VkOffset3D.Buffer srcOffsets()
Returns aVkOffset3D.Buffer view of thesrcOffsetsfield.
-
srcOffsets
public VkOffset3D srcOffsets(int index)
Returns aVkOffset3Dview of the struct at the specified index of thesrcOffsetsfield.
-
dstSubresource
public VkImageSubresourceLayers dstSubresource()
Returns aVkImageSubresourceLayersview of thedstSubresourcefield.
-
dstOffsets
public VkOffset3D.Buffer dstOffsets()
Returns aVkOffset3D.Buffer view of thedstOffsetsfield.
-
dstOffsets
public VkOffset3D dstOffsets(int index)
Returns aVkOffset3Dview of the struct at the specified index of thedstOffsetsfield.
-
srcSubresource
public VkImageBlit srcSubresource(VkImageSubresourceLayers value)
Copies the specifiedVkImageSubresourceLayersto thesrcSubresourcefield.
-
srcOffsets
public VkImageBlit srcOffsets(VkOffset3D.Buffer value)
Copies the specifiedVkOffset3D.Bufferto thesrcOffsetsfield.
-
srcOffsets
public VkImageBlit srcOffsets(int index, VkOffset3D value)
Copies the specifiedVkOffset3Dat the specified index of thesrcOffsetsfield.
-
dstSubresource
public VkImageBlit dstSubresource(VkImageSubresourceLayers value)
Copies the specifiedVkImageSubresourceLayersto thedstSubresourcefield.
-
dstOffsets
public VkImageBlit dstOffsets(VkOffset3D.Buffer value)
Copies the specifiedVkOffset3D.Bufferto thedstOffsetsfield.
-
dstOffsets
public VkImageBlit dstOffsets(int index, VkOffset3D value)
Copies the specifiedVkOffset3Dat the specified index of thedstOffsetsfield.
-
set
public VkImageBlit set(VkImageSubresourceLayers srcSubresource, VkOffset3D.Buffer srcOffsets, VkImageSubresourceLayers dstSubresource, VkOffset3D.Buffer dstOffsets)
Initializes this struct with the specified values.
-
nset
public VkImageBlit nset(long struct)
Unsafe version ofset.
-
set
public VkImageBlit set(VkImageBlit src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkImageBlit malloc()
Returns a newVkImageBlitinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkImageBlit calloc()
Returns a newVkImageBlitinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkImageBlit create()
Returns a newVkImageBlitinstance allocated withBufferUtils.
-
create
public static VkImageBlit create(long address)
-
malloc
public static VkImageBlit.Buffer malloc(int capacity)
Returns a newVkImageBlit.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkImageBlit.Buffer calloc(int capacity)
Returns a newVkImageBlit.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkImageBlit.Buffer create(int capacity)
Returns a newVkImageBlit.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkImageBlit.Buffer create(long address, int capacity)
Create aVkImageBlit.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
mallocStack
public static VkImageBlit mallocStack()
Returns a newVkImageBlitinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkImageBlit callocStack()
Returns a newVkImageBlitinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkImageBlit mallocStack(MemoryStack stack)
Returns a newVkImageBlitinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkImageBlit callocStack(MemoryStack stack)
Returns a newVkImageBlitinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkImageBlit.Buffer mallocStack(int capacity)
Returns a newVkImageBlit.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkImageBlit.Buffer callocStack(int capacity)
Returns a newVkImageBlit.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkImageBlit.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkImageBlit.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkImageBlit.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkImageBlit.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
-