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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkAccelerationStructureCreateInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying the parameters of a newly created acceleration structure object.
Description

If deviceAddress is zero, no specific address is requested.

If deviceAddress is not zero, deviceAddress must be an address retrieved from an identically created acceleration structure on the same implementation. The acceleration structure must also be placed on an identically created buffer and at the same offset.

Applications should avoid creating acceleration structures with application-provided addresses and implementation-provided addresses in the same process, to reduce the likelihood of ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS_KHR errors.

Note

The expected usage for this is that a trace capture/replay tool will add the BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT flag to all buffers that use BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT, and will add BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT to all buffers used as storage for an acceleration structure where deviceAddress is not zero. This also means that the tool will need to add MEMORY_ALLOCATE_DEVICE_ADDRESS_BIT to memory allocations to allow the flag to be set where the application may not have otherwise required it. During capture the tool will save the queried opaque device addresses in the trace. During replay, the buffers will be created specifying the original address so any address values stored in the trace data will remain valid.

Implementations are expected to separate such buffers in the GPU address space so normal allocations will avoid using these addresses. Apps/tools should avoid mixing app-provided and implementation-provided addresses for buffers created with BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT, to avoid address space allocation conflicts.

Applications should create an acceleration structure with a specific VkAccelerationStructureTypeKHR other than ACCELERATION_STRUCTURE_TYPE_GENERIC_KHR.

If the acceleration structure will be the target of a build operation, the required size for an acceleration structure can be queried with GetAccelerationStructureBuildSizesKHR. If the acceleration structure is going to be the target of a compacting copy, CmdWriteAccelerationStructuresPropertiesKHR or WriteAccelerationStructuresPropertiesKHR can be used to obtain the compacted size required.

If the acceleration structure will be the target of a build operation with BUILD_ACCELERATION_STRUCTURE_MOTION_BIT_NV it must include ACCELERATION_STRUCTURE_CREATE_MOTION_BIT_NV in flags and include VkAccelerationStructureMotionInfoNV as an extension structure in pNext with the number of instances as metadata for the object.

Valid Usage
- If deviceAddress is not zero, createFlags must include ACCELERATION_STRUCTURE_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR
- If createFlags includes ACCELERATION_STRUCTURE_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR, VkPhysicalDeviceAccelerationStructureFeaturesKHR::accelerationStructureCaptureReplay must be TRUE
- buffer must have been created with a usage value containing BUFFER_USAGE_ACCELERATION_STRUCTURE_STORAGE_BIT_KHR
- buffer must not have been created with BUFFER_CREATE_SPARSE_RESIDENCY_BIT
- The sum of offset and size must be less than the size of buffer
- offset must be a multiple of 256 bytes
- If ACCELERATION_STRUCTURE_CREATE_MOTION_BIT_NV is set in flags and type is ACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_KHR, one member of the pNext chain must be a pointer to a valid instance of VkAccelerationStructureMotionInfoNV
- If any geometry includes VkAccelerationStructureGeometryMotionTrianglesDataNV then flags must contain ACCELERATION_STRUCTURE_CREATE_MOTION_BIT_NV
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_ACCELERATION_STRUCTURE_CREATE_INFO_KHR
- pNext must be NULL or a pointer to a valid instance of VkAccelerationStructureMotionInfoNV
- The sType value of each struct in the pNext chain must be unique
- createFlags must be a valid combination of VkAccelerationStructureCreateFlagBitsKHR values
- buffer must be a valid VkBuffer handle
- type must be a valid VkAccelerationStructureTypeKHR value
See Also

CreateAccelerationStructureKHR

