Package org.lwjgl.vulkan

Class VkAccelerationStructureCaptureDescriptorDataInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkAccelerationStructureCaptureDescriptorDataInfoEXT>

org.lwjgl.vulkan.VkAccelerationStructureCaptureDescriptorDataInfoEXT

All Implemented Interfaces:

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

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

Structure specifying an acceleration structure for descriptor capture.

Valid Usage

• If accelerationStructure is not NULL_HANDLE then accelerationStructure must have been created with ACCELERATION_STRUCTURE_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXT set in VkAccelerationStructureCreateInfoKHR::createFlags
• If accelerationStructureNV is not NULL_HANDLE then accelerationStructureNV must have been created with ACCELERATION_STRUCTURE_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXT set in VkAccelerationStructureCreateInfoNV::info.flags
• If accelerationStructure is not NULL_HANDLE then accelerationStructureNV must be NULL_HANDLE
• If accelerationStructureNV is not NULL_HANDLE then accelerationStructure must be NULL_HANDLE

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ACCELERATION_STRUCTURE_CAPTURE_DESCRIPTOR_DATA_INFO_EXT
• pNext must be NULL
• If accelerationStructure is not NULL_HANDLE, accelerationStructure must be a valid VkAccelerationStructureKHR handle
• If accelerationStructureNV is not NULL_HANDLE, accelerationStructureNV must be a valid VkAccelerationStructureNV handle
• Both of accelerationStructure, and accelerationStructureNV that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same VkDevice

See Also

GetAccelerationStructureOpaqueCaptureDescriptorDataEXT

Layout

 struct VkAccelerationStructureCaptureDescriptorDataInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkAccelerationStructureKHR accelerationStructure();
     VkAccelerationStructureNV accelerationStructureNV();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkAccelerationStructureCaptureDescriptorDataInfoEXT.Buffer	An array of VkAccelerationStructureCaptureDescriptorDataInfoEXT 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	ACCELERATIONSTRUCTURE	The struct member offsets.
