Package org.lwjgl.vulkan

Class VkCopyMemoryToImageIndirectCommandNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkCopyMemoryToImageIndirectCommandNV>

org.lwjgl.vulkan.VkCopyMemoryToImageIndirectCommandNV

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkCopyMemoryToImageIndirectCommandNV
extends org.lwjgl.system.Struct<VkCopyMemoryToImageIndirectCommandNV>
implements org.lwjgl.system.NativeResource

Structure specifying indirect buffer image copy operation.

Valid Usage

• The srcAddress must be 4 byte aligned
• bufferRowLength must be 0, or greater than or equal to the width member of imageExtent
• bufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
• imageOffset must specify a valid offset in the destination image
• imageExtent must specify a valid region in the destination image and can be 0

Valid Usage (Implicit)

• imageSubresource must be a valid VkImageSubresourceLayers structure

See Also

VkExtent3D, VkImageSubresourceLayers, VkOffset3D

Layout

 struct VkCopyMemoryToImageIndirectCommandNV {
     VkDeviceAddress srcAddress();
     uint32_t bufferRowLength();
     uint32_t bufferImageHeight();
     VkImageSubresourceLayers imageSubresource();
     VkOffset3D imageOffset();
     VkExtent3D imageExtent();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkCopyMemoryToImageIndirectCommandNV.Buffer	An array of VkCopyMemoryToImageIndirectCommandNV structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	BUFFERIMAGEHEIGHT	The struct member offsets.
static final int	BUFFERROWLENGTH	The struct member offsets.
static final int	IMAGEEXTENT	The struct member offsets.
static final int	IMAGEOFFSET	The struct member offsets.
static final int	IMAGESUBRESOURCE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SRCADDRESS	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkCopyMemoryToImageIndirectCommandNV(ByteBuffer container)	Creates a VkCopyMemoryToImageIndirectCommandNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
int	bufferImageHeight()	see bufferRowLength
VkCopyMemoryToImageIndirectCommandNV	bufferImageHeight(int value)	Sets the specified value to the bufferImageHeight() field.
int	bufferRowLength()	bufferRowLength and bufferImageHeight specify in texels a subregion of a larger two- or three-dimensional image in buffer memory, and control the addressing calculations.
VkCopyMemoryToImageIndirectCommandNV	bufferRowLength(int value)	Sets the specified value to the bufferRowLength() field.
static VkCopyMemoryToImageIndirectCommandNV	calloc()	Returns a new VkCopyMemoryToImageIndirectCommandNV instance allocated with memCalloc.
static VkCopyMemoryToImageIndirectCommandNV.Buffer	calloc(int capacity)	Returns a new VkCopyMemoryToImageIndirectCommandNV.Buffer instance allocated with memCalloc.
static VkCopyMemoryToImageIndirectCommandNV.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkCopyMemoryToImageIndirectCommandNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkCopyMemoryToImageIndirectCommandNV	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkCopyMemoryToImageIndirectCommandNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkCopyMemoryToImageIndirectCommandNV	create()	Returns a new VkCopyMemoryToImageIndirectCommandNV instance allocated with BufferUtils.
static VkCopyMemoryToImageIndirectCommandNV.Buffer	create(int capacity)	Returns a new VkCopyMemoryToImageIndirectCommandNV.Buffer instance allocated with BufferUtils.
static VkCopyMemoryToImageIndirectCommandNV	create(long address)	Returns a new VkCopyMemoryToImageIndirectCommandNV instance for the specified memory address.
static VkCopyMemoryToImageIndirectCommandNV.Buffer	create(long address, int capacity)	Create a VkCopyMemoryToImageIndirectCommandNV.Buffer instance at the specified memory.
static @Nullable VkCopyMemoryToImageIndirectCommandNV	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkCopyMemoryToImageIndirectCommandNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkExtent3D	imageExtent()	the size in texels of the destination image in width, height and depth.
VkCopyMemoryToImageIndirectCommandNV	imageExtent(Consumer<VkExtent3D> consumer)	Passes the imageExtent() field to the specified Consumer.
VkCopyMemoryToImageIndirectCommandNV	imageExtent(VkExtent3D value)	Copies the specified VkExtent3D to the imageExtent() field.
VkOffset3D	imageOffset()	selects the initial x, y, z offsets in texels of the sub-region of the destination image data.
VkCopyMemoryToImageIndirectCommandNV	imageOffset(Consumer<VkOffset3D> consumer)	Passes the imageOffset() field to the specified Consumer.
VkCopyMemoryToImageIndirectCommandNV	imageOffset(VkOffset3D value)	Copies the specified VkOffset3D to the imageOffset() field.
VkImageSubresourceLayers	imageSubresource()	a VkImageSubresourceLayers used to specify the specific image subresources of the image used for the destination image data, which must match the values specified in pImageSubresources parameter of CmdCopyMemoryToImageIndirectNV during command recording.
VkCopyMemoryToImageIndirectCommandNV	imageSubresource(Consumer<VkImageSubresourceLayers> consumer)	Passes the imageSubresource() field to the specified Consumer.
VkCopyMemoryToImageIndirectCommandNV	imageSubresource(VkImageSubresourceLayers value)	Copies the specified VkImageSubresourceLayers to the imageSubresource() field.
static VkCopyMemoryToImageIndirectCommandNV	malloc()	Returns a new VkCopyMemoryToImageIndirectCommandNV instance allocated with memAlloc.
static VkCopyMemoryToImageIndirectCommandNV.Buffer	malloc(int capacity)	Returns a new VkCopyMemoryToImageIndirectCommandNV.Buffer instance allocated with memAlloc.
static VkCopyMemoryToImageIndirectCommandNV.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkCopyMemoryToImageIndirectCommandNV.Buffer instance allocated on the specified MemoryStack.
static VkCopyMemoryToImageIndirectCommandNV	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkCopyMemoryToImageIndirectCommandNV instance allocated on the specified MemoryStack.
static int	nbufferImageHeight(long struct)	Unsafe version of bufferImageHeight().
static void	nbufferImageHeight(long struct, int value)	Unsafe version of bufferImageHeight.
static int	nbufferRowLength(long struct)	Unsafe version of bufferRowLength().
static void	nbufferRowLength(long struct, int value)	Unsafe version of bufferRowLength.
static VkExtent3D	nimageExtent(long struct)	Unsafe version of imageExtent().
static void	nimageExtent(long struct, VkExtent3D value)	Unsafe version of imageExtent.
static VkOffset3D	nimageOffset(long struct)	Unsafe version of imageOffset().
static void	nimageOffset(long struct, VkOffset3D value)	Unsafe version of imageOffset.
static VkImageSubresourceLayers	nimageSubresource(long struct)	Unsafe version of imageSubresource().
static void	nimageSubresource(long struct, VkImageSubresourceLayers value)	Unsafe version of imageSubresource.
static long	nsrcAddress(long struct)	Unsafe version of srcAddress().
static void	nsrcAddress(long struct, long value)	Unsafe version of srcAddress.
VkCopyMemoryToImageIndirectCommandNV	set(long srcAddress, int bufferRowLength, int bufferImageHeight, VkImageSubresourceLayers imageSubresource, VkOffset3D imageOffset, VkExtent3D imageExtent)	Initializes this struct with the specified values.
VkCopyMemoryToImageIndirectCommandNV	set(VkCopyMemoryToImageIndirectCommandNV src)	Copies the specified struct data to this struct.
int	sizeof()
long	srcAddress()	the starting address of the source device memory to copy from.
VkCopyMemoryToImageIndirectCommandNV	srcAddress(long value)	Sets the specified value to the srcAddress() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

SRCADDRESS

public static final int SRCADDRESS

The struct member offsets.

BUFFERROWLENGTH

public static final int BUFFERROWLENGTH

The struct member offsets.

BUFFERIMAGEHEIGHT

public static final int BUFFERIMAGEHEIGHT

The struct member offsets.

IMAGESUBRESOURCE

public static final int IMAGESUBRESOURCE

The struct member offsets.

IMAGEOFFSET

public static final int IMAGEOFFSET

The struct member offsets.

IMAGEEXTENT

public static final int IMAGEEXTENT

The struct member offsets.

Constructor Details

VkCopyMemoryToImageIndirectCommandNV

public VkCopyMemoryToImageIndirectCommandNV(ByteBuffer container)

Creates a VkCopyMemoryToImageIndirectCommandNV 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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkCopyMemoryToImageIndirectCommandNV>

srcAddress

public long srcAddress()

the starting address of the source device memory to copy from.

bufferRowLength

public int bufferRowLength()

bufferRowLength and bufferImageHeight specify 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 the imageExtent.

bufferImageHeight

public int bufferImageHeight()

see bufferRowLength

imageSubresource

public VkImageSubresourceLayers imageSubresource()

a VkImageSubresourceLayers used to specify the specific image subresources of the image used for the destination image data, which must match the values specified in pImageSubresources parameter of CmdCopyMemoryToImageIndirectNV during command recording.

imageOffset

public VkOffset3D imageOffset()

selects the initial x, y, z offsets in texels of the sub-region of the destination image data.

imageExtent

public VkExtent3D imageExtent()

the size in texels of the destination image in width, height and depth.

srcAddress

public VkCopyMemoryToImageIndirectCommandNV srcAddress(long value)

Sets the specified value to the srcAddress() field.

bufferRowLength

public VkCopyMemoryToImageIndirectCommandNV bufferRowLength(int value)

Sets the specified value to the bufferRowLength() field.

bufferImageHeight

public VkCopyMemoryToImageIndirectCommandNV bufferImageHeight(int value)

Sets the specified value to the bufferImageHeight() field.

imageSubresource

public VkCopyMemoryToImageIndirectCommandNV imageSubresource(VkImageSubresourceLayers value)

Copies the specified VkImageSubresourceLayers to the imageSubresource() field.

imageSubresource

public VkCopyMemoryToImageIndirectCommandNV imageSubresource(Consumer<VkImageSubresourceLayers> consumer)

Passes the imageSubresource() field to the specified Consumer.

imageOffset

public VkCopyMemoryToImageIndirectCommandNV imageOffset(VkOffset3D value)

Copies the specified VkOffset3D to the imageOffset() field.

imageOffset

public VkCopyMemoryToImageIndirectCommandNV imageOffset(Consumer<VkOffset3D> consumer)

Passes the imageOffset() field to the specified Consumer.

imageExtent

public VkCopyMemoryToImageIndirectCommandNV imageExtent(VkExtent3D value)

Copies the specified VkExtent3D to the imageExtent() field.

imageExtent

public VkCopyMemoryToImageIndirectCommandNV imageExtent(Consumer<VkExtent3D> consumer)

Passes the imageExtent() field to the specified Consumer.

set

public VkCopyMemoryToImageIndirectCommandNV set(long srcAddress,
 int bufferRowLength,
 int bufferImageHeight,
 VkImageSubresourceLayers imageSubresource,
 VkOffset3D imageOffset,
 VkExtent3D imageExtent)

Initializes this struct with the specified values.

set

public VkCopyMemoryToImageIndirectCommandNV set(VkCopyMemoryToImageIndirectCommandNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkCopyMemoryToImageIndirectCommandNV malloc()

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

calloc

public static VkCopyMemoryToImageIndirectCommandNV calloc()

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

create

public static VkCopyMemoryToImageIndirectCommandNV create()

Returns a new VkCopyMemoryToImageIndirectCommandNV instance allocated with BufferUtils.

create

public static VkCopyMemoryToImageIndirectCommandNV create(long address)

Returns a new VkCopyMemoryToImageIndirectCommandNV instance for the specified memory address.

createSafe

public static @Nullable VkCopyMemoryToImageIndirectCommandNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkCopyMemoryToImageIndirectCommandNV.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkCopyMemoryToImageIndirectCommandNV.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkCopyMemoryToImageIndirectCommandNV.Buffer create(int capacity)

Returns a new VkCopyMemoryToImageIndirectCommandNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkCopyMemoryToImageIndirectCommandNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkCopyMemoryToImageIndirectCommandNV.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static VkCopyMemoryToImageIndirectCommandNV malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkCopyMemoryToImageIndirectCommandNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkCopyMemoryToImageIndirectCommandNV calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkCopyMemoryToImageIndirectCommandNV.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkCopyMemoryToImageIndirectCommandNV.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsrcAddress

public static long nsrcAddress(long struct)

Unsafe version of srcAddress().

nbufferRowLength

public static int nbufferRowLength(long struct)

Unsafe version of bufferRowLength().

nbufferImageHeight

public static int nbufferImageHeight(long struct)

Unsafe version of bufferImageHeight().

nimageSubresource

public static VkImageSubresourceLayers nimageSubresource(long struct)

Unsafe version of imageSubresource().

nimageOffset

public static VkOffset3D nimageOffset(long struct)

Unsafe version of imageOffset().

nimageExtent

public static VkExtent3D nimageExtent(long struct)

Unsafe version of imageExtent().

nsrcAddress

public static void nsrcAddress(long struct,
 long value)

Unsafe version of srcAddress.

nbufferRowLength

public static void nbufferRowLength(long struct,
 int value)

Unsafe version of bufferRowLength.

nbufferImageHeight

public static void nbufferImageHeight(long struct,
 int value)

Unsafe version of bufferImageHeight.

nimageSubresource

public static void nimageSubresource(long struct,
 VkImageSubresourceLayers value)

Unsafe version of imageSubresource.

nimageOffset

public static void nimageOffset(long struct,
 VkOffset3D value)

Unsafe version of imageOffset.

nimageExtent

public static void nimageExtent(long struct,
 VkExtent3D value)

Unsafe version of imageExtent.