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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkCopyAccelerationStructureToMemoryInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Parameters for serializing an acceleration structure.
Valid Usage
- The source acceleration structure src must have been constructed prior to the execution of this command
- The memory pointed to by dst must be at least as large as the serialization size of src, as reported by WriteAccelerationStructuresPropertiesKHR or CmdWriteAccelerationStructuresPropertiesKHR with a query type of QUERY_TYPE_ACCELERATION_STRUCTURE_SERIALIZATION_SIZE_KHR
- mode must be COPY_ACCELERATION_STRUCTURE_MODE_SERIALIZE_KHR
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_COPY_ACCELERATION_STRUCTURE_TO_MEMORY_INFO_KHR
- pNext must be NULL
- src must be a valid VkAccelerationStructureKHR handle
- mode must be a valid VkCopyAccelerationStructureModeKHR value
See Also

VkDeviceOrHostAddressKHR, CmdCopyAccelerationStructureToMemoryKHR, CopyAccelerationStructureToMemoryKHR

Layout
```
 struct VkCopyAccelerationStructureToMemoryInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkAccelerationStructureKHR src();
     VkDeviceOrHostAddressKHR dst();
     VkCopyAccelerationStructureModeKHR mode();
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VkCopyAccelerationStructureToMemoryInfoKHR.Buffer
An array of VkCopyAccelerationStructureToMemoryInfoKHR 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`	`DST MODE PNEXT`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`SRC 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
`VkCopyAccelerationStructureToMemoryInfoKHR(java.nio.ByteBuffer container)`	Creates a `VkCopyAccelerationStructureToMemoryInfoKHR` 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
`static VkCopyAccelerationStructureToMemoryInfoKHR`	`calloc()`	Returns a new `VkCopyAccelerationStructureToMemoryInfoKHR` instance allocated with `memCalloc`.
`static VkCopyAccelerationStructureToMemoryInfoKHR.Buffer`	`calloc(int capacity)`	Returns a new `VkCopyAccelerationStructureToMemoryInfoKHR.Buffer` instance allocated with `memCalloc`.
`static VkCopyAccelerationStructureToMemoryInfoKHR.Buffer`	`calloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkCopyAccelerationStructureToMemoryInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkCopyAccelerationStructureToMemoryInfoKHR`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkCopyAccelerationStructureToMemoryInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkCopyAccelerationStructureToMemoryInfoKHR`	`create()`	Returns a new `VkCopyAccelerationStructureToMemoryInfoKHR` instance allocated with `BufferUtils`.
`static VkCopyAccelerationStructureToMemoryInfoKHR.Buffer`	`create(int capacity)`	Returns a new `VkCopyAccelerationStructureToMemoryInfoKHR.Buffer` instance allocated with `BufferUtils`.
`static VkCopyAccelerationStructureToMemoryInfoKHR`	`create(long address)`	Returns a new `VkCopyAccelerationStructureToMemoryInfoKHR` instance for the specified memory address.
`static VkCopyAccelerationStructureToMemoryInfoKHR.Buffer`	`create(long address, int capacity)`	Create a `VkCopyAccelerationStructureToMemoryInfoKHR.Buffer` instance at the specified memory.
`static VkCopyAccelerationStructureToMemoryInfoKHR`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkCopyAccelerationStructureToMemoryInfoKHR.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`VkDeviceOrHostAddressKHR`	`dst()`	the device or host address to memory which is the target for the copy
`VkCopyAccelerationStructureToMemoryInfoKHR`	`dst(java.util.function.Consumer<VkDeviceOrHostAddressKHR> consumer)`	Passes the `dst()` field to the specified `Consumer`.
`VkCopyAccelerationStructureToMemoryInfoKHR`	`dst(VkDeviceOrHostAddressKHR value)`	Copies the specified `VkDeviceOrHostAddressKHR` to the `dst()` field.
`static VkCopyAccelerationStructureToMemoryInfoKHR`	`malloc()`	Returns a new `VkCopyAccelerationStructureToMemoryInfoKHR` instance allocated with `memAlloc`.
`static VkCopyAccelerationStructureToMemoryInfoKHR.Buffer`	`malloc(int capacity)`	Returns a new `VkCopyAccelerationStructureToMemoryInfoKHR.Buffer` instance allocated with `memAlloc`.
`static VkCopyAccelerationStructureToMemoryInfoKHR.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkCopyAccelerationStructureToMemoryInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkCopyAccelerationStructureToMemoryInfoKHR`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkCopyAccelerationStructureToMemoryInfoKHR` instance allocated on the specified `MemoryStack`.
`int`	`mode()`	a `VkCopyAccelerationStructureModeKHR` value specifying additional operations to perform during the copy.
`VkCopyAccelerationStructureToMemoryInfoKHR`	`mode(int value)`	Sets the specified value to the `mode()` field.
`static VkDeviceOrHostAddressKHR`	`ndst(long struct)`	Unsafe version of `dst()`.
`static void`	`ndst(long struct, VkDeviceOrHostAddressKHR value)`	Unsafe version of `dst`.
`static int`	`nmode(long struct)`	Unsafe version of `mode()`.
`static void`	`nmode(long struct, int value)`	Unsafe version of `mode`.
`static long`	`npNext(long struct)`	Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)`	Unsafe version of `pNext`.
`static long`	`nsrc(long struct)`	Unsafe version of `src()`.
`static void`	`nsrc(long struct, long value)`	Unsafe version of `src`.
`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.
`VkCopyAccelerationStructureToMemoryInfoKHR`	`pNext(long value)`	Sets the specified value to the `pNext()` field.
`VkCopyAccelerationStructureToMemoryInfoKHR`	`set(int sType, long pNext, long src, VkDeviceOrHostAddressKHR dst, int mode)`	Initializes this struct with the specified values.
`VkCopyAccelerationStructureToMemoryInfoKHR`	`set(VkCopyAccelerationStructureToMemoryInfoKHR src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`long`	`src()`	the source acceleration structure for the copy
`VkCopyAccelerationStructureToMemoryInfoKHR`	`src(long value)`	Sets the specified value to the `src()` field.
`int`	`sType()`	the type of this structure.
`VkCopyAccelerationStructureToMemoryInfoKHR`	`sType(int value)`	Sets the specified value to the `sType()` field.
`VkCopyAccelerationStructureToMemoryInfoKHR`	`sType$Default()`	Sets the `STRUCTURE_TYPE_COPY_ACCELERATION_STRUCTURE_TO_MEMORY_INFO_KHR` value to the `sType()` 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, SRC, DST, MODE
  
  The struct member offsets.

Constructor Detail
- VkCopyAccelerationStructureToMemoryInfoKHR
```
public VkCopyAccelerationStructureToMemoryInfoKHR(java.nio.ByteBuffer container)
```
  Creates a VkCopyAccelerationStructureToMemoryInfoKHR 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.

src
```
public long src()
```
the source acceleration structure for the copy

dst
```
public VkDeviceOrHostAddressKHR dst()
```
the device or host address to memory which is the target for the copy

mode
```
public int mode()
```
a VkCopyAccelerationStructureModeKHR value specifying additional operations to perform during the copy.

sType

public VkCopyAccelerationStructureToMemoryInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default
```
public VkCopyAccelerationStructureToMemoryInfoKHR sType$Default()
```
Sets the STRUCTURE_TYPE_COPY_ACCELERATION_STRUCTURE_TO_MEMORY_INFO_KHR value to the sType() field.

pNext

public VkCopyAccelerationStructureToMemoryInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

src

public VkCopyAccelerationStructureToMemoryInfoKHR src(long value)

Sets the specified value to the src() field.

dst

public VkCopyAccelerationStructureToMemoryInfoKHR dst(VkDeviceOrHostAddressKHR value)

Copies the specified VkDeviceOrHostAddressKHR to the dst() field.

dst

public VkCopyAccelerationStructureToMemoryInfoKHR dst(java.util.function.Consumer<VkDeviceOrHostAddressKHR> consumer)

Passes the dst() field to the specified Consumer.

mode

public VkCopyAccelerationStructureToMemoryInfoKHR mode(int value)

Sets the specified value to the mode() field.

set

public VkCopyAccelerationStructureToMemoryInfoKHR set(int sType,
                                                      long pNext,
                                                      long src,
                                                      VkDeviceOrHostAddressKHR dst,
                                                      int mode)

Initializes this struct with the specified values.

set

public VkCopyAccelerationStructureToMemoryInfoKHR set(VkCopyAccelerationStructureToMemoryInfoKHR src)

Copies the specified struct data to this struct.

Parameters:: src - the source struct
Returns:: this struct

malloc
```
public static VkCopyAccelerationStructureToMemoryInfoKHR malloc()
```
Returns a new VkCopyAccelerationStructureToMemoryInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.

calloc
```
public static VkCopyAccelerationStructureToMemoryInfoKHR calloc()
```
Returns a new VkCopyAccelerationStructureToMemoryInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.

create
```
public static VkCopyAccelerationStructureToMemoryInfoKHR create()
```
Returns a new VkCopyAccelerationStructureToMemoryInfoKHR instance allocated with BufferUtils.

create
```
public static VkCopyAccelerationStructureToMemoryInfoKHR create(long address)
```
Returns a new VkCopyAccelerationStructureToMemoryInfoKHR instance for the specified memory address.

createSafe

@Nullable
public static VkCopyAccelerationStructureToMemoryInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc
```
public static VkCopyAccelerationStructureToMemoryInfoKHR.Buffer malloc(int capacity)
```
Returns a new VkCopyAccelerationStructureToMemoryInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc
```
public static VkCopyAccelerationStructureToMemoryInfoKHR.Buffer calloc(int capacity)
```
Returns a new VkCopyAccelerationStructureToMemoryInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create
```
public static VkCopyAccelerationStructureToMemoryInfoKHR.Buffer create(int capacity)
```
Returns a new VkCopyAccelerationStructureToMemoryInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkCopyAccelerationStructureToMemoryInfoKHR.Buffer instance at the specified memory.

Parameters:: address - the memory address; capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc
```
public static VkCopyAccelerationStructureToMemoryInfoKHR malloc(org.lwjgl.system.MemoryStack stack)
```
Returns a new VkCopyAccelerationStructureToMemoryInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc
```
public static VkCopyAccelerationStructureToMemoryInfoKHR calloc(org.lwjgl.system.MemoryStack stack)
```
Returns a new VkCopyAccelerationStructureToMemoryInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:: stack - the stack from which to allocate; capacity - the buffer capacity

calloc
```
public static VkCopyAccelerationStructureToMemoryInfoKHR.Buffer calloc(int capacity,
                                                                       org.lwjgl.system.MemoryStack stack)
```
Returns a new VkCopyAccelerationStructureToMemoryInfoKHR.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().

nsrc

public static long nsrc(long struct)

Unsafe version of src().

ndst

public static VkDeviceOrHostAddressKHR ndst(long struct)

Unsafe version of dst().

nmode

public static int nmode(long struct)

Unsafe version of mode().

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.

nsrc

public static void nsrc(long struct,
                        long value)

Unsafe version of src.

ndst

public static void ndst(long struct,
                        VkDeviceOrHostAddressKHR value)

Unsafe version of dst.

nmode

public static void nmode(long struct,
                         int value)

Unsafe version of mode.

Class VkCopyAccelerationStructureToMemoryInfoKHR

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, SRC, DST, MODE

Constructor Detail

VkCopyAccelerationStructureToMemoryInfoKHR

Method Detail

sizeof

sType

pNext

src

dst

mode

sType

sType$Default

pNext

src

dst

dst

mode

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

nsType

npNext

nsrc

ndst

nmode

nsType

npNext

nsrc

ndst

nmode