Package org.lwjgl.vulkan

Class VkAccelerationStructureBuildSizesInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkAccelerationStructureBuildSizesInfoKHR>

org.lwjgl.vulkan.VkAccelerationStructureBuildSizesInfoKHR

All Implemented Interfaces:

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

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

Structure specifying build sizes for an acceleration structure.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ACCELERATION_STRUCTURE_BUILD_SIZES_INFO_KHR
• pNext must be NULL

See Also

GetAccelerationStructureBuildSizesKHR

Layout

 struct VkAccelerationStructureBuildSizesInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkDeviceSize accelerationStructureSize();
     VkDeviceSize updateScratchSize();
     VkDeviceSize buildScratchSize();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkAccelerationStructureBuildSizesInfoKHR.Buffer	An array of VkAccelerationStructureBuildSizesInfoKHR 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	ACCELERATIONSTRUCTURESIZE	The struct member offsets.
static final int	ALIGNOF	The struct alignment in bytes.
static final int	BUILDSCRATCHSIZE	The struct member offsets.
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.
static final int	UPDATESCRATCHSIZE	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
VkAccelerationStructureBuildSizesInfoKHR(ByteBuffer container)	Creates a VkAccelerationStructureBuildSizesInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
long	accelerationStructureSize()	the size in bytes required in a VkAccelerationStructureKHR for a build or update operation.
long	buildScratchSize()	the size in bytes required in a scratch buffer for a build operation.
static VkAccelerationStructureBuildSizesInfoKHR	calloc()	Returns a new VkAccelerationStructureBuildSizesInfoKHR instance allocated with memCalloc.
static VkAccelerationStructureBuildSizesInfoKHR.Buffer	calloc(int capacity)	Returns a new VkAccelerationStructureBuildSizesInfoKHR.Buffer instance allocated with memCalloc.
static VkAccelerationStructureBuildSizesInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureBuildSizesInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAccelerationStructureBuildSizesInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureBuildSizesInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAccelerationStructureBuildSizesInfoKHR	create()	Returns a new VkAccelerationStructureBuildSizesInfoKHR instance allocated with BufferUtils.
static VkAccelerationStructureBuildSizesInfoKHR.Buffer	create(int capacity)	Returns a new VkAccelerationStructureBuildSizesInfoKHR.Buffer instance allocated with BufferUtils.
static VkAccelerationStructureBuildSizesInfoKHR	create(long address)	Returns a new VkAccelerationStructureBuildSizesInfoKHR instance for the specified memory address.
static VkAccelerationStructureBuildSizesInfoKHR.Buffer	create(long address, int capacity)	Create a VkAccelerationStructureBuildSizesInfoKHR.Buffer instance at the specified memory.
static @Nullable VkAccelerationStructureBuildSizesInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkAccelerationStructureBuildSizesInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkAccelerationStructureBuildSizesInfoKHR	malloc()	Returns a new VkAccelerationStructureBuildSizesInfoKHR instance allocated with memAlloc.
static VkAccelerationStructureBuildSizesInfoKHR.Buffer	malloc(int capacity)	Returns a new VkAccelerationStructureBuildSizesInfoKHR.Buffer instance allocated with memAlloc.
static VkAccelerationStructureBuildSizesInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureBuildSizesInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkAccelerationStructureBuildSizesInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureBuildSizesInfoKHR instance allocated on the specified MemoryStack.
static long	naccelerationStructureSize(long struct)	Unsafe version of accelerationStructureSize().
static long	nbuildScratchSize(long struct)	Unsafe version of buildScratchSize().
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.
static long	nupdateScratchSize(long struct)	Unsafe version of updateScratchSize().
long	pNext()	NULL or a pointer to a structure extending this structure.
VkAccelerationStructureBuildSizesInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkAccelerationStructureBuildSizesInfoKHR	set(int sType, long pNext)	Initializes this struct with the specified values.
VkAccelerationStructureBuildSizesInfoKHR	set(VkAccelerationStructureBuildSizesInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkAccelerationStructureBuildSizesInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkAccelerationStructureBuildSizesInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_ACCELERATION_STRUCTURE_BUILD_SIZES_INFO_KHR value to the sType() field.
long	updateScratchSize()	the size in bytes required in a scratch buffer for an update operation.

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.

ACCELERATIONSTRUCTURESIZE

public static final int ACCELERATIONSTRUCTURESIZE

The struct member offsets.

UPDATESCRATCHSIZE

public static final int UPDATESCRATCHSIZE

The struct member offsets.

BUILDSCRATCHSIZE

public static final int BUILDSCRATCHSIZE

The struct member offsets.

Constructor Details

VkAccelerationStructureBuildSizesInfoKHR

public VkAccelerationStructureBuildSizesInfoKHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

accelerationStructureSize

public long accelerationStructureSize()

the size in bytes required in a VkAccelerationStructureKHR for a build or update operation.

updateScratchSize

public long updateScratchSize()

the size in bytes required in a scratch buffer for an update operation.

buildScratchSize

public long buildScratchSize()

the size in bytes required in a scratch buffer for a build operation.

sType

public VkAccelerationStructureBuildSizesInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkAccelerationStructureBuildSizesInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_ACCELERATION_STRUCTURE_BUILD_SIZES_INFO_KHR value to the sType() field.

pNext

public VkAccelerationStructureBuildSizesInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

set

public VkAccelerationStructureBuildSizesInfoKHR set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkAccelerationStructureBuildSizesInfoKHR set(VkAccelerationStructureBuildSizesInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkAccelerationStructureBuildSizesInfoKHR malloc()

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

calloc

public static VkAccelerationStructureBuildSizesInfoKHR calloc()

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

create

public static VkAccelerationStructureBuildSizesInfoKHR create()

Returns a new VkAccelerationStructureBuildSizesInfoKHR instance allocated with BufferUtils.

create

public static VkAccelerationStructureBuildSizesInfoKHR create(long address)

Returns a new VkAccelerationStructureBuildSizesInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkAccelerationStructureBuildSizesInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkAccelerationStructureBuildSizesInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkAccelerationStructureBuildSizesInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkAccelerationStructureBuildSizesInfoKHR.Buffer create(int capacity)

Returns a new VkAccelerationStructureBuildSizesInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkAccelerationStructureBuildSizesInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkAccelerationStructureBuildSizesInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

naccelerationStructureSize

public static long naccelerationStructureSize(long struct)

Unsafe version of accelerationStructureSize().

nupdateScratchSize

public static long nupdateScratchSize(long struct)

Unsafe version of updateScratchSize().

nbuildScratchSize

public static long nbuildScratchSize(long struct)

Unsafe version of buildScratchSize().

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.