Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkCopyMemoryToMicromapInfoEXT

extends Struct<VkCopyMemoryToMicromapInfoEXT>
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 a micromap.
Valid Usage
Valid Usage (Implicit)
See Also

VkDeviceOrHostAddressConstKHR, CmdCopyMemoryToMicromapEXT, CopyMemoryToMicromapEXT

Layout


struct VkCopyMemoryToMicromapInfoEXT {
    VkStructureType sType;
    void const * pNext;
    VkDeviceOrHostAddressConstKHR src;
    VkMicromapEXT dst;
    VkCopyMicromapModeEXT 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
VkCopyMemoryToMicromapInfoEXT(long address, ByteBuffer container)

public
VkCopyMemoryToMicromapInfoEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkCopyMemoryToMicromapInfoEXT
calloc()

Returns a new VkCopyMemoryToMicromapInfoEXT instance allocated with memCalloc.

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

Returns a new VkCopyMemoryToMicromapInfoEXT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkCopyMemoryToMicromapInfoEXT instance allocated with BufferUtils.

public static VkCopyMemoryToMicromapInfoEXT
create(long address)

Returns a new VkCopyMemoryToMicromapInfoEXT instance for the specified memory address.

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

Returns a new VkCopyMemoryToMicromapInfoEXT.Buffer instance allocated with BufferUtils.

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

Create a VkCopyMemoryToMicromapInfoEXT.Buffer instance at the specified memory.

public static VkCopyMemoryToMicromapInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
dst()

the target micromap for the copy.

public VkCopyMemoryToMicromapInfoEXT
dst(long value)

Sets the specified value to the dst field.

public static VkCopyMemoryToMicromapInfoEXT
malloc()

Returns a new VkCopyMemoryToMicromapInfoEXT instance allocated with memAlloc.

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

Returns a new VkCopyMemoryToMicromapInfoEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkCopyMemoryToMicromapInfoEXT instance allocated on the specified MemoryStack.

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

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

public int
mode()

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

public VkCopyMemoryToMicromapInfoEXT
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 VkCopyMemoryToMicromapInfoEXT
pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkCopyMemoryToMicromapInfoEXT

Returns:

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

Copies the specified VkDeviceOrHostAddressConstKHR to the src field.

public VkCopyMemoryToMicromapInfoEXT
src(Consumer<VkDeviceOrHostAddressConstKHR> consumer)

Passes the src field to the specified Consumer.

public int
sType()

a VkStructureType value identifying this structure.

public VkCopyMemoryToMicromapInfoEXT
sType(int value)

Sets the specified value to the sType field.

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

VkCopyMemoryToMicromapInfoEXTback to summary
protected VkCopyMemoryToMicromapInfoEXT(long address, ByteBuffer container)
VkCopyMemoryToMicromapInfoEXTback to summary
public VkCopyMemoryToMicromapInfoEXT(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkCopyMemoryToMicromapInfoEXT calloc(MemoryStack stack)

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

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

Returns a new VkCopyMemoryToMicromapInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkCopyMemoryToMicromapInfoEXT create(long address)

Returns a new VkCopyMemoryToMicromapInfoEXT instance for the specified memory address.

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

Returns a new VkCopyMemoryToMicromapInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkCopyMemoryToMicromapInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkCopyMemoryToMicromapInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkCopyMemoryToMicromapInfoEXT.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 micromap for the copy.

Annotations
@NativeType:VkMicromapEXT
dstback to summary
public VkCopyMemoryToMicromapInfoEXT dst(long value)

Sets the specified value to the dst field.

mallocback to summary
public static VkCopyMemoryToMicromapInfoEXT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkCopyMemoryToMicromapInfoEXT malloc(MemoryStack stack)

Returns a new VkCopyMemoryToMicromapInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new VkCopyMemoryToMicromapInfoEXT.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 VkCopyMicromapModeEXT value specifying additional operations to perform during the copy.

Annotations
@NativeType:VkCopyMicromapModeEXT
modeback to summary
public VkCopyMemoryToMicromapInfoEXT 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 VkCopyMemoryToMicromapInfoEXT pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkCopyMemoryToMicromapInfoEXT set(VkCopyMemoryToMicromapInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkCopyMemoryToMicromapInfoEXT

the source struct

Returns:VkCopyMemoryToMicromapInfoEXT

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

Copies the specified VkDeviceOrHostAddressConstKHR to the src field.

srcback to summary
public VkCopyMemoryToMicromapInfoEXT 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 VkCopyMemoryToMicromapInfoEXT sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_COPY_MEMORY_TO_MICROMAP_INFO_EXT value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkCopyMemoryToMicromapInfoEXT.Buffer

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

An array of VkCopyMemoryToMicromapInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkCopyMemoryToMicromapInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkCopyMemoryToMicromapInfoEXT.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 VkCopyMemoryToMicromapInfoEXT#dst field.
dst
()

public VkCopyMemoryToMicromapInfoEXT.Buffer
dst(long value)

Sets the specified value to the VkCopyMemoryToMicromapInfoEXT#dst field.

protected VkCopyMemoryToMicromapInfoEXT
public int

Returns:

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

public VkCopyMemoryToMicromapInfoEXT.Buffer
mode(int value)

Sets the specified value to the VkCopyMemoryToMicromapInfoEXT#mode field.

public long

Returns:

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

public VkCopyMemoryToMicromapInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkCopyMemoryToMicromapInfoEXT#pNext field.

protected VkCopyMemoryToMicromapInfoEXT.Buffer
public VkDeviceOrHostAddressConstKHR
public VkCopyMemoryToMicromapInfoEXT.Buffer
public VkCopyMemoryToMicromapInfoEXT.Buffer
public int

Returns:

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

public VkCopyMemoryToMicromapInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkCopyMemoryToMicromapInfoEXT#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkCopyMemoryToMicromapInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkCopyMemoryToMicromapInfoEXT.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 VkCopyMemoryToMicromapInfoEXT#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 VkCopyMemoryToMicromapInfoEXT#dst field.

Annotations
@NativeType:VkMicromapEXT
dstback to summary
public VkCopyMemoryToMicromapInfoEXT.Buffer dst(long value)

Sets the specified value to the VkCopyMemoryToMicromapInfoEXT#dst field.

getElementFactoryback to summary
protected VkCopyMemoryToMicromapInfoEXT getElementFactory()

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

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

the value of the VkCopyMemoryToMicromapInfoEXT#mode field.

Annotations
@NativeType:VkCopyMicromapModeEXT
modeback to summary
public VkCopyMemoryToMicromapInfoEXT.Buffer mode(int value)

Sets the specified value to the VkCopyMemoryToMicromapInfoEXT#mode field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkCopyMemoryToMicromapInfoEXT#pNext field.

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

Sets the specified value to the VkCopyMemoryToMicromapInfoEXT#pNext field.

selfback to summary
protected VkCopyMemoryToMicromapInfoEXT.Buffer self()

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

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

a VkDeviceOrHostAddressConstKHR view of the VkCopyMemoryToMicromapInfoEXT#src field.

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

Copies the specified VkDeviceOrHostAddressConstKHR to the VkCopyMemoryToMicromapInfoEXT#src field.

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

Passes the VkCopyMemoryToMicromapInfoEXT#src field to the specified Consumer.

sTypeback to summary
public int sType()
Returns:int

the value of the VkCopyMemoryToMicromapInfoEXT#sType field.

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

Sets the specified value to the VkCopyMemoryToMicromapInfoEXT#sType field.

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

Sets the STRUCTURE_TYPE_COPY_MEMORY_TO_MICROMAP_INFO_EXT value to the VkCopyMemoryToMicromapInfoEXT#sType field.