Class VkCopyImageToBufferInfo2KHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkCopyImageToBufferInfo2>

org.lwjgl.vulkan.VkCopyImageToBufferInfo2

org.lwjgl.vulkan.VkCopyImageToBufferInfo2KHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkCopyImageToBufferInfo2KHR
extends VkCopyImageToBufferInfo2

struct VkCopyImageToBufferInfo2KHR {
    VkStructureType sType;
    void const * pNext;
    VkImage srcImage;
    VkImageLayout srcImageLayout;
    VkBuffer dstBuffer;
    uint32_t regionCount;
    VkBufferImageCopy2 const * pRegions;
}

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields inherited from class VkCopyImageToBufferInfo2

ALIGNOF, DSTBUFFER, PNEXT, PREGIONS, REGIONCOUNT, SIZEOF, SRCIMAGE, SRCIMAGELAYOUT, STYPE

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkCopyImageToBufferInfo2KHR	calloc()	Returns a new VkCopyImageToBufferInfo2KHR instance allocated with memCalloc.
static VkCopyImageToBufferInfo2KHR.Buffer	calloc(int capacity)	Returns a new VkCopyImageToBufferInfo2KHR.Buffer instance allocated with memCalloc.
static VkCopyImageToBufferInfo2KHR.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkCopyImageToBufferInfo2KHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkCopyImageToBufferInfo2KHR	calloc(MemoryStack stack)	Returns a new VkCopyImageToBufferInfo2KHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkCopyImageToBufferInfo2KHR	create()	Returns a new VkCopyImageToBufferInfo2KHR instance allocated with BufferUtils.
static VkCopyImageToBufferInfo2KHR.Buffer	create(int capacity)	Returns a new VkCopyImageToBufferInfo2KHR.Buffer instance allocated with BufferUtils.
static VkCopyImageToBufferInfo2KHR	create(long address)	Returns a new VkCopyImageToBufferInfo2KHR instance for the specified memory address.
static VkCopyImageToBufferInfo2KHR.Buffer	create(long address, int capacity)	Create a VkCopyImageToBufferInfo2KHR.Buffer instance at the specified memory.
static @Nullable VkCopyImageToBufferInfo2KHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkCopyImageToBufferInfo2KHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkCopyImageToBufferInfo2KHR	dstBuffer(long value)	Sets the specified value to the dstBuffer field.
static VkCopyImageToBufferInfo2KHR	malloc()	Returns a new VkCopyImageToBufferInfo2KHR instance allocated with memAlloc.
static VkCopyImageToBufferInfo2KHR.Buffer	malloc(int capacity)	Returns a new VkCopyImageToBufferInfo2KHR.Buffer instance allocated with memAlloc.
static VkCopyImageToBufferInfo2KHR.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkCopyImageToBufferInfo2KHR.Buffer instance allocated on the specified MemoryStack.
static VkCopyImageToBufferInfo2KHR	malloc(MemoryStack stack)	Returns a new VkCopyImageToBufferInfo2KHR instance allocated on the specified MemoryStack.
VkCopyImageToBufferInfo2KHR	pNext(long value)	Sets the specified value to the pNext field.
VkCopyImageToBufferInfo2KHR	pRegions(VkBufferImageCopy2.Buffer value)	Sets the address of the specified VkBufferImageCopy2.Buffer to the pRegions field.
VkCopyImageToBufferInfo2KHR	set(int sType, long pNext, long srcImage, int srcImageLayout, long dstBuffer, VkBufferImageCopy2.Buffer pRegions)	Initializes this struct with the specified values.
VkCopyImageToBufferInfo2KHR	set(VkCopyImageToBufferInfo2KHR src)	Copies the specified struct data to this struct.
VkCopyImageToBufferInfo2KHR	srcImage(long value)	Sets the specified value to the srcImage field.
VkCopyImageToBufferInfo2KHR	srcImageLayout(int value)	Sets the specified value to the srcImageLayout field.
VkCopyImageToBufferInfo2KHR	sType(int value)	Sets the specified value to the sType field.
VkCopyImageToBufferInfo2KHR	sType$Default()	Sets the STRUCTURE_TYPE_COPY_IMAGE_TO_BUFFER_INFO_2 value to the sType field.