static final int	ACCELERATIONSTRUCTURENV	The struct member offsets.
static final int	ALIGNOF	The struct alignment in bytes.
static final int	PNEXT	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 org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
long	accelerationStructure()	the VkAccelerationStructureKHR handle of the acceleration structure to get opaque capture data for.
VkAccelerationStructureCaptureDescriptorDataInfoEXT	accelerationStructure(long value)	Sets the specified value to the accelerationStructure() field.
long	accelerationStructureNV()	the VkAccelerationStructureNV handle of the acceleration structure to get opaque capture data for.
VkAccelerationStructureCaptureDescriptorDataInfoEXT	accelerationStructureNV(long value)	Sets the specified value to the accelerationStructureNV() field.
static VkAccelerationStructureCaptureDescriptorDataInfoEXT	calloc()	Returns a new VkAccelerationStructureCaptureDescriptorDataInfoEXT instance allocated with memCalloc.
static VkAccelerationStructureCaptureDescriptorDataInfoEXT.Buffer	calloc(int capacity)	Returns a new VkAccelerationStructureCaptureDescriptorDataInfoEXT.Buffer instance allocated with memCalloc.
static VkAccelerationStructureCaptureDescriptorDataInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureCaptureDescriptorDataInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAccelerationStructureCaptureDescriptorDataInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureCaptureDescriptorDataInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAccelerationStructureCaptureDescriptorDataInfoEXT	create()	Returns a new VkAccelerationStructureCaptureDescriptorDataInfoEXT instance allocated with BufferUtils.
static VkAccelerationStructureCaptureDescriptorDataInfoEXT.Buffer	create(int capacity)	Returns a new VkAccelerationStructureCaptureDescriptorDataInfoEXT.Buffer instance allocated with BufferUtils.
static VkAccelerationStructureCaptureDescriptorDataInfoEXT	create(long address)	Returns a new VkAccelerationStructureCaptureDescriptorDataInfoEXT instance for the specified memory address.
static VkAccelerationStructureCaptureDescriptorDataInfoEXT.Buffer	create(long address, int capacity)	Create a VkAccelerationStructureCaptureDescriptorDataInfoEXT.Buffer instance at the specified memory.
static @Nullable VkAccelerationStructureCaptureDescriptorDataInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkAccelerationStructureCaptureDescriptorDataInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkAccelerationStructureCaptureDescriptorDataInfoEXT	malloc()	Returns a new VkAccelerationStructureCaptureDescriptorDataInfoEXT instance allocated with memAlloc.
static VkAccelerationStructureCaptureDescriptorDataInfoEXT.Buffer	malloc(int capacity)	Returns a new VkAccelerationStructureCaptureDescriptorDataInfoEXT.Buffer instance allocated with memAlloc.
static VkAccelerationStructureCaptureDescriptorDataInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureCaptureDescriptorDataInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkAccelerationStructureCaptureDescriptorDataInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureCaptureDescriptorDataInfoEXT instance allocated on the specified MemoryStack.
static long	naccelerationStructure(long struct)	Unsafe version of accelerationStructure().
static void	naccelerationStructure(long struct, long value)	Unsafe version of accelerationStructure.
static long	naccelerationStructureNV(long struct)	Unsafe version of accelerationStructureNV().
static void	naccelerationStructureNV(long struct, long value)	Unsafe version of accelerationStructureNV.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
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.
VkAccelerationStructureCaptureDescriptorDataInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkAccelerationStructureCaptureDescriptorDataInfoEXT	set(int sType, long pNext, long accelerationStructure, long accelerationStructureNV)	Initializes this struct with the specified values.
VkAccelerationStructureCaptureDescriptorDataInfoEXT	set(VkAccelerationStructureCaptureDescriptorDataInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkAccelerationStructureCaptureDescriptorDataInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkAccelerationStructureCaptureDescriptorDataInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_ACCELERATION_STRUCTURE_CAPTURE_DESCRIPTOR_DATA_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.

ACCELERATIONSTRUCTURE

public static final int ACCELERATIONSTRUCTURE

The struct member offsets.

ACCELERATIONSTRUCTURENV

public static final int ACCELERATIONSTRUCTURENV

The struct member offsets.

Constructor Details

VkAccelerationStructureCaptureDescriptorDataInfoEXT

public VkAccelerationStructureCaptureDescriptorDataInfoEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

accelerationStructure

public long accelerationStructure()

the VkAccelerationStructureKHR handle of the acceleration structure to get opaque capture data for.

accelerationStructureNV

public long accelerationStructureNV()

the VkAccelerationStructureNV handle of the acceleration structure to get opaque capture data for.

sType

public VkAccelerationStructureCaptureDescriptorDataInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkAccelerationStructureCaptureDescriptorDataInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_ACCELERATION_STRUCTURE_CAPTURE_DESCRIPTOR_DATA_INFO_EXT value to the sType() field.

pNext

public VkAccelerationStructureCaptureDescriptorDataInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

accelerationStructure

public VkAccelerationStructureCaptureDescriptorDataInfoEXT accelerationStructure(long value)

Sets the specified value to the accelerationStructure() field.

accelerationStructureNV

public VkAccelerationStructureCaptureDescriptorDataInfoEXT accelerationStructureNV(long value)

Sets the specified value to the accelerationStructureNV() field.

set

public VkAccelerationStructureCaptureDescriptorDataInfoEXT set(int sType,
 long pNext,
 long accelerationStructure,
 long accelerationStructureNV)

Initializes this struct with the specified values.

set

public VkAccelerationStructureCaptureDescriptorDataInfoEXT set(VkAccelerationStructureCaptureDescriptorDataInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkAccelerationStructureCaptureDescriptorDataInfoEXT malloc()

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

calloc

public static VkAccelerationStructureCaptureDescriptorDataInfoEXT calloc()

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

create

public static VkAccelerationStructureCaptureDescriptorDataInfoEXT create()

Returns a new VkAccelerationStructureCaptureDescriptorDataInfoEXT instance allocated with BufferUtils.

create

public static VkAccelerationStructureCaptureDescriptorDataInfoEXT create(long address)

Returns a new VkAccelerationStructureCaptureDescriptorDataInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkAccelerationStructureCaptureDescriptorDataInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkAccelerationStructureCaptureDescriptorDataInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkAccelerationStructureCaptureDescriptorDataInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkAccelerationStructureCaptureDescriptorDataInfoEXT.Buffer create(int capacity)

Returns a new VkAccelerationStructureCaptureDescriptorDataInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkAccelerationStructureCaptureDescriptorDataInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkAccelerationStructureCaptureDescriptorDataInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

naccelerationStructure

public static long naccelerationStructure(long struct)

Unsafe version of accelerationStructure().

naccelerationStructureNV

public static long naccelerationStructureNV(long struct)

Unsafe version of accelerationStructureNV().

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.

naccelerationStructure

public static void naccelerationStructure(long struct,
 long value)

Unsafe version of accelerationStructure.

naccelerationStructureNV

public static void naccelerationStructureNV(long struct,
 long value)

Unsafe version of accelerationStructureNV.