Package org.lwjgl.vulkan

Class VkCopyAccelerationStructureInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkCopyAccelerationStructureInfoKHR>

org.lwjgl.vulkan.VkCopyAccelerationStructureInfoKHR

All Implemented Interfaces:

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

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

Parameters for copying an acceleration structure.

Valid Usage

• mode must be COPY_ACCELERATION_STRUCTURE_MODE_COMPACT_KHR or COPY_ACCELERATION_STRUCTURE_MODE_CLONE_KHR
• The source acceleration structure src must have been constructed prior to the execution of this command
• If mode is COPY_ACCELERATION_STRUCTURE_MODE_COMPACT_KHR, src must have been constructed with BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_KHR in the build
• The buffer used to create src must be bound to device memory
• The buffer used to create dst must be bound to device memory
• The range of memory backing dst that is accessed by this command must not overlap the memory backing src that is accessed by this command

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COPY_ACCELERATION_STRUCTURE_INFO_KHR
• pNext must be NULL
• src must be a valid VkAccelerationStructureKHR handle
• dst must be a valid VkAccelerationStructureKHR handle
• mode must be a valid VkCopyAccelerationStructureModeKHR value
• Both of dst, and src must have been created, allocated, or retrieved from the same VkDevice

See Also

CmdCopyAccelerationStructureKHR, CopyAccelerationStructureKHR

Layout

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

Nested Class Summary

Nested Classes

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

Method Summary

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

VkCopyAccelerationStructureInfoKHR

public VkCopyAccelerationStructureInfoKHR(ByteBuffer container)

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

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 acceleration structure 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 VkCopyAccelerationStructureInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkCopyAccelerationStructureInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_COPY_ACCELERATION_STRUCTURE_INFO_KHR value to the sType() field.

pNext

public VkCopyAccelerationStructureInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

src

public VkCopyAccelerationStructureInfoKHR src(long value)

Sets the specified value to the src() field.

dst

public VkCopyAccelerationStructureInfoKHR dst(long value)

Sets the specified value to the dst() field.

mode

public VkCopyAccelerationStructureInfoKHR mode(int value)

Sets the specified value to the mode() field.

set

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

Initializes this struct with the specified values.

set

public VkCopyAccelerationStructureInfoKHR set(VkCopyAccelerationStructureInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkCopyAccelerationStructureInfoKHR malloc()

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

calloc

public static VkCopyAccelerationStructureInfoKHR calloc()

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

create

public static VkCopyAccelerationStructureInfoKHR create()

Returns a new VkCopyAccelerationStructureInfoKHR instance allocated with BufferUtils.

create

public static VkCopyAccelerationStructureInfoKHR create(long address)

Returns a new VkCopyAccelerationStructureInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkCopyAccelerationStructureInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkCopyAccelerationStructureInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkCopyAccelerationStructureInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkCopyAccelerationStructureInfoKHR.Buffer create(int capacity)

Returns a new VkCopyAccelerationStructureInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkCopyAccelerationStructureInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkCopyAccelerationStructureInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkCopyAccelerationStructureInfoKHR.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 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,
 long 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.