Structure specifying parameters of a buffer to image copy command.

Valid Usage

If the image region specified by each element of pRegions does not contain VkCopyCommandTransformInfoQCOM in its pNext chain, it must be a region that is contained within the specified imageSubresource of dstImage
If the image region specified by each element of pRegions contains VkCopyCommandTransformInfoQCOM in its pNext chain, the rotated destination region as described in Buffer and Image Addressing with Rotation must be contained within dstImage
If any element of pRegions contains VkCopyCommandTransformInfoQCOM in its pNext chain, then dstImage must have a 1x1x1 texel block extent
If any element of pRegions contains VkCopyCommandTransformInfoQCOM in its pNext chain, then dstImage must be of type IMAGE_TYPE_2D
If any element of pRegions contains VkCopyCommandTransformInfoQCOM in its pNext chain, then dstImage must not have a multi-planar format

srcBuffer must be large enough to contain all buffer locations that are accessed according to Buffer and Image Addressing, for each element of pRegions
The union of all source regions, and the union of all destination regions, specified by the elements of pRegions, must not overlap in memory
srcBuffer must have been created with BUFFER_USAGE_TRANSFER_SRC_BIT usage flag
The format features of dstImage must contain FORMAT_FEATURE_TRANSFER_DST_BIT
If srcBuffer is non-sparse then it must be bound completely and contiguously to a single VkDeviceMemory object
dstImage must have been created with IMAGE_USAGE_TRANSFER_DST_BIT usage flag
dstImageLayout must specify the layout of the image subresources of dstImage specified in pRegions at the time this command is executed on a VkDevice
dstImageLayout must be IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, IMAGE_LAYOUT_GENERAL, or IMAGE_LAYOUT_SHARED_PRESENT_KHR
If VK_EXT_depth_range_unrestricted is not enabled, for each element of pRegions whose imageSubresource contains a depth aspect, the data in srcBuffer must be in the range [0,1]

If dstImage is non-sparse then the image or the specified disjoint plane must be bound completely and contiguously to a single VkDeviceMemory object
The imageSubresource.mipLevel member of each element of pRegions must be less than the mipLevels specified in VkImageCreateInfo when dstImage was created
The imageSubresource.baseArrayLayer + imageSubresource.layerCount of each element of pRegions , if imageSubresource.layerCount is not REMAINING_ARRAY_LAYERS and maintenance5 is not enabled, must be less than or equal to the arrayLayers specified in VkImageCreateInfo when dstImage was created
dstImage must not have been created with flags containing IMAGE_CREATE_SUBSAMPLED_BIT_EXT

dstImage must have a sample count equal to SAMPLE_COUNT_1_BIT

If dstImage is of type IMAGE_TYPE_1D, then for each element of pRegions, imageOffset.y must be 0 and imageExtent.height must be 1
For each element of pRegions, imageOffset.z and (imageExtent.depth + imageOffset.z) must both be greater than or equal to 0 and less than or equal to the depth of the specified imageSubresource of dstImage
If dstImage is of type IMAGE_TYPE_1D or IMAGE_TYPE_2D, then for each element of pRegions, imageOffset.z must be 0 and imageExtent.depth must be 1
For each element of pRegions, imageOffset.x must be a multiple of the texel block extent width of the VkFormat of dstImage
For each element of pRegions, imageOffset.y must be a multiple of the texel block extent height of the VkFormat of dstImage
For each element of pRegions, imageOffset.z must be a multiple of the texel block extent depth of the VkFormat of dstImage
For each element of pRegions, if the sum of imageOffset.x and extent.width does not equal the width of the subresource specified by srcSubresource, extent.width must be a multiple of the texel block extent width of the VkFormat of dstImage
For each element of pRegions, if the sum of imageOffset.y and extent.height does not equal the height of the subresource specified by srcSubresource, extent.height must be a multiple of the texel block extent height of the VkFormat of dstImage
For each element of pRegions, if the sum of imageOffset.z and extent.depth does not equal the depth of the subresource specified by srcSubresource, extent.depth must be a multiple of the texel block extent depth of the VkFormat of dstImage
For each element of pRegions, imageSubresource.aspectMask must specify aspects present in dstImage
If dstImage has a multi-planar image format, then for each element of pRegions, imageSubresource.aspectMask must be a single valid multi-planar aspect mask bit
If dstImage is of type IMAGE_TYPE_3D, for each element of pRegions, imageSubresource.baseArrayLayer must be 0 and imageSubresource.layerCount must be 1

For each element of pRegions, bufferRowLength must be a multiple of the texel block extent width of the VkFormat of dstImage
For each element of pRegions, bufferImageHeight must be a multiple of the texel block extent height of the VkFormat of dstImage
For each element of pRegions, bufferRowLength divided by the texel block extent width and then multiplied by the texel block size of dstImage must be less than or equal to 2³¹-1

If dstImage does not have either a depth/stencil or a multi-planar format, then for each element of pRegions, bufferOffset must be a multiple of the texel block size
If dstImage has a multi-planar format, then for each element of pRegions, bufferOffset must be a multiple of the element size of the compatible format for the format and the aspectMask of the imageSubresource as defined in Compatible formats of planes of multi-planar formats
If dstImage has a depth/stencil format, the bufferOffset member of any element of pRegions must be a multiple of 4
For each element of pRegions not containing VkCopyCommandTransformInfoQCOM in its pNext chain, imageOffset.x and (imageExtent.width + imageOffset.x) must both be greater than or equal to 0 and less than or equal to the width of the specified imageSubresource of dstImage
For each element of pRegions not containing VkCopyCommandTransformInfoQCOM in its pNext chain, imageOffset.y and (imageExtent.height + imageOffset.y) must both be greater than or equal to 0 and less than or equal to the height of the specified imageSubresource of dstImage

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_COPY_BUFFER_TO_IMAGE_INFO_2
pNext must be NULL
srcBuffer must be a valid VkBuffer handle
dstImage must be a valid VkImage handle
dstImageLayout must be a valid VkImageLayout value
pRegions must be a valid pointer to an array of regionCount valid VkBufferImageCopy2 structures
regionCount must be greater than 0
Both of dstImage, and srcBuffer must have been created, allocated, or retrieved from the same VkDevice

Layout


struct VkCopyBufferToImageInfo2 {
    VkStructureType sType;
    void const * pNext;
    VkBuffer srcBuffer;
    VkImage dstImage;
    VkImageLayout dstImageLayout;
    uint32_t regionCount;
    VkBufferImageCopy2 const * pRegions;
}

Modifier and Type	Class and Description
public static class	VkCopyBufferToImageInfo2.Buffer An array of `VkCopyBufferToImageInfo2` structs.

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	DSTIMAGE The struct member offsets.
public static final int	DSTIMAGELAYOUT The struct member offsets.
public static final int	PNEXT The struct member offsets.
public static final int	PREGIONS The struct member offsets.
public static final int	REGIONCOUNT The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	SRCBUFFER The struct member offsets.
public static final int	STYPE The struct member offsets.

Access	Constructor and Description
protected	VkCopyBufferToImageInfo2(long address, ByteBuffer container)
public	VkCopyBufferToImageInfo2(ByteBuffer container) Creates a `VkCopyBufferToImageInfo2` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static VkCopyBufferToImageInfo2	calloc() Returns a new `VkCopyBufferToImageInfo2` instance allocated with `memCalloc`.
public static VkCopyBufferToImageInfo2.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkCopyBufferToImageInfo2.Buffer` instance allocated with `memCalloc`.
public static VkCopyBufferToImageInfo2	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkCopyBufferToImageInfo2` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkCopyBufferToImageInfo2.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkCopyBufferToImageInfo2.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected VkCopyBufferToImageInfo2	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static VkCopyBufferToImageInfo2	create() Returns a new `VkCopyBufferToImageInfo2` instance allocated with `BufferUtils`.
public static VkCopyBufferToImageInfo2	create(long address) Returns a new `VkCopyBufferToImageInfo2` instance for the specified memory address.
public static VkCopyBufferToImageInfo2.Buffer	create(int the buffer capacity capacity) Returns a new `VkCopyBufferToImageInfo2.Buffer` instance allocated with `BufferUtils`.
public static VkCopyBufferToImageInfo2.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkCopyBufferToImageInfo2.Buffer` instance at the specified memory.
public static VkCopyBufferToImageInfo2	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkCopyBufferToImageInfo2.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public long	dstImage() the destination image.
public VkCopyBufferToImageInfo2	dstImage(long value) Sets the specified value to the `dstImage` field.
public int	dstImageLayout() the layout of the destination image subresources for the copy.
public VkCopyBufferToImageInfo2	dstImageLayout(int value) Sets the specified value to the `dstImageLayout` field.
public static VkCopyBufferToImageInfo2	malloc() Returns a new `VkCopyBufferToImageInfo2` instance allocated with `memAlloc`.
public static VkCopyBufferToImageInfo2.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkCopyBufferToImageInfo2.Buffer` instance allocated with `memAlloc`.
public static VkCopyBufferToImageInfo2	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkCopyBufferToImageInfo2` instance allocated on the specified `MemoryStack`.
public static VkCopyBufferToImageInfo2.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkCopyBufferToImageInfo2.Buffer` instance allocated on the specified `MemoryStack`.
public static long	ndstImage(long struct) Unsafe version of `dstImage`.
public static void	ndstImage(long struct, long value) Unsafe version of `dstImage`.
public static int	ndstImageLayout(long struct) Unsafe version of `dstImageLayout`.
public static void	ndstImageLayout(long struct, int value) Unsafe version of `dstImageLayout`.
public static long	npNext(long struct) Unsafe version of `pNext`.
public static void	npNext(long struct, long value) Unsafe version of `pNext`.
public static VkBufferImageCopy2.Buffer	npRegions(long struct) Unsafe version of `pRegions`.
public static void	npRegions(long struct, VkBufferImageCopy2.Buffer value) Unsafe version of `pRegions`.
public static int	nregionCount(long struct) Unsafe version of `regionCount`.
public static void	nregionCount(long struct, int value) Sets the specified value to the `regionCount` field of the specified `struct`.
public static long	nsrcBuffer(long struct) Unsafe version of `srcBuffer`.
public static void	nsrcBuffer(long struct, long value) Unsafe version of `srcBuffer`.
public static int	nsType(long struct) Unsafe version of `sType`.
public static void	nsType(long struct, int value) Unsafe version of `sType`.
public long	pNext() `NULL` or a pointer to a structure extending this structure.
public VkCopyBufferToImageInfo2	pNext(long value) Sets the specified value to the `pNext` field.
public VkBufferImageCopy2.Buffer	pRegions() a pointer to an array of `VkBufferImageCopy2` structures specifying the regions to copy.
public VkCopyBufferToImageInfo2	pRegions(VkBufferImageCopy2.Buffer value) Sets the address of the specified `VkBufferImageCopy2.Buffer` to the `pRegions` field.
public int	regionCount() the number of regions to copy.
public VkCopyBufferToImageInfo2	set(int sType, long pNext, long srcBuffer, long dstImage, int dstImageLayout, VkBufferImageCopy2.Buffer pRegions) Initializes this struct with the specified values.
public VkCopyBufferToImageInfo2	Returns: this struct set(VkCopyBufferToImageInfo2 the source struct src) Copies the specified struct data to this struct.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public long	srcBuffer() the source buffer.
public VkCopyBufferToImageInfo2	srcBuffer(long value) Sets the specified value to the `srcBuffer` field.
public int	sType() a `VkStructureType` value identifying this structure.
public VkCopyBufferToImageInfo2	sType(int value) Sets the specified value to the `sType` field.
public VkCopyBufferToImageInfo2	sType$Default() Sets the `STRUCTURE_TYPE_COPY_BUFFER_TO_IMAGE_INFO_2` value to the `sType` field.
public static void	validate(long the struct to validate struct) Validates pointer members that should not be `NULL`.

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

DSTIMAGE	back to summary
public static final int DSTIMAGE The struct member offsets.

DSTIMAGELAYOUT	back to summary
public static final int DSTIMAGELAYOUT The struct member offsets.

PNEXT	back to summary
public static final int PNEXT The struct member offsets.

PREGIONS	back to summary
public static final int PREGIONS The struct member offsets.

REGIONCOUNT	back to summary
public static final int REGIONCOUNT The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

SRCBUFFER	back to summary
public static final int SRCBUFFER The struct member offsets.

STYPE	back to summary
public static final int STYPE The struct member offsets.

VkCopyBufferToImageInfo2	back to summary
protected VkCopyBufferToImageInfo2(long address, ByteBuffer container)

VkCopyBufferToImageInfo2	back to summary
public VkCopyBufferToImageInfo2(ByteBuffer container) Creates a `VkCopyBufferToImageInfo2` instance at the current position of the specified `ByteBuffer` 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

calloc	back to summary
public static VkCopyBufferToImageInfo2 calloc() Returns a new `VkCopyBufferToImageInfo2` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static VkCopyBufferToImageInfo2.Buffer calloc(int capacity) Returns a new `VkCopyBufferToImageInfo2.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkCopyBufferToImageInfo2.Buffer calloc(int capacity)

Returns a new VkCopyBufferToImageInfo2.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static VkCopyBufferToImageInfo2 calloc(MemoryStack stack) Returns a new `VkCopyBufferToImageInfo2` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkCopyBufferToImageInfo2 calloc(MemoryStack stack)

Returns a new VkCopyBufferToImageInfo2 instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static VkCopyBufferToImageInfo2.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkCopyBufferToImageInfo2.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static VkCopyBufferToImageInfo2.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkCopyBufferToImageInfo2.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

create back to summary

create	back to summary
protected VkCopyBufferToImageInfo2 create(long address, ByteBuffer container) Implements abstract org.lwjgl.system.Struct.create. Doc from org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass. Effectively, every `Struct` instance is a factory for more instances of the same type. This is used by `StructBuffer`. Parameters address:long the struct memory address container:ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. Annotations @Override

protected VkCopyBufferToImageInfo2 create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters

address:long: the struct memory address
container:ByteBuffer: an optional container buffer, to be referenced strongly by the struct instance.

Annotations

@Override

create	back to summary
public static VkCopyBufferToImageInfo2 create() Returns a new `VkCopyBufferToImageInfo2` instance allocated with `BufferUtils`.

create	back to summary
public static VkCopyBufferToImageInfo2 create(long address) Returns a new `VkCopyBufferToImageInfo2` instance for the specified memory address.

create back to summary

create	back to summary
public static VkCopyBufferToImageInfo2.Buffer create(int capacity) Returns a new `VkCopyBufferToImageInfo2.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static VkCopyBufferToImageInfo2.Buffer create(int capacity)

Returns a new VkCopyBufferToImageInfo2.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static VkCopyBufferToImageInfo2.Buffer create(long address, int capacity) Create a `VkCopyBufferToImageInfo2.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

public static VkCopyBufferToImageInfo2.Buffer create(long address, int capacity)

Create a VkCopyBufferToImageInfo2.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VkCopyBufferToImageInfo2 createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkCopyBufferToImageInfo2 createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VkCopyBufferToImageInfo2.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkCopyBufferToImageInfo2.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations

@Nullable

dstImage	back to summary
public long dstImage() the destination image. Annotations @NativeType:VkImage

dstImage

back to summary

public long dstImage()

the destination image.

Annotations

@NativeType:VkImage

dstImage	back to summary
public VkCopyBufferToImageInfo2 dstImage(long value) Sets the specified value to the `dstImage` field.

dstImageLayout	back to summary
public int dstImageLayout() the layout of the destination image subresources for the copy. Annotations @NativeType:VkImageLayout

dstImageLayout

back to summary

public int dstImageLayout()

the layout of the destination image subresources for the copy.

Annotations

@NativeType:VkImageLayout

dstImageLayout	back to summary
public VkCopyBufferToImageInfo2 dstImageLayout(int value) Sets the specified value to the `dstImageLayout` field.

malloc	back to summary
public static VkCopyBufferToImageInfo2 malloc() Returns a new `VkCopyBufferToImageInfo2` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static VkCopyBufferToImageInfo2.Buffer malloc(int capacity) Returns a new `VkCopyBufferToImageInfo2.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkCopyBufferToImageInfo2.Buffer malloc(int capacity)

Returns a new VkCopyBufferToImageInfo2.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static VkCopyBufferToImageInfo2 malloc(MemoryStack stack) Returns a new `VkCopyBufferToImageInfo2` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkCopyBufferToImageInfo2 malloc(MemoryStack stack)

Returns a new VkCopyBufferToImageInfo2 instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static VkCopyBufferToImageInfo2.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkCopyBufferToImageInfo2.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static VkCopyBufferToImageInfo2.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkCopyBufferToImageInfo2.Buffer instance allocated on the specified MemoryStack.

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

ndstImage	back to summary
public static long ndstImage(long struct) Unsafe version of `dstImage`.

ndstImage	back to summary
public static void ndstImage(long struct, long value) Unsafe version of `dstImage`.

ndstImageLayout	back to summary
public static int ndstImageLayout(long struct) Unsafe version of `dstImageLayout`.

ndstImageLayout	back to summary
public static void ndstImageLayout(long struct, int value) Unsafe version of `dstImageLayout`.

npNext	back to summary
public static long npNext(long struct) Unsafe version of `pNext`.

npNext	back to summary
public static void npNext(long struct, long value) Unsafe version of `pNext`.

npRegions	back to summary
public static VkBufferImageCopy2.Buffer npRegions(long struct) Unsafe version of `pRegions`.

npRegions	back to summary
public static void npRegions(long struct, VkBufferImageCopy2.Buffer value) Unsafe version of `pRegions`.

nregionCount	back to summary
public static int nregionCount(long struct) Unsafe version of `regionCount`.

nregionCount	back to summary
public static void nregionCount(long struct, int value) Sets the specified value to the `regionCount` field of the specified `struct`.

nsrcBuffer	back to summary
public static long nsrcBuffer(long struct) Unsafe version of `srcBuffer`.

nsrcBuffer	back to summary
public static void nsrcBuffer(long struct, long value) Unsafe version of `srcBuffer`.

nsType	back to summary
public static int nsType(long struct) Unsafe version of `sType`.

nsType	back to summary
public static void nsType(long struct, int value) Unsafe version of `sType`.

pNext back to summary

pNext	back to summary
public long pNext() `NULL` or a pointer to a structure extending this structure. Annotations @NativeType:void const *

public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations

@NativeType:void const *

pNext	back to summary
public VkCopyBufferToImageInfo2 pNext(long value) Sets the specified value to the `pNext` field.

pRegions back to summary

public VkBufferImageCopy2.Buffer pRegions()

a pointer to an array of VkBufferImageCopy2 structures specifying the regions to copy.

Annotations

@NativeType:VkBufferImageCopy2 const *

pRegions	back to summary
public VkCopyBufferToImageInfo2 pRegions(VkBufferImageCopy2.Buffer value) Sets the address of the specified `VkBufferImageCopy2.Buffer` to the `pRegions` field.

regionCount

back to summary

public int regionCount()

the number of regions to copy.

Annotations

@NativeType:uint32_t

set	back to summary
public VkCopyBufferToImageInfo2 set(int sType, long pNext, long srcBuffer, long dstImage, int dstImageLayout, VkBufferImageCopy2.Buffer pRegions) Initializes this struct with the specified values.

set

back to summary

public VkCopyBufferToImageInfo2 set(VkCopyBufferToImageInfo2 src)

Copies the specified struct data to this struct.

Parameters

src:VkCopyBufferToImageInfo2: the source struct

Returns:VkCopyBufferToImageInfo2

this struct

sizeof back to summary

public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

srcBuffer

back to summary

public long srcBuffer()

the source buffer.

Annotations

@NativeType:VkBuffer

srcBuffer	back to summary
public VkCopyBufferToImageInfo2 srcBuffer(long value) Sets the specified value to the `srcBuffer` field.

sType back to summary

public int sType()

a VkStructureType value identifying this structure.

Annotations

@NativeType:VkStructureType

sType	back to summary
public VkCopyBufferToImageInfo2 sType(int value) Sets the specified value to the `sType` field.

sType$Default	back to summary
public VkCopyBufferToImageInfo2 sType$Default() Sets the `STRUCTURE_TYPE_COPY_BUFFER_TO_IMAGE_INFO_2` value to the `sType` field.

validate back to summary

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters

struct:long: the struct to validate

org.lwjgl.vulkan back to summary

public Class VkCopyBufferToImageInfo2.Buffer

Class Inheritance

extends StructBuffer<VkCopyBufferToImageInfo2, VkCopyBufferToImageInfo2.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkCopyBufferToImageInfo2.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

Known Direct Subclasses

org.lwjgl.vulkan.VkCopyBufferToImageInfo2KHR.Buffer

An array of VkCopyBufferToImageInfo2 structs.

Field Summary

Modifier and Type	Field and Description
private static final VkCopyBufferToImageInfo2	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkCopyBufferToImageInfo2.Buffer` instance backed by the specified container.
public	Buffer(long address, int cap)
pack-priv	Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and Type	Method and Description
public long	Returns: the value of the `VkCopyBufferToImageInfo2#dstImage` field. dstImage()
public VkCopyBufferToImageInfo2.Buffer	dstImage(long value) Sets the specified value to the `VkCopyBufferToImageInfo2#dstImage` field.
public int	Returns: the value of the `VkCopyBufferToImageInfo2#dstImageLayout` field. dstImageLayout()
public VkCopyBufferToImageInfo2.Buffer	dstImageLayout(int value) Sets the specified value to the `VkCopyBufferToImageInfo2#dstImageLayout` field.
protected VkCopyBufferToImageInfo2	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `VkCopyBufferToImageInfo2#pNext` field. pNext()
public VkCopyBufferToImageInfo2.Buffer	pNext(long value) Sets the specified value to the `VkCopyBufferToImageInfo2#pNext` field.
public VkBufferImageCopy2.Buffer	Returns: a `VkBufferImageCopy2.Buffer` view of the struct array pointed to by the `VkCopyBufferToImageInfo2#pRegions` field. pRegions()
public VkCopyBufferToImageInfo2.Buffer	pRegions(VkBufferImageCopy2.Buffer value) Sets the address of the specified `VkBufferImageCopy2.Buffer` to the `VkCopyBufferToImageInfo2#pRegions` field.
public int	Returns: the value of the `VkCopyBufferToImageInfo2#regionCount` field. regionCount()
protected VkCopyBufferToImageInfo2.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public long	Returns: the value of the `VkCopyBufferToImageInfo2#srcBuffer` field. srcBuffer()
public VkCopyBufferToImageInfo2.Buffer	srcBuffer(long value) Sets the specified value to the `VkCopyBufferToImageInfo2#srcBuffer` field.
public int	Returns: the value of the `VkCopyBufferToImageInfo2#sType` field. sType()
public VkCopyBufferToImageInfo2.Buffer	sType(int value) Sets the specified value to the `VkCopyBufferToImageInfo2#sType` field.
public VkCopyBufferToImageInfo2.Buffer	sType$Default() Sets the `STRUCTURE_TYPE_COPY_BUFFER_TO_IMAGE_INFO_2` value to the `VkCopyBufferToImageInfo2#sType` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VkCopyBufferToImageInfo2 ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new VkCopyBufferToImageInfo2.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkCopyBufferToImageInfo2#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

dstImage	back to summary
public long dstImage() Returns:long the value of the `VkCopyBufferToImageInfo2#dstImage` field. Annotations @NativeType:VkImage

dstImage	back to summary
public VkCopyBufferToImageInfo2.Buffer dstImage(long value) Sets the specified value to the `VkCopyBufferToImageInfo2#dstImage` field.

dstImageLayout	back to summary
public int dstImageLayout() Returns:int the value of the `VkCopyBufferToImageInfo2#dstImageLayout` field. Annotations @NativeType:VkImageLayout

dstImageLayout	back to summary
public VkCopyBufferToImageInfo2.Buffer dstImageLayout(int value) Sets the specified value to the `VkCopyBufferToImageInfo2#dstImageLayout` field.

getElementFactory

back to summary

protected VkCopyBufferToImageInfo2 getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations

@Override

pNext	back to summary
public long pNext() Returns:long the value of the `VkCopyBufferToImageInfo2#pNext` field. Annotations @NativeType:void const *

pNext	back to summary
public VkCopyBufferToImageInfo2.Buffer pNext(long value) Sets the specified value to the `VkCopyBufferToImageInfo2#pNext` field.

pRegions	back to summary
public VkBufferImageCopy2.Buffer pRegions() Returns:VkBufferImageCopy2.Buffer a `VkBufferImageCopy2.Buffer` view of the struct array pointed to by the `VkCopyBufferToImageInfo2#pRegions` field. Annotations @NativeType:VkBufferImageCopy2 const *

pRegions	back to summary
public VkCopyBufferToImageInfo2.Buffer pRegions(VkBufferImageCopy2.Buffer value) Sets the address of the specified `VkBufferImageCopy2.Buffer` to the `VkCopyBufferToImageInfo2#pRegions` field.

regionCount	back to summary
public int regionCount() Returns:int the value of the `VkCopyBufferToImageInfo2#regionCount` field. Annotations @NativeType:uint32_t

self

back to summary

protected VkCopyBufferToImageInfo2.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations

@Override

srcBuffer	back to summary
public long srcBuffer() Returns:long the value of the `VkCopyBufferToImageInfo2#srcBuffer` field. Annotations @NativeType:VkBuffer

srcBuffer	back to summary
public VkCopyBufferToImageInfo2.Buffer srcBuffer(long value) Sets the specified value to the `VkCopyBufferToImageInfo2#srcBuffer` field.

sType	back to summary
public int sType() Returns:int the value of the `VkCopyBufferToImageInfo2#sType` field. Annotations @NativeType:VkStructureType

sType	back to summary
public VkCopyBufferToImageInfo2.Buffer sType(int value) Sets the specified value to the `VkCopyBufferToImageInfo2#sType` field.

sType$Default	back to summary
public VkCopyBufferToImageInfo2.Buffer sType$Default() Sets the `STRUCTURE_TYPE_COPY_BUFFER_TO_IMAGE_INFO_2` value to the `VkCopyBufferToImageInfo2#sType` field.

public Class VkCopyBufferToImageInfo2

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class VkCopyBufferToImageInfo2.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail