Structure specifying parameters of an image to host memory copy command.

Description

vkCopyImageToMemoryEXT does not check whether the device memory associated with srcImage is currently in use before performing the copy. The application must guarantee that any previously submitted command that writes to the copy regions has completed before the host performs the copy.

Copy regions for the image must be aligned to a multiple of the texel block extent in each dimension, except at the edges of the image, where region extents must match the edge of the image.

Valid Usage

If dstImage is sparse then all memory ranges accessed by the copy command must be bound as described in Binding Resource Memory
If the stencil aspect of dstImage is accessed, and dstImage was not created with separate stencil usage, the image must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT_EXT set in VkImageCreateInfo::usage
If the stencil aspect of dstImage is accessed, and dstImage was created with separate stencil usage, the image must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT_EXT set in VkImageStencilUsageCreateInfo::stencilUsage
If non-stencil aspects of dstImage are accessed, the image must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT_EXT set in VkImageCreateInfo::usage
If flags contains HOST_IMAGE_COPY_MEMCPY_EXT, the x, y, and z members of the dstOffset member of each element of pRegions must be 0
If flags contains HOST_IMAGE_COPY_MEMCPY_EXT, the extent member of each element of pRegions must equal the extents of dstImage identified by dstSubresource

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 dstSubresource.mipLevel member of each element of pRegions must be less than the mipLevels specified in VkImageCreateInfo when dstImage was created
The dstSubresource.baseArrayLayer + dstSubresource.layerCount of each element of pRegions , if dstSubresource.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

The image region specified by each element of pRegions must be contained within the specified dstSubresource of dstImage
For each element of pRegions, dstOffset.x and (extent.width + dstOffset.x) must both be greater than or equal to 0 and less than or equal to the width of the specified dstSubresource of dstImage
For each element of pRegions, dstOffset.y and (extent.height + dstOffset.y) must both be greater than or equal to 0 and less than or equal to the height of the specified dstSubresource of dstImage

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, dstOffset.y must be 0 and extent.height must be 1
For each element of pRegions, dstOffset.z and (extent.depth + dstOffset.z) must both be greater than or equal to 0 and less than or equal to the depth of the specified dstSubresource of dstImage
If dstImage is of type IMAGE_TYPE_1D or IMAGE_TYPE_2D, then for each element of pRegions, dstOffset.z must be 0 and extent.depth must be 1
For each element of pRegions, dstOffset.x must be a multiple of the texel block extent width of the VkFormat of dstImage
For each element of pRegions, dstOffset.y must be a multiple of the texel block extent height of the VkFormat of dstImage
For each element of pRegions, dstOffset.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 dstOffset.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 dstOffset.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 dstOffset.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, dstSubresource.aspectMask must specify aspects present in dstImage
If dstImage has a multi-planar image format, then for each element of pRegions, dstSubresource.aspectMask must be a single valid multi-planar aspect mask bit
If dstImage is of type IMAGE_TYPE_3D, for each element of pRegions, dstSubresource.baseArrayLayer must be 0 and dstSubresource.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
srcImageLayout must specify the current layout of the image subresources of srcImage specified in pRegions
srcImageLayout must be one of the image layouts returned in VkPhysicalDeviceHostImageCopyPropertiesEXT::pCopySrcLayouts

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_COPY_IMAGE_TO_MEMORY_INFO_EXT
pNext must be NULL
flags must be a valid combination of VkHostImageCopyFlagBitsEXT values
srcImage must be a valid VkImage handle
srcImageLayout must be a valid VkImageLayout value
pRegions must be a valid pointer to an array of regionCount valid VkImageToMemoryCopyEXT structures
regionCount must be greater than 0

Layout


struct VkCopyImageToMemoryInfoEXT {
    VkStructureType sType;
    void const * pNext;
    VkHostImageCopyFlagsEXT flags;
    VkImage srcImage;
    VkImageLayout srcImageLayout;
    uint32_t regionCount;
    VkImageToMemoryCopyEXT const * pRegions;
}

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

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	FLAGS 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	SRCIMAGE The struct member offsets.
public static final int	SRCIMAGELAYOUT The struct member offsets.
public static final int	STYPE The struct member offsets.

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

Method Summary

