Package org.lwjgl.vulkan
Class VkImageBlit
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
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
aspectMask
member ofsrcSubresource
anddstSubresource
must match - If neither of the
layerCount
members ofsrcSubresource
ordstSubresource
areREMAINING_ARRAY_LAYERS
, thelayerCount
members ofsrcSubresource
ordstSubresource
must match - If the
maintenance5
feature is not enabled, thelayerCount
member ofsrcSubresource
ordstSubresource
must not beREMAINING_ARRAY_LAYERS
- If one of the
layerCount
members ofsrcSubresource
ordstSubresource
isREMAINING_ARRAY_LAYERS
, the other member must be eitherREMAINING_ARRAY_LAYERS
or equal to thearrayLayers
member of theVkImageCreateInfo
used to create the image minusbaseArrayLayer
Valid Usage (Implicit)
srcSubresource
must be a validVkImageSubresourceLayers
structuredstSubresource
must be a validVkImageSubresourceLayers
structure
See Also
VkImageSubresourceLayers
, VkOffset3D
, CmdBlitImage
Layout
struct VkImageBlit {
VkImageSubresourceLayers
srcSubresource()
;
VkOffset3D
srcOffsets()
[2];
VkImageSubresourceLayers
dstSubresource()
;
VkOffset3D
dstOffsets()
[2];
}
-
Nested Class Summary
Nested classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionVkImageBlit
(ByteBuffer container) Creates aVkImageBlit
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkImageBlit
calloc()
Returns a newVkImageBlit
instance allocated withmemCalloc
.static VkImageBlit.Buffer
calloc
(int capacity) Returns a newVkImageBlit.Buffer
instance allocated withmemCalloc
.static VkImageBlit.Buffer
calloc
(int capacity, MemoryStack stack) Returns a newVkImageBlit.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImageBlit
calloc
(MemoryStack stack) Returns a newVkImageBlit
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImageBlit
Deprecated.static VkImageBlit.Buffer
callocStack
(int capacity) Deprecated.static VkImageBlit.Buffer
callocStack
(int capacity, MemoryStack stack) Deprecated.static VkImageBlit
callocStack
(MemoryStack stack) Deprecated.static VkImageBlit
create()
Returns a newVkImageBlit
instance allocated withBufferUtils
.static VkImageBlit.Buffer
create
(int capacity) Returns a newVkImageBlit.Buffer
instance allocated withBufferUtils
.static VkImageBlit
create
(long address) Returns a newVkImageBlit
instance for the specified memory address.static VkImageBlit.Buffer
create
(long address, int capacity) Create aVkImageBlit.Buffer
instance at the specified memory.static VkImageBlit
createSafe
(long address) static VkImageBlit.Buffer
createSafe
(long address, int capacity) a pointer to an array of twoVkOffset3D
structures specifying the bounds of the destination region withindstSubresource
.dstOffsets
(int index) a pointer to an array of twoVkOffset3D
structures specifying the bounds of the destination region withindstSubresource
.dstOffsets
(int index, Consumer<VkOffset3D> consumer) dstOffsets
(int index, VkOffset3D value) Copies the specifiedVkOffset3D
at the specified index of thedstOffsets()
field.dstOffsets
(Consumer<VkOffset3D.Buffer> consumer) Passes thedstOffsets()
field to the specifiedConsumer
.dstOffsets
(VkOffset3D.Buffer value) Copies the specifiedVkOffset3D.Buffer
to thedstOffsets()
field.the subresource to blit into.dstSubresource
(Consumer<VkImageSubresourceLayers> consumer) Passes thedstSubresource()
field to the specifiedConsumer
.Copies the specifiedVkImageSubresourceLayers
to thedstSubresource()
field.static VkImageBlit
malloc()
Returns a newVkImageBlit
instance allocated withmemAlloc
.static VkImageBlit.Buffer
malloc
(int capacity) Returns a newVkImageBlit.Buffer
instance allocated withmemAlloc
.static VkImageBlit.Buffer
malloc
(int capacity, MemoryStack stack) Returns a newVkImageBlit.Buffer
instance allocated on the specifiedMemoryStack
.static VkImageBlit
malloc
(MemoryStack stack) Returns a newVkImageBlit
instance allocated on the specifiedMemoryStack
.static VkImageBlit
Deprecated.static VkImageBlit.Buffer
mallocStack
(int capacity) Deprecated.static VkImageBlit.Buffer
mallocStack
(int capacity, MemoryStack stack) Deprecated.static VkImageBlit
mallocStack
(MemoryStack stack) Deprecated.static VkOffset3D.Buffer
ndstOffsets
(long struct) Unsafe version ofdstOffsets()
.static VkOffset3D
ndstOffsets
(long struct, int index) Unsafe version ofdstOffsets
.static void
ndstOffsets
(long struct, int index, VkOffset3D value) Unsafe version ofdstOffsets
.static void
ndstOffsets
(long struct, VkOffset3D.Buffer value) Unsafe version ofdstOffsets
.static VkImageSubresourceLayers
ndstSubresource
(long struct) Unsafe version ofdstSubresource()
.static void
ndstSubresource
(long struct, VkImageSubresourceLayers value) Unsafe version ofdstSubresource
.static VkOffset3D.Buffer
nsrcOffsets
(long struct) Unsafe version ofsrcOffsets()
.static VkOffset3D
nsrcOffsets
(long struct, int index) Unsafe version ofsrcOffsets
.static void
nsrcOffsets
(long struct, int index, VkOffset3D value) Unsafe version ofsrcOffsets
.static void
nsrcOffsets
(long struct, VkOffset3D.Buffer value) Unsafe version ofsrcOffsets
.static VkImageSubresourceLayers
nsrcSubresource
(long struct) Unsafe version ofsrcSubresource()
.static void
nsrcSubresource
(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.int
sizeof()
Returnssizeof(struct)
.a pointer to an array of twoVkOffset3D
structures specifying the bounds of the source region withinsrcSubresource
.srcOffsets
(int index) a pointer to an array of twoVkOffset3D
structures specifying the bounds of the source region withinsrcSubresource
.srcOffsets
(int index, Consumer<VkOffset3D> consumer) srcOffsets
(int index, VkOffset3D value) Copies the specifiedVkOffset3D
at the specified index of thesrcOffsets()
field.srcOffsets
(Consumer<VkOffset3D.Buffer> consumer) Passes thesrcOffsets()
field to the specifiedConsumer
.srcOffsets
(VkOffset3D.Buffer value) Copies the specifiedVkOffset3D.Buffer
to thesrcOffsets()
field.the subresource to blit from.srcSubresource
(Consumer<VkImageSubresourceLayers> consumer) Passes thesrcSubresource()
field to the specifiedConsumer
.Copies the specifiedVkImageSubresourceLayers
to thesrcSubresource()
field.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods 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 aVkImageBlit
instance at the current position of the specifiedByteBuffer
container. 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()Description copied from class:Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkImageBlit>
-
srcSubresource
the subresource to blit from. -
srcOffsets
a pointer to an array of twoVkOffset3D
structures specifying the bounds of the source region withinsrcSubresource
. -
srcOffsets
a pointer to an array of twoVkOffset3D
structures specifying the bounds of the source region withinsrcSubresource
. -
dstSubresource
the subresource to blit into. -
dstOffsets
a pointer to an array of twoVkOffset3D
structures specifying the bounds of the destination region withindstSubresource
. -
dstOffsets
a pointer to an array of twoVkOffset3D
structures specifying the bounds of the destination region withindstSubresource
. -
srcSubresource
Copies the specifiedVkImageSubresourceLayers
to thesrcSubresource()
field. -
srcSubresource
Passes thesrcSubresource()
field to the specifiedConsumer
. -
srcOffsets
Copies the specifiedVkOffset3D.Buffer
to thesrcOffsets()
field. -
srcOffsets
Copies the specifiedVkOffset3D
at the specified index of thesrcOffsets()
field. -
srcOffsets
Passes thesrcOffsets()
field to the specifiedConsumer
. -
srcOffsets
-
dstSubresource
Copies the specifiedVkImageSubresourceLayers
to thedstSubresource()
field. -
dstSubresource
Passes thedstSubresource()
field to the specifiedConsumer
. -
dstOffsets
Copies the specifiedVkOffset3D.Buffer
to thedstOffsets()
field. -
dstOffsets
Copies the specifiedVkOffset3D
at 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 newVkImageBlit
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkImageBlit
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkImageBlit
instance allocated withBufferUtils
. -
create
Returns a newVkImageBlit
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkImageBlit.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkImageBlit.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkImageBlit.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkImageBlit.Buffer
instance 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.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkImageBlit
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkImageBlit
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkImageBlit.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkImageBlit.Buffer
instance allocated on the specifiedMemoryStack
and 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
.
-