Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkCopyMemoryToAccelerationStructureInfoKHR

extends Struct<VkCopyMemoryToAccelerationStructureInfoKHR>
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 deserializing an acceleration structure.
Valid Usage
Valid Usage (Implicit)
See Also

VkDeviceOrHostAddressConstKHR, CmdCopyMemoryToAccelerationStructureKHR, CopyMemoryToAccelerationStructureKHR

Layout


struct VkCopyMemoryToAccelerationStructureInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkDeviceOrHostAddressConstKHR src;
    VkAccelerationStructureKHR 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
VkCopyMemoryToAccelerationStructureInfoKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkCopyMemoryToAccelerationStructureInfoKHR
calloc()

Returns a new VkCopyMemoryToAccelerationStructureInfoKHR instance allocated with memCalloc.

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

Returns a new VkCopyMemoryToAccelerationStructureInfoKHR.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkCopyMemoryToAccelerationStructureInfoKHR
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 VkCopyMemoryToAccelerationStructureInfoKHR
create()

Returns a new VkCopyMemoryToAccelerationStructureInfoKHR instance allocated with BufferUtils.

public static VkCopyMemoryToAccelerationStructureInfoKHR
create(long address)

Returns a new VkCopyMemoryToAccelerationStructureInfoKHR instance for the specified memory address.

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

Returns a new VkCopyMemoryToAccelerationStructureInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkCopyMemoryToAccelerationStructureInfoKHR.Buffer instance at the specified memory.

public static VkCopyMemoryToAccelerationStructureInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
dst()

the target acceleration structure for the copy.

public VkCopyMemoryToAccelerationStructureInfoKHR
dst(long value)

Sets the specified value to the dst field.

public static VkCopyMemoryToAccelerationStructureInfoKHR
malloc()

Returns a new VkCopyMemoryToAccelerationStructureInfoKHR instance allocated with memAlloc.

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

Returns a new VkCopyMemoryToAccelerationStructureInfoKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkCopyMemoryToAccelerationStructureInfoKHR instance allocated on the specified MemoryStack.

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

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

public int
mode()

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

public VkCopyMemoryToAccelerationStructureInfoKHR
mode(int value)

Sets the specified value to the mode field.

public static long
ndst(long struct)

Unsafe version of dst.

