Package org.lwjgl.vulkan
Class VkAccelerationStructureInfoNV
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkAccelerationStructureInfoNV
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkAccelerationStructureInfoNV extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying the parameters of acceleration structure object.Description
VkAccelerationStructureInfoNVcontains information that is used both for acceleration structure creation withvkCreateAccelerationStructureNVand in combination with the actual geometric data to build the acceleration structure withCmdBuildAccelerationStructureNV.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 - 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 validVkAccelerationStructureTypeNVvalueflagsmust be a valid combination ofVkBuildAccelerationStructureFlagBitsNVvalues- If
geometryCountis not 0,pGeometriesmust be a valid pointer to an array ofgeometryCountvalidVkGeometryNVstructures
See Also
VkAccelerationStructureCreateInfoNV,VkGeometryNV,CmdBuildAccelerationStructureNVMember documentation
sType– the type of this structure.pNext–NULLor a pointer to an extension-specific structure.type– aVkAccelerationStructureTypeNVvalue specifying the type of acceleration structure that will be created.flags– a bitmask ofVkBuildAccelerationStructureFlagBitsNVspecifying additional parameters of the acceleration structure.instanceCount– specifies the number of instances that will be in the new acceleration structure.geometryCount– specifies the number of geometries that will be in the new acceleration structure.pGeometries– an array ofVkGeometryNVstructures, which contain the scene data being passed into the acceleration structure.
Layout
struct VkAccelerationStructureInfoNV { VkStructureType sType; void const * pNext; VkAccelerationStructureTypeNV type; VkBuildAccelerationStructureFlagsNV flags; uint32_t instanceCount; uint32_t geometryCount;VkGeometryNVconst * pGeometries; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkAccelerationStructureInfoNV.BufferAn array ofVkAccelerationStructureInfoNVstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intFLAGS
GEOMETRYCOUNT
INSTANCECOUNT
PGEOMETRIES
PNEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPE
TYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkAccelerationStructureInfoNV(java.nio.ByteBuffer container)Creates aVkAccelerationStructureInfoNVinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkAccelerationStructureInfoNVcalloc()Returns a newVkAccelerationStructureInfoNVinstance allocated withmemCalloc.static VkAccelerationStructureInfoNV.Buffercalloc(int capacity)Returns a newVkAccelerationStructureInfoNV.Bufferinstance allocated withmemCalloc.static VkAccelerationStructureInfoNVcallocStack()Returns a newVkAccelerationStructureInfoNVinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkAccelerationStructureInfoNV.BuffercallocStack(int capacity)Returns a newVkAccelerationStructureInfoNV.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkAccelerationStructureInfoNV.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkAccelerationStructureInfoNV.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkAccelerationStructureInfoNVcallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkAccelerationStructureInfoNVinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkAccelerationStructureInfoNVcreate()Returns a newVkAccelerationStructureInfoNVinstance allocated withBufferUtils.static VkAccelerationStructureInfoNV.Buffercreate(int capacity)Returns a newVkAccelerationStructureInfoNV.Bufferinstance allocated withBufferUtils.static VkAccelerationStructureInfoNVcreate(long address)Returns a newVkAccelerationStructureInfoNVinstance for the specified memory address.static VkAccelerationStructureInfoNV.Buffercreate(long address, int capacity)Create aVkAccelerationStructureInfoNV.Bufferinstance at the specified memory.static VkAccelerationStructureInfoNVcreateSafe(long address)static VkAccelerationStructureInfoNV.BuffercreateSafe(long address, int capacity)intflags()Returns the value of theflagsfield.VkAccelerationStructureInfoNVflags(int value)Sets the specified value to theflagsfield.intgeometryCount()Returns the value of thegeometryCountfield.intinstanceCount()Returns the value of theinstanceCountfield.VkAccelerationStructureInfoNVinstanceCount(int value)Sets the specified value to theinstanceCountfield.static VkAccelerationStructureInfoNVmalloc()Returns a newVkAccelerationStructureInfoNVinstance allocated withmemAlloc.static VkAccelerationStructureInfoNV.Buffermalloc(int capacity)Returns a newVkAccelerationStructureInfoNV.Bufferinstance allocated withmemAlloc.static VkAccelerationStructureInfoNVmallocStack()Returns a newVkAccelerationStructureInfoNVinstance allocated on the thread-localMemoryStack.static VkAccelerationStructureInfoNV.BuffermallocStack(int capacity)Returns a newVkAccelerationStructureInfoNV.Bufferinstance allocated on the thread-localMemoryStack.static VkAccelerationStructureInfoNV.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkAccelerationStructureInfoNV.Bufferinstance allocated on the specifiedMemoryStack.static VkAccelerationStructureInfoNVmallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkAccelerationStructureInfoNVinstance allocated on the specifiedMemoryStack.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 VkGeometryNV.BuffernpGeometries(long struct)Unsafe version ofpGeometries().static voidnpGeometries(long struct, 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.VkGeometryNV.BufferpGeometries()Returns aVkGeometryNV.Bufferview of the struct array pointed to by thepGeometriesfield.VkAccelerationStructureInfoNVpGeometries(VkGeometryNV.Buffer value)Sets the address of the specifiedVkGeometryNV.Bufferto thepGeometriesfield.longpNext()Returns the value of thepNextfield.VkAccelerationStructureInfoNVpNext(long value)Sets the specified value to thepNextfield.VkAccelerationStructureInfoNVset(int sType, long pNext, int type, int flags, int instanceCount, VkGeometryNV.Buffer pGeometries)Initializes this struct with the specified values.VkAccelerationStructureInfoNVset(VkAccelerationStructureInfoNV src)Copies the specified struct data to this struct.intsizeof()intsType()Returns the value of thesTypefield.VkAccelerationStructureInfoNVsType(int value)Sets the specified value to thesTypefield.inttype()Returns the value of thetypefield.VkAccelerationStructureInfoNVtype(int value)Sets the specified value to thetypefield.static voidvalidate(long struct)Validates pointer members that should not beNULL.static voidvalidate(long array, int count)Callsvalidate(long)for each struct contained in the specified struct array.
-
-
-
Constructor Detail
-
VkAccelerationStructureInfoNV
public VkAccelerationStructureInfoNV(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
type
public int type()
Returns the value of thetypefield.
-
flags
public int flags()
Returns the value of theflagsfield.
-
instanceCount
public int instanceCount()
Returns the value of theinstanceCountfield.
-
geometryCount
public int geometryCount()
Returns the value of thegeometryCountfield.
-
pGeometries
@Nullable public VkGeometryNV.Buffer pGeometries()
Returns aVkGeometryNV.Bufferview of the struct array pointed to by thepGeometriesfield.
-
sType
public VkAccelerationStructureInfoNV sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkAccelerationStructureInfoNV pNext(long value)
Sets the specified value to thepNextfield.
-
type
public VkAccelerationStructureInfoNV type(int value)
Sets the specified value to thetypefield.
-
flags
public VkAccelerationStructureInfoNV flags(int value)
Sets the specified value to theflagsfield.
-
instanceCount
public VkAccelerationStructureInfoNV instanceCount(int value)
Sets the specified value to theinstanceCountfield.
-
pGeometries
public VkAccelerationStructureInfoNV pGeometries(@Nullable VkGeometryNV.Buffer value)
Sets the address of the specifiedVkGeometryNV.Bufferto thepGeometriesfield.
-
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
public VkAccelerationStructureInfoNV set(VkAccelerationStructureInfoNV src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkAccelerationStructureInfoNV malloc()
Returns a newVkAccelerationStructureInfoNVinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkAccelerationStructureInfoNV calloc()
Returns a newVkAccelerationStructureInfoNVinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkAccelerationStructureInfoNV create()
Returns a newVkAccelerationStructureInfoNVinstance allocated withBufferUtils.
-
create
public static VkAccelerationStructureInfoNV create(long address)
Returns a newVkAccelerationStructureInfoNVinstance for the specified memory address.
-
createSafe
@Nullable public static VkAccelerationStructureInfoNV createSafe(long address)
-
malloc
public static VkAccelerationStructureInfoNV.Buffer malloc(int capacity)
Returns a newVkAccelerationStructureInfoNV.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkAccelerationStructureInfoNV.Buffer calloc(int capacity)
Returns a newVkAccelerationStructureInfoNV.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkAccelerationStructureInfoNV.Buffer create(int capacity)
Returns a newVkAccelerationStructureInfoNV.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkAccelerationStructureInfoNV.Buffer create(long address, int capacity)
Create aVkAccelerationStructureInfoNV.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkAccelerationStructureInfoNV.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkAccelerationStructureInfoNV mallocStack()
Returns a newVkAccelerationStructureInfoNVinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkAccelerationStructureInfoNV callocStack()
Returns a newVkAccelerationStructureInfoNVinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkAccelerationStructureInfoNV mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkAccelerationStructureInfoNVinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkAccelerationStructureInfoNV callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkAccelerationStructureInfoNVinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkAccelerationStructureInfoNV.Buffer mallocStack(int capacity)
Returns a newVkAccelerationStructureInfoNV.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkAccelerationStructureInfoNV.Buffer callocStack(int capacity)
Returns a newVkAccelerationStructureInfoNV.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkAccelerationStructureInfoNV.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkAccelerationStructureInfoNV.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkAccelerationStructureInfoNV.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkAccelerationStructureInfoNV.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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
@Nullable public static VkGeometryNV.Buffer npGeometries(long struct)
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
public static void npGeometries(long struct, @Nullable VkGeometryNV.Buffer value)Unsafe version ofpGeometries.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
validate
public static void validate(long array, int count)Callsvalidate(long)for each struct contained in the specified struct array.- Parameters:
array- the struct array to validatecount- the number of structs inarray
-
-