Package org.lwjgl.vulkan

Class VkCopyMemoryToImageInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkCopyMemoryToImageInfo>

org.lwjgl.vulkan.VkCopyMemoryToImageInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkCopyMemoryToImageInfoEXT

public class VkCopyMemoryToImageInfo
extends Struct<VkCopyMemoryToImageInfo>
implements NativeResource

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	DSTIMAGE	The struct member offsets.
static final int	DSTIMAGELAYOUT	The struct member offsets.
static final int	FLAGS	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	PREGIONS	The struct member offsets.
static final int	REGIONCOUNT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkCopyMemoryToImageInfo	calloc()	Returns a new VkCopyMemoryToImageInfo instance allocated with memCalloc.
static VkCopyMemoryToImageInfo.Buffer	calloc(int capacity)	Returns a new VkCopyMemoryToImageInfo.Buffer instance allocated with memCalloc.
static VkCopyMemoryToImageInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkCopyMemoryToImageInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkCopyMemoryToImageInfo	calloc(MemoryStack stack)	Returns a new VkCopyMemoryToImageInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkCopyMemoryToImageInfo	create()	Returns a new VkCopyMemoryToImageInfo instance allocated with BufferUtils.
static VkCopyMemoryToImageInfo.Buffer	create(int capacity)	Returns a new VkCopyMemoryToImageInfo.Buffer instance allocated with BufferUtils.
static VkCopyMemoryToImageInfo	create(long address)	Returns a new VkCopyMemoryToImageInfo instance for the specified memory address.
static VkCopyMemoryToImageInfo.Buffer	create(long address, int capacity)	Create a VkCopyMemoryToImageInfo.Buffer instance at the specified memory.
static @Nullable VkCopyMemoryToImageInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkCopyMemoryToImageInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	dstImage()
VkCopyMemoryToImageInfo	dstImage(long value)	Sets the specified value to the dstImage field.
int	dstImageLayout()
VkCopyMemoryToImageInfo	dstImageLayout(int value)	Sets the specified value to the dstImageLayout field.
int	flags()
VkCopyMemoryToImageInfo	flags(int value)	Sets the specified value to the flags field.
static VkCopyMemoryToImageInfo	malloc()	Returns a new VkCopyMemoryToImageInfo instance allocated with memAlloc.
static VkCopyMemoryToImageInfo.Buffer	malloc(int capacity)	Returns a new VkCopyMemoryToImageInfo.Buffer instance allocated with memAlloc.
static VkCopyMemoryToImageInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkCopyMemoryToImageInfo.Buffer instance allocated on the specified MemoryStack.
static VkCopyMemoryToImageInfo	malloc(MemoryStack stack)	Returns a new VkCopyMemoryToImageInfo instance allocated on the specified MemoryStack.
static long	ndstImage(long struct)	Unsafe version of dstImage().
static void	ndstImage(long struct, long value)	Unsafe version of dstImage.
static int	ndstImageLayout(long struct)	Unsafe version of dstImageLayout().
static void	ndstImageLayout(long struct, int value)	Unsafe version of dstImageLayout.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static VkMemoryToImageCopy.Buffer	npRegions(long struct)	Unsafe version of pRegions().
static void	npRegions(long struct, VkMemoryToImageCopy.Buffer value)	Unsafe version of pRegions.
static int	nregionCount(long struct)	Unsafe version of regionCount().
static void	nregionCount(long struct, int value)	Sets the specified value to the regionCount field of the specified struct.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()
VkCopyMemoryToImageInfo	pNext(long value)	Sets the specified value to the pNext field.
VkMemoryToImageCopy.Buffer	pRegions()
VkCopyMemoryToImageInfo	pRegions(VkMemoryToImageCopy.Buffer value)	Sets the address of the specified VkMemoryToImageCopy.Buffer to the pRegions field.
int	regionCount()
VkCopyMemoryToImageInfo	set(int sType, long pNext, int flags, long dstImage, int dstImageLayout, VkMemoryToImageCopy.Buffer pRegions)	Initializes this struct with the specified values.
VkCopyMemoryToImageInfo	set(VkCopyMemoryToImageInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkCopyMemoryToImageInfo	sType(int value)	Sets the specified value to the sType field.
VkCopyMemoryToImageInfo	sType$Default()	Sets the STRUCTURE_TYPE_COPY_MEMORY_TO_IMAGE_INFO value to the sType field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

FLAGS

public static final int FLAGS

The struct member offsets.

DSTIMAGE

public static final int DSTIMAGE

The struct member offsets.

DSTIMAGELAYOUT

public static final int DSTIMAGELAYOUT

The struct member offsets.

REGIONCOUNT

public static final int REGIONCOUNT

The struct member offsets.

PREGIONS

public static final int PREGIONS

The struct member offsets.

Constructor Details

VkCopyMemoryToImageInfo

public VkCopyMemoryToImageInfo(ByteBuffer container)

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

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkCopyMemoryToImageInfo>

sType

public int sType()

Returns:

the value of the sType field.

pNext

public long pNext()

Returns:

the value of the pNext field.

flags

public int flags()

Returns:

the value of the flags field.

dstImage

public long dstImage()

Returns:

the value of the dstImage field.

dstImageLayout

public int dstImageLayout()

Returns:

the value of the dstImageLayout field.

regionCount

public int regionCount()

Returns:

the value of the regionCount field.

pRegions

public VkMemoryToImageCopy.Buffer pRegions()

Returns:

a VkMemoryToImageCopy.Buffer view of the struct array pointed to by the pRegions field.

sType

public VkCopyMemoryToImageInfo sType(int value)

Sets the specified value to the sType field.

sType$Default

public VkCopyMemoryToImageInfo sType$Default()

Sets the STRUCTURE_TYPE_COPY_MEMORY_TO_IMAGE_INFO value to the sType field.

pNext

public VkCopyMemoryToImageInfo pNext(long value)

Sets the specified value to the pNext field.

flags

public VkCopyMemoryToImageInfo flags(int value)

Sets the specified value to the flags field.

dstImage

public VkCopyMemoryToImageInfo dstImage(long value)

Sets the specified value to the dstImage field.

dstImageLayout

public VkCopyMemoryToImageInfo dstImageLayout(int value)

Sets the specified value to the dstImageLayout field.

pRegions

public VkCopyMemoryToImageInfo pRegions(VkMemoryToImageCopy.Buffer value)

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

set

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

Initializes this struct with the specified values.

set

public VkCopyMemoryToImageInfo set(VkCopyMemoryToImageInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkCopyMemoryToImageInfo malloc()

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

calloc

public static VkCopyMemoryToImageInfo calloc()

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

create

public static VkCopyMemoryToImageInfo create()

Returns a new VkCopyMemoryToImageInfo instance allocated with BufferUtils.

create

public static VkCopyMemoryToImageInfo create(long address)

Returns a new VkCopyMemoryToImageInfo instance for the specified memory address.

createSafe

public static @Nullable VkCopyMemoryToImageInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkCopyMemoryToImageInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkCopyMemoryToImageInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkCopyMemoryToImageInfo.Buffer create(int capacity)

Returns a new VkCopyMemoryToImageInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkCopyMemoryToImageInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkCopyMemoryToImageInfo malloc(MemoryStack stack)

Returns a new VkCopyMemoryToImageInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkCopyMemoryToImageInfo calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nflags

public static int nflags(long struct)

Unsafe version of flags().

ndstImage

public static long ndstImage(long struct)

Unsafe version of dstImage().

ndstImageLayout

public static int ndstImageLayout(long struct)

Unsafe version of dstImageLayout().

nregionCount

public static int nregionCount(long struct)

Unsafe version of regionCount().

npRegions

public static VkMemoryToImageCopy.Buffer npRegions(long struct)

Unsafe version of pRegions().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.

ndstImage

public static void ndstImage(long struct,
 long value)

Unsafe version of dstImage.

ndstImageLayout

public static void ndstImageLayout(long struct,
 int value)

Unsafe version of dstImageLayout.

nregionCount

public static void nregionCount(long struct,
 int value)

Sets the specified value to the regionCount field of the specified struct.

npRegions

public static void npRegions(long struct,
 VkMemoryToImageCopy.Buffer value)

Unsafe version of pRegions.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate