Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkMicromapBuildSizesInfoEXT

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

Structure specifying build sizes for a micromap.
Valid Usage (Implicit)
See Also

GetMicromapBuildSizesEXT

Layout


struct VkMicromapBuildSizesInfoEXT {
    VkStructureType sType;
    void const * pNext;
    VkDeviceSize micromapSize;
    VkDeviceSize buildScratchSize;
    VkBool32 discardable;
}

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
BUILDSCRATCHSIZE

The struct member offsets.

public static final int
DISCARDABLE

The struct member offsets.

public static final int
MICROMAPSIZE

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
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkMicromapBuildSizesInfoEXT(long address, ByteBuffer container)

public
VkMicromapBuildSizesInfoEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public long
buildScratchSize()

the size in bytes required in a scratch buffer for a build operation.

public VkMicromapBuildSizesInfoEXT
buildScratchSize(long value)

Sets the specified value to the buildScratchSize field.

public static VkMicromapBuildSizesInfoEXT
calloc()

Returns a new VkMicromapBuildSizesInfoEXT instance allocated with memCalloc.

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

Returns a new VkMicromapBuildSizesInfoEXT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkMicromapBuildSizesInfoEXT instance allocated with BufferUtils.

public static VkMicromapBuildSizesInfoEXT
create(long address)

Returns a new VkMicromapBuildSizesInfoEXT instance for the specified memory address.

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

Returns a new VkMicromapBuildSizesInfoEXT.Buffer instance allocated with BufferUtils.

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

Create a VkMicromapBuildSizesInfoEXT.Buffer instance at the specified memory.

public static VkMicromapBuildSizesInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public boolean
discardable()

indicates whether or not the micromap object may be destroyed after an acceleration structure build or update.

public VkMicromapBuildSizesInfoEXT
discardable(boolean value)

Sets the specified value to the discardable field.

public static VkMicromapBuildSizesInfoEXT
malloc()

Returns a new VkMicromapBuildSizesInfoEXT instance allocated with memAlloc.

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

Returns a new VkMicromapBuildSizesInfoEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkMicromapBuildSizesInfoEXT instance allocated on the specified MemoryStack.

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

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

public long
micromapSize()

the size in bytes required in a VkMicromapEXT for a build or update operation.

public VkMicromapBuildSizesInfoEXT
micromapSize(long value)

Sets the specified value to the micromapSize field.

public static long
nbuildScratchSize(long struct)

Unsafe version of buildScratchSize.

public static void
nbuildScratchSize(long struct, long value)

Unsafe version of buildScratchSize.

public static int
ndiscardable(long struct)

Unsafe version of discardable.

public static void
ndiscardable(long struct, int value)

Unsafe version of discardable.

public static long
nmicromapSize(long struct)

Unsafe version of micromapSize.

public static void
nmicromapSize(long struct, long value)

Unsafe version of micromapSize.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

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

Sets the specified value to the pNext field.

public VkMicromapBuildSizesInfoEXT
set(int sType, long pNext, long micromapSize, long buildScratchSize, boolean discardable)

Initializes this struct with the specified values.

public VkMicromapBuildSizesInfoEXT

Returns:

