Package org.lwjgl.vulkan

Class VkAccelerationStructureVersionInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkAccelerationStructureVersionInfoKHR>

org.lwjgl.vulkan.VkAccelerationStructureVersionInfoKHR

All Implemented Interfaces:

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

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

Acceleration structure version information.

Description

Note

pVersionData is a pointer to an array of 2×UUID_SIZE uint8_t values instead of two UUID_SIZE arrays as the expected use case for this member is to be pointed at the header of a previously serialized acceleration structure (via CmdCopyAccelerationStructureToMemoryKHR or CopyAccelerationStructureToMemoryKHR) that is loaded in memory. Using arrays would necessitate extra memory copies of the UUIDs.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ACCELERATION_STRUCTURE_VERSION_INFO_KHR
• pNext must be NULL
• pVersionData must be a valid pointer to an array of 2 × VK_UUID_SIZE uint8_t values

See Also

GetDeviceAccelerationStructureCompatibilityKHR

Layout

 struct VkAccelerationStructureVersionInfoKHR {
     VkStructureType sType();
     void const * pNext();
     uint8_t const * pVersionData(int);
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkAccelerationStructureVersionInfoKHR.Buffer	An array of VkAccelerationStructureVersionInfoKHR 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	PNEXT	The struct member offsets.
static final int	PVERSIONDATA	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
VkAccelerationStructureVersionInfoKHR(ByteBuffer container)	Creates a VkAccelerationStructureVersionInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkAccelerationStructureVersionInfoKHR	calloc()	Returns a new VkAccelerationStructureVersionInfoKHR instance allocated with memCalloc.
static VkAccelerationStructureVersionInfoKHR.Buffer	calloc(int capacity)	Returns a new VkAccelerationStructureVersionInfoKHR.Buffer instance allocated with memCalloc.
static VkAccelerationStructureVersionInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureVersionInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAccelerationStructureVersionInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureVersionInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAccelerationStructureVersionInfoKHR	create()	Returns a new VkAccelerationStructureVersionInfoKHR instance allocated with BufferUtils.
static VkAccelerationStructureVersionInfoKHR.Buffer	create(int capacity)	Returns a new VkAccelerationStructureVersionInfoKHR.Buffer instance allocated with BufferUtils.
static VkAccelerationStructureVersionInfoKHR	create(long address)	Returns a new VkAccelerationStructureVersionInfoKHR instance for the specified memory address.
static VkAccelerationStructureVersionInfoKHR.Buffer	create(long address, int capacity)	Create a VkAccelerationStructureVersionInfoKHR.Buffer instance at the specified memory.
static @Nullable VkAccelerationStructureVersionInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkAccelerationStructureVersionInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkAccelerationStructureVersionInfoKHR	malloc()	Returns a new VkAccelerationStructureVersionInfoKHR instance allocated with memAlloc.
static VkAccelerationStructureVersionInfoKHR.Buffer	malloc(int capacity)	Returns a new VkAccelerationStructureVersionInfoKHR.Buffer instance allocated with memAlloc.
static VkAccelerationStructureVersionInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureVersionInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkAccelerationStructureVersionInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureVersionInfoKHR instance allocated on the specified MemoryStack.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static ByteBuffer	npVersionData(long struct, int capacity)	Unsafe version of pVersionData.
static void	npVersionData(long struct, ByteBuffer value)	Unsafe version of pVersionData.
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.
VkAccelerationStructureVersionInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
ByteBuffer	pVersionData(int capacity)
VkAccelerationStructureVersionInfoKHR	pVersionData(ByteBuffer value)	Sets the address of the specified ByteBuffer to the pVersionData(int) field.
VkAccelerationStructureVersionInfoKHR	set(int sType, long pNext, ByteBuffer pVersionData)	Initializes this struct with the specified values.
VkAccelerationStructureVersionInfoKHR	set(VkAccelerationStructureVersionInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkAccelerationStructureVersionInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkAccelerationStructureVersionInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_ACCELERATION_STRUCTURE_VERSION_INFO_KHR value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

PVERSIONDATA

public static final int PVERSIONDATA

The struct member offsets.

Constructor Details

VkAccelerationStructureVersionInfoKHR

public VkAccelerationStructureVersionInfoKHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

pVersionData

public ByteBuffer pVersionData(int capacity)

Parameters:

capacity - the number of elements in the returned buffer

Returns:

a pointer to the version header of an acceleration structure as defined in CmdCopyAccelerationStructureToMemoryKHR

sType

public VkAccelerationStructureVersionInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkAccelerationStructureVersionInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_ACCELERATION_STRUCTURE_VERSION_INFO_KHR value to the sType() field.

pNext

public VkAccelerationStructureVersionInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

pVersionData

public VkAccelerationStructureVersionInfoKHR pVersionData(ByteBuffer value)

Sets the address of the specified ByteBuffer to the pVersionData(int) field.

set

public VkAccelerationStructureVersionInfoKHR set(int sType,
 long pNext,
 ByteBuffer pVersionData)

Initializes this struct with the specified values.

set

public VkAccelerationStructureVersionInfoKHR set(VkAccelerationStructureVersionInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkAccelerationStructureVersionInfoKHR malloc()

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

calloc

public static VkAccelerationStructureVersionInfoKHR calloc()

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

create

public static VkAccelerationStructureVersionInfoKHR create()

Returns a new VkAccelerationStructureVersionInfoKHR instance allocated with BufferUtils.

create

public static VkAccelerationStructureVersionInfoKHR create(long address)

Returns a new VkAccelerationStructureVersionInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkAccelerationStructureVersionInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkAccelerationStructureVersionInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkAccelerationStructureVersionInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkAccelerationStructureVersionInfoKHR.Buffer create(int capacity)

Returns a new VkAccelerationStructureVersionInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkAccelerationStructureVersionInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkAccelerationStructureVersionInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

npVersionData

public static ByteBuffer npVersionData(long struct,
 int capacity)

Unsafe version of pVersionData.

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.

npVersionData

public static void npVersionData(long struct,
 ByteBuffer value)

Unsafe version of pVersionData.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate