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.NativeResource
Structure specifying the parameters of acceleration structure object.Description
VkAccelerationStructureInfoNV
contains information that is used both for acceleration structure creation withvkCreateAccelerationStructureNV
and in combination with the actual geometric data to build the acceleration structure withCmdBuildAccelerationStructureNV
.Valid Usage
geometryCount
must be less than or equal toVkPhysicalDeviceRayTracingPropertiesNV
::maxGeometryCount
instanceCount
must 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
type
isACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_NV
thengeometryCount
must be 0 - If
type
isACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_NV
theninstanceCount
must be 0 - If
type
isACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_NV
then thegeometryType
member of each geometry inpGeometries
must be the same - If
flags
has theBUILD_ACCELERATION_STRUCTURE_PREFER_FAST_TRACE_BIT_NV
bit set, then it must not have theBUILD_ACCELERATION_STRUCTURE_PREFER_FAST_BUILD_BIT_NV
bit set scratch
must have been created withBUFFER_USAGE_RAY_TRACING_BIT_NV
usage flag- If
instanceData
is notNULL_HANDLE
,instanceData
must have been created withBUFFER_USAGE_RAY_TRACING_BIT_NV
usage flag
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_ACCELERATION_STRUCTURE_INFO_NV
pNext
must beNULL
type
must be a validVkAccelerationStructureTypeNV
valueflags
must be a valid combination ofVkBuildAccelerationStructureFlagBitsNV
values- If
geometryCount
is not 0,pGeometries
must be a valid pointer to an array ofgeometryCount
validVkGeometryNV
structures
See Also
VkAccelerationStructureCreateInfoNV
,VkGeometryNV
,CmdBuildAccelerationStructureNV
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.type
– aVkAccelerationStructureTypeNV
value specifying the type of acceleration structure that will be created.flags
– a bitmask ofVkBuildAccelerationStructureFlagBitsNV
specifying 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 ofVkGeometryNV
structures, 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;
VkGeometryNV
const * pGeometries; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkAccelerationStructureInfoNV.Buffer
An array ofVkAccelerationStructureInfoNV
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
FLAGS
GEOMETRYCOUNT
INSTANCECOUNT
PGEOMETRIES
PNEXTThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STYPE
TYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkAccelerationStructureInfoNV(java.nio.ByteBuffer container)
Creates aVkAccelerationStructureInfoNV
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkAccelerationStructureInfoNV
calloc()
Returns a newVkAccelerationStructureInfoNV
instance allocated withmemCalloc
.static VkAccelerationStructureInfoNV.Buffer
calloc(int capacity)
Returns a newVkAccelerationStructureInfoNV.Buffer
instance allocated withmemCalloc
.static VkAccelerationStructureInfoNV
callocStack()
Returns a newVkAccelerationStructureInfoNV
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkAccelerationStructureInfoNV.Buffer
callocStack(int capacity)
Returns a newVkAccelerationStructureInfoNV.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkAccelerationStructureInfoNV.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkAccelerationStructureInfoNV.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkAccelerationStructureInfoNV
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkAccelerationStructureInfoNV
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkAccelerationStructureInfoNV
create()
Returns a newVkAccelerationStructureInfoNV
instance allocated withBufferUtils
.static VkAccelerationStructureInfoNV.Buffer
create(int capacity)
Returns a newVkAccelerationStructureInfoNV.Buffer
instance allocated withBufferUtils
.static VkAccelerationStructureInfoNV
create(long address)
Returns a newVkAccelerationStructureInfoNV
instance for the specified memory address.static VkAccelerationStructureInfoNV.Buffer
create(long address, int capacity)
Create aVkAccelerationStructureInfoNV.Buffer
instance at the specified memory.static VkAccelerationStructureInfoNV
createSafe(long address)
static VkAccelerationStructureInfoNV.Buffer
createSafe(long address, int capacity)
int
flags()
Returns the value of theflags
field.VkAccelerationStructureInfoNV
flags(int value)
Sets the specified value to theflags
field.int
geometryCount()
Returns the value of thegeometryCount
field.int
instanceCount()
Returns the value of theinstanceCount
field.VkAccelerationStructureInfoNV
instanceCount(int value)
Sets the specified value to theinstanceCount
field.static VkAccelerationStructureInfoNV
malloc()
Returns a newVkAccelerationStructureInfoNV
instance allocated withmemAlloc
.static VkAccelerationStructureInfoNV.Buffer
malloc(int capacity)
Returns a newVkAccelerationStructureInfoNV.Buffer
instance allocated withmemAlloc
.static VkAccelerationStructureInfoNV
mallocStack()
Returns a newVkAccelerationStructureInfoNV
instance allocated on the thread-localMemoryStack
.static VkAccelerationStructureInfoNV.Buffer
mallocStack(int capacity)
Returns a newVkAccelerationStructureInfoNV.Buffer
instance allocated on the thread-localMemoryStack
.static VkAccelerationStructureInfoNV.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkAccelerationStructureInfoNV.Buffer
instance allocated on the specifiedMemoryStack
.static VkAccelerationStructureInfoNV
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkAccelerationStructureInfoNV
instance allocated on the specifiedMemoryStack
.static int
nflags(long struct)
Unsafe version offlags()
.static void
nflags(long struct, int value)
Unsafe version offlags
.static int
ngeometryCount(long struct)
Unsafe version ofgeometryCount()
.static void
ngeometryCount(long struct, int value)
Sets the specified value to thegeometryCount
field of the specifiedstruct
.static int
ninstanceCount(long struct)
Unsafe version ofinstanceCount()
.static void
ninstanceCount(long struct, int value)
Unsafe version ofinstanceCount
.static VkGeometryNV.Buffer
npGeometries(long struct)
Unsafe version ofpGeometries()
.static void
npGeometries(long struct, VkGeometryNV.Buffer value)
Unsafe version ofpGeometries
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.static int
ntype(long struct)
Unsafe version oftype()
.static void
ntype(long struct, int value)
Unsafe version oftype
.VkGeometryNV.Buffer
pGeometries()
Returns aVkGeometryNV.Buffer
view of the struct array pointed to by thepGeometries
field.VkAccelerationStructureInfoNV
pGeometries(VkGeometryNV.Buffer value)
Sets the address of the specifiedVkGeometryNV.Buffer
to thepGeometries
field.long
pNext()
Returns the value of thepNext
field.VkAccelerationStructureInfoNV
pNext(long value)
Sets the specified value to thepNext
field.VkAccelerationStructureInfoNV
set(int sType, long pNext, int type, int flags, int instanceCount, VkGeometryNV.Buffer pGeometries)
Initializes this struct with the specified values.VkAccelerationStructureInfoNV
set(VkAccelerationStructureInfoNV src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkAccelerationStructureInfoNV
sType(int value)
Sets the specified value to thesType
field.int
type()
Returns the value of thetype
field.VkAccelerationStructureInfoNV
type(int value)
Sets the specified value to thetype
field.static void
validate(long struct)
Validates pointer members that should not beNULL
.static void
validate(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 aVkAccelerationStructureInfoNV
instance at the current position of the specifiedByteBuffer
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
type
public int type()
Returns the value of thetype
field.
-
flags
public int flags()
Returns the value of theflags
field.
-
instanceCount
public int instanceCount()
Returns the value of theinstanceCount
field.
-
geometryCount
public int geometryCount()
Returns the value of thegeometryCount
field.
-
pGeometries
@Nullable public VkGeometryNV.Buffer pGeometries()
Returns aVkGeometryNV.Buffer
view of the struct array pointed to by thepGeometries
field.
-
sType
public VkAccelerationStructureInfoNV sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkAccelerationStructureInfoNV pNext(long value)
Sets the specified value to thepNext
field.
-
type
public VkAccelerationStructureInfoNV type(int value)
Sets the specified value to thetype
field.
-
flags
public VkAccelerationStructureInfoNV flags(int value)
Sets the specified value to theflags
field.
-
instanceCount
public VkAccelerationStructureInfoNV instanceCount(int value)
Sets the specified value to theinstanceCount
field.
-
pGeometries
public VkAccelerationStructureInfoNV pGeometries(@Nullable VkGeometryNV.Buffer value)
Sets the address of the specifiedVkGeometryNV.Buffer
to 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
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 newVkAccelerationStructureInfoNV
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkAccelerationStructureInfoNV calloc()
Returns a newVkAccelerationStructureInfoNV
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkAccelerationStructureInfoNV create()
Returns a newVkAccelerationStructureInfoNV
instance allocated withBufferUtils
.
-
create
public static VkAccelerationStructureInfoNV create(long address)
Returns a newVkAccelerationStructureInfoNV
instance for the specified memory address.
-
createSafe
@Nullable public static VkAccelerationStructureInfoNV createSafe(long address)
-
malloc
public static VkAccelerationStructureInfoNV.Buffer malloc(int capacity)
Returns a newVkAccelerationStructureInfoNV.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkAccelerationStructureInfoNV.Buffer calloc(int capacity)
Returns a newVkAccelerationStructureInfoNV.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkAccelerationStructureInfoNV.Buffer create(int capacity)
Returns a newVkAccelerationStructureInfoNV.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkAccelerationStructureInfoNV.Buffer create(long address, int capacity)
Create aVkAccelerationStructureInfoNV.Buffer
instance 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 newVkAccelerationStructureInfoNV
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkAccelerationStructureInfoNV callocStack()
Returns a newVkAccelerationStructureInfoNV
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkAccelerationStructureInfoNV mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkAccelerationStructureInfoNV
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkAccelerationStructureInfoNV callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkAccelerationStructureInfoNV
instance allocated on the specifiedMemoryStack
and 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.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkAccelerationStructureInfoNV.Buffer callocStack(int capacity)
Returns a newVkAccelerationStructureInfoNV.Buffer
instance allocated on the thread-localMemoryStack
and 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.Buffer
instance 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.Buffer
instance allocated on the specifiedMemoryStack
and 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 thegeometryCount
field 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
-
-