Package org.lwjgl.vulkan
Class VkAccelerationStructureInfoNV
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkAccelerationStructureInfoNV>
org.lwjgl.vulkan.VkAccelerationStructureInfoNV
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkAccelerationStructureInfoNV
extends org.lwjgl.system.Struct<VkAccelerationStructureInfoNV>
implements org.lwjgl.system.NativeResource
Structure specifying the parameters of acceleration structure object.
Description
VkAccelerationStructureInfoNV contains information that is used both for acceleration structure creation with CreateAccelerationStructureNV and in combination with the actual geometric data to build the acceleration structure with CmdBuildAccelerationStructureNV.
Valid Usage
geometryCountmust be less than or equal toVkPhysicalDeviceRayTracingPropertiesNV::maxGeometryCountinstanceCountmust be less than or equal toVkPhysicalDeviceRayTracingPropertiesNV::maxInstanceCount- The total number of triangles in all geometries must be less than or equal to
VkPhysicalDeviceRayTracingPropertiesNV::maxTriangleCount - If
typeisACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_NVthengeometryCountmust be 0 - If
typeisACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_NVtheninstanceCountmust be 0 - If
typeisACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_NVthen thegeometryTypemember of each geometry inpGeometriesmust be the same typemust not beACCELERATION_STRUCTURE_TYPE_GENERIC_KHR- If
flagshas theBUILD_ACCELERATION_STRUCTURE_PREFER_FAST_TRACE_BIT_NVbit set, then it must not have theBUILD_ACCELERATION_STRUCTURE_PREFER_FAST_BUILD_BIT_NVbit set scratchmust have been created withBUFFER_USAGE_RAY_TRACING_BIT_NVusage flag- If
instanceDatais notNULL_HANDLE,instanceDatamust have been created withBUFFER_USAGE_RAY_TRACING_BIT_NVusage flag
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_ACCELERATION_STRUCTURE_INFO_NVpNextmust beNULLtypemust be a validVkAccelerationStructureTypeKHRvalueflagsmust be a valid combination ofVkBuildAccelerationStructureFlagBitsNVvalues- If
geometryCountis not 0,pGeometriesmust be a valid pointer to an array ofgeometryCountvalidVkGeometryNVstructures
See Also
VkAccelerationStructureCreateInfoNV, VkGeometryNV, CmdBuildAccelerationStructureNV
Layout
struct VkAccelerationStructureInfoNV {
VkStructureType sType();
void const * pNext();
VkAccelerationStructureTypeKHR type();
VkBuildAccelerationStructureFlagsNV flags();
uint32_t instanceCount();
uint32_t geometryCount();
VkGeometryNV const * pGeometries();
}-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkAccelerationStructureInfoNV(ByteBuffer container) Creates aVkAccelerationStructureInfoNVinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkAccelerationStructureInfoNVinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkAccelerationStructureInfoNV.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkAccelerationStructureInfoNV.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkAccelerationStructureInfoNVinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.Deprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.create()Returns a newVkAccelerationStructureInfoNVinstance allocated withBufferUtils.create(int capacity) Returns a newVkAccelerationStructureInfoNV.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkAccelerationStructureInfoNVinstance for the specified memory address.create(long address, int capacity) Create aVkAccelerationStructureInfoNV.Bufferinstance at the specified memory.static @Nullable VkAccelerationStructureInfoNVcreateSafe(long address) static @Nullable VkAccelerationStructureInfoNV.BuffercreateSafe(long address, int capacity) intflags()a bitmask ofVkBuildAccelerationStructureFlagBitsNVspecifying additional parameters of the acceleration structure.flags(int value) Sets the specified value to theflags()field.intspecifies the number of geometries that will be in the new acceleration structure.intspecifies the number of instances that will be in the new acceleration structure.instanceCount(int value) Sets the specified value to theinstanceCount()field.malloc()Returns a newVkAccelerationStructureInfoNVinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkAccelerationStructureInfoNV.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkAccelerationStructureInfoNV.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkAccelerationStructureInfoNVinstance allocated on the specifiedMemoryStack.Deprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static intnflags(long struct) Unsafe version offlags().static voidnflags(long struct, int value) Unsafe version offlags.static intngeometryCount(long struct) Unsafe version ofgeometryCount().static voidngeometryCount(long struct, int value) Sets the specified value to thegeometryCountfield of the specifiedstruct.static intninstanceCount(long struct) Unsafe version ofinstanceCount().static voidninstanceCount(long struct, int value) Unsafe version ofinstanceCount.static @Nullable VkGeometryNV.BuffernpGeometries(long struct) Unsafe version ofpGeometries().static voidnpGeometries(long struct, @Nullable VkGeometryNV.Buffer value) Unsafe version ofpGeometries.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.static intntype(long struct) Unsafe version oftype().static voidntype(long struct, int value) Unsafe version oftype.@Nullable VkGeometryNV.Buffera pointer to an array ofgeometryCountVkGeometryNVstructures containing the scene data being passed into the acceleration structure.pGeometries(@Nullable VkGeometryNV.Buffer value) Sets the address of the specifiedVkGeometryNV.Bufferto thepGeometries()field.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.set(int sType, long pNext, int type, int flags, int instanceCount, @Nullable VkGeometryNV.Buffer pGeometries) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_ACCELERATION_STRUCTURE_INFO_NVvalue to thesType()field.inttype()aVkAccelerationStructureTypeNVvalue specifying the type of acceleration structure that will be created.type(int value) Sets the specified value to thetype()field.static voidvalidate(long struct) Validates pointer members that should not beNULL.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
TYPE
public static final int TYPEThe struct member offsets. -
FLAGS
public static final int FLAGSThe struct member offsets. -
INSTANCECOUNT
public static final int INSTANCECOUNTThe struct member offsets. -
GEOMETRYCOUNT
public static final int GEOMETRYCOUNTThe struct member offsets. -
PGEOMETRIES
public static final int PGEOMETRIESThe struct member offsets.
-
-
Constructor Details
-
VkAccelerationStructureInfoNV
Creates aVkAccelerationStructureInfoNVinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct<VkAccelerationStructureInfoNV>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
type
public int type()aVkAccelerationStructureTypeNVvalue specifying the type of acceleration structure that will be created. -
flags
public int flags()a bitmask ofVkBuildAccelerationStructureFlagBitsNVspecifying additional parameters of the acceleration structure. -
instanceCount
public int instanceCount()specifies the number of instances that will be in the new acceleration structure. -
geometryCount
public int geometryCount()specifies the number of geometries that will be in the new acceleration structure. -
pGeometries
a pointer to an array ofgeometryCountVkGeometryNVstructures containing the scene data being passed into the acceleration structure. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_ACCELERATION_STRUCTURE_INFO_NVvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
type
Sets the specified value to thetype()field. -
flags
Sets the specified value to theflags()field. -
instanceCount
Sets the specified value to theinstanceCount()field. -
pGeometries
Sets the address of the specifiedVkGeometryNV.Bufferto thepGeometries()field. -
set
public VkAccelerationStructureInfoNV set(int sType, long pNext, int type, int flags, int instanceCount, @Nullable VkGeometryNV.Buffer pGeometries) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkAccelerationStructureInfoNVinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkAccelerationStructureInfoNVinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkAccelerationStructureInfoNVinstance allocated withBufferUtils. -
create
Returns a newVkAccelerationStructureInfoNVinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkAccelerationStructureInfoNV.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkAccelerationStructureInfoNV.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkAccelerationStructureInfoNV.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkAccelerationStructureInfoNV.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
@Deprecated public static VkAccelerationStructureInfoNV mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
@Deprecated public static VkAccelerationStructureInfoNV callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
mallocStack
@Deprecated public static VkAccelerationStructureInfoNV.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkAccelerationStructureInfoNV.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkAccelerationStructureInfoNVinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkAccelerationStructureInfoNVinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkAccelerationStructureInfoNV.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkAccelerationStructureInfoNV.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkAccelerationStructureInfoNV.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkAccelerationStructureInfoNV.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
ntype
public static int ntype(long struct) Unsafe version oftype(). -
nflags
public static int nflags(long struct) Unsafe version offlags(). -
ninstanceCount
public static int ninstanceCount(long struct) Unsafe version ofinstanceCount(). -
ngeometryCount
public static int ngeometryCount(long struct) Unsafe version ofgeometryCount(). -
npGeometries
Unsafe version ofpGeometries(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
ntype
public static void ntype(long struct, int value) Unsafe version oftype. -
nflags
public static void nflags(long struct, int value) Unsafe version offlags. -
ninstanceCount
public static void ninstanceCount(long struct, int value) Unsafe version ofinstanceCount. -
ngeometryCount
public static void ngeometryCount(long struct, int value) Sets the specified value to thegeometryCountfield of the specifiedstruct. -
npGeometries
Unsafe version ofpGeometries. -
validate
public static void validate(long struct) Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-