Methods inherited from class VkCopyImageToBufferInfo2

dstBuffer, ndstBuffer, ndstBuffer, npNext, npNext, npRegions, npRegions, nregionCount, nregionCount, nsrcImage, nsrcImage, nsrcImageLayout, nsrcImageLayout, nsType, nsType, pNext, pRegions, regionCount, set, sizeof, srcImage, srcImageLayout, sType, validate

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

Constructor Details

VkCopyImageToBufferInfo2KHR

public VkCopyImageToBufferInfo2KHR(ByteBuffer container)

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

sType

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

Sets the specified value to the sType field.

Overrides:

sType in class VkCopyImageToBufferInfo2

sType$Default

public VkCopyImageToBufferInfo2KHR sType$Default()

Sets the STRUCTURE_TYPE_COPY_IMAGE_TO_BUFFER_INFO_2 value to the sType field.

Overrides:

sType$Default in class VkCopyImageToBufferInfo2

pNext

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

Sets the specified value to the pNext field.

Overrides:

pNext in class VkCopyImageToBufferInfo2

srcImage

public VkCopyImageToBufferInfo2KHR srcImage(@NativeType("VkImage")
 long value)

Sets the specified value to the srcImage field.

Overrides:

srcImage in class VkCopyImageToBufferInfo2

srcImageLayout

public VkCopyImageToBufferInfo2KHR srcImageLayout(@NativeType("VkImageLayout")
 int value)

Sets the specified value to the srcImageLayout field.

Overrides:

srcImageLayout in class VkCopyImageToBufferInfo2

dstBuffer

public VkCopyImageToBufferInfo2KHR dstBuffer(@NativeType("VkBuffer")
 long value)

Sets the specified value to the dstBuffer field.

Overrides:

dstBuffer in class VkCopyImageToBufferInfo2

pRegions

public VkCopyImageToBufferInfo2KHR pRegions(@NativeType("VkBufferImageCopy2 const *")
 VkBufferImageCopy2.Buffer value)

Sets the address of the specified VkBufferImageCopy2.Buffer to the pRegions field.

Overrides:

pRegions in class VkCopyImageToBufferInfo2

set

public VkCopyImageToBufferInfo2KHR set(int sType,
 long pNext,
 long srcImage,
 int srcImageLayout,
 long dstBuffer,
 VkBufferImageCopy2.Buffer pRegions)

Initializes this struct with the specified values.

Overrides:

set in class VkCopyImageToBufferInfo2

set

public VkCopyImageToBufferInfo2KHR set(VkCopyImageToBufferInfo2KHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkCopyImageToBufferInfo2KHR malloc()

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

calloc

public static VkCopyImageToBufferInfo2KHR calloc()

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

create

public static VkCopyImageToBufferInfo2KHR create()

Returns a new VkCopyImageToBufferInfo2KHR instance allocated with BufferUtils.

create

public static VkCopyImageToBufferInfo2KHR create(long address)

Returns a new VkCopyImageToBufferInfo2KHR instance for the specified memory address.

createSafe

public static @Nullable VkCopyImageToBufferInfo2KHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkCopyImageToBufferInfo2KHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkCopyImageToBufferInfo2KHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkCopyImageToBufferInfo2KHR.Buffer create(int capacity)

Returns a new VkCopyImageToBufferInfo2KHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkCopyImageToBufferInfo2KHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkCopyImageToBufferInfo2KHR malloc(MemoryStack stack)

Returns a new VkCopyImageToBufferInfo2KHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkCopyImageToBufferInfo2KHR calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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