Class VkCopyImageInfo2KHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkCopyImageInfo2>

org.lwjgl.vulkan.VkCopyImageInfo2

org.lwjgl.vulkan.VkCopyImageInfo2KHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkCopyImageInfo2KHR
extends VkCopyImageInfo2

struct VkCopyImageInfo2KHR {
    VkStructureType sType;
    void const * pNext;
    VkImage srcImage;
    VkImageLayout srcImageLayout;
    VkImage dstImage;
    VkImageLayout dstImageLayout;
    uint32_t regionCount;
    VkImageCopy2 const * pRegions;
}

Nested Class Summary

Nested Classes

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

ALIGNOF, DSTIMAGE, DSTIMAGELAYOUT, 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
VkCopyImageInfo2KHR(ByteBuffer container)	Creates a VkCopyImageInfo2KHR instance at the current position of the specified ByteBuffer container.

Method Summary

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

Methods inherited from class VkCopyImageInfo2

dstImage, dstImageLayout, ndstImage, ndstImage, ndstImageLayout, ndstImageLayout, 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

VkCopyImageInfo2KHR

public VkCopyImageInfo2KHR(ByteBuffer container)

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

Sets the specified value to the sType field.

Overrides:

sType in class VkCopyImageInfo2

sType$Default

public VkCopyImageInfo2KHR sType$Default()

Sets the STRUCTURE_TYPE_COPY_IMAGE_INFO_2 value to the sType field.

Overrides:

sType$Default in class VkCopyImageInfo2

pNext

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

Sets the specified value to the pNext field.

Overrides:

pNext in class VkCopyImageInfo2

srcImage

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

Sets the specified value to the srcImage field.

Overrides:

srcImage in class VkCopyImageInfo2

srcImageLayout

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

Sets the specified value to the srcImageLayout field.

Overrides:

srcImageLayout in class VkCopyImageInfo2

dstImage

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

Sets the specified value to the dstImage field.

Overrides:

dstImage in class VkCopyImageInfo2

dstImageLayout

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

Sets the specified value to the dstImageLayout field.

Overrides:

dstImageLayout in class VkCopyImageInfo2

pRegions

public VkCopyImageInfo2KHR pRegions(@NativeType("VkImageCopy2 const *")
 VkImageCopy2.Buffer value)

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

Overrides:

pRegions in class VkCopyImageInfo2

set

public VkCopyImageInfo2KHR set(int sType,
 long pNext,
 long srcImage,
 int srcImageLayout,
 long dstImage,
 int dstImageLayout,
 VkImageCopy2.Buffer pRegions)

Initializes this struct with the specified values.

Overrides:

set in class VkCopyImageInfo2

set

public VkCopyImageInfo2KHR set(VkCopyImageInfo2KHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkCopyImageInfo2KHR malloc()

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

calloc

public static VkCopyImageInfo2KHR calloc()

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

create

public static VkCopyImageInfo2KHR create()

Returns a new VkCopyImageInfo2KHR instance allocated with BufferUtils.

create

public static VkCopyImageInfo2KHR create(long address)

Returns a new VkCopyImageInfo2KHR instance for the specified memory address.

createSafe

public static @Nullable VkCopyImageInfo2KHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkCopyImageInfo2KHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkCopyImageInfo2KHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkCopyImageInfo2KHR.Buffer create(int capacity)

Returns a new VkCopyImageInfo2KHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkCopyImageInfo2KHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkCopyImageInfo2KHR malloc(MemoryStack stack)

Returns a new VkCopyImageInfo2KHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkCopyImageInfo2KHR calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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