Layout
```
 struct VkAccelerationStructureCreateInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkAccelerationStructureCreateFlagsKHR createFlags();
     VkBuffer buffer();
     VkDeviceSize offset();
     VkDeviceSize size();
     VkAccelerationStructureTypeKHR type();
     VkDeviceAddress deviceAddress();
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VkAccelerationStructureCreateInfoKHR.Buffer
An array of VkAccelerationStructureCreateInfoKHR 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`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`BUFFER CREATEFLAGS DEVICEADDRESS OFFSET PNEXT SIZE`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`STYPE TYPE`	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
`VkAccelerationStructureCreateInfoKHR(java.nio.ByteBuffer container)`	Creates a `VkAccelerationStructureCreateInfoKHR` 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`	`buffer()`	the buffer on which the acceleration structure will be stored.
`VkAccelerationStructureCreateInfoKHR`	`buffer(long value)`	Sets the specified value to the `buffer()` field.
`static VkAccelerationStructureCreateInfoKHR`	`calloc()`	Returns a new `VkAccelerationStructureCreateInfoKHR` instance allocated with `memCalloc`.
`static VkAccelerationStructureCreateInfoKHR.Buffer`	`calloc(int capacity)`	Returns a new `VkAccelerationStructureCreateInfoKHR.Buffer` instance allocated with `memCalloc`.
`static VkAccelerationStructureCreateInfoKHR.Buffer`	`calloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkAccelerationStructureCreateInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkAccelerationStructureCreateInfoKHR`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkAccelerationStructureCreateInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkAccelerationStructureCreateInfoKHR`	`create()`	Returns a new `VkAccelerationStructureCreateInfoKHR` instance allocated with `BufferUtils`.
`static VkAccelerationStructureCreateInfoKHR.Buffer`	`create(int capacity)`	Returns a new `VkAccelerationStructureCreateInfoKHR.Buffer` instance allocated with `BufferUtils`.
`static VkAccelerationStructureCreateInfoKHR`	`create(long address)`	Returns a new `VkAccelerationStructureCreateInfoKHR` instance for the specified memory address.
`static VkAccelerationStructureCreateInfoKHR.Buffer`	`create(long address, int capacity)`	Create a `VkAccelerationStructureCreateInfoKHR.Buffer` instance at the specified memory.
`int`	`createFlags()`	a bitmask of `VkAccelerationStructureCreateFlagBitsKHR` specifying additional creation parameters of the acceleration structure.
`VkAccelerationStructureCreateInfoKHR`	`createFlags(int value)`	Sets the specified value to the `createFlags()` field.
`static VkAccelerationStructureCreateInfoKHR`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkAccelerationStructureCreateInfoKHR.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`long`	`deviceAddress()`	the device address requested for the acceleration structure if the `accelerationStructureCaptureReplay` feature is being used.
`VkAccelerationStructureCreateInfoKHR`	`deviceAddress(long value)`	Sets the specified value to the `deviceAddress()` field.
`static VkAccelerationStructureCreateInfoKHR`	`malloc()`	Returns a new `VkAccelerationStructureCreateInfoKHR` instance allocated with `memAlloc`.
`static VkAccelerationStructureCreateInfoKHR.Buffer`	`malloc(int capacity)`	Returns a new `VkAccelerationStructureCreateInfoKHR.Buffer` instance allocated with `memAlloc`.
`static VkAccelerationStructureCreateInfoKHR.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkAccelerationStructureCreateInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkAccelerationStructureCreateInfoKHR`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkAccelerationStructureCreateInfoKHR` instance allocated on the specified `MemoryStack`.
`static long`	`nbuffer(long struct)`	Unsafe version of `buffer()`.
`static void`	`nbuffer(long struct, long value)`	Unsafe version of `buffer`.
`static int`	`ncreateFlags(long struct)`	Unsafe version of `createFlags()`.
`static void`	`ncreateFlags(long struct, int value)`	Unsafe version of `createFlags`.
`static long`	`ndeviceAddress(long struct)`	Unsafe version of `deviceAddress()`.
`static void`	`ndeviceAddress(long struct, long value)`	Unsafe version of `deviceAddress`.
`static long`	`noffset(long struct)`	Unsafe version of `offset()`.
`static void`	`noffset(long struct, long value)`	Unsafe version of `offset`.
`static long`	`npNext(long struct)`	Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)`	Unsafe version of `pNext`.
`static long`	`nsize(long struct)`	Unsafe version of `size()`.
`static void`	`nsize(long struct, long value)`	Unsafe version of `size`.
`static int`	`nsType(long struct)`	Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)`	Unsafe version of `sType`.
`static int`	`ntype(long struct)`	Unsafe version of `type()`.
`static void`	`ntype(long struct, int value)`	Unsafe version of `type`.
`long`	`offset()`	an offset in bytes from the base address of the buffer at which the acceleration structure will be stored, and must be a multiple of 256.
`VkAccelerationStructureCreateInfoKHR`	`offset(long value)`	Sets the specified value to the `offset()` field.
`long`	`pNext()`	`NULL` or a pointer to a structure extending this structure.
`VkAccelerationStructureCreateInfoKHR`	`pNext(long value)`	Sets the specified value to the `pNext()` field.
`VkAccelerationStructureCreateInfoKHR`	`pNext(VkAccelerationStructureMotionInfoNV value)`	Prepends the specified `VkAccelerationStructureMotionInfoNV` value to the `pNext` chain.
`VkAccelerationStructureCreateInfoKHR`	`set(int sType, long pNext, int createFlags, long buffer, long offset, long size, int type, long deviceAddress)`	Initializes this struct with the specified values.
`VkAccelerationStructureCreateInfoKHR`	`set(VkAccelerationStructureCreateInfoKHR src)`	Copies the specified struct data to this struct.
`long`	`size()`	the size required for the acceleration structure.
`VkAccelerationStructureCreateInfoKHR`	`size(long value)`	Sets the specified value to the `size()` field.
`int`	`sizeof()`
`int`	`sType()`	the type of this structure.
`VkAccelerationStructureCreateInfoKHR`	`sType(int value)`	Sets the specified value to the `sType()` field.
`VkAccelerationStructureCreateInfoKHR`	`sType$Default()`	Sets the `STRUCTURE_TYPE_ACCELERATION_STRUCTURE_CREATE_INFO_KHR` value to the `sType()` field.
`int`	`type()`	a `VkAccelerationStructureTypeKHR` value specifying the type of acceleration structure that will be created.
`VkAccelerationStructureCreateInfoKHR`	`type(int value)`	Sets the specified value to the `type()` 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.
  - STYPE, PNEXT, CREATEFLAGS, BUFFER, OFFSET, SIZE, TYPE, DEVICEADDRESS
    
    The struct member offsets.
- Constructor Detail
  - VkAccelerationStructureCreateInfoKHR
```
public VkAccelerationStructureCreateInfoKHR(java.nio.ByteBuffer container)
```
    Creates a VkAccelerationStructureCreateInfoKHR 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
  - sType
```
public int sType()
```
    the type of this structure.
  - pNext
```
public long pNext()
```
    NULL or a pointer to a structure extending this structure.
  - createFlags
```
public int createFlags()
```
    a bitmask of VkAccelerationStructureCreateFlagBitsKHR specifying additional creation parameters of the acceleration structure.
  - buffer
```
public long buffer()
```
    the buffer on which the acceleration structure will be stored.
  - offset
```
public long offset()
```
    an offset in bytes from the base address of the buffer at which the acceleration structure will be stored, and must be a multiple of 256.
  - size
```
public long size()
```
    the size required for the acceleration structure.
  - type
```
public int type()
```
    a VkAccelerationStructureTypeKHR value specifying the type of acceleration structure that will be created.
  - deviceAddress
```
public long deviceAddress()
```
    the device address requested for the acceleration structure if the accelerationStructureCaptureReplay feature is being used.
  - sType
```
public VkAccelerationStructureCreateInfoKHR sType(int value)
```
    Sets the specified value to the sType() field.
  - sType$Default
```
public VkAccelerationStructureCreateInfoKHR sType$Default()
```
    Sets the STRUCTURE_TYPE_ACCELERATION_STRUCTURE_CREATE_INFO_KHR value to the sType() field.
  - pNext
```
public VkAccelerationStructureCreateInfoKHR pNext(long value)
```
    Sets the specified value to the pNext() field.
  - pNext
```
public VkAccelerationStructureCreateInfoKHR pNext(VkAccelerationStructureMotionInfoNV value)
```
    Prepends the specified VkAccelerationStructureMotionInfoNV value to the pNext chain.
  - createFlags
```
public VkAccelerationStructureCreateInfoKHR createFlags(int value)
```
    Sets the specified value to the createFlags() field.
  - buffer
```
public VkAccelerationStructureCreateInfoKHR buffer(long value)
```
    Sets the specified value to the buffer() field.
  - offset
```
public VkAccelerationStructureCreateInfoKHR offset(long value)
```
    Sets the specified value to the offset() field.
  - size
```
public VkAccelerationStructureCreateInfoKHR size(long value)
```
    Sets the specified value to the size() field.
  - type
```
public VkAccelerationStructureCreateInfoKHR type(int value)
```
    Sets the specified value to the type() field.
  - deviceAddress
```
public VkAccelerationStructureCreateInfoKHR deviceAddress(long value)
```
    Sets the specified value to the deviceAddress() field.
  - set
```
public VkAccelerationStructureCreateInfoKHR set(int sType,
                                                long pNext,
                                                int createFlags,
                                                long buffer,
                                                long offset,
                                                long size,
                                                int type,
                                                long deviceAddress)
