Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkAccelerationStructureBuildRangeInfoKHR

extends Struct<VkAccelerationStructureBuildRangeInfoKHR>
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 offsets and counts for acceleration structure builds.
Description

The primitive count and primitive offset are interpreted differently depending on the VkGeometryTypeKHR used:

Valid Usage
See Also

BuildAccelerationStructuresKHR, CmdBuildAccelerationStructuresKHR

Layout


struct VkAccelerationStructureBuildRangeInfoKHR {
    uint32_t primitiveCount;
    uint32_t primitiveOffset;
    uint32_t firstVertex;
    uint32_t transformOffset;
}

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
FIRSTVERTEX

The struct member offsets.

public static final int
PRIMITIVECOUNT

The struct member offsets.

public static final int
PRIMITIVEOFFSET

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TRANSFORMOFFSET

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkAccelerationStructureBuildRangeInfoKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkAccelerationStructureBuildRangeInfoKHR
calloc()

Returns a new VkAccelerationStructureBuildRangeInfoKHR instance allocated with memCalloc.

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

Returns a new VkAccelerationStructureBuildRangeInfoKHR.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkAccelerationStructureBuildRangeInfoKHR instance allocated with BufferUtils.

public static VkAccelerationStructureBuildRangeInfoKHR
create(long address)

Returns a new VkAccelerationStructureBuildRangeInfoKHR instance for the specified memory address.

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

Returns a new VkAccelerationStructureBuildRangeInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkAccelerationStructureBuildRangeInfoKHR.Buffer instance at the specified memory.

public static VkAccelerationStructureBuildRangeInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
firstVertex()

the index of the first vertex to build from for triangle geometry.

public VkAccelerationStructureBuildRangeInfoKHR
firstVertex(int value)

Sets the specified value to the firstVertex field.

public static VkAccelerationStructureBuildRangeInfoKHR
malloc()

Returns a new VkAccelerationStructureBuildRangeInfoKHR instance allocated with memAlloc.

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

Returns a new VkAccelerationStructureBuildRangeInfoKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkAccelerationStructureBuildRangeInfoKHR instance allocated on the specified MemoryStack.

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

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

public static int
nfirstVertex(long struct)

Unsafe version of firstVertex.

public static void
nfirstVertex(long struct, int value)

Unsafe version of firstVertex.

public static int
nprimitiveCount(long struct)

Unsafe version of primitiveCount.

public static void
nprimitiveCount(long struct, int value)

Unsafe version of primitiveCount.

public static int
nprimitiveOffset(long struct)

Unsafe version of primitiveOffset.

public static void
nprimitiveOffset(long struct, int value)

Unsafe version of primitiveOffset.

public static int
ntransformOffset(long struct)

Unsafe version of transformOffset.

public static void
ntransformOffset(long struct, int value)

Unsafe version of transformOffset.

public int
primitiveCount()

defines the number of primitives for a corresponding acceleration structure geometry.

public VkAccelerationStructureBuildRangeInfoKHR
primitiveCount(int value)

Sets the specified value to the primitiveCount field.

public int
primitiveOffset()

defines an offset in bytes into the memory where primitive data is defined.

public VkAccelerationStructureBuildRangeInfoKHR
primitiveOffset(int value)

Sets the specified value to the primitiveOffset field.

public VkAccelerationStructureBuildRangeInfoKHR
set(int primitiveCount, int primitiveOffset, int firstVertex, int transformOffset)

Initializes this struct with the specified values.

public VkAccelerationStructureBuildRangeInfoKHR

Returns:

this struct
set
(VkAccelerationStructureBuildRangeInfoKHR
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
transformOffset()

defines an offset in bytes into the memory where a transform matrix is defined.

public VkAccelerationStructureBuildRangeInfoKHR
transformOffset(int value)

Sets the specified value to the transformOffset 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

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

FIRSTVERTEXback to summary
public static final int FIRSTVERTEX

The struct member offsets.

PRIMITIVECOUNTback to summary
public static final int PRIMITIVECOUNT

The struct member offsets.

PRIMITIVEOFFSETback to summary
public static final int PRIMITIVEOFFSET

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TRANSFORMOFFSETback to summary
public static final int TRANSFORMOFFSET

The struct member offsets.

Constructor Detail

VkAccelerationStructureBuildRangeInfoKHRback to summary
protected VkAccelerationStructureBuildRangeInfoKHR(long address, ByteBuffer container)
VkAccelerationStructureBuildRangeInfoKHRback to summary
public VkAccelerationStructureBuildRangeInfoKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkAccelerationStructureBuildRangeInfoKHR calloc(MemoryStack stack)

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

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

Returns a new VkAccelerationStructureBuildRangeInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkAccelerationStructureBuildRangeInfoKHR create(long address)

Returns a new VkAccelerationStructureBuildRangeInfoKHR instance for the specified memory address.

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

Returns a new VkAccelerationStructureBuildRangeInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkAccelerationStructureBuildRangeInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkAccelerationStructureBuildRangeInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
firstVertexback to summary
public int firstVertex()

the index of the first vertex to build from for triangle geometry.

Annotations
@NativeType:uint32_t
firstVertexback to summary
public VkAccelerationStructureBuildRangeInfoKHR firstVertex(int value)

Sets the specified value to the firstVertex field.

mallocback to summary
public static VkAccelerationStructureBuildRangeInfoKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkAccelerationStructureBuildRangeInfoKHR malloc(MemoryStack stack)

Returns a new VkAccelerationStructureBuildRangeInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nfirstVertexback to summary
public static int nfirstVertex(long struct)

Unsafe version of firstVertex.

nfirstVertexback to summary
public static void nfirstVertex(long struct, int value)

Unsafe version of firstVertex.

nprimitiveCountback to summary
public static int nprimitiveCount(long struct)

Unsafe version of primitiveCount.

nprimitiveCountback to summary
public static void nprimitiveCount(long struct, int value)

Unsafe version of primitiveCount.

nprimitiveOffsetback to summary
public static int nprimitiveOffset(long struct)

Unsafe version of primitiveOffset.

nprimitiveOffsetback to summary
public static void nprimitiveOffset(long struct, int value)

Unsafe version of primitiveOffset.

ntransformOffsetback to summary
public static int ntransformOffset(long struct)

Unsafe version of transformOffset.

ntransformOffsetback to summary
public static void ntransformOffset(long struct, int value)

Unsafe version of transformOffset.

primitiveCountback to summary
public int primitiveCount()

defines the number of primitives for a corresponding acceleration structure geometry.

Annotations
@NativeType:uint32_t
primitiveCountback to summary
public VkAccelerationStructureBuildRangeInfoKHR primitiveCount(int value)

Sets the specified value to the primitiveCount field.

primitiveOffsetback to summary
public int primitiveOffset()

defines an offset in bytes into the memory where primitive data is defined.

Annotations
@NativeType:uint32_t
primitiveOffsetback to summary
public VkAccelerationStructureBuildRangeInfoKHR primitiveOffset(int value)

Sets the specified value to the primitiveOffset field.

setback to summary
public VkAccelerationStructureBuildRangeInfoKHR set(int primitiveCount, int primitiveOffset, int firstVertex, int transformOffset)

Initializes this struct with the specified values.

setback to summary
public VkAccelerationStructureBuildRangeInfoKHR set(VkAccelerationStructureBuildRangeInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkAccelerationStructureBuildRangeInfoKHR

the source struct

Returns:VkAccelerationStructureBuildRangeInfoKHR

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
transformOffsetback to summary
public int transformOffset()

defines an offset in bytes into the memory where a transform matrix is defined.

Annotations
@NativeType:uint32_t
transformOffsetback to summary
public VkAccelerationStructureBuildRangeInfoKHR transformOffset(int value)

Sets the specified value to the transformOffset field.

org.lwjgl.vulkan back to summary

public Class VkAccelerationStructureBuildRangeInfoKHR.Buffer

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

An array of VkAccelerationStructureBuildRangeInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkAccelerationStructureBuildRangeInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkAccelerationStructureBuildRangeInfoKHR.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 int
public VkAccelerationStructureBuildRangeInfoKHR.Buffer
firstVertex(int value)

Sets the specified value to the VkAccelerationStructureBuildRangeInfoKHR#firstVertex field.

protected VkAccelerationStructureBuildRangeInfoKHR
public int
public VkAccelerationStructureBuildRangeInfoKHR.Buffer
primitiveCount(int value)

Sets the specified value to the VkAccelerationStructureBuildRangeInfoKHR#primitiveCount field.

public int
public VkAccelerationStructureBuildRangeInfoKHR.Buffer
primitiveOffset(int value)

Sets the specified value to the VkAccelerationStructureBuildRangeInfoKHR#primitiveOffset field.

protected VkAccelerationStructureBuildRangeInfoKHR.Buffer
public int
public VkAccelerationStructureBuildRangeInfoKHR.Buffer
transformOffset(int value)

Sets the specified value to the VkAccelerationStructureBuildRangeInfoKHR#transformOffset field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkAccelerationStructureBuildRangeInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

firstVertexback to summary
public int firstVertex()
Returns:int

the value of the VkAccelerationStructureBuildRangeInfoKHR#firstVertex field.

Annotations
@NativeType:uint32_t
firstVertexback to summary
public VkAccelerationStructureBuildRangeInfoKHR.Buffer firstVertex(int value)

Sets the specified value to the VkAccelerationStructureBuildRangeInfoKHR#firstVertex field.

getElementFactoryback to summary
protected VkAccelerationStructureBuildRangeInfoKHR getElementFactory()

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

Annotations
@Override
primitiveCountback to summary
public int primitiveCount()
Returns:int

the value of the VkAccelerationStructureBuildRangeInfoKHR#primitiveCount field.

Annotations
@NativeType:uint32_t
primitiveCountback to summary
public VkAccelerationStructureBuildRangeInfoKHR.Buffer primitiveCount(int value)

Sets the specified value to the VkAccelerationStructureBuildRangeInfoKHR#primitiveCount field.

primitiveOffsetback to summary
public int primitiveOffset()
Returns:int

the value of the VkAccelerationStructureBuildRangeInfoKHR#primitiveOffset field.

Annotations
@NativeType:uint32_t
primitiveOffsetback to summary
public VkAccelerationStructureBuildRangeInfoKHR.Buffer primitiveOffset(int value)

Sets the specified value to the VkAccelerationStructureBuildRangeInfoKHR#primitiveOffset field.

selfback to summary
protected VkAccelerationStructureBuildRangeInfoKHR.Buffer self()

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

Annotations
@Override
transformOffsetback to summary
public int transformOffset()
Returns:int

the value of the VkAccelerationStructureBuildRangeInfoKHR#transformOffset field.

Annotations
@NativeType:uint32_t
transformOffsetback to summary
public VkAccelerationStructureBuildRangeInfoKHR.Buffer transformOffset(int value)

Sets the specified value to the VkAccelerationStructureBuildRangeInfoKHR#transformOffset field.