LWJGL 3.3.3 · org.lwjgl.vulkan.VkAccelerationStructureGeometryTrianglesDataKHR

Structure specifying a triangle geometry in a bottom-level acceleration structure.

Description

Note

Unlike the stride for vertex buffers in VkVertexInputBindingDescription for graphics pipelines which must not exceed maxVertexInputBindingStride, vertexStride for acceleration structure geometry is instead restricted to being a 32-bit value.

Valid Usage

vertexStride must be a multiple of the size in bytes of the smallest component of vertexFormat
vertexStride must be less than or equal to 2³²-1
The format features of vertexFormat must contain FORMAT_FEATURE_ACCELERATION_STRUCTURE_VERTEX_BUFFER_BIT_KHR
indexType must be INDEX_TYPE_UINT16, INDEX_TYPE_UINT32, or INDEX_TYPE_NONE_KHR

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_TRIANGLES_DATA_KHR
Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkAccelerationStructureGeometryMotionTrianglesDataNV, VkAccelerationStructureTrianglesDisplacementMicromapNV, or VkAccelerationStructureTrianglesOpacityMicromapEXT
The sType value of each struct in the pNext chain must be unique
vertexFormat must be a valid VkFormat value
indexType must be a valid VkIndexType value

Layout


struct VkAccelerationStructureGeometryTrianglesDataKHR {
    VkStructureType sType;
    void const * pNext;
    VkFormat vertexFormat;
    VkDeviceOrHostAddressConstKHR vertexData;
    VkDeviceSize vertexStride;
    uint32_t maxVertex;
    VkIndexType indexType;
    VkDeviceOrHostAddressConstKHR indexData;
    VkDeviceOrHostAddressConstKHR transformData;
}

Modifier and Type	Class and Description
public static class	VkAccelerationStructureGeometryTrianglesDataKHR.Buffer An array of `VkAccelerationStructureGeometryTrianglesDataKHR` structs.

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	INDEXDATA The struct member offsets.
public static final int	INDEXTYPE The struct member offsets.
public static final int	MAXVERTEX 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	TRANSFORMDATA The struct member offsets.
public static final int	VERTEXDATA The struct member offsets.
public static final int	VERTEXFORMAT The struct member offsets.
public static final int	VERTEXSTRIDE The struct member offsets.

Access	Constructor and Description
protected	VkAccelerationStructureGeometryTrianglesDataKHR(long address, ByteBuffer container)
public	VkAccelerationStructureGeometryTrianglesDataKHR(ByteBuffer container) Creates a `VkAccelerationStructureGeometryTrianglesDataKHR` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static VkAccelerationStructureGeometryTrianglesDataKHR	calloc() Returns a new `VkAccelerationStructureGeometryTrianglesDataKHR` instance allocated with `memCalloc`.
public static VkAccelerationStructureGeometryTrianglesDataKHR.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkAccelerationStructureGeometryTrianglesDataKHR.Buffer` instance allocated with `memCalloc`.
public static VkAccelerationStructureGeometryTrianglesDataKHR	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkAccelerationStructureGeometryTrianglesDataKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkAccelerationStructureGeometryTrianglesDataKHR.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkAccelerationStructureGeometryTrianglesDataKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected VkAccelerationStructureGeometryTrianglesDataKHR	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 VkAccelerationStructureGeometryTrianglesDataKHR	create() Returns a new `VkAccelerationStructureGeometryTrianglesDataKHR` instance allocated with `BufferUtils`.
public static VkAccelerationStructureGeometryTrianglesDataKHR	create(long address) Returns a new `VkAccelerationStructureGeometryTrianglesDataKHR` instance for the specified memory address.
public static VkAccelerationStructureGeometryTrianglesDataKHR.Buffer	create(int the buffer capacity capacity) Returns a new `VkAccelerationStructureGeometryTrianglesDataKHR.Buffer` instance allocated with `BufferUtils`.
public static VkAccelerationStructureGeometryTrianglesDataKHR.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkAccelerationStructureGeometryTrianglesDataKHR.Buffer` instance at the specified memory.
public static VkAccelerationStructureGeometryTrianglesDataKHR	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkAccelerationStructureGeometryTrianglesDataKHR.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public VkDeviceOrHostAddressConstKHR	indexData() a device or host address to memory containing index data for this geometry.
public VkAccelerationStructureGeometryTrianglesDataKHR	indexData(VkDeviceOrHostAddressConstKHR value) Copies the specified `VkDeviceOrHostAddressConstKHR` to the `indexData` field.
public VkAccelerationStructureGeometryTrianglesDataKHR	indexData(Consumer<VkDeviceOrHostAddressConstKHR> consumer) Passes the `indexData` field to the specified `Consumer`.
public int	indexType() the `VkIndexType` of each index element.
public VkAccelerationStructureGeometryTrianglesDataKHR	indexType(int value) Sets the specified value to the `indexType` field.
public static VkAccelerationStructureGeometryTrianglesDataKHR	malloc() Returns a new `VkAccelerationStructureGeometryTrianglesDataKHR` instance allocated with `memAlloc`.
public static VkAccelerationStructureGeometryTrianglesDataKHR.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkAccelerationStructureGeometryTrianglesDataKHR.Buffer` instance allocated with `memAlloc`.
public static VkAccelerationStructureGeometryTrianglesDataKHR	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkAccelerationStructureGeometryTrianglesDataKHR` instance allocated on the specified `MemoryStack`.
public static VkAccelerationStructureGeometryTrianglesDataKHR.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkAccelerationStructureGeometryTrianglesDataKHR.Buffer` instance allocated on the specified `MemoryStack`.
public int	maxVertex() the highest index of a vertex that will be addressed by a build command using this structure.
public VkAccelerationStructureGeometryTrianglesDataKHR	maxVertex(int value) Sets the specified value to the `maxVertex` field.
public static VkDeviceOrHostAddressConstKHR	nindexData(long struct) Unsafe version of `indexData`.
public static void	nindexData(long struct, VkDeviceOrHostAddressConstKHR value) Unsafe version of `indexData`.
public static int	nindexType(long struct) Unsafe version of `indexType`.
public static void	nindexType(long struct, int value) Unsafe version of `indexType`.
public static int	nmaxVertex(long struct) Unsafe version of `maxVertex`.
public static void	nmaxVertex(long struct, int value) Unsafe version of `maxVertex`.
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 VkDeviceOrHostAddressConstKHR	ntransformData(long struct) Unsafe version of `transformData`.
public static void	ntransformData(long struct, VkDeviceOrHostAddressConstKHR value) Unsafe version of `transformData`.
public static VkDeviceOrHostAddressConstKHR	nvertexData(long struct) Unsafe version of `vertexData`.
public static void	nvertexData(long struct, VkDeviceOrHostAddressConstKHR value) Unsafe version of `vertexData`.
public static int	nvertexFormat(long struct) Unsafe version of `vertexFormat`.
public static void	nvertexFormat(long struct, int value) Unsafe version of `vertexFormat`.
public static long	nvertexStride(long struct) Unsafe version of `vertexStride`.
public static void	nvertexStride(long struct, long value) Unsafe version of `vertexStride`.
public long	pNext() `NULL` or a pointer to a structure extending this structure.
public VkAccelerationStructureGeometryTrianglesDataKHR	pNext(long value) Sets the specified value to the `pNext` field.
public VkAccelerationStructureGeometryTrianglesDataKHR	pNext(VkAccelerationStructureGeometryMotionTrianglesDataNV value) Prepends the specified `VkAccelerationStructureGeometryMotionTrianglesDataNV` value to the `pNext` chain.
public VkAccelerationStructureGeometryTrianglesDataKHR	pNext(VkAccelerationStructureTrianglesDisplacementMicromapNV value) Prepends the specified `VkAccelerationStructureTrianglesDisplacementMicromapNV` value to the `pNext` chain.
public VkAccelerationStructureGeometryTrianglesDataKHR	pNext(VkAccelerationStructureTrianglesOpacityMicromapEXT value) Prepends the specified `VkAccelerationStructureTrianglesOpacityMicromapEXT` value to the `pNext` chain.
public VkAccelerationStructureGeometryTrianglesDataKHR	set(int sType, long pNext, int vertexFormat, VkDeviceOrHostAddressConstKHR vertexData, long vertexStride, int maxVertex, int indexType, VkDeviceOrHostAddressConstKHR indexData, VkDeviceOrHostAddressConstKHR transformData) Initializes this struct with the specified values.
public VkAccelerationStructureGeometryTrianglesDataKHR	Returns: this struct set(VkAccelerationStructureGeometryTrianglesDataKHR 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 VkAccelerationStructureGeometryTrianglesDataKHR	sType(int value) Sets the specified value to the `sType` field.
public VkAccelerationStructureGeometryTrianglesDataKHR	sType$Default() Sets the `STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_TRIANGLES_DATA_KHR` value to the `sType` field.
public VkDeviceOrHostAddressConstKHR	transformData() a device or host address to memory containing an optional reference to a `VkTransformMatrixKHR` structure describing a transformation from the space in which the vertices in this geometry are described to the space in which the acceleration structure is defined.
public VkAccelerationStructureGeometryTrianglesDataKHR	transformData(VkDeviceOrHostAddressConstKHR value) Copies the specified `VkDeviceOrHostAddressConstKHR` to the `transformData` field.
public VkAccelerationStructureGeometryTrianglesDataKHR	transformData(Consumer<VkDeviceOrHostAddressConstKHR> consumer) Passes the `transformData` field to the specified `Consumer`.
public VkDeviceOrHostAddressConstKHR	vertexData() a device or host address to memory containing vertex data for this geometry.
public VkAccelerationStructureGeometryTrianglesDataKHR	vertexData(VkDeviceOrHostAddressConstKHR value) Copies the specified `VkDeviceOrHostAddressConstKHR` to the `vertexData` field.
public VkAccelerationStructureGeometryTrianglesDataKHR	vertexData(Consumer<VkDeviceOrHostAddressConstKHR> consumer) Passes the `vertexData` field to the specified `Consumer`.
public int	vertexFormat() the `VkFormat` of each vertex element.
public VkAccelerationStructureGeometryTrianglesDataKHR	vertexFormat(int value) Sets the specified value to the `vertexFormat` field.
public long	vertexStride() the stride in bytes between each vertex.
public VkAccelerationStructureGeometryTrianglesDataKHR	vertexStride(long value) Sets the specified value to the `vertexStride` field.

public Class VkAccelerationStructureGeometryTrianglesDataKHR

Description

Note

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary