Package org.lwjgl.vulkan

Class VkAccelerationStructureInstanceKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkAccelerationStructureInstanceKHR>

org.lwjgl.vulkan.VkAccelerationStructureInstanceKHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkAccelerationStructureInstanceNV

public class VkAccelerationStructureInstanceKHR
extends Struct<VkAccelerationStructureInstanceKHR>
implements NativeResource

 struct VkAccelerationStructureInstanceKHR {
     {@link VkTransformMatrixKHR VkTransformMatrixKHR} transform;
     uint32_t instanceCustomIndex : 24;
     uint32_t mask : 8;
     uint32_t instanceShaderBindingTableRecordOffset : 24;
     VkGeometryInstanceFlagsKHR flags : 8;
     uint64_t accelerationStructureReference;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkAccelerationStructureInstanceKHR.Buffer	An array of VkAccelerationStructureInstanceKHR structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ACCELERATIONSTRUCTUREREFERENCE	The struct member offsets.
static final int	ALIGNOF	The struct alignment in bytes.
static final int	BITFIELD0	The struct member offsets.
static final int	BITFIELD1	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TRANSFORM	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
VkAccelerationStructureInstanceKHR(ByteBuffer container)	Creates a VkAccelerationStructureInstanceKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
long	accelerationStructureReference()
VkAccelerationStructureInstanceKHR	accelerationStructureReference(long value)	Sets the specified value to the accelerationStructureReference field.
static VkAccelerationStructureInstanceKHR	calloc()	Returns a new VkAccelerationStructureInstanceKHR instance allocated with memCalloc.
static VkAccelerationStructureInstanceKHR.Buffer	calloc(int capacity)	Returns a new VkAccelerationStructureInstanceKHR.Buffer instance allocated with memCalloc.
static VkAccelerationStructureInstanceKHR.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkAccelerationStructureInstanceKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAccelerationStructureInstanceKHR	calloc(MemoryStack stack)	Returns a new VkAccelerationStructureInstanceKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAccelerationStructureInstanceKHR	create()	Returns a new VkAccelerationStructureInstanceKHR instance allocated with BufferUtils.
static VkAccelerationStructureInstanceKHR.Buffer	create(int capacity)	Returns a new VkAccelerationStructureInstanceKHR.Buffer instance allocated with BufferUtils.
static VkAccelerationStructureInstanceKHR	create(long address)	Returns a new VkAccelerationStructureInstanceKHR instance for the specified memory address.
static VkAccelerationStructureInstanceKHR.Buffer	create(long address, int capacity)	Create a VkAccelerationStructureInstanceKHR.Buffer instance at the specified memory.
static @Nullable VkAccelerationStructureInstanceKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkAccelerationStructureInstanceKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()
VkAccelerationStructureInstanceKHR	flags(int value)	Sets the specified value to the flags field.
int	instanceCustomIndex()
VkAccelerationStructureInstanceKHR	instanceCustomIndex(int value)	Sets the specified value to the instanceCustomIndex field.
int	instanceShaderBindingTableRecordOffset()
VkAccelerationStructureInstanceKHR	instanceShaderBindingTableRecordOffset(int value)	Sets the specified value to the instanceShaderBindingTableRecordOffset field.
static VkAccelerationStructureInstanceKHR	malloc()	Returns a new VkAccelerationStructureInstanceKHR instance allocated with memAlloc.
static VkAccelerationStructureInstanceKHR.Buffer	malloc(int capacity)	Returns a new VkAccelerationStructureInstanceKHR.Buffer instance allocated with memAlloc.
static VkAccelerationStructureInstanceKHR.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkAccelerationStructureInstanceKHR.Buffer instance allocated on the specified MemoryStack.
static VkAccelerationStructureInstanceKHR	malloc(MemoryStack stack)	Returns a new VkAccelerationStructureInstanceKHR instance allocated on the specified MemoryStack.
int	mask()
VkAccelerationStructureInstanceKHR	mask(int value)	Sets the specified value to the mask field.
static long	naccelerationStructureReference(long struct)	Unsafe version of accelerationStructureReference().
static void	naccelerationStructureReference(long struct, long value)	Unsafe version of accelerationStructureReference.
static int	nbitfield0(long struct)
static void	nbitfield0(long struct, int value)
static int	nbitfield1(long struct)
static void	nbitfield1(long struct, int value)
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
static int	ninstanceCustomIndex(long struct)	Unsafe version of instanceCustomIndex().
static void	ninstanceCustomIndex(long struct, int value)	Unsafe version of instanceCustomIndex.
static int	ninstanceShaderBindingTableRecordOffset(long struct)	Unsafe version of instanceShaderBindingTableRecordOffset().
static void	ninstanceShaderBindingTableRecordOffset(long struct, int value)	Unsafe version of instanceShaderBindingTableRecordOffset.
static int	nmask(long struct)	Unsafe version of mask().
static void	nmask(long struct, int value)	Unsafe version of mask.
static VkTransformMatrixKHR	ntransform(long struct)	Unsafe version of transform().
static void	ntransform(long struct, VkTransformMatrixKHR value)	Unsafe version of transform.
VkAccelerationStructureInstanceKHR	set(VkAccelerationStructureInstanceKHR src)	Copies the specified struct data to this struct.
VkAccelerationStructureInstanceKHR	set(VkTransformMatrixKHR transform, int instanceCustomIndex, int mask, int instanceShaderBindingTableRecordOffset, int flags, long accelerationStructureReference)	Initializes this struct with the specified values.
int	sizeof()	Returns sizeof(struct).
VkTransformMatrixKHR	transform()
VkAccelerationStructureInstanceKHR	transform(Consumer<VkTransformMatrixKHR> consumer)	Passes the transform field to the specified Consumer.
VkAccelerationStructureInstanceKHR	transform(VkTransformMatrixKHR value)	Copies the specified VkTransformMatrixKHR to the transform 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.

TRANSFORM

public static final int TRANSFORM

The struct member offsets.

BITFIELD0

public static final int BITFIELD0

The struct member offsets.

BITFIELD1

public static final int BITFIELD1

The struct member offsets.

ACCELERATIONSTRUCTUREREFERENCE

public static final int ACCELERATIONSTRUCTUREREFERENCE

The struct member offsets.

Constructor Details

VkAccelerationStructureInstanceKHR

public VkAccelerationStructureInstanceKHR(ByteBuffer container)

Creates a VkAccelerationStructureInstanceKHR 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()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkAccelerationStructureInstanceKHR>

transform

public VkTransformMatrixKHR transform()

Returns:

a VkTransformMatrixKHR view of the transform field.

instanceCustomIndex

public int instanceCustomIndex()

Returns:

the value of the instanceCustomIndex field.

mask

public int mask()

Returns:

the value of the mask field.

instanceShaderBindingTableRecordOffset

public int instanceShaderBindingTableRecordOffset()

Returns:

the value of the instanceShaderBindingTableRecordOffset field.

flags

public int flags()

Returns:

the value of the flags field.

accelerationStructureReference

public long accelerationStructureReference()

Returns:

the value of the accelerationStructureReference field.

transform

public VkAccelerationStructureInstanceKHR transform(VkTransformMatrixKHR value)

Copies the specified VkTransformMatrixKHR to the transform field.

transform

public VkAccelerationStructureInstanceKHR transform(Consumer<VkTransformMatrixKHR> consumer)

Passes the transform field to the specified Consumer.

instanceCustomIndex

public VkAccelerationStructureInstanceKHR instanceCustomIndex(int value)

Sets the specified value to the instanceCustomIndex field.

mask

public VkAccelerationStructureInstanceKHR mask(int value)

Sets the specified value to the mask field.

instanceShaderBindingTableRecordOffset

public VkAccelerationStructureInstanceKHR instanceShaderBindingTableRecordOffset(int value)

Sets the specified value to the instanceShaderBindingTableRecordOffset field.

flags

public VkAccelerationStructureInstanceKHR flags(int value)

Sets the specified value to the flags field.

accelerationStructureReference

public VkAccelerationStructureInstanceKHR accelerationStructureReference(long value)

Sets the specified value to the accelerationStructureReference field.

set

public VkAccelerationStructureInstanceKHR set(VkTransformMatrixKHR transform,
 int instanceCustomIndex,
 int mask,
 int instanceShaderBindingTableRecordOffset,
 int flags,
 long accelerationStructureReference)

Initializes this struct with the specified values.

set

public VkAccelerationStructureInstanceKHR set(VkAccelerationStructureInstanceKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkAccelerationStructureInstanceKHR malloc()

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

calloc

public static VkAccelerationStructureInstanceKHR calloc()

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

create

public static VkAccelerationStructureInstanceKHR create()

Returns a new VkAccelerationStructureInstanceKHR instance allocated with BufferUtils.

create

public static VkAccelerationStructureInstanceKHR create(long address)

Returns a new VkAccelerationStructureInstanceKHR instance for the specified memory address.

createSafe

public static @Nullable VkAccelerationStructureInstanceKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkAccelerationStructureInstanceKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkAccelerationStructureInstanceKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkAccelerationStructureInstanceKHR.Buffer create(int capacity)

Returns a new VkAccelerationStructureInstanceKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkAccelerationStructureInstanceKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkAccelerationStructureInstanceKHR malloc(MemoryStack stack)

Returns a new VkAccelerationStructureInstanceKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkAccelerationStructureInstanceKHR calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkAccelerationStructureInstanceKHR.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkAccelerationStructureInstanceKHR.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new VkAccelerationStructureInstanceKHR.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

ntransform

public static VkTransformMatrixKHR ntransform(long struct)

Unsafe version of transform().

nbitfield0

public static int nbitfield0(long struct)

ninstanceCustomIndex

public static int ninstanceCustomIndex(long struct)

Unsafe version of instanceCustomIndex().

nmask

public static int nmask(long struct)

Unsafe version of mask().

nbitfield1

public static int nbitfield1(long struct)

ninstanceShaderBindingTableRecordOffset

public static int ninstanceShaderBindingTableRecordOffset(long struct)

Unsafe version of instanceShaderBindingTableRecordOffset().

nflags

public static int nflags(long struct)

Unsafe version of flags().

naccelerationStructureReference

public static long naccelerationStructureReference(long struct)

Unsafe version of accelerationStructureReference().

ntransform

public static void ntransform(long struct,
 VkTransformMatrixKHR value)

Unsafe version of transform.

nbitfield0

public static void nbitfield0(long struct,
 int value)

ninstanceCustomIndex

public static void ninstanceCustomIndex(long struct,
 int value)

Unsafe version of instanceCustomIndex.

nmask

public static void nmask(long struct,
 int value)

Unsafe version of mask.

nbitfield1

public static void nbitfield1(long struct,
 int value)

ninstanceShaderBindingTableRecordOffset

public static void ninstanceShaderBindingTableRecordOffset(long struct,
 int value)

Unsafe version of instanceShaderBindingTableRecordOffset.

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.

naccelerationStructureReference

public static void naccelerationStructureReference(long struct,
 long value)

Unsafe version of accelerationStructureReference.