Class VkCopyBufferToImageInfo2KHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkCopyBufferToImageInfo2>

org.lwjgl.vulkan.VkCopyBufferToImageInfo2

org.lwjgl.vulkan.VkCopyBufferToImageInfo2KHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkCopyBufferToImageInfo2KHR
extends VkCopyBufferToImageInfo2

struct VkCopyBufferToImageInfo2KHR {
    VkStructureType sType;
    void const * pNext;
    VkBuffer srcBuffer;
    VkImage dstImage;
    VkImageLayout dstImageLayout;
    uint32_t regionCount;
    VkBufferImageCopy2 const * pRegions;
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkCopyBufferToImageInfo2KHR.Buffer	An array of VkCopyBufferToImageInfo2KHR 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 VkCopyBufferToImageInfo2

ALIGNOF, DSTIMAGE, DSTIMAGELAYOUT, PNEXT, PREGIONS, REGIONCOUNT, SIZEOF, SRCBUFFER, STYPE

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class VkCopyBufferToImageInfo2

dstImage, dstImageLayout, ndstImage, ndstImage, ndstImageLayout, ndstImageLayout, npNext, npNext, npRegions, npRegions, nregionCount, nregionCount, nsrcBuffer, nsrcBuffer, nsType, nsType, pNext, pRegions, regionCount, set, sizeof, srcBuffer, 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

VkCopyBufferToImageInfo2KHR

public VkCopyBufferToImageInfo2KHR(ByteBuffer container)

Creates a VkCopyBufferToImageInfo2KHR 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 VkCopyBufferToImageInfo2KHR sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

Overrides:

sType in class VkCopyBufferToImageInfo2

sType$Default

public VkCopyBufferToImageInfo2KHR sType$Default()

Sets the STRUCTURE_TYPE_COPY_BUFFER_TO_IMAGE_INFO_2 value to the sType field.

Overrides:

sType$Default in class VkCopyBufferToImageInfo2

pNext

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

Sets the specified value to the pNext field.

Overrides:

pNext in class VkCopyBufferToImageInfo2

srcBuffer

public VkCopyBufferToImageInfo2KHR srcBuffer(@NativeType("VkBuffer")
 long value)

Sets the specified value to the srcBuffer field.

Overrides:

srcBuffer in class VkCopyBufferToImageInfo2

dstImage

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

Sets the specified value to the dstImage field.

Overrides:

dstImage in class VkCopyBufferToImageInfo2

dstImageLayout

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

Sets the specified value to the dstImageLayout field.

Overrides:

dstImageLayout in class VkCopyBufferToImageInfo2

pRegions

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

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

Overrides:

pRegions in class VkCopyBufferToImageInfo2

set

public VkCopyBufferToImageInfo2KHR set(int sType,
 long pNext,
 long srcBuffer,
 long dstImage,
 int dstImageLayout,
 VkBufferImageCopy2.Buffer pRegions)

Initializes this struct with the specified values.

Overrides:

set in class VkCopyBufferToImageInfo2

set

public VkCopyBufferToImageInfo2KHR set(VkCopyBufferToImageInfo2KHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkCopyBufferToImageInfo2KHR malloc()

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

calloc

public static VkCopyBufferToImageInfo2KHR calloc()

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

create

public static VkCopyBufferToImageInfo2KHR create()

Returns a new VkCopyBufferToImageInfo2KHR instance allocated with BufferUtils.

create

public static VkCopyBufferToImageInfo2KHR create(long address)

Returns a new VkCopyBufferToImageInfo2KHR instance for the specified memory address.

createSafe

public static @Nullable VkCopyBufferToImageInfo2KHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkCopyBufferToImageInfo2KHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkCopyBufferToImageInfo2KHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkCopyBufferToImageInfo2KHR.Buffer create(int capacity)

Returns a new VkCopyBufferToImageInfo2KHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkCopyBufferToImageInfo2KHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkCopyBufferToImageInfo2KHR malloc(MemoryStack stack)

Returns a new VkCopyBufferToImageInfo2KHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkCopyBufferToImageInfo2KHR calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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