Package org.lwjgl.vulkan

Class VkAccelerationStructureGeometryKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkAccelerationStructureGeometryKHR>

org.lwjgl.vulkan.VkAccelerationStructureGeometryKHR

All Implemented Interfaces:

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

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

Structure specifying geometries to be built into an acceleration structure.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_KHR
• pNext must be NULL
• geometryType must be a valid VkGeometryTypeKHR value
• If geometryType is GEOMETRY_TYPE_TRIANGLES_KHR, the triangles member of geometry must be a valid VkAccelerationStructureGeometryTrianglesDataKHR structure
• If geometryType is GEOMETRY_TYPE_AABBS_KHR, the aabbs member of geometry must be a valid VkAccelerationStructureGeometryAabbsDataKHR structure
• If geometryType is GEOMETRY_TYPE_INSTANCES_KHR, the instances member of geometry must be a valid VkAccelerationStructureGeometryInstancesDataKHR structure
• flags must be a valid combination of VkGeometryFlagBitsKHR values

See Also

VkAccelerationStructureBuildGeometryInfoKHR, VkAccelerationStructureGeometryDataKHR

Layout

 struct VkAccelerationStructureGeometryKHR {
     VkStructureType sType();
     void const * pNext();
     VkGeometryTypeKHR geometryType();
     VkAccelerationStructureGeometryDataKHR geometry();
     VkGeometryFlagsKHR flags();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkAccelerationStructureGeometryKHR.Buffer	An array of VkAccelerationStructureGeometryKHR 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	FLAGS	The struct member offsets.
static final int	GEOMETRY	The struct member offsets.
static final int	GEOMETRYTYPE	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	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
VkAccelerationStructureGeometryKHR(ByteBuffer container)	Creates a VkAccelerationStructureGeometryKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkAccelerationStructureGeometryKHR	calloc()	Returns a new VkAccelerationStructureGeometryKHR instance allocated with memCalloc.
static VkAccelerationStructureGeometryKHR.Buffer	calloc(int capacity)	Returns a new VkAccelerationStructureGeometryKHR.Buffer instance allocated with memCalloc.
static VkAccelerationStructureGeometryKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureGeometryKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAccelerationStructureGeometryKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureGeometryKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAccelerationStructureGeometryKHR	create()	Returns a new VkAccelerationStructureGeometryKHR instance allocated with BufferUtils.
static VkAccelerationStructureGeometryKHR.Buffer	create(int capacity)	Returns a new VkAccelerationStructureGeometryKHR.Buffer instance allocated with BufferUtils.
static VkAccelerationStructureGeometryKHR	create(long address)	Returns a new VkAccelerationStructureGeometryKHR instance for the specified memory address.
static VkAccelerationStructureGeometryKHR.Buffer	create(long address, int capacity)	Create a VkAccelerationStructureGeometryKHR.Buffer instance at the specified memory.
static @Nullable VkAccelerationStructureGeometryKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkAccelerationStructureGeometryKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()	a bitmask of VkGeometryFlagBitsKHR values describing additional properties of how the geometry should be built.
VkAccelerationStructureGeometryKHR	flags(int value)	Sets the specified value to the flags() field.
VkAccelerationStructureGeometryDataKHR	geometry()	a VkAccelerationStructureGeometryDataKHR union describing the geometry data for the relevant geometry type.
VkAccelerationStructureGeometryKHR	geometry(Consumer<VkAccelerationStructureGeometryDataKHR> consumer)	Passes the geometry() field to the specified Consumer.
VkAccelerationStructureGeometryKHR	geometry(VkAccelerationStructureGeometryDataKHR value)	Copies the specified VkAccelerationStructureGeometryDataKHR to the geometry() field.
int	geometryType()	describes which type of geometry this VkAccelerationStructureGeometryKHR refers to.
VkAccelerationStructureGeometryKHR	geometryType(int value)	Sets the specified value to the geometryType() field.
static VkAccelerationStructureGeometryKHR	malloc()	Returns a new VkAccelerationStructureGeometryKHR instance allocated with memAlloc.
static VkAccelerationStructureGeometryKHR.Buffer	malloc(int capacity)	Returns a new VkAccelerationStructureGeometryKHR.Buffer instance allocated with memAlloc.
static VkAccelerationStructureGeometryKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureGeometryKHR.Buffer instance allocated on the specified MemoryStack.
static VkAccelerationStructureGeometryKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureGeometryKHR instance allocated on the specified MemoryStack.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
static VkAccelerationStructureGeometryDataKHR	ngeometry(long struct)	Unsafe version of geometry().
static void	ngeometry(long struct, VkAccelerationStructureGeometryDataKHR value)	Unsafe version of geometry.
static int	ngeometryType(long struct)	Unsafe version of geometryType().
static void	ngeometryType(long struct, int value)	Unsafe version of geometryType.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkAccelerationStructureGeometryKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkAccelerationStructureGeometryKHR	set(int sType, long pNext, int geometryType, VkAccelerationStructureGeometryDataKHR geometry, int flags)	Initializes this struct with the specified values.
VkAccelerationStructureGeometryKHR	set(VkAccelerationStructureGeometryKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkAccelerationStructureGeometryKHR	sType(int value)	Sets the specified value to the sType() field.
VkAccelerationStructureGeometryKHR	sType$Default()	Sets the STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_KHR value to the sType() 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.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

GEOMETRYTYPE

public static final int GEOMETRYTYPE

The struct member offsets.

GEOMETRY

public static final int GEOMETRY

The struct member offsets.

FLAGS

public static final int FLAGS

The struct member offsets.

Constructor Details

VkAccelerationStructureGeometryKHR

public VkAccelerationStructureGeometryKHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

geometryType

public int geometryType()

describes which type of geometry this VkAccelerationStructureGeometryKHR refers to.

geometry

public VkAccelerationStructureGeometryDataKHR geometry()

a VkAccelerationStructureGeometryDataKHR union describing the geometry data for the relevant geometry type.

flags

public int flags()

a bitmask of VkGeometryFlagBitsKHR values describing additional properties of how the geometry should be built.

sType

public VkAccelerationStructureGeometryKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkAccelerationStructureGeometryKHR sType$Default()

Sets the STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_KHR value to the sType() field.

pNext

public VkAccelerationStructureGeometryKHR pNext(long value)

Sets the specified value to the pNext() field.

geometryType

public VkAccelerationStructureGeometryKHR geometryType(int value)

Sets the specified value to the geometryType() field.

geometry

public VkAccelerationStructureGeometryKHR geometry(VkAccelerationStructureGeometryDataKHR value)

Copies the specified VkAccelerationStructureGeometryDataKHR to the geometry() field.

geometry

public VkAccelerationStructureGeometryKHR geometry(Consumer<VkAccelerationStructureGeometryDataKHR> consumer)

Passes the geometry() field to the specified Consumer.

flags

public VkAccelerationStructureGeometryKHR flags(int value)

Sets the specified value to the flags() field.

set

public VkAccelerationStructureGeometryKHR set(int sType,
 long pNext,
 int geometryType,
 VkAccelerationStructureGeometryDataKHR geometry,
 int flags)

Initializes this struct with the specified values.

set

public VkAccelerationStructureGeometryKHR set(VkAccelerationStructureGeometryKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkAccelerationStructureGeometryKHR malloc()

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

calloc

public static VkAccelerationStructureGeometryKHR calloc()

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

create

public static VkAccelerationStructureGeometryKHR create()

Returns a new VkAccelerationStructureGeometryKHR instance allocated with BufferUtils.

create

public static VkAccelerationStructureGeometryKHR create(long address)

Returns a new VkAccelerationStructureGeometryKHR instance for the specified memory address.

createSafe

public static @Nullable VkAccelerationStructureGeometryKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkAccelerationStructureGeometryKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkAccelerationStructureGeometryKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkAccelerationStructureGeometryKHR.Buffer create(int capacity)

Returns a new VkAccelerationStructureGeometryKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkAccelerationStructureGeometryKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkAccelerationStructureGeometryKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkAccelerationStructureGeometryKHR.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

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

ngeometryType

public static int ngeometryType(long struct)

Unsafe version of geometryType().

ngeometry

public static VkAccelerationStructureGeometryDataKHR ngeometry(long struct)

Unsafe version of geometry().

nflags

public static int nflags(long struct)

Unsafe version of flags().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

ngeometryType

public static void ngeometryType(long struct,
 int value)

Unsafe version of geometryType.

ngeometry

public static void ngeometry(long struct,
 VkAccelerationStructureGeometryDataKHR value)

Unsafe version of geometry.

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.