```
    Initializes this struct with the specified values.
  - set
```
public VkAccelerationStructureCreateInfoKHR set(VkAccelerationStructureCreateInfoKHR src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkAccelerationStructureCreateInfoKHR malloc()
```
    Returns a new VkAccelerationStructureCreateInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkAccelerationStructureCreateInfoKHR calloc()
```
    Returns a new VkAccelerationStructureCreateInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkAccelerationStructureCreateInfoKHR create()
```
    Returns a new VkAccelerationStructureCreateInfoKHR instance allocated with BufferUtils.
  - create
```
public static VkAccelerationStructureCreateInfoKHR create(long address)
```
    Returns a new VkAccelerationStructureCreateInfoKHR instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkAccelerationStructureCreateInfoKHR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkAccelerationStructureCreateInfoKHR.Buffer malloc(int capacity)
```
    Returns a new VkAccelerationStructureCreateInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkAccelerationStructureCreateInfoKHR.Buffer calloc(int capacity)
```
    Returns a new VkAccelerationStructureCreateInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkAccelerationStructureCreateInfoKHR.Buffer create(int capacity)
```
    Returns a new VkAccelerationStructureCreateInfoKHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkAccelerationStructureCreateInfoKHR.Buffer create(long address,
                                                                 int capacity)
```
    Create a VkAccelerationStructureCreateInfoKHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkAccelerationStructureCreateInfoKHR.Buffer createSafe(long address,
                                                                     int capacity)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkAccelerationStructureCreateInfoKHR malloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAccelerationStructureCreateInfoKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - calloc
```
public static VkAccelerationStructureCreateInfoKHR calloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAccelerationStructureCreateInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - malloc
```
public static VkAccelerationStructureCreateInfoKHR.Buffer malloc(int capacity,
                                                                 org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAccelerationStructureCreateInfoKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - calloc
```
public static VkAccelerationStructureCreateInfoKHR.Buffer calloc(int capacity,
                                                                 org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAccelerationStructureCreateInfoKHR.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
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - ncreateFlags
```
public static int ncreateFlags(long struct)
```
    Unsafe version of createFlags().
  - nbuffer
```
public static long nbuffer(long struct)
```
    Unsafe version of buffer().
  - noffset
```
public static long noffset(long struct)
```
    Unsafe version of offset().
  - nsize
```
public static long nsize(long struct)
```
    Unsafe version of size().
  - ntype
```
public static int ntype(long struct)
```
    Unsafe version of type().
  - ndeviceAddress
```
public static long ndeviceAddress(long struct)
```
    Unsafe version of deviceAddress().
  - 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.
  - ncreateFlags
```
public static void ncreateFlags(long struct,
                                int value)
```
    Unsafe version of createFlags.
  - nbuffer
```
public static void nbuffer(long struct,
                           long value)
```
    Unsafe version of buffer.
  - noffset
```
public static void noffset(long struct,
                           long value)
```
    Unsafe version of offset.
  - nsize
```
public static void nsize(long struct,
                         long value)
```
    Unsafe version of size.
  - ntype
```
public static void ntype(long struct,
                         int value)
```
    Unsafe version of type.
  - ndeviceAddress
```
public static void ndeviceAddress(long struct,
                                  long value)
```
    Unsafe version of deviceAddress.

Class VkAccelerationStructureCreateInfoKHR

Description

Note

Valid Usage

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

STYPE, PNEXT, CREATEFLAGS, BUFFER, OFFSET, SIZE, TYPE, DEVICEADDRESS

Constructor Detail

VkAccelerationStructureCreateInfoKHR

Method Detail

sizeof

sType

pNext

createFlags

buffer

offset

size

type

deviceAddress

sType

sType$Default

pNext

pNext

createFlags

buffer

offset

size

type

deviceAddress

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

nsType

npNext

ncreateFlags

nbuffer

noffset

nsize

ntype

ndeviceAddress

nsType

npNext

ncreateFlags

nbuffer

noffset

nsize

ntype

ndeviceAddress