Class VkCopyDeviceMemoryImageInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkCopyDeviceMemoryImageInfoKHR>

org.lwjgl.vulkan.VkCopyDeviceMemoryImageInfoKHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkCopyDeviceMemoryImageInfoKHR
extends Struct<VkCopyDeviceMemoryImageInfoKHR>
implements NativeResource

struct VkCopyDeviceMemoryImageInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkImage image;
    uint32_t regionCount;
    VkDeviceMemoryImageCopyKHR const * pRegions;
}

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	IMAGE	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 Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

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

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

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.

IMAGE

public static final int IMAGE

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

VkCopyDeviceMemoryImageInfoKHR

public VkCopyDeviceMemoryImageInfoKHR(ByteBuffer container)

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

sType

@NativeType("VkStructureType")
public int sType()

Returns:

the value of the sType field.

pNext

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

Returns:

the value of the pNext field.

image

@NativeType("VkImage")
public long image()

Returns:

the value of the image field.

regionCount

@NativeType("uint32_t")
public int regionCount()

Returns:

the value of the regionCount field.

pRegions

@NativeType("VkDeviceMemoryImageCopyKHR const *")
public VkDeviceMemoryImageCopyKHR.Buffer pRegions()

Returns:

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

sType

public VkCopyDeviceMemoryImageInfoKHR sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

sType$Default

public VkCopyDeviceMemoryImageInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_COPY_DEVICE_MEMORY_IMAGE_INFO_KHR value to the sType field.

pNext

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

Sets the specified value to the pNext field.

image

public VkCopyDeviceMemoryImageInfoKHR image(@NativeType("VkImage")
 long value)

Sets the specified value to the image field.

pRegions

public VkCopyDeviceMemoryImageInfoKHR pRegions(@NativeType("VkDeviceMemoryImageCopyKHR const *")
 VkDeviceMemoryImageCopyKHR.Buffer value)

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

set

public VkCopyDeviceMemoryImageInfoKHR set(int sType,
 long pNext,
 long image,
 VkDeviceMemoryImageCopyKHR.Buffer pRegions)

Initializes this struct with the specified values.

set

public VkCopyDeviceMemoryImageInfoKHR set(VkCopyDeviceMemoryImageInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkCopyDeviceMemoryImageInfoKHR malloc()

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

calloc

public static VkCopyDeviceMemoryImageInfoKHR calloc()

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

create

public static VkCopyDeviceMemoryImageInfoKHR create()

Returns a new VkCopyDeviceMemoryImageInfoKHR instance allocated with BufferUtils.

create

public static VkCopyDeviceMemoryImageInfoKHR create(long address)

Returns a new VkCopyDeviceMemoryImageInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkCopyDeviceMemoryImageInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkCopyDeviceMemoryImageInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkCopyDeviceMemoryImageInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkCopyDeviceMemoryImageInfoKHR.Buffer create(int capacity)

Returns a new VkCopyDeviceMemoryImageInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkCopyDeviceMemoryImageInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkCopyDeviceMemoryImageInfoKHR malloc(MemoryStack stack)

Returns a new VkCopyDeviceMemoryImageInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkCopyDeviceMemoryImageInfoKHR calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nimage

public static long nimage(long struct)

Unsafe version of image().

nregionCount

public static int nregionCount(long struct)

Unsafe version of regionCount().

npRegions

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

nimage

public static void nimage(long struct,
 long value)

Unsafe version of image.

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