Package org.lwjgl.vulkan

Class VkCopyImageToBufferInfo2

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkCopyImageToBufferInfo2>

org.lwjgl.vulkan.VkCopyImageToBufferInfo2

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkCopyImageToBufferInfo2KHR

public class VkCopyImageToBufferInfo2
extends Struct<VkCopyImageToBufferInfo2>
implements NativeResource

 struct VkCopyImageToBufferInfo2 {
     VkStructureType sType;
     void const * pNext;
     VkImage srcImage;
     VkImageLayout srcImageLayout;
     VkBuffer dstBuffer;
     uint32_t regionCount;
     VkBufferImageCopy2 const * pRegions;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkCopyImageToBufferInfo2.Buffer	An array of VkCopyImageToBufferInfo2 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	DSTBUFFER	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
VkCopyImageToBufferInfo2(ByteBuffer container)	Creates a VkCopyImageToBufferInfo2 instance at the current position of the specified ByteBuffer container.

Method Summary

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

SRCIMAGE

public static final int SRCIMAGE

The struct member offsets.

SRCIMAGELAYOUT

public static final int SRCIMAGELAYOUT

The struct member offsets.

DSTBUFFER

public static final int DSTBUFFER

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

VkCopyImageToBufferInfo2

public VkCopyImageToBufferInfo2(ByteBuffer container)

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

sType

public int sType()

Returns:

the value of the sType field.

pNext

public long pNext()

Returns:

the value of the pNext field.

srcImage

public long srcImage()

Returns:

the value of the srcImage field.

srcImageLayout

public int srcImageLayout()

Returns:

the value of the srcImageLayout field.

dstBuffer

public long dstBuffer()

Returns:

the value of the dstBuffer field.

regionCount

public int regionCount()

Returns:

the value of the regionCount field.

pRegions

public VkBufferImageCopy2.Buffer pRegions()

Returns:

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

sType

public VkCopyImageToBufferInfo2 sType(int value)

Sets the specified value to the sType field.

sType$Default

public VkCopyImageToBufferInfo2 sType$Default()

Sets the STRUCTURE_TYPE_COPY_IMAGE_TO_BUFFER_INFO_2 value to the sType field.

pNext

public VkCopyImageToBufferInfo2 pNext(long value)

Sets the specified value to the pNext field.

srcImage

public VkCopyImageToBufferInfo2 srcImage(long value)

Sets the specified value to the srcImage field.

srcImageLayout

public VkCopyImageToBufferInfo2 srcImageLayout(int value)

Sets the specified value to the srcImageLayout field.

dstBuffer

public VkCopyImageToBufferInfo2 dstBuffer(long value)

Sets the specified value to the dstBuffer field.

pRegions

public VkCopyImageToBufferInfo2 pRegions(VkBufferImageCopy2.Buffer value)

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

set

public VkCopyImageToBufferInfo2 set(int sType,
 long pNext,
 long srcImage,
 int srcImageLayout,
 long dstBuffer,
 VkBufferImageCopy2.Buffer pRegions)

Initializes this struct with the specified values.

set

public VkCopyImageToBufferInfo2 set(VkCopyImageToBufferInfo2 src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkCopyImageToBufferInfo2 malloc()

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

calloc

public static VkCopyImageToBufferInfo2 calloc()

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

create

public static VkCopyImageToBufferInfo2 create()

Returns a new VkCopyImageToBufferInfo2 instance allocated with BufferUtils.

create

public static VkCopyImageToBufferInfo2 create(long address)

Returns a new VkCopyImageToBufferInfo2 instance for the specified memory address.

createSafe

public static @Nullable VkCopyImageToBufferInfo2 createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkCopyImageToBufferInfo2.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkCopyImageToBufferInfo2.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkCopyImageToBufferInfo2.Buffer create(int capacity)

Returns a new VkCopyImageToBufferInfo2.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkCopyImageToBufferInfo2.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkCopyImageToBufferInfo2 malloc(MemoryStack stack)

Returns a new VkCopyImageToBufferInfo2 instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkCopyImageToBufferInfo2 calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsrcImage

public static long nsrcImage(long struct)

Unsafe version of srcImage().

nsrcImageLayout

public static int nsrcImageLayout(long struct)

Unsafe version of srcImageLayout().

ndstBuffer

public static long ndstBuffer(long struct)

Unsafe version of dstBuffer().

nregionCount

public static int nregionCount(long struct)

Unsafe version of regionCount().

npRegions

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

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.

ndstBuffer

public static void ndstBuffer(long struct,
 long value)

Unsafe version of dstBuffer.

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