Package org.lwjgl.vulkan

Class VkCopyBufferToImageInfo2

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkCopyBufferToImageInfo2>

org.lwjgl.vulkan.VkCopyBufferToImageInfo2

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkCopyBufferToImageInfo2KHR

public class VkCopyBufferToImageInfo2
extends Struct<VkCopyBufferToImageInfo2>
implements NativeResource

 struct VkCopyBufferToImageInfo2 {
     VkStructureType sType;
     void const * pNext;
     VkBuffer srcBuffer;
     VkImage dstImage;
     VkImageLayout dstImageLayout;
     uint32_t regionCount;
     {@link VkBufferImageCopy2 VkBufferImageCopy2} const * pRegions;
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

SRCBUFFER

public static final int SRCBUFFER

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

VkCopyBufferToImageInfo2

public VkCopyBufferToImageInfo2(ByteBuffer container)

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

sType

public int sType()

Returns:

the value of the sType field.

pNext

public long pNext()

Returns:

the value of the pNext field.

srcBuffer

public long srcBuffer()

Returns:

the value of the srcBuffer 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 VkBufferImageCopy2.Buffer pRegions()

Returns:

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

sType

public VkCopyBufferToImageInfo2 sType(int value)

Sets the specified value to the sType field.

sType$Default

public VkCopyBufferToImageInfo2 sType$Default()

Sets the STRUCTURE_TYPE_COPY_BUFFER_TO_IMAGE_INFO_2 value to the sType field.

pNext

public VkCopyBufferToImageInfo2 pNext(long value)

Sets the specified value to the pNext field.

srcBuffer

public VkCopyBufferToImageInfo2 srcBuffer(long value)

Sets the specified value to the srcBuffer field.

dstImage

public VkCopyBufferToImageInfo2 dstImage(long value)

Sets the specified value to the dstImage field.

dstImageLayout

public VkCopyBufferToImageInfo2 dstImageLayout(int value)

Sets the specified value to the dstImageLayout field.

pRegions

public VkCopyBufferToImageInfo2 pRegions(VkBufferImageCopy2.Buffer value)

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

set

public VkCopyBufferToImageInfo2 set(int sType,
 long pNext,
 long srcBuffer,
 long dstImage,
 int dstImageLayout,
 VkBufferImageCopy2.Buffer pRegions)

Initializes this struct with the specified values.

set

public VkCopyBufferToImageInfo2 set(VkCopyBufferToImageInfo2 src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkCopyBufferToImageInfo2 malloc()

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

calloc

public static VkCopyBufferToImageInfo2 calloc()

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

create

public static VkCopyBufferToImageInfo2 create()

Returns a new VkCopyBufferToImageInfo2 instance allocated with BufferUtils.

create

public static VkCopyBufferToImageInfo2 create(long address)

Returns a new VkCopyBufferToImageInfo2 instance for the specified memory address.

createSafe

public static @Nullable VkCopyBufferToImageInfo2 createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkCopyBufferToImageInfo2.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkCopyBufferToImageInfo2.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkCopyBufferToImageInfo2.Buffer create(int capacity)

Returns a new VkCopyBufferToImageInfo2.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkCopyBufferToImageInfo2.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkCopyBufferToImageInfo2 malloc(MemoryStack stack)

Returns a new VkCopyBufferToImageInfo2 instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkCopyBufferToImageInfo2 calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsrcBuffer

public static long nsrcBuffer(long struct)

Unsafe version of srcBuffer().

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

nsrcBuffer

public static void nsrcBuffer(long struct,
 long value)

Unsafe version of srcBuffer.

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