Class VkCopyMemoryToImageIndirectInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkCopyMemoryToImageIndirectInfoKHR>

org.lwjgl.vulkan.VkCopyMemoryToImageIndirectInfoKHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkCopyMemoryToImageIndirectInfoKHR
extends Struct<VkCopyMemoryToImageIndirectInfoKHR>
implements NativeResource

struct VkCopyMemoryToImageIndirectInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkAddressCopyFlagsKHR srcCopyFlags;
    uint32_t copyCount;
    VkStridedDeviceAddressRangeKHR copyAddressRange;
    VkImage dstImage;
    VkImageLayout dstImageLayout;
    VkImageSubresourceLayers const * pImageSubresources;
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkCopyMemoryToImageIndirectInfoKHR.Buffer	An array of VkCopyMemoryToImageIndirectInfoKHR 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	COPYADDRESSRANGE	The struct member offsets.
static final int	COPYCOUNT	The struct member offsets.
static final int	DSTIMAGE	The struct member offsets.
static final int	DSTIMAGELAYOUT	The struct member offsets.
static final int	PIMAGESUBRESOURCES	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SRCCOPYFLAGS	The struct member offsets.
static final int	STYPE	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkCopyMemoryToImageIndirectInfoKHR	calloc()	Returns a new VkCopyMemoryToImageIndirectInfoKHR instance allocated with memCalloc.
static VkCopyMemoryToImageIndirectInfoKHR.Buffer	calloc(int capacity)	Returns a new VkCopyMemoryToImageIndirectInfoKHR.Buffer instance allocated with memCalloc.
static VkCopyMemoryToImageIndirectInfoKHR.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkCopyMemoryToImageIndirectInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkCopyMemoryToImageIndirectInfoKHR	calloc(MemoryStack stack)	Returns a new VkCopyMemoryToImageIndirectInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
VkStridedDeviceAddressRangeKHR	copyAddressRange()
VkCopyMemoryToImageIndirectInfoKHR	copyAddressRange(Consumer<VkStridedDeviceAddressRangeKHR> consumer)	Passes the copyAddressRange field to the specified Consumer.
VkCopyMemoryToImageIndirectInfoKHR	copyAddressRange(VkStridedDeviceAddressRangeKHR value)	Copies the specified VkStridedDeviceAddressRangeKHR to the copyAddressRange field.
int	copyCount()
static VkCopyMemoryToImageIndirectInfoKHR	create()	Returns a new VkCopyMemoryToImageIndirectInfoKHR instance allocated with BufferUtils.
static VkCopyMemoryToImageIndirectInfoKHR.Buffer	create(int capacity)	Returns a new VkCopyMemoryToImageIndirectInfoKHR.Buffer instance allocated with BufferUtils.
static VkCopyMemoryToImageIndirectInfoKHR	create(long address)	Returns a new VkCopyMemoryToImageIndirectInfoKHR instance for the specified memory address.
static VkCopyMemoryToImageIndirectInfoKHR.Buffer	create(long address, int capacity)	Create a VkCopyMemoryToImageIndirectInfoKHR.Buffer instance at the specified memory.
static @Nullable VkCopyMemoryToImageIndirectInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkCopyMemoryToImageIndirectInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	dstImage()
VkCopyMemoryToImageIndirectInfoKHR	dstImage(long value)	Sets the specified value to the dstImage field.
int	dstImageLayout()
VkCopyMemoryToImageIndirectInfoKHR	dstImageLayout(int value)	Sets the specified value to the dstImageLayout field.
static VkCopyMemoryToImageIndirectInfoKHR	malloc()	Returns a new VkCopyMemoryToImageIndirectInfoKHR instance allocated with memAlloc.
static VkCopyMemoryToImageIndirectInfoKHR.Buffer	malloc(int capacity)	Returns a new VkCopyMemoryToImageIndirectInfoKHR.Buffer instance allocated with memAlloc.
static VkCopyMemoryToImageIndirectInfoKHR.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkCopyMemoryToImageIndirectInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkCopyMemoryToImageIndirectInfoKHR	malloc(MemoryStack stack)	Returns a new VkCopyMemoryToImageIndirectInfoKHR instance allocated on the specified MemoryStack.
static VkStridedDeviceAddressRangeKHR	ncopyAddressRange(long struct)	Unsafe version of copyAddressRange().
static void	ncopyAddressRange(long struct, VkStridedDeviceAddressRangeKHR value)	Unsafe version of copyAddressRange.
static int	ncopyCount(long struct)	Unsafe version of copyCount().
static void	ncopyCount(long struct, int value)	Sets the specified value to the copyCount field of the specified struct.
static long	ndstImage(long struct)	Unsafe version of dstImage().
static void	ndstImage(long struct, long value)	Unsafe version of dstImage.
static int	ndstImageLayout(long struct)	Unsafe version of dstImageLayout().
static void	ndstImageLayout(long struct, int value)	Unsafe version of dstImageLayout.
static VkImageSubresourceLayers.Buffer	npImageSubresources(long struct)	Unsafe version of pImageSubresources().
static void	npImageSubresources(long struct, VkImageSubresourceLayers.Buffer value)	Unsafe version of pImageSubresources.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsrcCopyFlags(long struct)	Unsafe version of srcCopyFlags().
static void	nsrcCopyFlags(long struct, int value)	Unsafe version of srcCopyFlags.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
VkImageSubresourceLayers.Buffer	pImageSubresources()
VkCopyMemoryToImageIndirectInfoKHR	pImageSubresources(VkImageSubresourceLayers.Buffer value)	Sets the address of the specified VkImageSubresourceLayers.Buffer to the pImageSubresources field.
long	pNext()
VkCopyMemoryToImageIndirectInfoKHR	pNext(long value)	Sets the specified value to the pNext field.
VkCopyMemoryToImageIndirectInfoKHR	set(int sType, long pNext, int srcCopyFlags, VkStridedDeviceAddressRangeKHR copyAddressRange, long dstImage, int dstImageLayout, VkImageSubresourceLayers.Buffer pImageSubresources)	Initializes this struct with the specified values.
VkCopyMemoryToImageIndirectInfoKHR	set(VkCopyMemoryToImageIndirectInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	srcCopyFlags()
VkCopyMemoryToImageIndirectInfoKHR	srcCopyFlags(int value)	Sets the specified value to the srcCopyFlags field.
int	sType()
VkCopyMemoryToImageIndirectInfoKHR	sType(int value)	Sets the specified value to the sType field.
VkCopyMemoryToImageIndirectInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_COPY_MEMORY_TO_IMAGE_INDIRECT_INFO_KHR value to the sType field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

SRCCOPYFLAGS

public static final int SRCCOPYFLAGS

The struct member offsets.

COPYCOUNT

public static final int COPYCOUNT

The struct member offsets.

COPYADDRESSRANGE

public static final int COPYADDRESSRANGE

The struct member offsets.

DSTIMAGE

public static final int DSTIMAGE

The struct member offsets.

DSTIMAGELAYOUT

public static final int DSTIMAGELAYOUT

The struct member offsets.

PIMAGESUBRESOURCES

public static final int PIMAGESUBRESOURCES

The struct member offsets.

Constructor Details

VkCopyMemoryToImageIndirectInfoKHR

public VkCopyMemoryToImageIndirectInfoKHR(ByteBuffer container)

Creates a VkCopyMemoryToImageIndirectInfoKHR 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<VkCopyMemoryToImageIndirectInfoKHR>

sType

@NativeType("VkStructureType")
public int sType()

Returns:

the value of the sType field.

pNext

@NativeType("void const *")
public long pNext()

Returns:

the value of the pNext field.

srcCopyFlags

@NativeType("VkAddressCopyFlagsKHR")
public int srcCopyFlags()

Returns:

the value of the srcCopyFlags field.

copyCount

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

Returns:

the value of the copyCount field.

copyAddressRange

public VkStridedDeviceAddressRangeKHR copyAddressRange()

Returns:

a VkStridedDeviceAddressRangeKHR view of the copyAddressRange field.

dstImage

@NativeType("VkImage")
public long dstImage()

Returns:

the value of the dstImage field.

dstImageLayout

@NativeType("VkImageLayout")
public int dstImageLayout()

Returns:

the value of the dstImageLayout field.

pImageSubresources

@NativeType("VkImageSubresourceLayers const *")
public VkImageSubresourceLayers.Buffer pImageSubresources()

Returns:

a VkImageSubresourceLayers.Buffer view of the struct array pointed to by the pImageSubresources field.

sType

public VkCopyMemoryToImageIndirectInfoKHR sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

sType$Default

public VkCopyMemoryToImageIndirectInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_COPY_MEMORY_TO_IMAGE_INDIRECT_INFO_KHR value to the sType field.

pNext

public VkCopyMemoryToImageIndirectInfoKHR pNext(@NativeType("void const *")
 long value)

Sets the specified value to the pNext field.

srcCopyFlags

public VkCopyMemoryToImageIndirectInfoKHR srcCopyFlags(@NativeType("VkAddressCopyFlagsKHR")
 int value)

Sets the specified value to the srcCopyFlags field.

copyAddressRange

public VkCopyMemoryToImageIndirectInfoKHR copyAddressRange(VkStridedDeviceAddressRangeKHR value)

Copies the specified VkStridedDeviceAddressRangeKHR to the copyAddressRange field.

copyAddressRange

public VkCopyMemoryToImageIndirectInfoKHR copyAddressRange(Consumer<VkStridedDeviceAddressRangeKHR> consumer)

Passes the copyAddressRange field to the specified Consumer.

dstImage

public VkCopyMemoryToImageIndirectInfoKHR dstImage(@NativeType("VkImage")
 long value)

Sets the specified value to the dstImage field.

dstImageLayout

public VkCopyMemoryToImageIndirectInfoKHR dstImageLayout(@NativeType("VkImageLayout")
 int value)

Sets the specified value to the dstImageLayout field.

pImageSubresources

public VkCopyMemoryToImageIndirectInfoKHR pImageSubresources(@NativeType("VkImageSubresourceLayers const *")
 VkImageSubresourceLayers.Buffer value)

Sets the address of the specified VkImageSubresourceLayers.Buffer to the pImageSubresources field.

set

public VkCopyMemoryToImageIndirectInfoKHR set(int sType,
 long pNext,
 int srcCopyFlags,
 VkStridedDeviceAddressRangeKHR copyAddressRange,
 long dstImage,
 int dstImageLayout,
 VkImageSubresourceLayers.Buffer pImageSubresources)

Initializes this struct with the specified values.

set

public VkCopyMemoryToImageIndirectInfoKHR set(VkCopyMemoryToImageIndirectInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkCopyMemoryToImageIndirectInfoKHR malloc()

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

calloc

public static VkCopyMemoryToImageIndirectInfoKHR calloc()

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

create

public static VkCopyMemoryToImageIndirectInfoKHR create()

Returns a new VkCopyMemoryToImageIndirectInfoKHR instance allocated with BufferUtils.

create

public static VkCopyMemoryToImageIndirectInfoKHR create(long address)

Returns a new VkCopyMemoryToImageIndirectInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkCopyMemoryToImageIndirectInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkCopyMemoryToImageIndirectInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkCopyMemoryToImageIndirectInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkCopyMemoryToImageIndirectInfoKHR.Buffer create(int capacity)

Returns a new VkCopyMemoryToImageIndirectInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkCopyMemoryToImageIndirectInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkCopyMemoryToImageIndirectInfoKHR malloc(MemoryStack stack)

Returns a new VkCopyMemoryToImageIndirectInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkCopyMemoryToImageIndirectInfoKHR calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nsrcCopyFlags

public static int nsrcCopyFlags(long struct)

Unsafe version of srcCopyFlags().

ncopyCount

public static int ncopyCount(long struct)

Unsafe version of copyCount().

ncopyAddressRange

public static VkStridedDeviceAddressRangeKHR ncopyAddressRange(long struct)

Unsafe version of copyAddressRange().

ndstImage

public static long ndstImage(long struct)

Unsafe version of dstImage().

ndstImageLayout

public static int ndstImageLayout(long struct)

Unsafe version of dstImageLayout().

npImageSubresources

public static VkImageSubresourceLayers.Buffer npImageSubresources(long struct)

Unsafe version of pImageSubresources().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

nsrcCopyFlags

public static void nsrcCopyFlags(long struct,
 int value)

Unsafe version of srcCopyFlags.

ncopyCount

public static void ncopyCount(long struct,
 int value)

Sets the specified value to the copyCount field of the specified struct.

ncopyAddressRange

public static void ncopyAddressRange(long struct,
 VkStridedDeviceAddressRangeKHR value)

Unsafe version of copyAddressRange.

ndstImage

public static void ndstImage(long struct,
 long value)

Unsafe version of dstImage.

ndstImageLayout

public static void ndstImageLayout(long struct,
 int value)

Unsafe version of dstImageLayout.

npImageSubresources

public static void npImageSubresources(long struct,
 VkImageSubresourceLayers.Buffer value)

Unsafe version of pImageSubresources.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate