Package org.lwjgl.vulkan

Class VkAccelerationStructureGeometryInstancesDataKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkAccelerationStructureGeometryInstancesDataKHR>

org.lwjgl.vulkan.VkAccelerationStructureGeometryInstancesDataKHR

All Implemented Interfaces:

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

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

Structure specifying a geometry consisting of instances of other acceleration structures.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_INSTANCES_DATA_KHR
• pNext must be NULL

See Also

VkAccelerationStructureGeometryDataKHR, VkDeviceOrHostAddressConstKHR

Layout

 struct VkAccelerationStructureGeometryInstancesDataKHR {
     VkStructureType sType();
     void const * pNext();
     VkBool32 arrayOfPointers();
     VkDeviceOrHostAddressConstKHR data();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
boolean	arrayOfPointers()	specifies whether data is used as an array of addresses or just an array.
VkAccelerationStructureGeometryInstancesDataKHR	arrayOfPointers(boolean value)	Sets the specified value to the arrayOfPointers() field.
static VkAccelerationStructureGeometryInstancesDataKHR	calloc()	Returns a new VkAccelerationStructureGeometryInstancesDataKHR instance allocated with memCalloc.
static VkAccelerationStructureGeometryInstancesDataKHR.Buffer	calloc(int capacity)	Returns a new VkAccelerationStructureGeometryInstancesDataKHR.Buffer instance allocated with memCalloc.
static VkAccelerationStructureGeometryInstancesDataKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureGeometryInstancesDataKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAccelerationStructureGeometryInstancesDataKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureGeometryInstancesDataKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAccelerationStructureGeometryInstancesDataKHR	create()	Returns a new VkAccelerationStructureGeometryInstancesDataKHR instance allocated with BufferUtils.
static VkAccelerationStructureGeometryInstancesDataKHR.Buffer	create(int capacity)	Returns a new VkAccelerationStructureGeometryInstancesDataKHR.Buffer instance allocated with BufferUtils.
static VkAccelerationStructureGeometryInstancesDataKHR	create(long address)	Returns a new VkAccelerationStructureGeometryInstancesDataKHR instance for the specified memory address.
static VkAccelerationStructureGeometryInstancesDataKHR.Buffer	create(long address, int capacity)	Create a VkAccelerationStructureGeometryInstancesDataKHR.Buffer instance at the specified memory.
static @Nullable VkAccelerationStructureGeometryInstancesDataKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkAccelerationStructureGeometryInstancesDataKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkDeviceOrHostAddressConstKHR	data()	either the address of an array of device or host addresses referencing individual VkAccelerationStructureInstanceKHR structures or packed motion instance information as described in motion instances if arrayOfPointers is TRUE, or the address of an array of VkAccelerationStructureInstanceKHR or VkAccelerationStructureMotionInstanceNV structures.
VkAccelerationStructureGeometryInstancesDataKHR	data(Consumer<VkDeviceOrHostAddressConstKHR> consumer)	Passes the data() field to the specified Consumer.
VkAccelerationStructureGeometryInstancesDataKHR	data(VkDeviceOrHostAddressConstKHR value)	Copies the specified VkDeviceOrHostAddressConstKHR to the data() field.
static VkAccelerationStructureGeometryInstancesDataKHR	malloc()	Returns a new VkAccelerationStructureGeometryInstancesDataKHR instance allocated with memAlloc.
static VkAccelerationStructureGeometryInstancesDataKHR.Buffer	malloc(int capacity)	Returns a new VkAccelerationStructureGeometryInstancesDataKHR.Buffer instance allocated with memAlloc.
static VkAccelerationStructureGeometryInstancesDataKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureGeometryInstancesDataKHR.Buffer instance allocated on the specified MemoryStack.
static VkAccelerationStructureGeometryInstancesDataKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureGeometryInstancesDataKHR instance allocated on the specified MemoryStack.
static int	narrayOfPointers(long struct)	Unsafe version of arrayOfPointers().
static void	narrayOfPointers(long struct, int value)	Unsafe version of arrayOfPointers.
static VkDeviceOrHostAddressConstKHR	ndata(long struct)	Unsafe version of data().
static void	ndata(long struct, VkDeviceOrHostAddressConstKHR value)	Unsafe version of data.
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.
VkAccelerationStructureGeometryInstancesDataKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkAccelerationStructureGeometryInstancesDataKHR	set(int sType, long pNext, boolean arrayOfPointers, VkDeviceOrHostAddressConstKHR data)	Initializes this struct with the specified values.
VkAccelerationStructureGeometryInstancesDataKHR	set(VkAccelerationStructureGeometryInstancesDataKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkAccelerationStructureGeometryInstancesDataKHR	sType(int value)	Sets the specified value to the sType() field.
VkAccelerationStructureGeometryInstancesDataKHR	sType$Default()	Sets the STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_INSTANCES_DATA_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.

ARRAYOFPOINTERS

public static final int ARRAYOFPOINTERS

The struct member offsets.

DATA

public static final int DATA

The struct member offsets.

Constructor Details

VkAccelerationStructureGeometryInstancesDataKHR

public VkAccelerationStructureGeometryInstancesDataKHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

arrayOfPointers

public boolean arrayOfPointers()

specifies whether data is used as an array of addresses or just an array.

data

public VkDeviceOrHostAddressConstKHR data()

either the address of an array of device or host addresses referencing individual VkAccelerationStructureInstanceKHR structures or packed motion instance information as described in motion instances if arrayOfPointers is TRUE, or the address of an array of VkAccelerationStructureInstanceKHR or VkAccelerationStructureMotionInstanceNV structures. Addresses and VkAccelerationStructureInstanceKHR structures are tightly packed. VkAccelerationStructureMotionInstanceNV structures have a stride of 160 bytes.

sType

public VkAccelerationStructureGeometryInstancesDataKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkAccelerationStructureGeometryInstancesDataKHR sType$Default()

Sets the STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_INSTANCES_DATA_KHR value to the sType() field.

pNext

public VkAccelerationStructureGeometryInstancesDataKHR pNext(long value)

Sets the specified value to the pNext() field.

arrayOfPointers

public VkAccelerationStructureGeometryInstancesDataKHR arrayOfPointers(boolean value)

Sets the specified value to the arrayOfPointers() field.

data

public VkAccelerationStructureGeometryInstancesDataKHR data(VkDeviceOrHostAddressConstKHR value)

Copies the specified VkDeviceOrHostAddressConstKHR to the data() field.

data

public VkAccelerationStructureGeometryInstancesDataKHR data(Consumer<VkDeviceOrHostAddressConstKHR> consumer)

Passes the data() field to the specified Consumer.

set

public VkAccelerationStructureGeometryInstancesDataKHR set(int sType,
 long pNext,
 boolean arrayOfPointers,
 VkDeviceOrHostAddressConstKHR data)

Initializes this struct with the specified values.

set

public VkAccelerationStructureGeometryInstancesDataKHR set(VkAccelerationStructureGeometryInstancesDataKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkAccelerationStructureGeometryInstancesDataKHR malloc()

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

calloc

public static VkAccelerationStructureGeometryInstancesDataKHR calloc()

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

create

public static VkAccelerationStructureGeometryInstancesDataKHR create()

Returns a new VkAccelerationStructureGeometryInstancesDataKHR instance allocated with BufferUtils.

create

public static VkAccelerationStructureGeometryInstancesDataKHR create(long address)

Returns a new VkAccelerationStructureGeometryInstancesDataKHR instance for the specified memory address.

createSafe

public static @Nullable VkAccelerationStructureGeometryInstancesDataKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkAccelerationStructureGeometryInstancesDataKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkAccelerationStructureGeometryInstancesDataKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkAccelerationStructureGeometryInstancesDataKHR.Buffer create(int capacity)

Returns a new VkAccelerationStructureGeometryInstancesDataKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkAccelerationStructureGeometryInstancesDataKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkAccelerationStructureGeometryInstancesDataKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

narrayOfPointers

public static int narrayOfPointers(long struct)

Unsafe version of arrayOfPointers().

ndata

public static VkDeviceOrHostAddressConstKHR ndata(long struct)

Unsafe version of data().

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.

narrayOfPointers

public static void narrayOfPointers(long struct,
 int value)

Unsafe version of arrayOfPointers.

ndata

public static void ndata(long struct,
 VkDeviceOrHostAddressConstKHR value)

Unsafe version of data.