Class VkCopyImageToMemoryInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkCopyImageToMemoryInfo>

org.lwjgl.vulkan.VkCopyImageToMemoryInfo

org.lwjgl.vulkan.VkCopyImageToMemoryInfoEXT

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkCopyImageToMemoryInfoEXT
extends VkCopyImageToMemoryInfo

struct VkCopyImageToMemoryInfoEXT {
    VkStructureType sType;
    void const * pNext;
    VkHostImageCopyFlags flags;
    VkImage srcImage;
    VkImageLayout srcImageLayout;
    uint32_t regionCount;
    VkImageToMemoryCopy const * pRegions;
}

Nested Class Summary

Nested Classes

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

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

Method Summary

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

Methods inherited from class VkCopyImageToMemoryInfo

flags, nflags, nflags, 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

VkCopyImageToMemoryInfoEXT

public VkCopyImageToMemoryInfoEXT(ByteBuffer container)

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

Sets the specified value to the sType field.

Overrides:

sType in class VkCopyImageToMemoryInfo

sType$Default

public VkCopyImageToMemoryInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_COPY_IMAGE_TO_MEMORY_INFO value to the sType field.

Overrides:

sType$Default in class VkCopyImageToMemoryInfo

pNext

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

Sets the specified value to the pNext field.

Overrides:

pNext in class VkCopyImageToMemoryInfo

flags

public VkCopyImageToMemoryInfoEXT flags(@NativeType("VkHostImageCopyFlags")
 int value)

Sets the specified value to the flags field.

Overrides:

flags in class VkCopyImageToMemoryInfo

srcImage

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

Sets the specified value to the srcImage field.

Overrides:

srcImage in class VkCopyImageToMemoryInfo

srcImageLayout

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

Sets the specified value to the srcImageLayout field.

Overrides:

srcImageLayout in class VkCopyImageToMemoryInfo

pRegions

public VkCopyImageToMemoryInfoEXT pRegions(@NativeType("VkImageToMemoryCopy const *")
 VkImageToMemoryCopy.Buffer value)

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

Overrides:

pRegions in class VkCopyImageToMemoryInfo

set

public VkCopyImageToMemoryInfoEXT set(int sType,
 long pNext,
 int flags,
 long srcImage,
 int srcImageLayout,
 VkImageToMemoryCopy.Buffer pRegions)

Initializes this struct with the specified values.

Overrides:

set in class VkCopyImageToMemoryInfo

set

public VkCopyImageToMemoryInfoEXT set(VkCopyImageToMemoryInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkCopyImageToMemoryInfoEXT malloc()

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

calloc

public static VkCopyImageToMemoryInfoEXT calloc()

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

create

public static VkCopyImageToMemoryInfoEXT create()

Returns a new VkCopyImageToMemoryInfoEXT instance allocated with BufferUtils.

create

public static VkCopyImageToMemoryInfoEXT create(long address)

Returns a new VkCopyImageToMemoryInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkCopyImageToMemoryInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkCopyImageToMemoryInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkCopyImageToMemoryInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkCopyImageToMemoryInfoEXT.Buffer create(int capacity)

Returns a new VkCopyImageToMemoryInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkCopyImageToMemoryInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkCopyImageToMemoryInfoEXT malloc(MemoryStack stack)

Returns a new VkCopyImageToMemoryInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkCopyImageToMemoryInfoEXT calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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