Package org.lwjgl.vulkan

Class VkCopyImageToMemoryInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkCopyImageToMemoryInfo>

org.lwjgl.vulkan.VkCopyImageToMemoryInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkCopyImageToMemoryInfoEXT

public class VkCopyImageToMemoryInfo
extends Struct<VkCopyImageToMemoryInfo>
implements NativeResource

 struct VkCopyImageToMemoryInfo {
     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	VkCopyImageToMemoryInfo.Buffer	An array of VkCopyImageToMemoryInfo 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	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	SRCIMAGE	The struct member offsets.
static final int	SRCIMAGELAYOUT	The struct member offsets.
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
VkCopyImageToMemoryInfo(ByteBuffer container)	Creates a VkCopyImageToMemoryInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkCopyImageToMemoryInfo	calloc()	Returns a new VkCopyImageToMemoryInfo instance allocated with memCalloc.
static VkCopyImageToMemoryInfo.Buffer	calloc(int capacity)	Returns a new VkCopyImageToMemoryInfo.Buffer instance allocated with memCalloc.
static VkCopyImageToMemoryInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkCopyImageToMemoryInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkCopyImageToMemoryInfo	calloc(MemoryStack stack)	Returns a new VkCopyImageToMemoryInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkCopyImageToMemoryInfo	create()	Returns a new VkCopyImageToMemoryInfo instance allocated with BufferUtils.
static VkCopyImageToMemoryInfo.Buffer	create(int capacity)	Returns a new VkCopyImageToMemoryInfo.Buffer instance allocated with BufferUtils.
static VkCopyImageToMemoryInfo	create(long address)	Returns a new VkCopyImageToMemoryInfo instance for the specified memory address.
static VkCopyImageToMemoryInfo.Buffer	create(long address, int capacity)	Create a VkCopyImageToMemoryInfo.Buffer instance at the specified memory.
static @Nullable VkCopyImageToMemoryInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkCopyImageToMemoryInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()
VkCopyImageToMemoryInfo	flags(int value)	Sets the specified value to the flags field.
static VkCopyImageToMemoryInfo	malloc()	Returns a new VkCopyImageToMemoryInfo instance allocated with memAlloc.
static VkCopyImageToMemoryInfo.Buffer	malloc(int capacity)	Returns a new VkCopyImageToMemoryInfo.Buffer instance allocated with memAlloc.
static VkCopyImageToMemoryInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkCopyImageToMemoryInfo.Buffer instance allocated on the specified MemoryStack.
static VkCopyImageToMemoryInfo	malloc(MemoryStack stack)	Returns a new VkCopyImageToMemoryInfo instance allocated on the specified MemoryStack.
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 VkImageToMemoryCopy.Buffer	npRegions(long struct)	Unsafe version of pRegions().
static void	npRegions(long struct, VkImageToMemoryCopy.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 long	nsrcImage(long struct)	Unsafe version of srcImage().
static void	nsrcImage(long struct, long value)	Unsafe version of srcImage.
static int	nsrcImageLayout(long struct)	Unsafe version of srcImageLayout().
static void	nsrcImageLayout(long struct, int value)	Unsafe version of srcImageLayout.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()
VkCopyImageToMemoryInfo	pNext(long value)	Sets the specified value to the pNext field.
VkImageToMemoryCopy.Buffer	pRegions()
VkCopyImageToMemoryInfo	pRegions(VkImageToMemoryCopy.Buffer value)	Sets the address of the specified VkImageToMemoryCopy.Buffer to the pRegions field.
int	regionCount()
VkCopyImageToMemoryInfo	set(int sType, long pNext, int flags, long srcImage, int srcImageLayout, VkImageToMemoryCopy.Buffer pRegions)	Initializes this struct with the specified values.
VkCopyImageToMemoryInfo	set(VkCopyImageToMemoryInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
long	srcImage()
VkCopyImageToMemoryInfo	srcImage(long value)	Sets the specified value to the srcImage field.
int	srcImageLayout()
VkCopyImageToMemoryInfo	srcImageLayout(int value)	Sets the specified value to the srcImageLayout field.
int	sType()
VkCopyImageToMemoryInfo	sType(int value)	Sets the specified value to the sType field.
VkCopyImageToMemoryInfo	sType$Default()	Sets the STRUCTURE_TYPE_COPY_IMAGE_TO_MEMORY_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.

SRCIMAGE

public static final int SRCIMAGE

The struct member offsets.

SRCIMAGELAYOUT

public static final int SRCIMAGELAYOUT

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

VkCopyImageToMemoryInfo

public VkCopyImageToMemoryInfo(ByteBuffer container)

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

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.

srcImage

public long srcImage()

Returns:

the value of the srcImage field.

srcImageLayout

public int srcImageLayout()

Returns:

the value of the srcImageLayout field.

regionCount

public int regionCount()

Returns:

the value of the regionCount field.

pRegions

public VkImageToMemoryCopy.Buffer pRegions()

Returns:

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

sType

public VkCopyImageToMemoryInfo sType(int value)

Sets the specified value to the sType field.

sType$Default

public VkCopyImageToMemoryInfo sType$Default()

Sets the STRUCTURE_TYPE_COPY_IMAGE_TO_MEMORY_INFO value to the sType field.

pNext

public VkCopyImageToMemoryInfo pNext(long value)

Sets the specified value to the pNext field.

flags

public VkCopyImageToMemoryInfo flags(int value)

Sets the specified value to the flags field.

srcImage

public VkCopyImageToMemoryInfo srcImage(long value)

Sets the specified value to the srcImage field.

srcImageLayout

public VkCopyImageToMemoryInfo srcImageLayout(int value)

Sets the specified value to the srcImageLayout field.

pRegions

public VkCopyImageToMemoryInfo pRegions(VkImageToMemoryCopy.Buffer value)

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

set

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

Initializes this struct with the specified values.

set

public VkCopyImageToMemoryInfo set(VkCopyImageToMemoryInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkCopyImageToMemoryInfo malloc()

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

calloc

public static VkCopyImageToMemoryInfo calloc()

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

create

public static VkCopyImageToMemoryInfo create()

Returns a new VkCopyImageToMemoryInfo instance allocated with BufferUtils.

create

public static VkCopyImageToMemoryInfo create(long address)

Returns a new VkCopyImageToMemoryInfo instance for the specified memory address.

createSafe

public static @Nullable VkCopyImageToMemoryInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkCopyImageToMemoryInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkCopyImageToMemoryInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkCopyImageToMemoryInfo.Buffer create(int capacity)

Returns a new VkCopyImageToMemoryInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkCopyImageToMemoryInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkCopyImageToMemoryInfo malloc(MemoryStack stack)

Returns a new VkCopyImageToMemoryInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkCopyImageToMemoryInfo calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkCopyImageToMemoryInfo.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().

nsrcImage

public static long nsrcImage(long struct)

Unsafe version of srcImage().

nsrcImageLayout

public static int nsrcImageLayout(long struct)

Unsafe version of srcImageLayout().

nregionCount

public static int nregionCount(long struct)

Unsafe version of regionCount().

npRegions

public static VkImageToMemoryCopy.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.

nsrcImage

public static void nsrcImage(long struct,
 long value)

Unsafe version of srcImage.

nsrcImageLayout

public static void nsrcImageLayout(long struct,
 int value)

Unsafe version of srcImageLayout.

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,
 VkImageToMemoryCopy.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