Package org.lwjgl.vulkan

Class VkCopyMicromapToMemoryInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkCopyMicromapToMemoryInfoEXT>

org.lwjgl.vulkan.VkCopyMicromapToMemoryInfoEXT

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkCopyMicromapToMemoryInfoEXT
extends org.lwjgl.system.Struct<VkCopyMicromapToMemoryInfoEXT>
implements org.lwjgl.system.NativeResource

Parameters for serializing a micromap.

Valid Usage

• The source micromap src must have been constructed prior to the execution of this command
• The memory pointed to by dst must be at least as large as the serialization size of src, as reported by WriteMicromapsPropertiesEXT or CmdWriteMicromapsPropertiesEXT with a query type of QUERY_TYPE_MICROMAP_SERIALIZATION_SIZE_EXT
• mode must be COPY_MICROMAP_MODE_SERIALIZE_EXT

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COPY_MICROMAP_TO_MEMORY_INFO_EXT
• pNext must be NULL
• src must be a valid VkMicromapEXT handle
• mode must be a valid VkCopyMicromapModeEXT value

See Also

VkDeviceOrHostAddressKHR, CmdCopyMicromapToMemoryEXT, CopyMicromapToMemoryEXT

Layout

 struct VkCopyMicromapToMemoryInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkMicromapEXT src();
     VkDeviceOrHostAddressKHR dst();
     VkCopyMicromapModeEXT mode();
 }

Nested Class Summary

