Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkCopyAccelerationStructureToMemoryInfoKHR

extends Struct<VkCopyAccelerationStructureToMemoryInfoKHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Parameters for serializing an acceleration structure.
Valid Usage
Valid Usage (Implicit)
See Also

VkDeviceOrHostAddressKHR, CmdCopyAccelerationStructureToMemoryKHR, CopyAccelerationStructureToMemoryKHR

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DST

The struct member offsets.

public static final int
MODE

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SRC

The struct member offsets.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkCopyAccelerationStructureToMemoryInfoKHR(ByteBuffer container)

Creates a VkCopyAccelerationStructureToMemoryInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkCopyAccelerationStructureToMemoryInfoKHR
calloc()

Returns a new VkCopyAccelerationStructureToMemoryInfoKHR instance allocated with memCalloc.

public static VkCopyAccelerationStructureToMemoryInfoKHR.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkCopyAccelerationStructureToMemoryInfoKHR.Buffer instance allocated with memCalloc.

public static VkCopyAccelerationStructureToMemoryInfoKHR
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkCopyAccelerationStructureToMemoryInfoKHR.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected VkCopyAccelerationStructureToMemoryInfoKHR
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkCopyAccelerationStructureToMemoryInfoKHR
create()

Returns a new VkCopyAccelerationStructureToMemoryInfoKHR instance allocated with BufferUtils.

public static VkCopyAccelerationStructureToMemoryInfoKHR
create(long address)

Returns a new VkCopyAccelerationStructureToMemoryInfoKHR instance for the specified memory address.

public static VkCopyAccelerationStructureToMemoryInfoKHR.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkCopyAccelerationStructureToMemoryInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkCopyAccelerationStructureToMemoryInfoKHR.Buffer instance at the specified memory.

public static VkCopyAccelerationStructureToMemoryInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public VkDeviceOrHostAddressKHR
dst()

the device or host address to memory which is the target for the copy

public VkCopyAccelerationStructureToMemoryInfoKHR
dst(VkDeviceOrHostAddressKHR value)

Copies the specified VkDeviceOrHostAddressKHR to the dst field.

public VkCopyAccelerationStructureToMemoryInfoKHR
dst(Consumer<VkDeviceOrHostAddressKHR> consumer)

Passes the dst field to the specified Consumer.

public static VkCopyAccelerationStructureToMemoryInfoKHR
malloc()

Returns a new VkCopyAccelerationStructureToMemoryInfoKHR instance allocated with memAlloc.

public static VkCopyAccelerationStructureToMemoryInfoKHR.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkCopyAccelerationStructureToMemoryInfoKHR.Buffer instance allocated with memAlloc.

public static VkCopyAccelerationStructureToMemoryInfoKHR
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkCopyAccelerationStructureToMemoryInfoKHR instance allocated on the specified MemoryStack.

public static VkCopyAccelerationStructureToMemoryInfoKHR.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public int
mode()

a VkCopyAccelerationStructureModeKHR value specifying additional operations to perform during the copy.

public VkCopyAccelerationStructureToMemoryInfoKHR
mode(int value)

Sets the specified value to the mode field.

public static VkDeviceOrHostAddressKHR
ndst(long struct)

Unsafe version of dst.

public static void
ndst(long struct, VkDeviceOrHostAddressKHR value)

Unsafe version of dst.

public static int
nmode(long struct)

Unsafe version of mode.

public static void
nmode(long struct, int value)

Unsafe version of mode.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static long
nsrc(long struct)

Unsafe version of src.

public static void
nsrc(long struct, long value)

Unsafe version of src.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkCopyAccelerationStructureToMemoryInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkCopyAccelerationStructureToMemoryInfoKHR

Returns:

this struct
set
(VkCopyAccelerationStructureToMemoryInfoKHR
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public long
src()

the source acceleration structure for the copy

public VkCopyAccelerationStructureToMemoryInfoKHR
src(long value)

Sets the specified value to the src field.

public int
sType()

a VkStructureType value identifying this structure.

public VkCopyAccelerationStructureToMemoryInfoKHR
sType(int value)

Sets the specified value to the sType field.

public VkCopyAccelerationStructureToMemoryInfoKHR
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

DSTback to summary
public static final int DST

The struct member offsets.

MODEback to summary
public static final int MODE

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SRCback to summary
public static final int SRC

The struct member offsets.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkCopyAccelerationStructureToMemoryInfoKHRback to summary
protected VkCopyAccelerationStructureToMemoryInfoKHR(long address, ByteBuffer container)
VkCopyAccelerationStructureToMemoryInfoKHRback to summary
public VkCopyAccelerationStructureToMemoryInfoKHR(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

callocback to summary
public static VkCopyAccelerationStructureToMemoryInfoKHR calloc()

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

callocback to summary
public static VkCopyAccelerationStructureToMemoryInfoKHR.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkCopyAccelerationStructureToMemoryInfoKHR calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkCopyAccelerationStructureToMemoryInfoKHR.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected VkCopyAccelerationStructureToMemoryInfoKHR create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkCopyAccelerationStructureToMemoryInfoKHR create()

Returns a new VkCopyAccelerationStructureToMemoryInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkCopyAccelerationStructureToMemoryInfoKHR create(long address)

Returns a new VkCopyAccelerationStructureToMemoryInfoKHR instance for the specified memory address.

createback to summary
public static VkCopyAccelerationStructureToMemoryInfoKHR.Buffer create(int capacity)

Returns a new VkCopyAccelerationStructureToMemoryInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkCopyAccelerationStructureToMemoryInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkCopyAccelerationStructureToMemoryInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkCopyAccelerationStructureToMemoryInfoKHR.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
dstback to summary
public VkDeviceOrHostAddressKHR dst()

the device or host address to memory which is the target for the copy

dstback to summary
public VkCopyAccelerationStructureToMemoryInfoKHR dst(VkDeviceOrHostAddressKHR value)

Copies the specified VkDeviceOrHostAddressKHR to the dst field.

dstback to summary
public VkCopyAccelerationStructureToMemoryInfoKHR dst(Consumer<VkDeviceOrHostAddressKHR> consumer)

Passes the dst field to the specified Consumer.

mallocback to summary
public static VkCopyAccelerationStructureToMemoryInfoKHR malloc()

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

mallocback to summary
public static VkCopyAccelerationStructureToMemoryInfoKHR.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkCopyAccelerationStructureToMemoryInfoKHR malloc(MemoryStack stack)

Returns a new VkCopyAccelerationStructureToMemoryInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkCopyAccelerationStructureToMemoryInfoKHR.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

modeback to summary
public int mode()

a VkCopyAccelerationStructureModeKHR value specifying additional operations to perform during the copy.

Annotations
@NativeType:VkCopyAccelerationStructureModeKHR
modeback to summary
public VkCopyAccelerationStructureToMemoryInfoKHR mode(int value)

Sets the specified value to the mode field.

ndstback to summary
public static VkDeviceOrHostAddressKHR ndst(long struct)

Unsafe version of dst.

ndstback to summary
public static void ndst(long struct, VkDeviceOrHostAddressKHR value)

Unsafe version of dst.

nmodeback to summary
public static int nmode(long struct)

Unsafe version of mode.

nmodeback to summary
public static void nmode(long struct, int value)

Unsafe version of mode.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsrcback to summary
public static long nsrc(long struct)

Unsafe version of src.

nsrcback to summary
public static void nsrc(long struct, long value)

Unsafe version of src.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkCopyAccelerationStructureToMemoryInfoKHR pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkCopyAccelerationStructureToMemoryInfoKHR set(VkCopyAccelerationStructureToMemoryInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkCopyAccelerationStructureToMemoryInfoKHR

the source struct

Returns:VkCopyAccelerationStructureToMemoryInfoKHR

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
srcback to summary
public long src()

the source acceleration structure for the copy

Annotations
@NativeType:VkAccelerationStructureKHR
srcback to summary
public VkCopyAccelerationStructureToMemoryInfoKHR src(long value)

Sets the specified value to the src field.

sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkCopyAccelerationStructureToMemoryInfoKHR sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkCopyAccelerationStructureToMemoryInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_COPY_ACCELERATION_STRUCTURE_TO_MEMORY_INFO_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkCopyAccelerationStructureToMemoryInfoKHR.Buffer

extends StructBuffer<VkCopyAccelerationStructureToMemoryInfoKHR, VkCopyAccelerationStructureToMemoryInfoKHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkCopyAccelerationStructureToMemoryInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkCopyAccelerationStructureToMemoryInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkCopyAccelerationStructureToMemoryInfoKHR.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public VkDeviceOrHostAddressKHR
public VkCopyAccelerationStructureToMemoryInfoKHR.Buffer
public VkCopyAccelerationStructureToMemoryInfoKHR.Buffer
protected VkCopyAccelerationStructureToMemoryInfoKHR
public int

Returns:

the value of the VkCopyAccelerationStructureToMemoryInfoKHR#mode field.
mode
()

public VkCopyAccelerationStructureToMemoryInfoKHR.Buffer
mode(int value)

Sets the specified value to the VkCopyAccelerationStructureToMemoryInfoKHR#mode field.

public long

Returns:

the value of the VkCopyAccelerationStructureToMemoryInfoKHR#pNext field.
pNext
()

public VkCopyAccelerationStructureToMemoryInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkCopyAccelerationStructureToMemoryInfoKHR#pNext field.

protected VkCopyAccelerationStructureToMemoryInfoKHR.Buffer
public long

Returns:

the value of the VkCopyAccelerationStructureToMemoryInfoKHR#src field.
src
()

public VkCopyAccelerationStructureToMemoryInfoKHR.Buffer
src(long value)

Sets the specified value to the VkCopyAccelerationStructureToMemoryInfoKHR#src field.

public int

Returns:

the value of the VkCopyAccelerationStructureToMemoryInfoKHR#sType field.
sType
()

public VkCopyAccelerationStructureToMemoryInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkCopyAccelerationStructureToMemoryInfoKHR#sType field.

public VkCopyAccelerationStructureToMemoryInfoKHR.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkCopyAccelerationStructureToMemoryInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkCopyAccelerationStructureToMemoryInfoKHR.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkCopyAccelerationStructureToMemoryInfoKHR#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

dstback to summary
public VkDeviceOrHostAddressKHR dst()
Returns:VkDeviceOrHostAddressKHR

a VkDeviceOrHostAddressKHR view of the VkCopyAccelerationStructureToMemoryInfoKHR#dst field.

dstback to summary
public VkCopyAccelerationStructureToMemoryInfoKHR.Buffer dst(VkDeviceOrHostAddressKHR value)

Copies the specified VkDeviceOrHostAddressKHR to the VkCopyAccelerationStructureToMemoryInfoKHR#dst field.

dstback to summary
public VkCopyAccelerationStructureToMemoryInfoKHR.Buffer dst(Consumer<VkDeviceOrHostAddressKHR> consumer)

Passes the VkCopyAccelerationStructureToMemoryInfoKHR#dst field to the specified Consumer.

getElementFactoryback to summary
protected VkCopyAccelerationStructureToMemoryInfoKHR getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
modeback to summary
public int mode()
Returns:int

the value of the VkCopyAccelerationStructureToMemoryInfoKHR#mode field.

Annotations
@NativeType:VkCopyAccelerationStructureModeKHR
modeback to summary
public VkCopyAccelerationStructureToMemoryInfoKHR.Buffer mode(int value)

Sets the specified value to the VkCopyAccelerationStructureToMemoryInfoKHR#mode field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkCopyAccelerationStructureToMemoryInfoKHR#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkCopyAccelerationStructureToMemoryInfoKHR.Buffer pNext(long value)

Sets the specified value to the VkCopyAccelerationStructureToMemoryInfoKHR#pNext field.

selfback to summary
protected VkCopyAccelerationStructureToMemoryInfoKHR.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
srcback to summary
public long src()
Returns:long

the value of the VkCopyAccelerationStructureToMemoryInfoKHR#src field.

Annotations
@NativeType:VkAccelerationStructureKHR
srcback to summary
public VkCopyAccelerationStructureToMemoryInfoKHR.Buffer src(long value)

Sets the specified value to the VkCopyAccelerationStructureToMemoryInfoKHR#src field.

sTypeback to summary
public int sType()
Returns:int

the value of the VkCopyAccelerationStructureToMemoryInfoKHR#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkCopyAccelerationStructureToMemoryInfoKHR.Buffer sType(int value)

Sets the specified value to the VkCopyAccelerationStructureToMemoryInfoKHR#sType field.

sType$Defaultback to summary
public VkCopyAccelerationStructureToMemoryInfoKHR.Buffer sType$Default()

Sets the STRUCTURE_TYPE_COPY_ACCELERATION_STRUCTURE_TO_MEMORY_INFO_KHR value to the VkCopyAccelerationStructureToMemoryInfoKHR#sType field.