Package org.lwjgl.vulkan
Class VkImageResolve
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkImageResolve
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,NativeResource
,Pointer
public class VkImageResolve extends Struct implements NativeResource
Structure specifying an image resolve operation.Valid Usage
- The
aspectMask
member ofsrcSubresource
anddstSubresource
must only containIMAGE_ASPECT_COLOR_BIT
- The
layerCount
member ofsrcSubresource
anddstSubresource
must match - If either of the calling command’s
srcImage
ordstImage
parameters are ofVkImageType
IMAGE_TYPE_3D
, thebaseArrayLayer
andlayerCount
members of bothsrcSubresource
anddstSubresource
must be 0 and 1, respectively srcOffset.x
and(extent.width srcOffset.x)
must both be greater than or equal to 0 and less than or equal to the source image subresource widthsrcOffset.y
and(extent.height srcOffset.y)
must both be greater than or equal to 0 and less than or equal to the source image subresource height- If the calling command’s
srcImage
is of typeIMAGE_TYPE_1D
, thensrcOffset.y
must be 0 andextent.height
must be 1. srcOffset.z
and(extent.depth srcOffset.z)
must both be greater than or equal to 0 and less than or equal to the source image subresource depth- If the calling command’s
srcImage
is of typeIMAGE_TYPE_1D
orIMAGE_TYPE_2D
, thensrcOffset.z
must be 0 andextent.depth
must be 1. dstOffset.x
and(extent.width dstOffset.x)
must both be greater than or equal to 0 and less than or equal to the destination image subresource widthdstOffset.y
and(extent.height dstOffset.y)
must both be greater than or equal to 0 and less than or equal to the destination image subresource height- If the calling command’s
dstImage
is of typeIMAGE_TYPE_1D
, thendstOffset.y
must be 0 andextent.height
must be 1. dstOffset.z
and(extent.depth dstOffset.z)
must both be greater than or equal to 0 and less than or equal to the destination image subresource depth- If the calling command’s
dstImage
is of typeIMAGE_TYPE_1D
orIMAGE_TYPE_2D
, thendstOffset.z
must be 0 andextent.depth
must be 1.
Valid Usage (Implicit)
srcSubresource
must be a validVkImageSubresourceLayers
structuredstSubresource
must be a validVkImageSubresourceLayers
structure
See Also
VkExtent3D
,VkImageSubresourceLayers
,VkOffset3D
,CmdResolveImage
Member documentation
srcSubresource
–srcSubresource
anddstSubresource
areVkImageSubresourceLayers
structures specifying the image subresources of the images used for the source and destination image data, respectively. Resolve of depth/stencil images is not supported.srcOffset
–srcOffset
anddstOffset
select the initialx
,y
, andz
offsets in texels of the sub-regions of the source and destination image data.dstSubresource
– seesrcSubresource
dstOffset
– seesrcOffset
extent
– the size in texels of the source image to resolve inwidth
,height
anddepth
.
Layout
struct VkImageResolve {
VkImageSubresourceLayers
srcSubresource;VkOffset3D
srcOffset;VkImageSubresourceLayers
dstSubresource;VkOffset3D
dstOffset;VkExtent3D
extent; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkImageResolve.Buffer
An array ofVkImageResolve
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
DSTOFFSET
DSTSUBRESOURCE
EXTENTThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
SRCOFFSET
SRCSUBRESOURCEThe struct member offsets.-
Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor Description VkImageResolve(java.nio.ByteBuffer container)
Creates aVkImageResolve
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkImageResolve
calloc()
Returns a newVkImageResolve
instance allocated withmemCalloc
.static VkImageResolve.Buffer
calloc(int capacity)
Returns a newVkImageResolve.Buffer
instance allocated withmemCalloc
.static VkImageResolve
callocStack()
Returns a newVkImageResolve
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImageResolve.Buffer
callocStack(int capacity)
Returns a newVkImageResolve.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImageResolve.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkImageResolve.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImageResolve
callocStack(MemoryStack stack)
Returns a newVkImageResolve
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImageResolve
create()
Returns a newVkImageResolve
instance allocated withBufferUtils
.static VkImageResolve.Buffer
create(int capacity)
Returns a newVkImageResolve.Buffer
instance allocated withBufferUtils
.static VkImageResolve
create(long address)
Returns a newVkImageResolve
instance for the specified memory address.static VkImageResolve.Buffer
create(long address, int capacity)
Create aVkImageResolve.Buffer
instance at the specified memory.static VkImageResolve
createSafe(long address)
static VkImageResolve.Buffer
createSafe(long address, int capacity)
VkOffset3D
dstOffset()
Returns aVkOffset3D
view of thedstOffset
field.VkImageResolve
dstOffset(java.util.function.Consumer<VkOffset3D> consumer)
Passes thedstOffset
field to the specifiedConsumer
.VkImageResolve
dstOffset(VkOffset3D value)
Copies the specifiedVkOffset3D
to thedstOffset
field.VkImageSubresourceLayers
dstSubresource()
Returns aVkImageSubresourceLayers
view of thedstSubresource
field.VkImageResolve
dstSubresource(java.util.function.Consumer<VkImageSubresourceLayers> consumer)
Passes thedstSubresource
field to the specifiedConsumer
.VkImageResolve
dstSubresource(VkImageSubresourceLayers value)
Copies the specifiedVkImageSubresourceLayers
to thedstSubresource
field.VkExtent3D
extent()
Returns aVkExtent3D
view of theextent
field.VkImageResolve
extent(java.util.function.Consumer<VkExtent3D> consumer)
Passes theextent
field to the specifiedConsumer
.VkImageResolve
extent(VkExtent3D value)
Copies the specifiedVkExtent3D
to theextent
field.static VkImageResolve
malloc()
Returns a newVkImageResolve
instance allocated withmemAlloc
.static VkImageResolve.Buffer
malloc(int capacity)
Returns a newVkImageResolve.Buffer
instance allocated withmemAlloc
.static VkImageResolve
mallocStack()
Returns a newVkImageResolve
instance allocated on the thread-localMemoryStack
.static VkImageResolve.Buffer
mallocStack(int capacity)
Returns a newVkImageResolve.Buffer
instance allocated on the thread-localMemoryStack
.static VkImageResolve.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkImageResolve.Buffer
instance allocated on the specifiedMemoryStack
.static VkImageResolve
mallocStack(MemoryStack stack)
Returns a newVkImageResolve
instance allocated on the specifiedMemoryStack
.static VkOffset3D
ndstOffset(long struct)
Unsafe version ofdstOffset()
.static void
ndstOffset(long struct, VkOffset3D value)
Unsafe version ofdstOffset
.static VkImageSubresourceLayers
ndstSubresource(long struct)
Unsafe version ofdstSubresource()
.static void
ndstSubresource(long struct, VkImageSubresourceLayers value)
Unsafe version ofdstSubresource
.static VkExtent3D
nextent(long struct)
Unsafe version ofextent()
.static void
nextent(long struct, VkExtent3D value)
Unsafe version ofextent
.static VkOffset3D
nsrcOffset(long struct)
Unsafe version ofsrcOffset()
.static void
nsrcOffset(long struct, VkOffset3D value)
Unsafe version ofsrcOffset
.static VkImageSubresourceLayers
nsrcSubresource(long struct)
Unsafe version ofsrcSubresource()
.static void
nsrcSubresource(long struct, VkImageSubresourceLayers value)
Unsafe version ofsrcSubresource
.VkImageResolve
set(VkImageResolve src)
Copies the specified struct data to this struct.VkImageResolve
set(VkImageSubresourceLayers srcSubresource, VkOffset3D srcOffset, VkImageSubresourceLayers dstSubresource, VkOffset3D dstOffset, VkExtent3D extent)
Initializes this struct with the specified values.int
sizeof()
Returnssizeof(struct)
.VkOffset3D
srcOffset()
Returns aVkOffset3D
view of thesrcOffset
field.VkImageResolve
srcOffset(java.util.function.Consumer<VkOffset3D> consumer)
Passes thesrcOffset
field to the specifiedConsumer
.VkImageResolve
srcOffset(VkOffset3D value)
Copies the specifiedVkOffset3D
to thesrcOffset
field.VkImageSubresourceLayers
srcSubresource()
Returns aVkImageSubresourceLayers
view of thesrcSubresource
field.VkImageResolve
srcSubresource(java.util.function.Consumer<VkImageSubresourceLayers> consumer)
Passes thesrcSubresource
field to the specifiedConsumer
.VkImageResolve
srcSubresource(VkImageSubresourceLayers value)
Copies the specifiedVkImageSubresourceLayers
to thesrcSubresource
field.-
Methods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
-
-
-
Constructor Detail
-
VkImageResolve
public VkImageResolve(java.nio.ByteBuffer container)
Creates aVkImageResolve
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 Detail
-
sizeof
public int sizeof()
Description copied from class:Struct
Returnssizeof(struct)
.
-
srcSubresource
public VkImageSubresourceLayers srcSubresource()
Returns aVkImageSubresourceLayers
view of thesrcSubresource
field.
-
srcSubresource
public VkImageResolve srcSubresource(java.util.function.Consumer<VkImageSubresourceLayers> consumer)
Passes thesrcSubresource
field to the specifiedConsumer
.
-
srcOffset
public VkOffset3D srcOffset()
Returns aVkOffset3D
view of thesrcOffset
field.
-
srcOffset
public VkImageResolve srcOffset(java.util.function.Consumer<VkOffset3D> consumer)
Passes thesrcOffset
field to the specifiedConsumer
.
-
dstSubresource
public VkImageSubresourceLayers dstSubresource()
Returns aVkImageSubresourceLayers
view of thedstSubresource
field.
-
dstSubresource
public VkImageResolve dstSubresource(java.util.function.Consumer<VkImageSubresourceLayers> consumer)
Passes thedstSubresource
field to the specifiedConsumer
.
-
dstOffset
public VkOffset3D dstOffset()
Returns aVkOffset3D
view of thedstOffset
field.
-
dstOffset
public VkImageResolve dstOffset(java.util.function.Consumer<VkOffset3D> consumer)
Passes thedstOffset
field to the specifiedConsumer
.
-
extent
public VkExtent3D extent()
Returns aVkExtent3D
view of theextent
field.
-
extent
public VkImageResolve extent(java.util.function.Consumer<VkExtent3D> consumer)
Passes theextent
field to the specifiedConsumer
.
-
srcSubresource
public VkImageResolve srcSubresource(VkImageSubresourceLayers value)
Copies the specifiedVkImageSubresourceLayers
to thesrcSubresource
field.
-
srcOffset
public VkImageResolve srcOffset(VkOffset3D value)
Copies the specifiedVkOffset3D
to thesrcOffset
field.
-
dstSubresource
public VkImageResolve dstSubresource(VkImageSubresourceLayers value)
Copies the specifiedVkImageSubresourceLayers
to thedstSubresource
field.
-
dstOffset
public VkImageResolve dstOffset(VkOffset3D value)
Copies the specifiedVkOffset3D
to thedstOffset
field.
-
extent
public VkImageResolve extent(VkExtent3D value)
Copies the specifiedVkExtent3D
to theextent
field.
-
set
public VkImageResolve set(VkImageSubresourceLayers srcSubresource, VkOffset3D srcOffset, VkImageSubresourceLayers dstSubresource, VkOffset3D dstOffset, VkExtent3D extent)
Initializes this struct with the specified values.
-
set
public VkImageResolve set(VkImageResolve src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkImageResolve malloc()
Returns a newVkImageResolve
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkImageResolve calloc()
Returns a newVkImageResolve
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkImageResolve create()
Returns a newVkImageResolve
instance allocated withBufferUtils
.
-
create
public static VkImageResolve create(long address)
Returns a newVkImageResolve
instance for the specified memory address.
-
createSafe
@Nullable public static VkImageResolve createSafe(long address)
-
malloc
public static VkImageResolve.Buffer malloc(int capacity)
Returns a newVkImageResolve.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkImageResolve.Buffer calloc(int capacity)
Returns a newVkImageResolve.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImageResolve.Buffer create(int capacity)
Returns a newVkImageResolve.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImageResolve.Buffer create(long address, int capacity)
Create aVkImageResolve.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkImageResolve.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkImageResolve mallocStack()
Returns a newVkImageResolve
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkImageResolve callocStack()
Returns a newVkImageResolve
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkImageResolve mallocStack(MemoryStack stack)
Returns a newVkImageResolve
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkImageResolve callocStack(MemoryStack stack)
Returns a newVkImageResolve
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkImageResolve.Buffer mallocStack(int capacity)
Returns a newVkImageResolve.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkImageResolve.Buffer callocStack(int capacity)
Returns a newVkImageResolve.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkImageResolve.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkImageResolve.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkImageResolve.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkImageResolve.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
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()
.
-
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
.
-
-