Package org.lwjgl.vulkan
Class VkBufferImageCopy
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkBufferImageCopy>
org.lwjgl.vulkan.VkBufferImageCopy
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkBufferImageCopy
extends org.lwjgl.system.Struct<VkBufferImageCopy>
implements org.lwjgl.system.NativeResource
Structure specifying a buffer image copy operation.
Valid Usage
bufferRowLengthmust be 0, or greater than or equal to thewidthmember ofimageExtentbufferImageHeightmust be 0, or greater than or equal to theheightmember ofimageExtent- The
aspectMaskmember ofimageSubresourcemust only have a single bit set imageExtent.widthmust not be 0imageExtent.heightmust not be 0imageExtent.depthmust not be 0
Valid Usage (Implicit)
imageSubresourcemust be a validVkImageSubresourceLayersstructure
See Also
VkExtent3D, VkImageSubresourceLayers, VkOffset3D, CmdCopyBufferToImage, CmdCopyImageToBuffer
Layout
struct VkBufferImageCopy {
VkDeviceSize bufferOffset();
uint32_t bufferRowLength();
uint32_t bufferImageHeight();
VkImageSubresourceLayers imageSubresource();
VkOffset3D imageOffset();
VkExtent3D imageExtent();
}-
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 member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkBufferImageCopy(ByteBuffer container) Creates aVkBufferImageCopyinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionintseebufferRowLengthbufferImageHeight(int value) Sets the specified value to thebufferImageHeight()field.longthe offset in bytes from the start of the buffer object where the image data is copied from or to.bufferOffset(long value) Sets the specified value to thebufferOffset()field.intbufferRowLengthandbufferImageHeightspecify in texels a subregion of a larger two- or three-dimensional image in buffer memory, and control the addressing calculations.bufferRowLength(int value) Sets the specified value to thebufferRowLength()field.static VkBufferImageCopycalloc()Returns a newVkBufferImageCopyinstance allocated withmemCalloc.static VkBufferImageCopy.Buffercalloc(int capacity) Returns a newVkBufferImageCopy.Bufferinstance allocated withmemCalloc.static VkBufferImageCopy.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkBufferImageCopy.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkBufferImageCopycalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkBufferImageCopyinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkBufferImageCopyDeprecated.static VkBufferImageCopy.BuffercallocStack(int capacity) Deprecated.static VkBufferImageCopy.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkBufferImageCopycallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static VkBufferImageCopycreate()Returns a newVkBufferImageCopyinstance allocated withBufferUtils.static VkBufferImageCopy.Buffercreate(int capacity) Returns a newVkBufferImageCopy.Bufferinstance allocated withBufferUtils.static VkBufferImageCopycreate(long address) Returns a newVkBufferImageCopyinstance for the specified memory address.static VkBufferImageCopy.Buffercreate(long address, int capacity) Create aVkBufferImageCopy.Bufferinstance at the specified memory.static @Nullable VkBufferImageCopycreateSafe(long address) static @Nullable VkBufferImageCopy.BuffercreateSafe(long address, int capacity) the size in texels of the image to copy inwidth,heightanddepth.imageExtent(Consumer<VkExtent3D> consumer) Passes theimageExtent()field to the specifiedConsumer.imageExtent(VkExtent3D value) Copies the specifiedVkExtent3Dto theimageExtent()field.selects the initialx,y,zoffsets in texels of the sub-region of the source or destination image data.imageOffset(Consumer<VkOffset3D> consumer) Passes theimageOffset()field to the specifiedConsumer.imageOffset(VkOffset3D value) Copies the specifiedVkOffset3Dto theimageOffset()field.aVkImageSubresourceLayersused to specify the specific image subresources of the image used for the source or destination image data.imageSubresource(Consumer<VkImageSubresourceLayers> consumer) Passes theimageSubresource()field to the specifiedConsumer.Copies the specifiedVkImageSubresourceLayersto theimageSubresource()field.static VkBufferImageCopymalloc()Returns a newVkBufferImageCopyinstance allocated withmemAlloc.static VkBufferImageCopy.Buffermalloc(int capacity) Returns a newVkBufferImageCopy.Bufferinstance allocated withmemAlloc.static VkBufferImageCopy.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkBufferImageCopy.Bufferinstance allocated on the specifiedMemoryStack.static VkBufferImageCopymalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkBufferImageCopyinstance allocated on the specifiedMemoryStack.static VkBufferImageCopyDeprecated.static VkBufferImageCopy.BuffermallocStack(int capacity) Deprecated.static VkBufferImageCopy.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkBufferImageCopymallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static intnbufferImageHeight(long struct) Unsafe version ofbufferImageHeight().static voidnbufferImageHeight(long struct, int value) Unsafe version ofbufferImageHeight.static longnbufferOffset(long struct) Unsafe version ofbufferOffset().static voidnbufferOffset(long struct, long value) Unsafe version ofbufferOffset.static intnbufferRowLength(long struct) Unsafe version ofbufferRowLength().static voidnbufferRowLength(long struct, int value) Unsafe version ofbufferRowLength.static VkExtent3DnimageExtent(long struct) Unsafe version ofimageExtent().static voidnimageExtent(long struct, VkExtent3D value) Unsafe version ofimageExtent.static VkOffset3DnimageOffset(long struct) Unsafe version ofimageOffset().static voidnimageOffset(long struct, VkOffset3D value) Unsafe version ofimageOffset.static VkImageSubresourceLayersnimageSubresource(long struct) Unsafe version ofimageSubresource().static voidnimageSubresource(long struct, VkImageSubresourceLayers value) Unsafe version ofimageSubresource.set(long bufferOffset, int bufferRowLength, int bufferImageHeight, VkImageSubresourceLayers imageSubresource, VkOffset3D imageOffset, VkExtent3D imageExtent) Initializes this struct with the specified values.set(VkBufferImageCopy src) Copies the specified struct data to this struct.intsizeof()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. -
BUFFEROFFSET
public static final int BUFFEROFFSETThe struct member offsets. -
BUFFERROWLENGTH
public static final int BUFFERROWLENGTHThe struct member offsets. -
BUFFERIMAGEHEIGHT
public static final int BUFFERIMAGEHEIGHTThe struct member offsets. -
IMAGESUBRESOURCE
public static final int IMAGESUBRESOURCEThe struct member offsets. -
IMAGEOFFSET
public static final int IMAGEOFFSETThe struct member offsets. -
IMAGEEXTENT
public static final int IMAGEEXTENTThe struct member offsets.
-
-
Constructor Details
-
VkBufferImageCopy
Creates aVkBufferImageCopyinstance 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<VkBufferImageCopy>
-
bufferOffset
public long bufferOffset()the offset in bytes from the start of the buffer object where the image data is copied from or to. -
bufferRowLength
public int bufferRowLength()bufferRowLengthandbufferImageHeightspecify in texels a subregion of a larger two- or three-dimensional image in buffer memory, and control the addressing calculations. If either of these values is zero, that aspect of the buffer memory is considered to be tightly packed according to theimageExtent. -
bufferImageHeight
public int bufferImageHeight()seebufferRowLength -
imageSubresource
aVkImageSubresourceLayersused to specify the specific image subresources of the image used for the source or destination image data. -
imageOffset
selects the initialx,y,zoffsets in texels of the sub-region of the source or destination image data. -
imageExtent
the size in texels of the image to copy inwidth,heightanddepth. -
bufferOffset
Sets the specified value to thebufferOffset()field. -
bufferRowLength
Sets the specified value to thebufferRowLength()field. -
bufferImageHeight
Sets the specified value to thebufferImageHeight()field. -
imageSubresource
Copies the specifiedVkImageSubresourceLayersto theimageSubresource()field. -
imageSubresource
Passes theimageSubresource()field to the specifiedConsumer. -
imageOffset
Copies the specifiedVkOffset3Dto theimageOffset()field. -
imageOffset
Passes theimageOffset()field to the specifiedConsumer. -
imageExtent
Copies the specifiedVkExtent3Dto theimageExtent()field. -
imageExtent
Passes theimageExtent()field to the specifiedConsumer. -
set
public VkBufferImageCopy set(long bufferOffset, int bufferRowLength, int bufferImageHeight, VkImageSubresourceLayers imageSubresource, VkOffset3D imageOffset, VkExtent3D imageExtent) 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 newVkBufferImageCopyinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkBufferImageCopyinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkBufferImageCopyinstance allocated withBufferUtils. -
create
Returns a newVkBufferImageCopyinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkBufferImageCopy.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkBufferImageCopy.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkBufferImageCopy.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkBufferImageCopy.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 VkBufferImageCopy.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 VkBufferImageCopy.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkBufferImageCopyinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkBufferImageCopyinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
Returns a newVkBufferImageCopy.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
Returns a newVkBufferImageCopy.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nbufferOffset
public static long nbufferOffset(long struct) Unsafe version ofbufferOffset(). -
nbufferRowLength
public static int nbufferRowLength(long struct) Unsafe version ofbufferRowLength(). -
nbufferImageHeight
public static int nbufferImageHeight(long struct) Unsafe version ofbufferImageHeight(). -
nimageSubresource
Unsafe version ofimageSubresource(). -
nimageOffset
Unsafe version ofimageOffset(). -
nimageExtent
Unsafe version ofimageExtent(). -
nbufferOffset
public static void nbufferOffset(long struct, long value) Unsafe version ofbufferOffset. -
nbufferRowLength
public static void nbufferRowLength(long struct, int value) Unsafe version ofbufferRowLength. -
nbufferImageHeight
public static void nbufferImageHeight(long struct, int value) Unsafe version ofbufferImageHeight. -
nimageSubresource
Unsafe version ofimageSubresource. -
nimageOffset
Unsafe version ofimageOffset. -
nimageExtent
Unsafe version ofimageExtent.
-