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
srcSubresource
must be a validVkImageSubresourceLayers
structuredstSubresource
must be a validVkImageSubresourceLayers
structure- The
aspectMask
member ofsrcSubresource
anddstSubresource
must match - 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 - The
aspectMask
member ofsrcSubresource
must specify aspects present in the calling command'ssrcImage
- The
aspectMask
member ofdstSubresource
must 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 {
VkImageSubresourceLayers
srcSubresource;VkOffset3D
[2] srcOffsets;VkImageSubresourceLayers
dstSubresource;VkOffset3D
[2] dstOffsets; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkImageBlit.Buffer
An array ofVkImageBlit
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The 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 aVkImageBlit
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static VkImageBlit
calloc()
Returns a newVkImageBlit
instance allocated withmemCalloc
.static VkImageBlit.Buffer
calloc(int capacity)
Returns a newVkImageBlit.Buffer
instance allocated withmemCalloc
.static VkImageBlit
callocStack()
Returns a newVkImageBlit
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImageBlit.Buffer
callocStack(int capacity)
Returns a newVkImageBlit.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImageBlit.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkImageBlit.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImageBlit
callocStack(MemoryStack stack)
Returns a newVkImageBlit
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.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)
static VkImageBlit.Buffer
create(long address, int capacity)
Create aVkImageBlit.Buffer
instance at the specified memory.VkOffset3D.Buffer
dstOffsets()
Returns aVkOffset3D
.Buffer view of thedstOffsets
field.VkOffset3D
dstOffsets(int index)
Returns aVkOffset3D
view of the struct at the specified index of thedstOffsets
field.VkImageBlit
dstOffsets(int index, VkOffset3D value)
Copies the specifiedVkOffset3D
at the specified index of thedstOffsets
field.VkImageBlit
dstOffsets(VkOffset3D.Buffer value)
Copies the specifiedVkOffset3D.Buffer
to thedstOffsets
field.VkImageSubresourceLayers
dstSubresource()
Returns aVkImageSubresourceLayers
view of thedstSubresource
field.VkImageBlit
dstSubresource(VkImageSubresourceLayers value)
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
mallocStack()
Returns a newVkImageBlit
instance allocated on the thread-localMemoryStack
.static VkImageBlit.Buffer
mallocStack(int capacity)
Returns a newVkImageBlit.Buffer
instance allocated on the thread-localMemoryStack
.static VkImageBlit.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkImageBlit.Buffer
instance allocated on the specifiedMemoryStack
.static VkImageBlit
mallocStack(MemoryStack stack)
Returns a newVkImageBlit
instance allocated on the specifiedMemoryStack
.VkImageBlit
nset(long struct)
Unsafe version ofset
.VkImageBlit
set(VkImageBlit src)
Copies the specified struct data to this struct.VkImageBlit
set(VkImageSubresourceLayers srcSubresource, VkOffset3D.Buffer srcOffsets, VkImageSubresourceLayers dstSubresource, VkOffset3D.Buffer dstOffsets)
Initializes this struct with the specified values.int
sizeof()
Returns thesizeof(struct)
.VkOffset3D.Buffer
srcOffsets()
Returns aVkOffset3D
.Buffer view of thesrcOffsets
field.VkOffset3D
srcOffsets(int index)
Returns aVkOffset3D
view of the struct at the specified index of thesrcOffsets
field.VkImageBlit
srcOffsets(int index, VkOffset3D value)
Copies the specifiedVkOffset3D
at the specified index of thesrcOffsets
field.VkImageBlit
srcOffsets(VkOffset3D.Buffer value)
Copies the specifiedVkOffset3D.Buffer
to thesrcOffsets
field.VkImageSubresourceLayers
srcSubresource()
Returns aVkImageSubresourceLayers
view of thesrcSubresource
field.VkImageBlit
srcSubresource(VkImageSubresourceLayers value)
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
-
-
-
-
Constructor Detail
-
VkImageBlit
public VkImageBlit(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
Description copied from class:Struct
Returns thesizeof(struct)
.
-
srcSubresource
public VkImageSubresourceLayers srcSubresource()
Returns aVkImageSubresourceLayers
view of thesrcSubresource
field.
-
srcOffsets
public VkOffset3D.Buffer srcOffsets()
Returns aVkOffset3D
.Buffer view of thesrcOffsets
field.
-
srcOffsets
public VkOffset3D srcOffsets(int index)
Returns aVkOffset3D
view of the struct at the specified index of thesrcOffsets
field.
-
dstSubresource
public VkImageSubresourceLayers dstSubresource()
Returns aVkImageSubresourceLayers
view of thedstSubresource
field.
-
dstOffsets
public VkOffset3D.Buffer dstOffsets()
Returns aVkOffset3D
.Buffer view of thedstOffsets
field.
-
dstOffsets
public VkOffset3D dstOffsets(int index)
Returns aVkOffset3D
view of the struct at the specified index of thedstOffsets
field.
-
srcSubresource
public VkImageBlit srcSubresource(VkImageSubresourceLayers value)
Copies the specifiedVkImageSubresourceLayers
to thesrcSubresource
field.
-
srcOffsets
public VkImageBlit srcOffsets(VkOffset3D.Buffer value)
Copies the specifiedVkOffset3D.Buffer
to thesrcOffsets
field.
-
srcOffsets
public VkImageBlit srcOffsets(int index, VkOffset3D value)
Copies the specifiedVkOffset3D
at the specified index of thesrcOffsets
field.
-
dstSubresource
public VkImageBlit dstSubresource(VkImageSubresourceLayers value)
Copies the specifiedVkImageSubresourceLayers
to thedstSubresource
field.
-
dstOffsets
public VkImageBlit dstOffsets(VkOffset3D.Buffer value)
Copies the specifiedVkOffset3D.Buffer
to thedstOffsets
field.
-
dstOffsets
public VkImageBlit dstOffsets(int index, VkOffset3D value)
Copies the specifiedVkOffset3D
at the specified index of thedstOffsets
field.
-
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 newVkImageBlit
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkImageBlit calloc()
Returns a newVkImageBlit
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkImageBlit create()
Returns a newVkImageBlit
instance allocated withBufferUtils
.
-
create
public static VkImageBlit create(long address)
-
malloc
public static VkImageBlit.Buffer malloc(int capacity)
Returns a newVkImageBlit.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkImageBlit.Buffer calloc(int capacity)
Returns a newVkImageBlit.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImageBlit.Buffer create(int capacity)
Returns a newVkImageBlit.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImageBlit.Buffer create(long address, int capacity)
Create aVkImageBlit.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkImageBlit mallocStack()
Returns a newVkImageBlit
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkImageBlit callocStack()
Returns a newVkImageBlit
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkImageBlit mallocStack(MemoryStack stack)
Returns a newVkImageBlit
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkImageBlit callocStack(MemoryStack stack)
Returns a newVkImageBlit
instance allocated on the specifiedMemoryStack
and 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.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkImageBlit.Buffer callocStack(int capacity)
Returns a newVkImageBlit.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkImageBlit.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkImageBlit.Buffer
instance 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.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-