Class VkCopyMemoryToImageInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkCopyMemoryToImageInfo>

org.lwjgl.vulkan.VkCopyMemoryToImageInfo

org.lwjgl.vulkan.VkCopyMemoryToImageInfoEXT

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkCopyMemoryToImageInfoEXT
extends VkCopyMemoryToImageInfo

struct VkCopyMemoryToImageInfoEXT {
    VkStructureType sType;
    void const * pNext;
    VkHostImageCopyFlags flags;
    VkImage dstImage;
    VkImageLayout dstImageLayout;
    uint32_t regionCount;
    VkMemoryToImageCopy const * pRegions;
}

Nested Class Summary

Nested Classes

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

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

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class VkCopyMemoryToImageInfo

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

VkCopyMemoryToImageInfoEXT

public VkCopyMemoryToImageInfoEXT(ByteBuffer container)

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

Sets the specified value to the sType field.

Overrides:

sType in class VkCopyMemoryToImageInfo

sType$Default

public VkCopyMemoryToImageInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_COPY_MEMORY_TO_IMAGE_INFO value to the sType field.

Overrides:

sType$Default in class VkCopyMemoryToImageInfo

pNext

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

Sets the specified value to the pNext field.

Overrides:

pNext in class VkCopyMemoryToImageInfo

flags

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

Sets the specified value to the flags field.

Overrides:

flags in class VkCopyMemoryToImageInfo

dstImage

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

Sets the specified value to the dstImage field.

Overrides:

dstImage in class VkCopyMemoryToImageInfo

dstImageLayout

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

Sets the specified value to the dstImageLayout field.

Overrides:

dstImageLayout in class VkCopyMemoryToImageInfo

pRegions

public VkCopyMemoryToImageInfoEXT pRegions(@NativeType("VkMemoryToImageCopy const *")
 VkMemoryToImageCopy.Buffer value)

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

Overrides:

pRegions in class VkCopyMemoryToImageInfo

set

public VkCopyMemoryToImageInfoEXT set(int sType,
 long pNext,
 int flags,
 long dstImage,
 int dstImageLayout,
 VkMemoryToImageCopy.Buffer pRegions)

Initializes this struct with the specified values.

Overrides:

set in class VkCopyMemoryToImageInfo

set

public VkCopyMemoryToImageInfoEXT set(VkCopyMemoryToImageInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkCopyMemoryToImageInfoEXT malloc()

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

calloc

public static VkCopyMemoryToImageInfoEXT calloc()

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

create

public static VkCopyMemoryToImageInfoEXT create()

Returns a new VkCopyMemoryToImageInfoEXT instance allocated with BufferUtils.

create

public static VkCopyMemoryToImageInfoEXT create(long address)

Returns a new VkCopyMemoryToImageInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkCopyMemoryToImageInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkCopyMemoryToImageInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkCopyMemoryToImageInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkCopyMemoryToImageInfoEXT.Buffer create(int capacity)

Returns a new VkCopyMemoryToImageInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkCopyMemoryToImageInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkCopyMemoryToImageInfoEXT malloc(MemoryStack stack)

Returns a new VkCopyMemoryToImageInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkCopyMemoryToImageInfoEXT calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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