this struct
set
(VkMicromapBuildSizesInfoEXT
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 int
sType()

a VkStructureType value identifying this structure.

public VkMicromapBuildSizesInfoEXT
sType(int value)

Sets the specified value to the sType field.

public VkMicromapBuildSizesInfoEXT
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.

BUILDSCRATCHSIZEback to summary
public static final int BUILDSCRATCHSIZE

The struct member offsets.

DISCARDABLEback to summary
public static final int DISCARDABLE

The struct member offsets.

MICROMAPSIZEback to summary
public static final int MICROMAPSIZE

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.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkMicromapBuildSizesInfoEXTback to summary
protected VkMicromapBuildSizesInfoEXT(long address, ByteBuffer container)
VkMicromapBuildSizesInfoEXTback to summary
public VkMicromapBuildSizesInfoEXT(ByteBuffer container)

Creates a VkMicromapBuildSizesInfoEXT 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

buildScratchSizeback to summary
public long buildScratchSize()

the size in bytes required in a scratch buffer for a build operation.

Annotations
@NativeType:VkDeviceSize
buildScratchSizeback to summary
public VkMicromapBuildSizesInfoEXT buildScratchSize(long value)

Sets the specified value to the buildScratchSize field.

callocback to summary
public static VkMicromapBuildSizesInfoEXT calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkMicromapBuildSizesInfoEXT calloc(MemoryStack stack)

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

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

Returns a new VkMicromapBuildSizesInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkMicromapBuildSizesInfoEXT create(long address)

Returns a new VkMicromapBuildSizesInfoEXT instance for the specified memory address.

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

Returns a new VkMicromapBuildSizesInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkMicromapBuildSizesInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkMicromapBuildSizesInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
discardableback to summary
public boolean discardable()

indicates whether or not the micromap object may be destroyed after an acceleration structure build or update. A false value means that acceleration structures built with this micromap may contain references to the data contained therein, and the application must not destroy the micromap until ray traversal has concluded. A true value means that the information in the micromap will be copied by value into the acceleration structure, and the micromap may be destroyed after the acceleration structure build concludes.

Annotations
@NativeType:VkBool32
discardableback to summary
public VkMicromapBuildSizesInfoEXT discardable(boolean value)

Sets the specified value to the discardable field.

mallocback to summary
public static VkMicromapBuildSizesInfoEXT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkMicromapBuildSizesInfoEXT malloc(MemoryStack stack)

Returns a new VkMicromapBuildSizesInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

micromapSizeback to summary
public long micromapSize()

the size in bytes required in a VkMicromapEXT for a build or update operation.

Annotations
@NativeType:VkDeviceSize
micromapSizeback to summary
public VkMicromapBuildSizesInfoEXT micromapSize(long value)

Sets the specified value to the micromapSize field.

nbuildScratchSizeback to summary
public static long nbuildScratchSize(long struct)

Unsafe version of buildScratchSize.

nbuildScratchSizeback to summary
public static void nbuildScratchSize(long struct, long value)

Unsafe version of buildScratchSize.

ndiscardableback to summary
public static int ndiscardable(long struct)

Unsafe version of discardable.

ndiscardableback to summary
public static void ndiscardable(long struct, int value)

Unsafe version of discardable.

nmicromapSizeback to summary
public static long nmicromapSize(long struct)

Unsafe version of micromapSize.

nmicromapSizeback to summary
public static void nmicromapSize(long struct, long value)

Unsafe version of micromapSize.

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.

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

Sets the specified value to the pNext field.

setback to summary
public VkMicromapBuildSizesInfoEXT set(int sType, long pNext, long micromapSize, long buildScratchSize, boolean discardable)

Initializes this struct with the specified values.

setback to summary
public VkMicromapBuildSizesInfoEXT set(VkMicromapBuildSizesInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkMicromapBuildSizesInfoEXT

the source struct

Returns:VkMicromapBuildSizesInfoEXT

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
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_MICROMAP_BUILD_SIZES_INFO_EXT value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkMicromapBuildSizesInfoEXT.Buffer

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

An array of VkMicromapBuildSizesInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkMicromapBuildSizesInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkMicromapBuildSizesInfoEXT.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
public VkMicromapBuildSizesInfoEXT.Buffer
buildScratchSize(long value)

Sets the specified value to the VkMicromapBuildSizesInfoEXT#buildScratchSize field.

public boolean

Returns:

the value of the VkMicromapBuildSizesInfoEXT#discardable field.
discardable
()

public VkMicromapBuildSizesInfoEXT.Buffer
discardable(boolean value)

Sets the specified value to the VkMicromapBuildSizesInfoEXT#discardable field.

protected VkMicromapBuildSizesInfoEXT
public long

Returns:

the value of the VkMicromapBuildSizesInfoEXT#micromapSize field.
micromapSize
()

public VkMicromapBuildSizesInfoEXT.Buffer
micromapSize(long value)

Sets the specified value to the VkMicromapBuildSizesInfoEXT#micromapSize field.

public long

Returns:

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

public VkMicromapBuildSizesInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkMicromapBuildSizesInfoEXT#pNext field.

protected VkMicromapBuildSizesInfoEXT.Buffer
public int

Returns:

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

public VkMicromapBuildSizesInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkMicromapBuildSizesInfoEXT#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkMicromapBuildSizesInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkMicromapBuildSizesInfoEXT.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 VkMicromapBuildSizesInfoEXT#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

buildScratchSizeback to summary
public long buildScratchSize()
Returns:long

the value of the VkMicromapBuildSizesInfoEXT#buildScratchSize field.

Annotations
@NativeType:VkDeviceSize
buildScratchSizeback to summary
public VkMicromapBuildSizesInfoEXT.Buffer buildScratchSize(long value)

Sets the specified value to the VkMicromapBuildSizesInfoEXT#buildScratchSize field.

discardableback to summary
public boolean discardable()
Returns:boolean

the value of the VkMicromapBuildSizesInfoEXT#discardable field.

Annotations
@NativeType:VkBool32
discardableback to summary
public VkMicromapBuildSizesInfoEXT.Buffer discardable(boolean value)

Sets the specified value to the VkMicromapBuildSizesInfoEXT#discardable field.

getElementFactoryback to summary
protected VkMicromapBuildSizesInfoEXT getElementFactory()

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

Annotations
@Override
micromapSizeback to summary
public long micromapSize()
Returns:long

the value of the VkMicromapBuildSizesInfoEXT#micromapSize field.

Annotations
@NativeType:VkDeviceSize
micromapSizeback to summary
public VkMicromapBuildSizesInfoEXT.Buffer micromapSize(long value)

Sets the specified value to the VkMicromapBuildSizesInfoEXT#micromapSize field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkMicromapBuildSizesInfoEXT#pNext field.

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

Sets the specified value to the VkMicromapBuildSizesInfoEXT#pNext field.

selfback to summary
protected VkMicromapBuildSizesInfoEXT.Buffer self()

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

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkMicromapBuildSizesInfoEXT#sType field.

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

Sets the specified value to the VkMicromapBuildSizesInfoEXT#sType field.

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

Sets the STRUCTURE_TYPE_MICROMAP_BUILD_SIZES_INFO_EXT value to the VkMicromapBuildSizesInfoEXT#sType field.