Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkAccelerationStructureBuildSizesInfoKHR

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

GetAccelerationStructureBuildSizesKHR

Layout


struct VkAccelerationStructureBuildSizesInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkDeviceSize accelerationStructureSize;
    VkDeviceSize updateScratchSize;
    VkDeviceSize buildScratchSize;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ACCELERATIONSTRUCTURESIZE

The struct member offsets.

public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
BUILDSCRATCHSIZE

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.

public static final int
UPDATESCRATCHSIZE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkAccelerationStructureBuildSizesInfoKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public long
accelerationStructureSize()

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

public VkAccelerationStructureBuildSizesInfoKHR
accelerationStructureSize(long value)

Sets the specified value to the accelerationStructureSize field.

public long
buildScratchSize()

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

public VkAccelerationStructureBuildSizesInfoKHR
buildScratchSize(long value)

Sets the specified value to the buildScratchSize field.

public static VkAccelerationStructureBuildSizesInfoKHR
calloc()

Returns a new VkAccelerationStructureBuildSizesInfoKHR instance allocated with memCalloc.

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

Returns a new VkAccelerationStructureBuildSizesInfoKHR.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkAccelerationStructureBuildSizesInfoKHR instance allocated with BufferUtils.

public static VkAccelerationStructureBuildSizesInfoKHR
create(long address)

Returns a new VkAccelerationStructureBuildSizesInfoKHR instance for the specified memory address.

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

Returns a new VkAccelerationStructureBuildSizesInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkAccelerationStructureBuildSizesInfoKHR.Buffer instance at the specified memory.

public static VkAccelerationStructureBuildSizesInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkAccelerationStructureBuildSizesInfoKHR
malloc()

Returns a new VkAccelerationStructureBuildSizesInfoKHR instance allocated with memAlloc.

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

Returns a new VkAccelerationStructureBuildSizesInfoKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkAccelerationStructureBuildSizesInfoKHR instance allocated on the specified MemoryStack.

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

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

public static long
public static void
naccelerationStructureSize(long struct, long value)

Unsafe version of accelerationStructureSize.

public static long
nbuildScratchSize(long struct)

Unsafe version of buildScratchSize.

public static void
nbuildScratchSize(long struct, long value)

Unsafe version of buildScratchSize.

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 static long
nupdateScratchSize(long struct)

Unsafe version of updateScratchSize.

public static void
nupdateScratchSize(long struct, long value)

Unsafe version of updateScratchSize.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkAccelerationStructureBuildSizesInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkAccelerationStructureBuildSizesInfoKHR
set(int sType, long pNext, long accelerationStructureSize, long updateScratchSize, long buildScratchSize)

Initializes this struct with the specified values.

public VkAccelerationStructureBuildSizesInfoKHR

Returns:

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

Sets the specified value to the sType field.

public VkAccelerationStructureBuildSizesInfoKHR
public long
updateScratchSize()

the size in bytes required in a scratch buffer for an update operation.

public VkAccelerationStructureBuildSizesInfoKHR
updateScratchSize(long value)

Sets the specified value to the updateScratchSize field.

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

ACCELERATIONSTRUCTURESIZEback to summary
public static final int ACCELERATIONSTRUCTURESIZE

The struct member offsets.

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.

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.

UPDATESCRATCHSIZEback to summary
public static final int UPDATESCRATCHSIZE

The struct member offsets.

Constructor Detail

VkAccelerationStructureBuildSizesInfoKHRback to summary
protected VkAccelerationStructureBuildSizesInfoKHR(long address, ByteBuffer container)
VkAccelerationStructureBuildSizesInfoKHRback to summary
public VkAccelerationStructureBuildSizesInfoKHR(ByteBuffer container)

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

accelerationStructureSizeback to summary
public long accelerationStructureSize()

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

Annotations
@NativeType:VkDeviceSize
accelerationStructureSizeback to summary
public VkAccelerationStructureBuildSizesInfoKHR accelerationStructureSize(long value)

Sets the specified value to the accelerationStructureSize field.

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 VkAccelerationStructureBuildSizesInfoKHR buildScratchSize(long value)

Sets the specified value to the buildScratchSize field.

callocback to summary
public static VkAccelerationStructureBuildSizesInfoKHR calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkAccelerationStructureBuildSizesInfoKHR calloc(MemoryStack stack)

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

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

Returns a new VkAccelerationStructureBuildSizesInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkAccelerationStructureBuildSizesInfoKHR create(long address)

Returns a new VkAccelerationStructureBuildSizesInfoKHR instance for the specified memory address.

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

Returns a new VkAccelerationStructureBuildSizesInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkAccelerationStructureBuildSizesInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkAccelerationStructureBuildSizesInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkAccelerationStructureBuildSizesInfoKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkAccelerationStructureBuildSizesInfoKHR malloc(MemoryStack stack)

