Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkCopyMicromapInfoEXT

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

CmdCopyMicromapEXT, CopyMicromapEXT

Layout


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

public
VkCopyMicromapInfoEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkCopyMicromapInfoEXT
calloc()

Returns a new VkCopyMicromapInfoEXT instance allocated with memCalloc.

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

Returns a new VkCopyMicromapInfoEXT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkCopyMicromapInfoEXT instance allocated with BufferUtils.

public static VkCopyMicromapInfoEXT
create(long address)

Returns a new VkCopyMicromapInfoEXT instance for the specified memory address.

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

Returns a new VkCopyMicromapInfoEXT.Buffer instance allocated with BufferUtils.

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

Create a VkCopyMicromapInfoEXT.Buffer instance at the specified memory.

public static VkCopyMicromapInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkCopyMicromapInfoEXT.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 VkCopyMicromapInfoEXT
dst(long value)

Sets the specified value to the dst field.

public static VkCopyMicromapInfoEXT
malloc()

Returns a new VkCopyMicromapInfoEXT instance allocated with memAlloc.

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

Returns a new VkCopyMicromapInfoEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkCopyMicromapInfoEXT instance allocated on the specified MemoryStack.

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

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

public int
mode()

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

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

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkCopyMicromapInfoEXT

Returns:

this struct
set
(VkCopyMicromapInfoEXT
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 micromap for the copy.

public VkCopyMicromapInfoEXT
src(long value)

Sets the specified value to the src field.

public int
sType()

a VkStructureType value identifying this structure.

public VkCopyMicromapInfoEXT
sType(int value)

Sets the specified value to the sType field.

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

VkCopyMicromapInfoEXTback to summary
protected VkCopyMicromapInfoEXT(long address, ByteBuffer container)
VkCopyMicromapInfoEXTback to summary
public VkCopyMicromapInfoEXT(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkCopyMicromapInfoEXT calloc(MemoryStack stack)

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

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

Returns a new VkCopyMicromapInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkCopyMicromapInfoEXT create(long address)

Returns a new VkCopyMicromapInfoEXT instance for the specified memory address.

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

Returns a new VkCopyMicromapInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkCopyMicromapInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkCopyMicromapInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkCopyMicromapInfoEXT.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 VkCopyMicromapInfoEXT dst(long value)

Sets the specified value to the dst field.

mallocback to summary
public static VkCopyMicromapInfoEXT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkCopyMicromapInfoEXT malloc(MemoryStack stack)

Returns a new VkCopyMicromapInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new VkCopyMicromapInfoEXT.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 VkCopyMicromapInfoEXT 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 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 VkCopyMicromapInfoEXT pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkCopyMicromapInfoEXT set(VkCopyMicromapInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkCopyMicromapInfoEXT

the source struct

Returns:VkCopyMicromapInfoEXT

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 micromap for the copy.

Annotations
@NativeType:VkMicromapEXT
srcback to summary
public VkCopyMicromapInfoEXT 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 VkCopyMicromapInfoEXT sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_COPY_MICROMAP_INFO_EXT value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkCopyMicromapInfoEXT.Buffer

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

An array of VkCopyMicromapInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkCopyMicromapInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

public VkCopyMicromapInfoEXT.Buffer
dst(long value)

Sets the specified value to the VkCopyMicromapInfoEXT#dst field.

protected VkCopyMicromapInfoEXT
public int

Returns:

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

public VkCopyMicromapInfoEXT.Buffer
mode(int value)

Sets the specified value to the VkCopyMicromapInfoEXT#mode field.

public long

Returns:

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

public VkCopyMicromapInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkCopyMicromapInfoEXT#pNext field.

protected VkCopyMicromapInfoEXT.Buffer
public long

Returns:

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

public VkCopyMicromapInfoEXT.Buffer
src(long value)

Sets the specified value to the VkCopyMicromapInfoEXT#src field.

public int

Returns:

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

public VkCopyMicromapInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkCopyMicromapInfoEXT#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkCopyMicromapInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Sets the specified value to the VkCopyMicromapInfoEXT#dst field.

getElementFactoryback to summary
protected VkCopyMicromapInfoEXT getElementFactory()

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

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

the value of the VkCopyMicromapInfoEXT#mode field.

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

Sets the specified value to the VkCopyMicromapInfoEXT#mode field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkCopyMicromapInfoEXT#pNext field.

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

Sets the specified value to the VkCopyMicromapInfoEXT#pNext field.

selfback to summary
protected VkCopyMicromapInfoEXT.Buffer self()

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

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

the value of the VkCopyMicromapInfoEXT#src field.

Annotations
@NativeType:VkMicromapEXT
srcback to summary
public VkCopyMicromapInfoEXT.Buffer src(long value)

Sets the specified value to the VkCopyMicromapInfoEXT#src field.

sTypeback to summary
public int sType()
Returns:int

the value of the VkCopyMicromapInfoEXT#sType field.

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

Sets the specified value to the VkCopyMicromapInfoEXT#sType field.

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

Sets the STRUCTURE_TYPE_COPY_MICROMAP_INFO_EXT value to the VkCopyMicromapInfoEXT#sType field.