Package org.lwjgl.vulkan
Class VkImageBlit
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkImageBlit>
org.lwjgl.vulkan.VkImageBlit
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkImageBlit
extends org.lwjgl.system.Struct<VkImageBlit>
implements org.lwjgl.system.NativeResource
Structure specifying an image blit operation.
Description
For each element of the pRegions array, a blit operation is performed for the specified source and destination regions.
Valid Usage
- The
aspectMaskmember ofsrcSubresourceanddstSubresourcemust match - If neither of the
layerCountmembers ofsrcSubresourceordstSubresourceareREMAINING_ARRAY_LAYERS, thelayerCountmembers ofsrcSubresourceordstSubresourcemust match - If one of the
layerCountmembers ofsrcSubresourceordstSubresourceisREMAINING_ARRAY_LAYERS, the other member must be eitherREMAINING_ARRAY_LAYERSor equal to thearrayLayersmember of theVkImageCreateInfoused to create the image minusbaseArrayLayer
Valid Usage (Implicit)
srcSubresourcemust be a validVkImageSubresourceLayersstructuredstSubresourcemust be a validVkImageSubresourceLayersstructure
See Also
VkImageSubresourceLayers, VkOffset3D, CmdBlitImage
Layout
struct VkImageBlit {
VkImageSubresourceLayers srcSubresource();
VkOffset3D srcOffsets()[2];
VkImageSubresourceLayers dstSubresource();
VkOffset3D dstOffsets()[2];
}-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkImageBlit(ByteBuffer container) Creates aVkImageBlitinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkImageBlitcalloc()Returns a newVkImageBlitinstance allocated withmemCalloc.static VkImageBlit.Buffercalloc(int capacity) Returns a newVkImageBlit.Bufferinstance allocated withmemCalloc.static VkImageBlit.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImageBlit.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImageBlitcalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkImageBlitinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImageBlitDeprecated.static VkImageBlit.BuffercallocStack(int capacity) Deprecated.static VkImageBlit.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkImageBlitcallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static VkImageBlitcreate()Returns a newVkImageBlitinstance allocated withBufferUtils.static VkImageBlit.Buffercreate(int capacity) Returns a newVkImageBlit.Bufferinstance allocated withBufferUtils.static VkImageBlitcreate(long address) Returns a newVkImageBlitinstance for the specified memory address.static VkImageBlit.Buffercreate(long address, int capacity) Create aVkImageBlit.Bufferinstance at the specified memory.static @Nullable VkImageBlitcreateSafe(long address) static @Nullable VkImageBlit.BuffercreateSafe(long address, int capacity) a pointer to an array of twoVkOffset3Dstructures specifying the bounds of the destination region withindstSubresource.dstOffsets(int index) a pointer to an array of twoVkOffset3Dstructures specifying the bounds of the destination region withindstSubresource.dstOffsets(int index, Consumer<VkOffset3D> consumer) dstOffsets(int index, VkOffset3D value) Copies the specifiedVkOffset3Dat the specified index of thedstOffsets()field.dstOffsets(Consumer<VkOffset3D.Buffer> consumer) Passes thedstOffsets()field to the specifiedConsumer.dstOffsets(VkOffset3D.Buffer value) Copies the specifiedVkOffset3D.Bufferto thedstOffsets()field.the subresource to blit into.dstSubresource(Consumer<VkImageSubresourceLayers> consumer) Passes thedstSubresource()field to the specifiedConsumer.Copies the specifiedVkImageSubresourceLayersto thedstSubresource()field.static VkImageBlitmalloc()Returns a newVkImageBlitinstance allocated withmemAlloc.static VkImageBlit.Buffermalloc(int capacity) Returns a newVkImageBlit.Bufferinstance allocated withmemAlloc.static VkImageBlit.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImageBlit.Bufferinstance allocated on the specifiedMemoryStack.static VkImageBlitmalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkImageBlitinstance allocated on the specifiedMemoryStack.static VkImageBlitDeprecated.static VkImageBlit.BuffermallocStack(int capacity) Deprecated.static VkImageBlit.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkImageBlitmallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.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 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.set(VkImageBlit src) Copies the specified struct data to this struct.set(VkImageSubresourceLayers srcSubresource, VkOffset3D.Buffer srcOffsets, VkImageSubresourceLayers dstSubresource, VkOffset3D.Buffer dstOffsets) Initializes this struct with the specified values.intsizeof()a pointer to an array of twoVkOffset3Dstructures specifying the bounds of the source region withinsrcSubresource.srcOffsets(int index) a pointer to an array of twoVkOffset3Dstructures specifying the bounds of the source region withinsrcSubresource.srcOffsets(int index, Consumer<VkOffset3D> consumer) srcOffsets(int index, VkOffset3D value) Copies the specifiedVkOffset3Dat the specified index of thesrcOffsets()field.srcOffsets(Consumer<VkOffset3D.Buffer> consumer) Passes thesrcOffsets()field to the specifiedConsumer.srcOffsets(VkOffset3D.Buffer value) Copies the specifiedVkOffset3D.Bufferto thesrcOffsets()field.the subresource to blit from.srcSubresource(Consumer<VkImageSubresourceLayers> consumer) Passes thesrcSubresource()field to the specifiedConsumer.Copies the specifiedVkImageSubresourceLayersto thesrcSubresource()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
SRCSUBRESOURCE
public static final int SRCSUBRESOURCEThe struct member offsets. -
SRCOFFSETS
public static final int SRCOFFSETSThe struct member offsets. -
DSTSUBRESOURCE
public static final int DSTSUBRESOURCEThe struct member offsets. -
DSTOFFSETS
public static final int DSTOFFSETSThe struct member offsets.
-
-
Constructor Details
-
VkImageBlit
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 Details
-
sizeof
public int sizeof()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkImageBlit>
-
srcSubresource
the subresource to blit from. -
srcOffsets
a pointer to an array of twoVkOffset3Dstructures specifying the bounds of the source region withinsrcSubresource. -
srcOffsets
a pointer to an array of twoVkOffset3Dstructures specifying the bounds of the source region withinsrcSubresource. -
dstSubresource
the subresource to blit into. -
dstOffsets
a pointer to an array of twoVkOffset3Dstructures specifying the bounds of the destination region withindstSubresource. -
dstOffsets
a pointer to an array of twoVkOffset3Dstructures specifying the bounds of the destination region withindstSubresource. -
srcSubresource
Copies the specifiedVkImageSubresourceLayersto thesrcSubresource()field. -
srcSubresource
Passes thesrcSubresource()field to the specifiedConsumer. -
srcOffsets
Copies the specifiedVkOffset3D.Bufferto thesrcOffsets()field. -
srcOffsets
Copies the specifiedVkOffset3Dat the specified index of thesrcOffsets()field. -
srcOffsets
Passes thesrcOffsets()field to the specifiedConsumer. -
srcOffsets
-
dstSubresource
Copies the specifiedVkImageSubresourceLayersto thedstSubresource()field. -
dstSubresource
Passes thedstSubresource()field to the specifiedConsumer. -
dstOffsets
Copies the specifiedVkOffset3D.Bufferto thedstOffsets()field. -
dstOffsets
Copies the specifiedVkOffset3Dat the specified index of thedstOffsets()field. -
dstOffsets
Passes thedstOffsets()field to the specifiedConsumer. -
dstOffsets
-
set
public VkImageBlit set(VkImageSubresourceLayers srcSubresource, VkOffset3D.Buffer srcOffsets, VkImageSubresourceLayers dstSubresource, VkOffset3D.Buffer dstOffsets) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkImageBlitinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkImageBlitinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkImageBlitinstance allocated withBufferUtils. -
create
Returns a newVkImageBlitinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkImageBlit.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkImageBlit.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkImageBlit.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkImageBlit.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
mallocStack
@Deprecated public static VkImageBlit.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkImageBlit.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkImageBlitinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkImageBlitinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
Returns a newVkImageBlit.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
Returns a newVkImageBlit.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsrcSubresource
Unsafe version ofsrcSubresource(). -
nsrcOffsets
Unsafe version ofsrcOffsets(). -
nsrcOffsets
Unsafe version ofsrcOffsets. -
ndstSubresource
Unsafe version ofdstSubresource(). -
ndstOffsets
Unsafe version ofdstOffsets(). -
ndstOffsets
Unsafe version ofdstOffsets. -
nsrcSubresource
Unsafe version ofsrcSubresource. -
nsrcOffsets
Unsafe version ofsrcOffsets. -
nsrcOffsets
Unsafe version ofsrcOffsets. -
ndstSubresource
Unsafe version ofdstSubresource. -
ndstOffsets
Unsafe version ofdstOffsets. -
ndstOffsets
Unsafe version ofdstOffsets.
-