Package org.lwjgl.vulkan

Class VkAccelerationStructureBuildRangeInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkAccelerationStructureBuildRangeInfoKHR>

org.lwjgl.vulkan.VkAccelerationStructureBuildRangeInfoKHR

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkAccelerationStructureBuildRangeInfoKHR
extends org.lwjgl.system.Struct<VkAccelerationStructureBuildRangeInfoKHR>
implements org.lwjgl.system.NativeResource

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:

• For geometries of type GEOMETRY_TYPE_TRIANGLES_KHR, primitiveCount is the number of triangles to be built, where each triangle is treated as 3 vertices.
  • If the geometry uses indices, primitiveCount × 3 indices are consumed from VkAccelerationStructureGeometryTrianglesDataKHR::indexData, starting at an offset of primitiveOffset. The value of firstVertex is added to the index values before fetching vertices.
  • If the geometry does not use indices, primitiveCount × 3 vertices are consumed from VkAccelerationStructureGeometryTrianglesDataKHR::vertexData, starting at an offset of primitiveOffset + VkAccelerationStructureGeometryTrianglesDataKHR::vertexStride × firstVertex.
  • If VkAccelerationStructureGeometryTrianglesDataKHR::transformData is not NULL, a single VkTransformMatrixKHR structure is consumed from VkAccelerationStructureGeometryTrianglesDataKHR::transformData, at an offset of transformOffset. This matrix describes a transformation from the space in which the vertices for all triangles in this geometry are described to the space in which the acceleration structure is defined.
• For geometries of type GEOMETRY_TYPE_AABBS_KHR, primitiveCount is the number of axis-aligned bounding boxes. primitiveCount VkAabbPositionsKHR structures are consumed from VkAccelerationStructureGeometryAabbsDataKHR::data, starting at an offset of primitiveOffset.
• For geometries of type GEOMETRY_TYPE_INSTANCES_KHR, primitiveCount is the number of acceleration structures. primitiveCount VkAccelerationStructureInstanceKHR or VkAccelerationStructureMotionInstanceNV structures are consumed from VkAccelerationStructureGeometryInstancesDataKHR::data, starting at an offset of primitiveOffset.

Valid Usage

• For geometries of type GEOMETRY_TYPE_TRIANGLES_KHR, if the geometry uses indices, the offset primitiveOffset from VkAccelerationStructureGeometryTrianglesDataKHR::indexData must be a multiple of the element size of VkAccelerationStructureGeometryTrianglesDataKHR::indexType
• For geometries of type GEOMETRY_TYPE_TRIANGLES_KHR, if the geometry does not use indices, the offset primitiveOffset from VkAccelerationStructureGeometryTrianglesDataKHR::vertexData must be a multiple of the component size of VkAccelerationStructureGeometryTrianglesDataKHR::vertexFormat
• For geometries of type GEOMETRY_TYPE_TRIANGLES_KHR, the offset transformOffset from VkAccelerationStructureGeometryTrianglesDataKHR::transformData must be a multiple of 16
• For geometries of type GEOMETRY_TYPE_AABBS_KHR, the offset primitiveOffset from VkAccelerationStructureGeometryAabbsDataKHR::data must be a multiple of 8
• For geometries of type GEOMETRY_TYPE_INSTANCES_KHR, the offset primitiveOffset from VkAccelerationStructureGeometryInstancesDataKHR::data must be a multiple of 16

See Also

BuildAccelerationStructuresKHR, CmdBuildAccelerationStructuresKHR

Layout

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkAccelerationStructureBuildRangeInfoKHR.Buffer	An array of VkAccelerationStructureBuildRangeInfoKHR structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	FIRSTVERTEX	The struct member offsets.
static final int	PRIMITIVECOUNT	The struct member offsets.
static final int	PRIMITIVEOFFSET	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TRANSFORMOFFSET	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkAccelerationStructureBuildRangeInfoKHR(ByteBuffer container)	Creates a VkAccelerationStructureBuildRangeInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkAccelerationStructureBuildRangeInfoKHR	calloc()	Returns a new VkAccelerationStructureBuildRangeInfoKHR instance allocated with memCalloc.
static VkAccelerationStructureBuildRangeInfoKHR.Buffer	calloc(int capacity)	Returns a new VkAccelerationStructureBuildRangeInfoKHR.Buffer instance allocated with memCalloc.
static VkAccelerationStructureBuildRangeInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureBuildRangeInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAccelerationStructureBuildRangeInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureBuildRangeInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAccelerationStructureBuildRangeInfoKHR	create()	Returns a new VkAccelerationStructureBuildRangeInfoKHR instance allocated with BufferUtils.
static VkAccelerationStructureBuildRangeInfoKHR.Buffer	create(int capacity)	Returns a new VkAccelerationStructureBuildRangeInfoKHR.Buffer instance allocated with BufferUtils.
static VkAccelerationStructureBuildRangeInfoKHR	create(long address)	Returns a new VkAccelerationStructureBuildRangeInfoKHR instance for the specified memory address.
static VkAccelerationStructureBuildRangeInfoKHR.Buffer	create(long address, int capacity)	Create a VkAccelerationStructureBuildRangeInfoKHR.Buffer instance at the specified memory.
static @Nullable VkAccelerationStructureBuildRangeInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkAccelerationStructureBuildRangeInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	firstVertex()	the index of the first vertex to build from for triangle geometry.
VkAccelerationStructureBuildRangeInfoKHR	firstVertex(int value)	Sets the specified value to the firstVertex() field.
static VkAccelerationStructureBuildRangeInfoKHR	malloc()	Returns a new VkAccelerationStructureBuildRangeInfoKHR instance allocated with memAlloc.
static VkAccelerationStructureBuildRangeInfoKHR.Buffer	malloc(int capacity)	Returns a new VkAccelerationStructureBuildRangeInfoKHR.Buffer instance allocated with memAlloc.
static VkAccelerationStructureBuildRangeInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureBuildRangeInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkAccelerationStructureBuildRangeInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureBuildRangeInfoKHR instance allocated on the specified MemoryStack.
static int	nfirstVertex(long struct)	Unsafe version of firstVertex().
static void	nfirstVertex(long struct, int value)	Unsafe version of firstVertex.
static int	nprimitiveCount(long struct)	Unsafe version of primitiveCount().
static void	nprimitiveCount(long struct, int value)	Unsafe version of primitiveCount.
static int	nprimitiveOffset(long struct)	Unsafe version of primitiveOffset().
static void	nprimitiveOffset(long struct, int value)	Unsafe version of primitiveOffset.
static int	ntransformOffset(long struct)	Unsafe version of transformOffset().
static void	ntransformOffset(long struct, int value)	Unsafe version of transformOffset.
int	primitiveCount()	defines the number of primitives for a corresponding acceleration structure geometry.
VkAccelerationStructureBuildRangeInfoKHR	primitiveCount(int value)	Sets the specified value to the primitiveCount() field.
int	primitiveOffset()	defines an offset in bytes into the memory where primitive data is defined.
VkAccelerationStructureBuildRangeInfoKHR	primitiveOffset(int value)	Sets the specified value to the primitiveOffset() field.
VkAccelerationStructureBuildRangeInfoKHR	set(int primitiveCount, int primitiveOffset, int firstVertex, int transformOffset)	Initializes this struct with the specified values.
VkAccelerationStructureBuildRangeInfoKHR	set(VkAccelerationStructureBuildRangeInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	transformOffset()	defines an offset in bytes into the memory where a transform matrix is defined.
VkAccelerationStructureBuildRangeInfoKHR	transformOffset(int value)	Sets the specified value to the transformOffset() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

PRIMITIVECOUNT

public static final int PRIMITIVECOUNT

The struct member offsets.

PRIMITIVEOFFSET

public static final int PRIMITIVEOFFSET

The struct member offsets.

FIRSTVERTEX

public static final int FIRSTVERTEX

The struct member offsets.

TRANSFORMOFFSET

public static final int TRANSFORMOFFSET

The struct member offsets.

Constructor Details

VkAccelerationStructureBuildRangeInfoKHR

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkAccelerationStructureBuildRangeInfoKHR>

primitiveCount

public int primitiveCount()

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

primitiveOffset

public int primitiveOffset()

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

firstVertex

public int firstVertex()

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

transformOffset

public int transformOffset()

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

primitiveCount

public VkAccelerationStructureBuildRangeInfoKHR primitiveCount(int value)

Sets the specified value to the primitiveCount() field.

primitiveOffset

public VkAccelerationStructureBuildRangeInfoKHR primitiveOffset(int value)

Sets the specified value to the primitiveOffset() field.

firstVertex

public VkAccelerationStructureBuildRangeInfoKHR firstVertex(int value)

Sets the specified value to the firstVertex() field.

transformOffset

public VkAccelerationStructureBuildRangeInfoKHR transformOffset(int value)

Sets the specified value to the transformOffset() field.

set

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

Initializes this struct with the specified values.

set

public VkAccelerationStructureBuildRangeInfoKHR set(VkAccelerationStructureBuildRangeInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkAccelerationStructureBuildRangeInfoKHR malloc()

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

calloc

public static VkAccelerationStructureBuildRangeInfoKHR calloc()

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

create

public static VkAccelerationStructureBuildRangeInfoKHR create()

Returns a new VkAccelerationStructureBuildRangeInfoKHR instance allocated with BufferUtils.

create

public static VkAccelerationStructureBuildRangeInfoKHR create(long address)

Returns a new VkAccelerationStructureBuildRangeInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkAccelerationStructureBuildRangeInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkAccelerationStructureBuildRangeInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkAccelerationStructureBuildRangeInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkAccelerationStructureBuildRangeInfoKHR.Buffer create(int capacity)

Returns a new VkAccelerationStructureBuildRangeInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkAccelerationStructureBuildRangeInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkAccelerationStructureBuildRangeInfoKHR malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkAccelerationStructureBuildRangeInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkAccelerationStructureBuildRangeInfoKHR calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkAccelerationStructureBuildRangeInfoKHR.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkAccelerationStructureBuildRangeInfoKHR.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nprimitiveCount

public static int nprimitiveCount(long struct)

Unsafe version of primitiveCount().

nprimitiveOffset

public static int nprimitiveOffset(long struct)

Unsafe version of primitiveOffset().

nfirstVertex

public static int nfirstVertex(long struct)

Unsafe version of firstVertex().

ntransformOffset

public static int ntransformOffset(long struct)

Unsafe version of transformOffset().

nprimitiveCount

public static void nprimitiveCount(long struct,
 int value)

Unsafe version of primitiveCount.

nprimitiveOffset

public static void nprimitiveOffset(long struct,
 int value)

Unsafe version of primitiveOffset.

nfirstVertex

public static void nfirstVertex(long struct,
 int value)

Unsafe version of firstVertex.

ntransformOffset

public static void ntransformOffset(long struct,
 int value)

Unsafe version of transformOffset.