Nested Classes

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

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

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	DST	The struct member offsets.
static final int	MODE	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SRC	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
VkCopyMicromapToMemoryInfoEXT(ByteBuffer container)	Creates a VkCopyMicromapToMemoryInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkCopyMicromapToMemoryInfoEXT	calloc()	Returns a new VkCopyMicromapToMemoryInfoEXT instance allocated with memCalloc.
static VkCopyMicromapToMemoryInfoEXT.Buffer	calloc(int capacity)	Returns a new VkCopyMicromapToMemoryInfoEXT.Buffer instance allocated with memCalloc.
static VkCopyMicromapToMemoryInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkCopyMicromapToMemoryInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkCopyMicromapToMemoryInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkCopyMicromapToMemoryInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkCopyMicromapToMemoryInfoEXT	create()	Returns a new VkCopyMicromapToMemoryInfoEXT instance allocated with BufferUtils.
static VkCopyMicromapToMemoryInfoEXT.Buffer	create(int capacity)	Returns a new VkCopyMicromapToMemoryInfoEXT.Buffer instance allocated with BufferUtils.
static VkCopyMicromapToMemoryInfoEXT	create(long address)	Returns a new VkCopyMicromapToMemoryInfoEXT instance for the specified memory address.
static VkCopyMicromapToMemoryInfoEXT.Buffer	create(long address, int capacity)	Create a VkCopyMicromapToMemoryInfoEXT.Buffer instance at the specified memory.
static @Nullable VkCopyMicromapToMemoryInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkCopyMicromapToMemoryInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkDeviceOrHostAddressKHR	dst()	the device or host address to memory which is the target for the copy
VkCopyMicromapToMemoryInfoEXT	dst(Consumer<VkDeviceOrHostAddressKHR> consumer)	Passes the dst() field to the specified Consumer.
VkCopyMicromapToMemoryInfoEXT	dst(VkDeviceOrHostAddressKHR value)	Copies the specified VkDeviceOrHostAddressKHR to the dst() field.
static VkCopyMicromapToMemoryInfoEXT	malloc()	Returns a new VkCopyMicromapToMemoryInfoEXT instance allocated with memAlloc.
static VkCopyMicromapToMemoryInfoEXT.Buffer	malloc(int capacity)	Returns a new VkCopyMicromapToMemoryInfoEXT.Buffer instance allocated with memAlloc.
static VkCopyMicromapToMemoryInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkCopyMicromapToMemoryInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkCopyMicromapToMemoryInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkCopyMicromapToMemoryInfoEXT instance allocated on the specified MemoryStack.
int	mode()	a VkCopyMicromapModeEXT value specifying additional operations to perform during the copy.
VkCopyMicromapToMemoryInfoEXT	mode(int value)	Sets the specified value to the mode() field.
static VkDeviceOrHostAddressKHR	ndst(long struct)	Unsafe version of dst().
static void	ndst(long struct, VkDeviceOrHostAddressKHR value)	Unsafe version of dst.
static int	nmode(long struct)	Unsafe version of mode().
static void	nmode(long struct, int value)	Unsafe version of mode.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static long	nsrc(long struct)	Unsafe version of src().
static void	nsrc(long struct, long value)	Unsafe version of src.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkCopyMicromapToMemoryInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkCopyMicromapToMemoryInfoEXT	set(int sType, long pNext, long src, VkDeviceOrHostAddressKHR dst, int mode)	Initializes this struct with the specified values.
VkCopyMicromapToMemoryInfoEXT	set(VkCopyMicromapToMemoryInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
long	src()	the source micromap for the copy
VkCopyMicromapToMemoryInfoEXT	src(long value)	Sets the specified value to the src() field.
int	sType()	a VkStructureType value identifying this structure.
VkCopyMicromapToMemoryInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkCopyMicromapToMemoryInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_COPY_MICROMAP_TO_MEMORY_INFO_EXT value to the sType() field.

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.

SRC

public static final int SRC

The struct member offsets.

DST

public static final int DST

The struct member offsets.

MODE

public static final int MODE

The struct member offsets.

Constructor Details

VkCopyMicromapToMemoryInfoEXT

public VkCopyMicromapToMemoryInfoEXT(ByteBuffer container)

Creates a VkCopyMicromapToMemoryInfoEXT 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()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkCopyMicromapToMemoryInfoEXT>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

src

public long src()

the source micromap for the copy

dst

public VkDeviceOrHostAddressKHR dst()

the device or host address to memory which is the target for the copy

mode

public int mode()

a VkCopyMicromapModeEXT value specifying additional operations to perform during the copy.

sType

public VkCopyMicromapToMemoryInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkCopyMicromapToMemoryInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_COPY_MICROMAP_TO_MEMORY_INFO_EXT value to the sType() field.

pNext

public VkCopyMicromapToMemoryInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

src

public VkCopyMicromapToMemoryInfoEXT src(long value)

Sets the specified value to the src() field.

dst

public VkCopyMicromapToMemoryInfoEXT dst(VkDeviceOrHostAddressKHR value)

Copies the specified VkDeviceOrHostAddressKHR to the dst() field.

dst

public VkCopyMicromapToMemoryInfoEXT dst(Consumer<VkDeviceOrHostAddressKHR> consumer)

Passes the dst() field to the specified Consumer.

mode

public VkCopyMicromapToMemoryInfoEXT mode(int value)

Sets the specified value to the mode() field.

set

public VkCopyMicromapToMemoryInfoEXT set(int sType,
 long pNext,
 long src,
 VkDeviceOrHostAddressKHR dst,
 int mode)

Initializes this struct with the specified values.

set

public VkCopyMicromapToMemoryInfoEXT set(VkCopyMicromapToMemoryInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkCopyMicromapToMemoryInfoEXT malloc()

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

calloc

public static VkCopyMicromapToMemoryInfoEXT calloc()

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

create

public static VkCopyMicromapToMemoryInfoEXT create()

Returns a new VkCopyMicromapToMemoryInfoEXT instance allocated with BufferUtils.

create

public static VkCopyMicromapToMemoryInfoEXT create(long address)

Returns a new VkCopyMicromapToMemoryInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkCopyMicromapToMemoryInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkCopyMicromapToMemoryInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkCopyMicromapToMemoryInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkCopyMicromapToMemoryInfoEXT.Buffer create(int capacity)

Returns a new VkCopyMicromapToMemoryInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkCopyMicromapToMemoryInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkCopyMicromapToMemoryInfoEXT malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkCopyMicromapToMemoryInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkCopyMicromapToMemoryInfoEXT calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkCopyMicromapToMemoryInfoEXT.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkCopyMicromapToMemoryInfoEXT.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

nsrc

public static long nsrc(long struct)

Unsafe version of src().

ndst

public static VkDeviceOrHostAddressKHR ndst(long struct)

Unsafe version of dst().

nmode

public static int nmode(long struct)

Unsafe version of mode().

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.

nsrc

public static void nsrc(long struct,
 long value)

Unsafe version of src.

ndst

public static void ndst(long struct,
 VkDeviceOrHostAddressKHR value)

Unsafe version of dst.

nmode

public static void nmode(long struct,
 int value)

Unsafe version of mode.