Returns a new VkAccelerationStructureBuildSizesInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

naccelerationStructureSizeback to summary
public static long naccelerationStructureSize(long struct)

Unsafe version of accelerationStructureSize.

naccelerationStructureSizeback to summary
public static void naccelerationStructureSize(long struct, long value)

Unsafe version of accelerationStructureSize.

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.

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.

nupdateScratchSizeback to summary
public static long nupdateScratchSize(long struct)

Unsafe version of updateScratchSize.

nupdateScratchSizeback to summary
public static void nupdateScratchSize(long struct, long value)

Unsafe version of updateScratchSize.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkAccelerationStructureBuildSizesInfoKHR set(int sType, long pNext, long accelerationStructureSize, long updateScratchSize, long buildScratchSize)

Initializes this struct with the specified values.

setback to summary
public VkAccelerationStructureBuildSizesInfoKHR set(VkAccelerationStructureBuildSizesInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkAccelerationStructureBuildSizesInfoKHR

the source struct

Returns:VkAccelerationStructureBuildSizesInfoKHR

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 VkAccelerationStructureBuildSizesInfoKHR sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_ACCELERATION_STRUCTURE_BUILD_SIZES_INFO_KHR value to the sType field.

updateScratchSizeback to summary
public long updateScratchSize()

the size in bytes required in a scratch buffer for an update operation.

Annotations
@NativeType:VkDeviceSize
updateScratchSizeback to summary
public VkAccelerationStructureBuildSizesInfoKHR updateScratchSize(long value)

Sets the specified value to the updateScratchSize field.

org.lwjgl.vulkan back to summary

public Class VkAccelerationStructureBuildSizesInfoKHR.Buffer

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

An array of VkAccelerationStructureBuildSizesInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkAccelerationStructureBuildSizesInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Sets the specified value to the VkAccelerationStructureBuildSizesInfoKHR#buildScratchSize field.

protected VkAccelerationStructureBuildSizesInfoKHR
public long

Returns:

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

public VkAccelerationStructureBuildSizesInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkAccelerationStructureBuildSizesInfoKHR#pNext field.

protected VkAccelerationStructureBuildSizesInfoKHR.Buffer
public int

Returns:

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

public VkAccelerationStructureBuildSizesInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkAccelerationStructureBuildSizesInfoKHR#sType field.

public VkAccelerationStructureBuildSizesInfoKHR.Buffer
public long
public VkAccelerationStructureBuildSizesInfoKHR.Buffer
updateScratchSize(long value)

Sets the specified value to the VkAccelerationStructureBuildSizesInfoKHR#updateScratchSize field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkAccelerationStructureBuildSizesInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

accelerationStructureSizeback to summary
public long accelerationStructureSize()
Returns:long

the value of the VkAccelerationStructureBuildSizesInfoKHR#accelerationStructureSize field.

Annotations
@NativeType:VkDeviceSize
accelerationStructureSizeback to summary
public VkAccelerationStructureBuildSizesInfoKHR.Buffer accelerationStructureSize(long value)

Sets the specified value to the VkAccelerationStructureBuildSizesInfoKHR#accelerationStructureSize field.

buildScratchSizeback to summary
public long buildScratchSize()
Returns:long

the value of the VkAccelerationStructureBuildSizesInfoKHR#buildScratchSize field.

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

Sets the specified value to the VkAccelerationStructureBuildSizesInfoKHR#buildScratchSize field.

getElementFactoryback to summary
protected VkAccelerationStructureBuildSizesInfoKHR getElementFactory()

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

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkAccelerationStructureBuildSizesInfoKHR#pNext field.

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

Sets the specified value to the VkAccelerationStructureBuildSizesInfoKHR#pNext field.

selfback to summary
protected VkAccelerationStructureBuildSizesInfoKHR.Buffer self()

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

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

the value of the VkAccelerationStructureBuildSizesInfoKHR#sType field.

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

Sets the specified value to the VkAccelerationStructureBuildSizesInfoKHR#sType field.

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

Sets the STRUCTURE_TYPE_ACCELERATION_STRUCTURE_BUILD_SIZES_INFO_KHR value to the VkAccelerationStructureBuildSizesInfoKHR#sType field.

updateScratchSizeback to summary
public long updateScratchSize()
Returns:long

the value of the VkAccelerationStructureBuildSizesInfoKHR#updateScratchSize field.

Annotations
@NativeType:VkDeviceSize
updateScratchSizeback to summary
public VkAccelerationStructureBuildSizesInfoKHR.Buffer updateScratchSize(long value)

Sets the specified value to the VkAccelerationStructureBuildSizesInfoKHR#updateScratchSize field.