Class VkCopyMemoryToImageIndirectCommandKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkCopyMemoryToImageIndirectCommandKHR>

org.lwjgl.vulkan.VkCopyMemoryToImageIndirectCommandKHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkCopyMemoryToImageIndirectCommandNV

public class VkCopyMemoryToImageIndirectCommandKHR
extends Struct<VkCopyMemoryToImageIndirectCommandKHR>
implements NativeResource

struct VkCopyMemoryToImageIndirectCommandKHR {
    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	VkCopyMemoryToImageIndirectCommandKHR.Buffer	An array of VkCopyMemoryToImageIndirectCommandKHR structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

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 Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	bufferImageHeight()
VkCopyMemoryToImageIndirectCommandKHR	bufferImageHeight(int value)	Sets the specified value to the bufferImageHeight field.
int	bufferRowLength()
VkCopyMemoryToImageIndirectCommandKHR	bufferRowLength(int value)	Sets the specified value to the bufferRowLength field.
static VkCopyMemoryToImageIndirectCommandKHR	calloc()	Returns a new VkCopyMemoryToImageIndirectCommandKHR instance allocated with memCalloc.
static VkCopyMemoryToImageIndirectCommandKHR.Buffer	calloc(int capacity)	Returns a new VkCopyMemoryToImageIndirectCommandKHR.Buffer instance allocated with memCalloc.
static VkCopyMemoryToImageIndirectCommandKHR.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkCopyMemoryToImageIndirectCommandKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkCopyMemoryToImageIndirectCommandKHR	calloc(MemoryStack stack)	Returns a new VkCopyMemoryToImageIndirectCommandKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkCopyMemoryToImageIndirectCommandKHR	create()	Returns a new VkCopyMemoryToImageIndirectCommandKHR instance allocated with BufferUtils.
static VkCopyMemoryToImageIndirectCommandKHR.Buffer	create(int capacity)	Returns a new VkCopyMemoryToImageIndirectCommandKHR.Buffer instance allocated with BufferUtils.
static VkCopyMemoryToImageIndirectCommandKHR	create(long address)	Returns a new VkCopyMemoryToImageIndirectCommandKHR instance for the specified memory address.
static VkCopyMemoryToImageIndirectCommandKHR.Buffer	create(long address, int capacity)	Create a VkCopyMemoryToImageIndirectCommandKHR.Buffer instance at the specified memory.
static @Nullable VkCopyMemoryToImageIndirectCommandKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkCopyMemoryToImageIndirectCommandKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkExtent3D	imageExtent()
VkCopyMemoryToImageIndirectCommandKHR	imageExtent(Consumer<VkExtent3D> consumer)	Passes the imageExtent field to the specified Consumer.
VkCopyMemoryToImageIndirectCommandKHR	imageExtent(VkExtent3D value)	Copies the specified VkExtent3D to the imageExtent field.
VkOffset3D	imageOffset()
VkCopyMemoryToImageIndirectCommandKHR	imageOffset(Consumer<VkOffset3D> consumer)	Passes the imageOffset field to the specified Consumer.
VkCopyMemoryToImageIndirectCommandKHR	imageOffset(VkOffset3D value)	Copies the specified VkOffset3D to the imageOffset field.
VkImageSubresourceLayers	imageSubresource()
VkCopyMemoryToImageIndirectCommandKHR	imageSubresource(Consumer<VkImageSubresourceLayers> consumer)	Passes the imageSubresource field to the specified Consumer.
VkCopyMemoryToImageIndirectCommandKHR	imageSubresource(VkImageSubresourceLayers value)	Copies the specified VkImageSubresourceLayers to the imageSubresource field.
static VkCopyMemoryToImageIndirectCommandKHR	malloc()	Returns a new VkCopyMemoryToImageIndirectCommandKHR instance allocated with memAlloc.
static VkCopyMemoryToImageIndirectCommandKHR.Buffer	malloc(int capacity)	Returns a new VkCopyMemoryToImageIndirectCommandKHR.Buffer instance allocated with memAlloc.
static VkCopyMemoryToImageIndirectCommandKHR.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkCopyMemoryToImageIndirectCommandKHR.Buffer instance allocated on the specified MemoryStack.
static VkCopyMemoryToImageIndirectCommandKHR	malloc(MemoryStack stack)	Returns a new VkCopyMemoryToImageIndirectCommandKHR 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.
VkCopyMemoryToImageIndirectCommandKHR	set(long srcAddress, int bufferRowLength, int bufferImageHeight, VkImageSubresourceLayers imageSubresource, VkOffset3D imageOffset, VkExtent3D imageExtent)	Initializes this struct with the specified values.
VkCopyMemoryToImageIndirectCommandKHR	set(VkCopyMemoryToImageIndirectCommandKHR src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
long	srcAddress()
VkCopyMemoryToImageIndirectCommandKHR	srcAddress(long value)	Sets the specified value to the srcAddress field.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface 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

VkCopyMemoryToImageIndirectCommandKHR

public VkCopyMemoryToImageIndirectCommandKHR(ByteBuffer container)

Creates a VkCopyMemoryToImageIndirectCommandKHR 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()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkCopyMemoryToImageIndirectCommandKHR>

srcAddress

@NativeType("VkDeviceAddress")
public long srcAddress()

Returns:

the value of the srcAddress field.

bufferRowLength

@NativeType("uint32_t")
public int bufferRowLength()

Returns:

the value of the bufferRowLength field.

bufferImageHeight

@NativeType("uint32_t")
public int bufferImageHeight()

Returns:

the value of the bufferImageHeight field.

imageSubresource

public VkImageSubresourceLayers imageSubresource()

Returns:

a VkImageSubresourceLayers view of the imageSubresource field.

imageOffset

public VkOffset3D imageOffset()

Returns:

a VkOffset3D view of the imageOffset field.

imageExtent

public VkExtent3D imageExtent()

Returns:

a VkExtent3D view of the imageExtent field.

srcAddress

public VkCopyMemoryToImageIndirectCommandKHR srcAddress(@NativeType("VkDeviceAddress")
 long value)

Sets the specified value to the srcAddress field.

bufferRowLength

public VkCopyMemoryToImageIndirectCommandKHR bufferRowLength(@NativeType("uint32_t")
 int value)

Sets the specified value to the bufferRowLength field.

bufferImageHeight

public VkCopyMemoryToImageIndirectCommandKHR bufferImageHeight(@NativeType("uint32_t")
 int value)

Sets the specified value to the bufferImageHeight field.

imageSubresource

public VkCopyMemoryToImageIndirectCommandKHR imageSubresource(VkImageSubresourceLayers value)

Copies the specified VkImageSubresourceLayers to the imageSubresource field.

imageSubresource

public VkCopyMemoryToImageIndirectCommandKHR imageSubresource(Consumer<VkImageSubresourceLayers> consumer)

Passes the imageSubresource field to the specified Consumer.

imageOffset

public VkCopyMemoryToImageIndirectCommandKHR imageOffset(VkOffset3D value)

Copies the specified VkOffset3D to the imageOffset field.

imageOffset

public VkCopyMemoryToImageIndirectCommandKHR imageOffset(Consumer<VkOffset3D> consumer)

Passes the imageOffset field to the specified Consumer.

imageExtent

public VkCopyMemoryToImageIndirectCommandKHR imageExtent(VkExtent3D value)

Copies the specified VkExtent3D to the imageExtent field.

imageExtent

public VkCopyMemoryToImageIndirectCommandKHR imageExtent(Consumer<VkExtent3D> consumer)

Passes the imageExtent field to the specified Consumer.

set

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

Initializes this struct with the specified values.

set

public VkCopyMemoryToImageIndirectCommandKHR set(VkCopyMemoryToImageIndirectCommandKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkCopyMemoryToImageIndirectCommandKHR malloc()

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

calloc

public static VkCopyMemoryToImageIndirectCommandKHR calloc()

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

create

public static VkCopyMemoryToImageIndirectCommandKHR create()

Returns a new VkCopyMemoryToImageIndirectCommandKHR instance allocated with BufferUtils.

create

public static VkCopyMemoryToImageIndirectCommandKHR create(long address)

Returns a new VkCopyMemoryToImageIndirectCommandKHR instance for the specified memory address.

createSafe

public static @Nullable VkCopyMemoryToImageIndirectCommandKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkCopyMemoryToImageIndirectCommandKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkCopyMemoryToImageIndirectCommandKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkCopyMemoryToImageIndirectCommandKHR.Buffer create(int capacity)

Returns a new VkCopyMemoryToImageIndirectCommandKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkCopyMemoryToImageIndirectCommandKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkCopyMemoryToImageIndirectCommandKHR malloc(MemoryStack stack)

Returns a new VkCopyMemoryToImageIndirectCommandKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkCopyMemoryToImageIndirectCommandKHR calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkCopyMemoryToImageIndirectCommandKHR.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.