Modifier and Type	Method and Description
public static VkCopyImageToMemoryInfoEXT	calloc() Returns a new `VkCopyImageToMemoryInfoEXT` instance allocated with `memCalloc`.
public static VkCopyImageToMemoryInfoEXT.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkCopyImageToMemoryInfoEXT.Buffer` instance allocated with `memCalloc`.
public static VkCopyImageToMemoryInfoEXT	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkCopyImageToMemoryInfoEXT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkCopyImageToMemoryInfoEXT.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkCopyImageToMemoryInfoEXT.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected VkCopyImageToMemoryInfoEXT	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 VkCopyImageToMemoryInfoEXT	create() Returns a new `VkCopyImageToMemoryInfoEXT` instance allocated with `BufferUtils`.
public static VkCopyImageToMemoryInfoEXT	create(long address) Returns a new `VkCopyImageToMemoryInfoEXT` instance for the specified memory address.
public static VkCopyImageToMemoryInfoEXT.Buffer	create(int the buffer capacity capacity) Returns a new `VkCopyImageToMemoryInfoEXT.Buffer` instance allocated with `BufferUtils`.
public static VkCopyImageToMemoryInfoEXT.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkCopyImageToMemoryInfoEXT.Buffer` instance at the specified memory.
public static VkCopyImageToMemoryInfoEXT	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkCopyImageToMemoryInfoEXT.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	flags() a bitmask of `VkHostImageCopyFlagBitsEXT` values describing additional copy parameters.
public VkCopyImageToMemoryInfoEXT	flags(int value) Sets the specified value to the `flags` field.
public static VkCopyImageToMemoryInfoEXT	malloc() Returns a new `VkCopyImageToMemoryInfoEXT` instance allocated with `memAlloc`.
public static VkCopyImageToMemoryInfoEXT.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkCopyImageToMemoryInfoEXT.Buffer` instance allocated with `memAlloc`.
public static VkCopyImageToMemoryInfoEXT	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkCopyImageToMemoryInfoEXT` instance allocated on the specified `MemoryStack`.
public static VkCopyImageToMemoryInfoEXT.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkCopyImageToMemoryInfoEXT.Buffer` instance allocated on the specified `MemoryStack`.
public static int	nflags(long struct) Unsafe version of `flags`.
public static void	nflags(long struct, int value) Unsafe version of `flags`.
public static long	npNext(long struct) Unsafe version of `pNext`.
public static void	npNext(long struct, long value) Unsafe version of `pNext`.
public static VkImageToMemoryCopyEXT.Buffer	npRegions(long struct) Unsafe version of `pRegions`.
public static void	npRegions(long struct, VkImageToMemoryCopyEXT.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	nsrcImage(long struct) Unsafe version of `srcImage`.
public static void	nsrcImage(long struct, long value) Unsafe version of `srcImage`.
public static int	nsrcImageLayout(long struct) Unsafe version of `srcImageLayout`.
public static void	nsrcImageLayout(long struct, int value) Unsafe version of `srcImageLayout`.
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 VkCopyImageToMemoryInfoEXT	pNext(long value) Sets the specified value to the `pNext` field.
public VkImageToMemoryCopyEXT.Buffer	pRegions() a pointer to an array of `VkImageToMemoryCopyEXT` structures specifying the regions to copy.
public VkCopyImageToMemoryInfoEXT	pRegions(VkImageToMemoryCopyEXT.Buffer value) Sets the address of the specified `VkImageToMemoryCopyEXT.Buffer` to the `pRegions` field.
public int	regionCount() the number of regions to copy.
public VkCopyImageToMemoryInfoEXT	set(int sType, long pNext, int flags, long srcImage, int srcImageLayout, VkImageToMemoryCopyEXT.Buffer pRegions) Initializes this struct with the specified values.
public VkCopyImageToMemoryInfoEXT	Returns: this struct set(VkCopyImageToMemoryInfoEXT 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	srcImage() the source image.
public VkCopyImageToMemoryInfoEXT	srcImage(long value) Sets the specified value to the `srcImage` field.
public int	srcImageLayout() the layout of the source image subresources for the copy.
public VkCopyImageToMemoryInfoEXT	srcImageLayout(int value) Sets the specified value to the `srcImageLayout` field.
public int	sType() a `VkStructureType` value identifying this structure.
public VkCopyImageToMemoryInfoEXT	sType(int value) Sets the specified value to the `sType` field.
public VkCopyImageToMemoryInfoEXT	sType$Default() Sets the `STRUCTURE_TYPE_COPY_IMAGE_TO_MEMORY_INFO_EXT` 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.

FLAGS	back to summary
public static final int FLAGS 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.

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

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

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

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

VkCopyImageToMemoryInfoEXT	back to summary
public VkCopyImageToMemoryInfoEXT(ByteBuffer container) Creates a `VkCopyImageToMemoryInfoEXT` 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 VkCopyImageToMemoryInfoEXT calloc() Returns a new `VkCopyImageToMemoryInfoEXT` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

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

public static VkCopyImageToMemoryInfoEXT.Buffer calloc(int capacity)

Returns a new VkCopyImageToMemoryInfoEXT.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 VkCopyImageToMemoryInfoEXT calloc(MemoryStack stack) Returns a new `VkCopyImageToMemoryInfoEXT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkCopyImageToMemoryInfoEXT calloc(MemoryStack stack)