public static void
ndst(long struct, long 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 VkDeviceOrHostAddressConstKHR
nsrc(long struct)

Unsafe version of src.

public static void
nsrc(long struct, VkDeviceOrHostAddressConstKHR 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 VkCopyMemoryToAccelerationStructureInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkCopyMemoryToAccelerationStructureInfoKHR
set(int sType, long pNext, VkDeviceOrHostAddressConstKHR src, long dst, int mode)

Initializes this struct with the specified values.

public VkCopyMemoryToAccelerationStructureInfoKHR

Returns:

this struct
set
(VkCopyMemoryToAccelerationStructureInfoKHR
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 VkDeviceOrHostAddressConstKHR
src()

the device or host address to memory containing the source data for the copy.

public VkCopyMemoryToAccelerationStructureInfoKHR
src(VkDeviceOrHostAddressConstKHR value)

Copies the specified VkDeviceOrHostAddressConstKHR to the src field.

public VkCopyMemoryToAccelerationStructureInfoKHR
src(Consumer<VkDeviceOrHostAddressConstKHR> consumer)

Passes the src field to the specified Consumer.

public int
sType()

a VkStructureType value identifying this structure.

public VkCopyMemoryToAccelerationStructureInfoKHR
sType(int value)

Sets the specified value to the sType field.

public VkCopyMemoryToAccelerationStructureInfoKHR
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

VkCopyMemoryToAccelerationStructureInfoKHRback to summary
protected VkCopyMemoryToAccelerationStructureInfoKHR(long address, ByteBuffer container)
VkCopyMemoryToAccelerationStructureInfoKHRback to summary
public VkCopyMemoryToAccelerationStructureInfoKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkCopyMemoryToAccelerationStructureInfoKHR calloc(MemoryStack stack)

Returns a new VkCopyMemoryToAccelerationStructureInfoKHR 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 VkCopyMemoryToAccelerationStructureInfoKHR.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkCopyMemoryToAccelerationStructureInfoKHR.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 VkCopyMemoryToAccelerationStructureInfoKHR 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 VkCopyMemoryToAccelerationStructureInfoKHR create()

Returns a new VkCopyMemoryToAccelerationStructureInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkCopyMemoryToAccelerationStructureInfoKHR create(long address)

Returns a new VkCopyMemoryToAccelerationStructureInfoKHR instance for the specified memory address.

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

Returns a new VkCopyMemoryToAccelerationStructureInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkCopyMemoryToAccelerationStructureInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkCopyMemoryToAccelerationStructureInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
dstback to summary
public long dst()

the target acceleration structure for the copy.

Annotations
@NativeType:VkAccelerationStructureKHR
dstback to summary
public VkCopyMemoryToAccelerationStructureInfoKHR dst(long value)

Sets the specified value to the dst field.

mallocback to summary
public static VkCopyMemoryToAccelerationStructureInfoKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkCopyMemoryToAccelerationStructureInfoKHR malloc(MemoryStack stack)

Returns a new VkCopyMemoryToAccelerationStructureInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new VkCopyMemoryToAccelerationStructureInfoKHR.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 VkCopyMemoryToAccelerationStructureInfoKHR mode(int value)

Sets the specified value to the mode field.

ndstback to summary
public static long ndst(long struct)

Unsafe version of dst.

ndstback to summary
public static void ndst(long struct, long 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 VkDeviceOrHostAddressConstKHR nsrc(long struct)

Unsafe version of src.

nsrcback to summary
public static void nsrc(long struct, VkDeviceOrHostAddressConstKHR 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 VkCopyMemoryToAccelerationStructureInfoKHR pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkCopyMemoryToAccelerationStructureInfoKHR set(int sType, long pNext, VkDeviceOrHostAddressConstKHR src, long dst, int mode)

Initializes this struct with the specified values.

setback to summary
public VkCopyMemoryToAccelerationStructureInfoKHR set(VkCopyMemoryToAccelerationStructureInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkCopyMemoryToAccelerationStructureInfoKHR

the source struct

Returns:VkCopyMemoryToAccelerationStructureInfoKHR

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 VkDeviceOrHostAddressConstKHR src()

the device or host address to memory containing the source data for the copy.

srcback to summary
public VkCopyMemoryToAccelerationStructureInfoKHR src(VkDeviceOrHostAddressConstKHR value)

Copies the specified VkDeviceOrHostAddressConstKHR to the src field.

srcback to summary
public VkCopyMemoryToAccelerationStructureInfoKHR src(Consumer<VkDeviceOrHostAddressConstKHR> consumer)

Passes the src field to the specified Consumer.

sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_COPY_MEMORY_TO_ACCELERATION_STRUCTURE_INFO_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkCopyMemoryToAccelerationStructureInfoKHR.Buffer

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

An array of VkCopyMemoryToAccelerationStructureInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkCopyMemoryToAccelerationStructureInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkCopyMemoryToAccelerationStructureInfoKHR.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 long

Returns:

the value of the VkCopyMemoryToAccelerationStructureInfoKHR#dst field.
dst
()

public VkCopyMemoryToAccelerationStructureInfoKHR.Buffer
dst(long value)

Sets the specified value to the VkCopyMemoryToAccelerationStructureInfoKHR#dst field.

protected VkCopyMemoryToAccelerationStructureInfoKHR
public int

Returns:

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

public VkCopyMemoryToAccelerationStructureInfoKHR.Buffer
mode(int value)

Sets the specified value to the VkCopyMemoryToAccelerationStructureInfoKHR#mode field.

public long

Returns:

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

public VkCopyMemoryToAccelerationStructureInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkCopyMemoryToAccelerationStructureInfoKHR#pNext field.

protected VkCopyMemoryToAccelerationStructureInfoKHR.Buffer
public VkDeviceOrHostAddressConstKHR
public VkCopyMemoryToAccelerationStructureInfoKHR.Buffer
public VkCopyMemoryToAccelerationStructureInfoKHR.Buffer
public int

Returns:

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

public VkCopyMemoryToAccelerationStructureInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkCopyMemoryToAccelerationStructureInfoKHR#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkCopyMemoryToAccelerationStructureInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkCopyMemoryToAccelerationStructureInfoKHR.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 VkCopyMemoryToAccelerationStructureInfoKHR#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 long dst()
Returns:long

the value of the VkCopyMemoryToAccelerationStructureInfoKHR#dst field.

Annotations
@NativeType:VkAccelerationStructureKHR
dstback to summary
public VkCopyMemoryToAccelerationStructureInfoKHR.Buffer dst(long value)

Sets the specified value to the VkCopyMemoryToAccelerationStructureInfoKHR#dst field.

getElementFactoryback to summary
protected VkCopyMemoryToAccelerationStructureInfoKHR getElementFactory()

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

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

the value of the VkCopyMemoryToAccelerationStructureInfoKHR#mode field.

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

Sets the specified value to the VkCopyMemoryToAccelerationStructureInfoKHR#mode field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkCopyMemoryToAccelerationStructureInfoKHR#pNext field.

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

Sets the specified value to the VkCopyMemoryToAccelerationStructureInfoKHR#pNext field.

selfback to summary
protected VkCopyMemoryToAccelerationStructureInfoKHR.Buffer self()

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

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

a VkDeviceOrHostAddressConstKHR view of the VkCopyMemoryToAccelerationStructureInfoKHR#src field.

srcback to summary
public VkCopyMemoryToAccelerationStructureInfoKHR.Buffer src(VkDeviceOrHostAddressConstKHR value)

Copies the specified VkDeviceOrHostAddressConstKHR to the VkCopyMemoryToAccelerationStructureInfoKHR#src field.

srcback to summary
public VkCopyMemoryToAccelerationStructureInfoKHR.Buffer src(Consumer<VkDeviceOrHostAddressConstKHR> consumer)

Passes the VkCopyMemoryToAccelerationStructureInfoKHR#src field to the specified Consumer.

sTypeback to summary
public int sType()
Returns:int

the value of the VkCopyMemoryToAccelerationStructureInfoKHR#sType field.

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

Sets the specified value to the VkCopyMemoryToAccelerationStructureInfoKHR#sType field.

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

Sets the STRUCTURE_TYPE_COPY_MEMORY_TO_ACCELERATION_STRUCTURE_INFO_KHR value to the VkCopyMemoryToAccelerationStructureInfoKHR#sType field.