Package org.lwjgl.vulkan

Class VkWriteDescriptorSetAccelerationStructureKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkWriteDescriptorSetAccelerationStructureKHR>

org.lwjgl.vulkan.VkWriteDescriptorSetAccelerationStructureKHR

All Implemented Interfaces:

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

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

Structure specifying acceleration structure descriptor information.

Valid Usage

• accelerationStructureCount must be equal to descriptorCount in the extended structure
• Each acceleration structure in pAccelerationStructures must have been created with a type of ACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_KHR or ACCELERATION_STRUCTURE_TYPE_GENERIC_KHR
• If the nullDescriptor feature is not enabled, each element of pAccelerationStructures must not be NULL_HANDLE

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET_ACCELERATION_STRUCTURE_KHR
• pAccelerationStructures must be a valid pointer to an array of accelerationStructureCount valid or NULL_HANDLE VkAccelerationStructureKHR handles
• accelerationStructureCount must be greater than 0

Layout

 struct VkWriteDescriptorSetAccelerationStructureKHR {
     VkStructureType sType();
     void const * pNext();
     uint32_t accelerationStructureCount();
     VkAccelerationStructureKHR const * pAccelerationStructures();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkWriteDescriptorSetAccelerationStructureKHR.Buffer	An array of VkWriteDescriptorSetAccelerationStructureKHR 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	ACCELERATIONSTRUCTURECOUNT	The struct member offsets.
static final int	ALIGNOF	The struct alignment in bytes.
static final int	PACCELERATIONSTRUCTURES	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.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	accelerationStructureCount()	the number of elements in pAccelerationStructures.
VkWriteDescriptorSetAccelerationStructureKHR	accelerationStructureCount(int value)	Sets the specified value to the accelerationStructureCount() field.
static VkWriteDescriptorSetAccelerationStructureKHR	calloc()	Returns a new VkWriteDescriptorSetAccelerationStructureKHR instance allocated with memCalloc.
static VkWriteDescriptorSetAccelerationStructureKHR.Buffer	calloc(int capacity)	Returns a new VkWriteDescriptorSetAccelerationStructureKHR.Buffer instance allocated with memCalloc.
static VkWriteDescriptorSetAccelerationStructureKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkWriteDescriptorSetAccelerationStructureKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkWriteDescriptorSetAccelerationStructureKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkWriteDescriptorSetAccelerationStructureKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkWriteDescriptorSetAccelerationStructureKHR	create()	Returns a new VkWriteDescriptorSetAccelerationStructureKHR instance allocated with BufferUtils.
static VkWriteDescriptorSetAccelerationStructureKHR.Buffer	create(int capacity)	Returns a new VkWriteDescriptorSetAccelerationStructureKHR.Buffer instance allocated with BufferUtils.
static VkWriteDescriptorSetAccelerationStructureKHR	create(long address)	Returns a new VkWriteDescriptorSetAccelerationStructureKHR instance for the specified memory address.
static VkWriteDescriptorSetAccelerationStructureKHR.Buffer	create(long address, int capacity)	Create a VkWriteDescriptorSetAccelerationStructureKHR.Buffer instance at the specified memory.
static @Nullable VkWriteDescriptorSetAccelerationStructureKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkWriteDescriptorSetAccelerationStructureKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkWriteDescriptorSetAccelerationStructureKHR	malloc()	Returns a new VkWriteDescriptorSetAccelerationStructureKHR instance allocated with memAlloc.
static VkWriteDescriptorSetAccelerationStructureKHR.Buffer	malloc(int capacity)	Returns a new VkWriteDescriptorSetAccelerationStructureKHR.Buffer instance allocated with memAlloc.
static VkWriteDescriptorSetAccelerationStructureKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkWriteDescriptorSetAccelerationStructureKHR.Buffer instance allocated on the specified MemoryStack.
static VkWriteDescriptorSetAccelerationStructureKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkWriteDescriptorSetAccelerationStructureKHR instance allocated on the specified MemoryStack.
static int	naccelerationStructureCount(long struct)	Unsafe version of accelerationStructureCount().
static void	naccelerationStructureCount(long struct, int value)	Sets the specified value to the accelerationStructureCount field of the specified struct.
static @Nullable LongBuffer	npAccelerationStructures(long struct)	Unsafe version of pAccelerationStructures.
static void	npAccelerationStructures(long struct, @Nullable LongBuffer value)	Unsafe version of pAccelerationStructures.
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.
@Nullable LongBuffer	pAccelerationStructures()	a pointer to an array of VkAccelerationStructureKHR structures specifying the acceleration structures to update.
VkWriteDescriptorSetAccelerationStructureKHR	pAccelerationStructures(@Nullable LongBuffer value)	Sets the address of the specified LongBuffer to the pAccelerationStructures() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkWriteDescriptorSetAccelerationStructureKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkWriteDescriptorSetAccelerationStructureKHR	set(int sType, long pNext, int accelerationStructureCount, @Nullable LongBuffer pAccelerationStructures)	Initializes this struct with the specified values.
VkWriteDescriptorSetAccelerationStructureKHR	set(VkWriteDescriptorSetAccelerationStructureKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkWriteDescriptorSetAccelerationStructureKHR	sType(int value)	Sets the specified value to the sType() field.
VkWriteDescriptorSetAccelerationStructureKHR	sType$Default()	Sets the STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET_ACCELERATION_STRUCTURE_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.

ACCELERATIONSTRUCTURECOUNT

public static final int ACCELERATIONSTRUCTURECOUNT

The struct member offsets.

PACCELERATIONSTRUCTURES

public static final int PACCELERATIONSTRUCTURES

The struct member offsets.

Constructor Details

VkWriteDescriptorSetAccelerationStructureKHR

public VkWriteDescriptorSetAccelerationStructureKHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

accelerationStructureCount

public int accelerationStructureCount()

the number of elements in pAccelerationStructures.

pAccelerationStructures

public @Nullable LongBuffer pAccelerationStructures()

a pointer to an array of VkAccelerationStructureKHR structures specifying the acceleration structures to update.

sType

public VkWriteDescriptorSetAccelerationStructureKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkWriteDescriptorSetAccelerationStructureKHR sType$Default()

Sets the STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET_ACCELERATION_STRUCTURE_KHR value to the sType() field.

pNext

public VkWriteDescriptorSetAccelerationStructureKHR pNext(long value)

Sets the specified value to the pNext() field.

accelerationStructureCount

public VkWriteDescriptorSetAccelerationStructureKHR accelerationStructureCount(int value)

Sets the specified value to the accelerationStructureCount() field.

pAccelerationStructures

public VkWriteDescriptorSetAccelerationStructureKHR pAccelerationStructures(@Nullable LongBuffer value)

Sets the address of the specified LongBuffer to the pAccelerationStructures() field.

set

public VkWriteDescriptorSetAccelerationStructureKHR set(int sType,
 long pNext,
 int accelerationStructureCount,
 @Nullable LongBuffer pAccelerationStructures)

Initializes this struct with the specified values.

set

public VkWriteDescriptorSetAccelerationStructureKHR set(VkWriteDescriptorSetAccelerationStructureKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkWriteDescriptorSetAccelerationStructureKHR malloc()

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

calloc

public static VkWriteDescriptorSetAccelerationStructureKHR calloc()

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

create

public static VkWriteDescriptorSetAccelerationStructureKHR create()

Returns a new VkWriteDescriptorSetAccelerationStructureKHR instance allocated with BufferUtils.

create

public static VkWriteDescriptorSetAccelerationStructureKHR create(long address)

Returns a new VkWriteDescriptorSetAccelerationStructureKHR instance for the specified memory address.

createSafe

public static @Nullable VkWriteDescriptorSetAccelerationStructureKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkWriteDescriptorSetAccelerationStructureKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkWriteDescriptorSetAccelerationStructureKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkWriteDescriptorSetAccelerationStructureKHR.Buffer create(int capacity)

Returns a new VkWriteDescriptorSetAccelerationStructureKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkWriteDescriptorSetAccelerationStructureKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkWriteDescriptorSetAccelerationStructureKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

naccelerationStructureCount

public static int naccelerationStructureCount(long struct)

Unsafe version of accelerationStructureCount().

npAccelerationStructures

public static @Nullable LongBuffer npAccelerationStructures(long struct)

Unsafe version of pAccelerationStructures.

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.

naccelerationStructureCount

public static void naccelerationStructureCount(long struct,
 int value)

Sets the specified value to the accelerationStructureCount field of the specified struct.

npAccelerationStructures

public static void npAccelerationStructures(long struct,
 @Nullable LongBuffer value)

Unsafe version of pAccelerationStructures.