Returns a new VkCopyImageToMemoryInfoEXT 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 VkCopyImageToMemoryInfoEXT.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkCopyImageToMemoryInfoEXT.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 VkCopyImageToMemoryInfoEXT.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkCopyImageToMemoryInfoEXT.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 VkCopyImageToMemoryInfoEXT 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 VkCopyImageToMemoryInfoEXT 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 VkCopyImageToMemoryInfoEXT create() Returns a new `VkCopyImageToMemoryInfoEXT` instance allocated with `BufferUtils`.

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

create back to summary

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

public static VkCopyImageToMemoryInfoEXT.Buffer create(int capacity)

Returns a new VkCopyImageToMemoryInfoEXT.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

Create a VkCopyImageToMemoryInfoEXT.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 VkCopyImageToMemoryInfoEXT createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkCopyImageToMemoryInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

flags back to summary

flags	back to summary
public int flags() a bitmask of `VkHostImageCopyFlagBitsEXT` values describing additional copy parameters. Annotations @NativeType:VkHostImageCopyFlagsEXT

public int flags()

a bitmask of VkHostImageCopyFlagBitsEXT values describing additional copy parameters.

Annotations

@NativeType:VkHostImageCopyFlagsEXT

flags	back to summary
public VkCopyImageToMemoryInfoEXT flags(int value) Sets the specified value to the `flags` field.

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

malloc back to summary

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

public static VkCopyImageToMemoryInfoEXT.Buffer malloc(int capacity)

Returns a new VkCopyImageToMemoryInfoEXT.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 VkCopyImageToMemoryInfoEXT malloc(MemoryStack stack) Returns a new `VkCopyImageToMemoryInfoEXT` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkCopyImageToMemoryInfoEXT malloc(MemoryStack stack)

Returns a new VkCopyImageToMemoryInfoEXT 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 VkCopyImageToMemoryInfoEXT.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkCopyImageToMemoryInfoEXT.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

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

nflags	back to summary
public static int nflags(long struct) Unsafe version of `flags`.

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

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 VkImageToMemoryCopyEXT.Buffer npRegions(long struct) Unsafe version of `pRegions`.

npRegions	back to summary
public static void npRegions(long struct, VkImageToMemoryCopyEXT.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`.

nsrcImage	back to summary
public static long nsrcImage(long struct) Unsafe version of `srcImage`.

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

nsrcImageLayout	back to summary
public static int nsrcImageLayout(long struct) Unsafe version of `srcImageLayout`.

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

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 VkCopyImageToMemoryInfoEXT pNext(long value) Sets the specified value to the `pNext` field.

pRegions back to summary

pRegions	back to summary
public VkImageToMemoryCopyEXT.Buffer pRegions() a pointer to an array of `VkImageToMemoryCopyEXT` structures specifying the regions to copy. Annotations @NativeType:VkImageToMemoryCopyEXT const *

public VkImageToMemoryCopyEXT.Buffer pRegions()

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

Annotations

@NativeType:VkImageToMemoryCopyEXT const *

pRegions	back to summary
public VkCopyImageToMemoryInfoEXT pRegions(VkImageToMemoryCopyEXT.Buffer value) Sets the address of the specified `VkImageToMemoryCopyEXT.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 VkCopyImageToMemoryInfoEXT set(int sType, long pNext, int flags, long srcImage, int srcImageLayout, VkImageToMemoryCopyEXT.Buffer pRegions) Initializes this struct with the specified values.

set

back to summary

public VkCopyImageToMemoryInfoEXT set(VkCopyImageToMemoryInfoEXT src)

Copies the specified struct data to this struct.

Parameters

src:VkCopyImageToMemoryInfoEXT: the source struct

Returns:VkCopyImageToMemoryInfoEXT

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

srcImage

back to summary

public long srcImage()

the source image.

Annotations

@NativeType:VkImage

srcImage	back to summary
public VkCopyImageToMemoryInfoEXT srcImage(long value) Sets the specified value to the `srcImage` field.

srcImageLayout

back to summary

public int srcImageLayout()

the layout of the source image subresources for the copy.

Annotations

@NativeType:VkImageLayout

srcImageLayout	back to summary
public VkCopyImageToMemoryInfoEXT srcImageLayout(int value) Sets the specified value to the `srcImageLayout` field.

sType back to summary

public int sType()

a VkStructureType value identifying this structure.

Annotations

@NativeType:VkStructureType

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

sType$Default	back to summary
public VkCopyImageToMemoryInfoEXT sType$Default() Sets the `STRUCTURE_TYPE_COPY_IMAGE_TO_MEMORY_INFO_EXT` 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 VkCopyImageToMemoryInfoEXT.Buffer

Class Inheritance

extends StructBuffer<VkCopyImageToMemoryInfoEXT, VkCopyImageToMemoryInfoEXT.Buffer>
implements NativeResource

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

All Implemented Interfaces

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

An array of VkCopyImageToMemoryInfoEXT structs.

Field Summary

Modifier and Type	Field and Description
private static final VkCopyImageToMemoryInfoEXT	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkCopyImageToMemoryInfoEXT.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 int	Returns: the value of the `VkCopyImageToMemoryInfoEXT#flags` field. flags()
public VkCopyImageToMemoryInfoEXT.Buffer	flags(int value) Sets the specified value to the `VkCopyImageToMemoryInfoEXT#flags` field.
protected VkCopyImageToMemoryInfoEXT	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `VkCopyImageToMemoryInfoEXT#pNext` field. pNext()
public VkCopyImageToMemoryInfoEXT.Buffer	pNext(long value) Sets the specified value to the `VkCopyImageToMemoryInfoEXT#pNext` field.
public VkImageToMemoryCopyEXT.Buffer	Returns: a `VkImageToMemoryCopyEXT.Buffer` view of the struct array pointed to by the `VkCopyImageToMemoryInfoEXT#pRegions` field. pRegions()
public VkCopyImageToMemoryInfoEXT.Buffer	pRegions(VkImageToMemoryCopyEXT.Buffer value) Sets the address of the specified `VkImageToMemoryCopyEXT.Buffer` to the `VkCopyImageToMemoryInfoEXT#pRegions` field.
public int	Returns: the value of the `VkCopyImageToMemoryInfoEXT#regionCount` field. regionCount()
protected VkCopyImageToMemoryInfoEXT.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public long	Returns: the value of the `VkCopyImageToMemoryInfoEXT#srcImage` field. srcImage()
public VkCopyImageToMemoryInfoEXT.Buffer	srcImage(long value) Sets the specified value to the `VkCopyImageToMemoryInfoEXT#srcImage` field.
public int	Returns: the value of the `VkCopyImageToMemoryInfoEXT#srcImageLayout` field. srcImageLayout()
public VkCopyImageToMemoryInfoEXT.Buffer	srcImageLayout(int value) Sets the specified value to the `VkCopyImageToMemoryInfoEXT#srcImageLayout` field.
public int	Returns: the value of the `VkCopyImageToMemoryInfoEXT#sType` field. sType()
public VkCopyImageToMemoryInfoEXT.Buffer	sType(int value) Sets the specified value to the `VkCopyImageToMemoryInfoEXT#sType` field.
public VkCopyImageToMemoryInfoEXT.Buffer	sType$Default() Sets the `STRUCTURE_TYPE_COPY_IMAGE_TO_MEMORY_INFO_EXT` value to the `VkCopyImageToMemoryInfoEXT#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 VkCopyImageToMemoryInfoEXT ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new VkCopyImageToMemoryInfoEXT.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 VkCopyImageToMemoryInfoEXT#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

flags	back to summary
public int flags() Returns:int the value of the `VkCopyImageToMemoryInfoEXT#flags` field. Annotations @NativeType:VkHostImageCopyFlagsEXT

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

getElementFactory

back to summary

protected VkCopyImageToMemoryInfoEXT getElementFactory()

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

Annotations

@Override

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

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

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

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

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

self

back to summary

protected VkCopyImageToMemoryInfoEXT.Buffer self()

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

Annotations

@Override

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

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

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

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

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

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

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

public Class VkCopyImageToMemoryInfoEXT

Description

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 VkCopyImageToMemoryInfoEXT.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail