java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkAccelerationStructureInstanceKHR

All Implemented Interfaces:

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

Direct Known Subclasses:

VkAccelerationStructureInstanceNV
```
public class VkAccelerationStructureInstanceKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying a single acceleration structure instance for building into an acceleration structure geometry.
Description

The C language specification does not define the ordering of bit-fields, but in practice, this struct produces the correct layout with existing compilers. The intended bit pattern is for the following:
- instanceCustomIndex and mask occupy the same memory as if a single uint32_t was specified in their place
  - instanceCustomIndex occupies the 24 least significant bits of that memory
  - mask occupies the 8 most significant bits of that memory
- instanceShaderBindingTableRecordOffset and flags occupy the same memory as if a single uint32_t was specified in their place
  - instanceShaderBindingTableRecordOffset occupies the 24 least significant bits of that memory
  - flags occupies the 8 most significant bits of that memory
If a compiler produces code that diverges from that pattern, applications must employ another method to set values according to the correct bit pattern.

Valid Usage (Implicit)
- flags must be a valid combination of VkGeometryInstanceFlagBitsKHR values
See Also

VkAccelerationStructureMotionInstanceDataNV, VkTransformMatrixKHR

Layout
```
 struct VkAccelerationStructureInstanceKHR {
     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 interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default
- Nested classes/interfaces inherited from class org.lwjgl.system.Struct
  org.lwjgl.system.Struct.StructValidation

Field Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`long`	`accelerationStructureReference()`	either: a device address containing the value obtained from `GetAccelerationStructureDeviceAddressKHR` or `GetAccelerationStructureHandleNV` (used by device operations which reference acceleration structures) or, a `VkAccelerationStructureKHR` object (used by host operations which reference acceleration structures).
`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, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkAccelerationStructureInstanceKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkAccelerationStructureInstanceKHR`	`calloc(org.lwjgl.system.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 VkAccelerationStructureInstanceKHR`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkAccelerationStructureInstanceKHR.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`int`	`flags()`	an 8-bit mask of `VkGeometryInstanceFlagBitsKHR` values to apply to this instance.
`VkAccelerationStructureInstanceKHR`	`flags(int value)`	Sets the specified value to the `flags()` field.
`int`	`instanceCustomIndex()`	a 24-bit user-specified index value accessible to ray shaders in the `InstanceCustomIndexKHR` built-in.
`VkAccelerationStructureInstanceKHR`	`instanceCustomIndex(int value)`	Sets the specified value to the `instanceCustomIndex()` field.
`int`	`instanceShaderBindingTableRecordOffset()`	a 24-bit offset used in calculating the hit shader binding table index.
`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, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkAccelerationStructureInstanceKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkAccelerationStructureInstanceKHR`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkAccelerationStructureInstanceKHR` instance allocated on the specified `MemoryStack`.
`int`	`mask()`	an 8-bit visibility mask for the geometry.
`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()`
`VkTransformMatrixKHR`	`transform()`	a `VkTransformMatrixKHR` structure describing a transformation to be applied to the acceleration structure.
`VkAccelerationStructureInstanceKHR`	`transform(java.util.function.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 interface org.lwjgl.system.NativeResource
close, free

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate

- Field Detail
  - SIZEOF
    
    The struct size in bytes.
  - ALIGNOF
    
    The struct alignment in bytes.
  - TRANSFORM, BITFIELD0, BITFIELD1, ACCELERATIONSTRUCTUREREFERENCE
    
    The struct member offsets.
- Constructor Detail
  - VkAccelerationStructureInstanceKHR
```
public VkAccelerationStructureInstanceKHR(java.nio.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 Detail
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - transform
```
public VkTransformMatrixKHR transform()
```
    a VkTransformMatrixKHR structure describing a transformation to be applied to the acceleration structure.
  - instanceCustomIndex
```
public int instanceCustomIndex()
```
    a 24-bit user-specified index value accessible to ray shaders in the InstanceCustomIndexKHR built-in.
  - mask
```
public int mask()
```
    an 8-bit visibility mask for the geometry. The instance may only be hit if Cull Mask & instance.mask != 0
  - instanceShaderBindingTableRecordOffset
```
public int instanceShaderBindingTableRecordOffset()
```
    a 24-bit offset used in calculating the hit shader binding table index.
  - flags
```
public int flags()
```
    an 8-bit mask of VkGeometryInstanceFlagBitsKHR values to apply to this instance.
  - accelerationStructureReference
```
public long accelerationStructureReference()
```
    either:
    
    a device address containing the value obtained from GetAccelerationStructureDeviceAddressKHR or GetAccelerationStructureHandleNV (used by device operations which reference acceleration structures) or,
    
    a VkAccelerationStructureKHR object (used by host operations which reference acceleration structures).
  - transform
```
public VkAccelerationStructureInstanceKHR transform(VkTransformMatrixKHR value)
```
    Copies the specified VkTransformMatrixKHR to the transform() field.
  - transform
```
public VkAccelerationStructureInstanceKHR transform(java.util.function.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
```
@Nullable
public static 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
```
@Nullable
public static VkAccelerationStructureInstanceKHR.Buffer createSafe(long address,
                                                                   int capacity)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkAccelerationStructureInstanceKHR malloc(org.lwjgl.system.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(org.lwjgl.system.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,
                                                               org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAccelerationStructureInstanceKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - calloc
```
public static VkAccelerationStructureInstanceKHR.Buffer calloc(int capacity,
                                                               org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAccelerationStructureInstanceKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - 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.

Class VkAccelerationStructureInstanceKHR

Description

Valid Usage (Implicit)

See Also

Layout

Nested Class Summary

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

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

TRANSFORM, BITFIELD0, BITFIELD1, ACCELERATIONSTRUCTUREREFERENCE

Constructor Detail

VkAccelerationStructureInstanceKHR

Method Detail

sizeof

transform

instanceCustomIndex

mask

instanceShaderBindingTableRecordOffset

flags

accelerationStructureReference

transform

transform

instanceCustomIndex

mask

instanceShaderBindingTableRecordOffset

flags

accelerationStructureReference

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

ntransform

nbitfield0

ninstanceCustomIndex

nmask

nbitfield1

ninstanceShaderBindingTableRecordOffset

nflags

naccelerationStructureReference

ntransform

nbitfield0

ninstanceCustomIndex

nmask

nbitfield1

ninstanceShaderBindingTableRecordOffset

nflags

naccelerationStructureReference