Package org.lwjgl.vulkan

Class VkCopyMemoryToMicromapInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkCopyMemoryToMicromapInfoEXT>

org.lwjgl.vulkan.VkCopyMemoryToMicromapInfoEXT

All Implemented Interfaces:

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

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

Parameters for deserializing a micromap.

Valid Usage

• The source memory pointed to by src must contain data previously serialized using CmdCopyMicromapToMemoryEXT
• mode must be COPY_MICROMAP_MODE_DESERIALIZE_EXT
• The data in src must have a format compatible with the destination physical device as returned by GetDeviceMicromapCompatibilityEXT
• dst must have been created with a size greater than or equal to that used to serialize the data in src

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COPY_MEMORY_TO_MICROMAP_INFO_EXT
• pNext must be NULL
• dst must be a valid VkMicromapEXT handle
• mode must be a valid VkCopyMicromapModeEXT value

See Also

VkDeviceOrHostAddressConstKHR, CmdCopyMemoryToMicromapEXT, CopyMemoryToMicromapEXT

Layout

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

Nested Class Summary

Nested Classes

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

Method Summary

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

VkCopyMemoryToMicromapInfoEXT

public VkCopyMemoryToMicromapInfoEXT(ByteBuffer container)

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

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 VkDeviceOrHostAddressConstKHR src()

the device or host address to memory containing the source data for the copy.

dst

public long dst()

the target micromap for the copy.

mode

public int mode()

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

sType

public VkCopyMemoryToMicromapInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkCopyMemoryToMicromapInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_COPY_MEMORY_TO_MICROMAP_INFO_EXT value to the sType() field.

pNext

public VkCopyMemoryToMicromapInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

src

public VkCopyMemoryToMicromapInfoEXT src(VkDeviceOrHostAddressConstKHR value)

Copies the specified VkDeviceOrHostAddressConstKHR to the src() field.

src

public VkCopyMemoryToMicromapInfoEXT src(Consumer<VkDeviceOrHostAddressConstKHR> consumer)

Passes the src() field to the specified Consumer.

dst

public VkCopyMemoryToMicromapInfoEXT dst(long value)

Sets the specified value to the dst() field.

mode

public VkCopyMemoryToMicromapInfoEXT mode(int value)

Sets the specified value to the mode() field.

set

public VkCopyMemoryToMicromapInfoEXT set(int sType,
 long pNext,
 VkDeviceOrHostAddressConstKHR src,
 long dst,
 int mode)

Initializes this struct with the specified values.

set

public VkCopyMemoryToMicromapInfoEXT set(VkCopyMemoryToMicromapInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkCopyMemoryToMicromapInfoEXT malloc()

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

calloc

public static VkCopyMemoryToMicromapInfoEXT calloc()

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

create

public static VkCopyMemoryToMicromapInfoEXT create()

Returns a new VkCopyMemoryToMicromapInfoEXT instance allocated with BufferUtils.

create

public static VkCopyMemoryToMicromapInfoEXT create(long address)

Returns a new VkCopyMemoryToMicromapInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkCopyMemoryToMicromapInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkCopyMemoryToMicromapInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkCopyMemoryToMicromapInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkCopyMemoryToMicromapInfoEXT.Buffer create(int capacity)

Returns a new VkCopyMemoryToMicromapInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkCopyMemoryToMicromapInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkCopyMemoryToMicromapInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkCopyMemoryToMicromapInfoEXT.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 VkDeviceOrHostAddressConstKHR nsrc(long struct)

Unsafe version of src().

ndst

public static long 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,
 VkDeviceOrHostAddressConstKHR value)

Unsafe version of src.

ndst

public static void ndst(long struct,
 long value)

Unsafe version of dst.

nmode

public static void nmode(long struct,
 int value)

Unsafe version of mode.