Package org.lwjgl.vulkan

Class VkCopyMemoryToAccelerationStructureInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkCopyMemoryToAccelerationStructureInfoKHR>

org.lwjgl.vulkan.VkCopyMemoryToAccelerationStructureInfoKHR

All Implemented Interfaces:

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

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

Parameters for deserializing an acceleration structure.

Valid Usage

• The source memory pointed to by src must contain data previously serialized using CmdCopyAccelerationStructureToMemoryKHR, potentially modified to relocate acceleration structure references as described in that command
• mode must be COPY_ACCELERATION_STRUCTURE_MODE_DESERIALIZE_KHR
• The data in src must have a format compatible with the destination physical device as returned by GetDeviceAccelerationStructureCompatibilityKHR
• 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_ACCELERATION_STRUCTURE_INFO_KHR
• pNext must be NULL
• dst must be a valid VkAccelerationStructureKHR handle
• mode must be a valid VkCopyAccelerationStructureModeKHR value

See Also

VkDeviceOrHostAddressConstKHR, CmdCopyMemoryToAccelerationStructureKHR, CopyMemoryToAccelerationStructureKHR

Layout

 struct VkCopyMemoryToAccelerationStructureInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkDeviceOrHostAddressConstKHR src();
     VkAccelerationStructureKHR dst();
     VkCopyAccelerationStructureModeKHR mode();
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

VkCopyMemoryToAccelerationStructureInfoKHR

public VkCopyMemoryToAccelerationStructureInfoKHR(ByteBuffer container)

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

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 acceleration structure for the copy.

mode

public int mode()

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

sType

public VkCopyMemoryToAccelerationStructureInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkCopyMemoryToAccelerationStructureInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_COPY_MEMORY_TO_ACCELERATION_STRUCTURE_INFO_KHR value to the sType() field.

pNext

public VkCopyMemoryToAccelerationStructureInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

src

public VkCopyMemoryToAccelerationStructureInfoKHR src(VkDeviceOrHostAddressConstKHR value)

Copies the specified VkDeviceOrHostAddressConstKHR to the src() field.

src

public VkCopyMemoryToAccelerationStructureInfoKHR src(Consumer<VkDeviceOrHostAddressConstKHR> consumer)

Passes the src() field to the specified Consumer.

dst

public VkCopyMemoryToAccelerationStructureInfoKHR dst(long value)

Sets the specified value to the dst() field.

mode

public VkCopyMemoryToAccelerationStructureInfoKHR mode(int value)

Sets the specified value to the mode() field.

set

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

Initializes this struct with the specified values.

set

public VkCopyMemoryToAccelerationStructureInfoKHR set(VkCopyMemoryToAccelerationStructureInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkCopyMemoryToAccelerationStructureInfoKHR malloc()

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

calloc

public static VkCopyMemoryToAccelerationStructureInfoKHR calloc()

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

create

public static VkCopyMemoryToAccelerationStructureInfoKHR create()

Returns a new VkCopyMemoryToAccelerationStructureInfoKHR instance allocated with BufferUtils.

create

public static VkCopyMemoryToAccelerationStructureInfoKHR create(long address)

Returns a new VkCopyMemoryToAccelerationStructureInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkCopyMemoryToAccelerationStructureInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkCopyMemoryToAccelerationStructureInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkCopyMemoryToAccelerationStructureInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkCopyMemoryToAccelerationStructureInfoKHR.Buffer create(int capacity)

Returns a new VkCopyMemoryToAccelerationStructureInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkCopyMemoryToAccelerationStructureInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkCopyMemoryToAccelerationStructureInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkCopyMemoryToAccelerationStructureInfoKHR.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.