Package org.lwjgl.vulkan
Class VkBindAccelerationStructureMemoryInfoNV
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkBindAccelerationStructureMemoryInfoNV>
org.lwjgl.vulkan.VkBindAccelerationStructureMemoryInfoNV
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
public class VkBindAccelerationStructureMemoryInfoNV
extends Struct<VkBindAccelerationStructureMemoryInfoNV>
implements NativeResource
Structure specifying acceleration structure memory binding.
Valid Usage
accelerationStructure
must not already be backed by a memory objectmemoryOffset
must be less than the size ofmemory
memory
must have been allocated using one of the memory types allowed in thememoryTypeBits
member of theVkMemoryRequirements
structure returned from a call toGetAccelerationStructureMemoryRequirementsNV
withaccelerationStructure
andtype
ofACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_OBJECT_NV
memoryOffset
must be an integer multiple of thealignment
member of theVkMemoryRequirements
structure returned from a call toGetAccelerationStructureMemoryRequirementsNV
withaccelerationStructure
andtype
ofACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_OBJECT_NV
- The
size
member of theVkMemoryRequirements
structure returned from a call toGetAccelerationStructureMemoryRequirementsNV
withaccelerationStructure
andtype
ofACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_OBJECT_NV
must be less than or equal to the size ofmemory
minusmemoryOffset
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_BIND_ACCELERATION_STRUCTURE_MEMORY_INFO_NV
pNext
must beNULL
accelerationStructure
must be a validVkAccelerationStructureNV
handlememory
must be a validVkDeviceMemory
handle- If
deviceIndexCount
is not 0,pDeviceIndices
must be a valid pointer to an array ofdeviceIndexCount
uint32_t
values - Both of
accelerationStructure
, andmemory
must have been created, allocated, or retrieved from the sameVkDevice
See Also
BindAccelerationStructureMemoryNV
Layout
struct VkBindAccelerationStructureMemoryInfoNV {
VkStructureType sType()
;
void const * pNext()
;
VkAccelerationStructureNV accelerationStructure()
;
VkDeviceMemory memory()
;
VkDeviceSize memoryOffset()
;
uint32_t deviceIndexCount()
;
uint32_t const * pDeviceIndices()
;
}
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
An array ofVkBindAccelerationStructureMemoryInfoNV
structs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The struct member offsets.static final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionCreates aVkBindAccelerationStructureMemoryInfoNV
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionlong
the acceleration structure to be attached to memory.accelerationStructure
(long value) Sets the specified value to theaccelerationStructure()
field.calloc()
Returns a newVkBindAccelerationStructureMemoryInfoNV
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkBindAccelerationStructureMemoryInfoNV.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkBindAccelerationStructureMemoryInfoNV.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.calloc
(MemoryStack stack) Returns a newVkBindAccelerationStructureMemoryInfoNV
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.Deprecated.callocStack
(int capacity) Deprecated.callocStack
(int capacity, MemoryStack stack) Deprecated.callocStack
(MemoryStack stack) Deprecated.create()
Returns a newVkBindAccelerationStructureMemoryInfoNV
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkBindAccelerationStructureMemoryInfoNV.Buffer
instance allocated withBufferUtils
.create
(long address) Returns a newVkBindAccelerationStructureMemoryInfoNV
instance for the specified memory address.create
(long address, int capacity) Create aVkBindAccelerationStructureMemoryInfoNV.Buffer
instance at the specified memory.createSafe
(long address) createSafe
(long address, int capacity) int
the number of elements inpDeviceIndices
.malloc()
Returns a newVkBindAccelerationStructureMemoryInfoNV
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkBindAccelerationStructureMemoryInfoNV.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkBindAccelerationStructureMemoryInfoNV.Buffer
instance allocated on the specifiedMemoryStack
.malloc
(MemoryStack stack) Returns a newVkBindAccelerationStructureMemoryInfoNV
instance allocated on the specifiedMemoryStack
.Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.mallocStack
(MemoryStack stack) Deprecated.long
memory()
aVkDeviceMemory
object describing the device memory to attach.memory
(long value) Sets the specified value to thememory()
field.long
the start offset of the region of memory that is to be bound to the acceleration structure.memoryOffset
(long value) Sets the specified value to thememoryOffset()
field.static long
naccelerationStructure
(long struct) Unsafe version ofaccelerationStructure()
.static void
naccelerationStructure
(long struct, long value) Unsafe version ofaccelerationStructure
.static int
ndeviceIndexCount
(long struct) Unsafe version ofdeviceIndexCount()
.static void
ndeviceIndexCount
(long struct, int value) Sets the specified value to thedeviceIndexCount
field of the specifiedstruct
.static long
nmemory
(long struct) Unsafe version ofmemory()
.static void
nmemory
(long struct, long value) Unsafe version ofmemory
.static long
nmemoryOffset
(long struct) Unsafe version ofmemoryOffset()
.static void
nmemoryOffset
(long struct, long value) Unsafe version ofmemoryOffset
.static IntBuffer
npDeviceIndices
(long struct) Unsafe version ofpDeviceIndices
.static void
npDeviceIndices
(long struct, IntBuffer value) Unsafe version ofpDeviceIndices
.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
.a pointer to an array of device indices.pDeviceIndices
(IntBuffer value) Sets the address of the specifiedIntBuffer
to thepDeviceIndices()
field.long
pNext()
NULL
or a pointer to a structure extending this structure.pNext
(long value) Sets the specified value to thepNext()
field.set
(int sType, long pNext, long accelerationStructure, long memory, long memoryOffset, IntBuffer pDeviceIndices) Initializes this struct with the specified values.Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.int
sType()
aVkStructureType
value identifying this structure.sType
(int value) Sets the specified value to thesType()
field.Sets theSTRUCTURE_TYPE_BIND_ACCELERATION_STRUCTURE_MEMORY_INFO_NV
value to thesType()
field.static void
validate
(long struct) Validates pointer members that should not beNULL
.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods 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. -
ACCELERATIONSTRUCTURE
public static final int ACCELERATIONSTRUCTUREThe struct member offsets. -
MEMORY
public static final int MEMORYThe struct member offsets. -
MEMORYOFFSET
public static final int MEMORYOFFSETThe struct member offsets. -
DEVICEINDEXCOUNT
public static final int DEVICEINDEXCOUNTThe struct member offsets. -
PDEVICEINDICES
public static final int PDEVICEINDICESThe struct member offsets.
-
-
Constructor Details
-
VkBindAccelerationStructureMemoryInfoNV
Creates aVkBindAccelerationStructureMemoryInfoNV
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 Details
-
sizeof
public int sizeof()Description copied from class:Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkBindAccelerationStructureMemoryInfoNV>
-
sType
public int sType()aVkStructureType
value identifying this structure. -
pNext
public long pNext()NULL
or a pointer to a structure extending this structure. -
accelerationStructure
public long accelerationStructure()the acceleration structure to be attached to memory. -
memory
public long memory()aVkDeviceMemory
object describing the device memory to attach. -
memoryOffset
public long memoryOffset()the start offset of the region of memory that is to be bound to the acceleration structure. The number of bytes returned in theVkMemoryRequirements
::size
member inmemory
, starting frommemoryOffset
bytes, will be bound to the specified acceleration structure. -
deviceIndexCount
public int deviceIndexCount()the number of elements inpDeviceIndices
. -
pDeviceIndices
a pointer to an array of device indices. -
sType
Sets the specified value to thesType()
field. -
sType$Default
Sets theSTRUCTURE_TYPE_BIND_ACCELERATION_STRUCTURE_MEMORY_INFO_NV
value to thesType()
field. -
pNext
Sets the specified value to thepNext()
field. -
accelerationStructure
Sets the specified value to theaccelerationStructure()
field. -
memory
Sets the specified value to thememory()
field. -
memoryOffset
Sets the specified value to thememoryOffset()
field. -
pDeviceIndices
Sets the address of the specifiedIntBuffer
to thepDeviceIndices()
field. -
set
public VkBindAccelerationStructureMemoryInfoNV set(int sType, long pNext, long accelerationStructure, long memory, long memoryOffset, @Nullable IntBuffer pDeviceIndices) 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 newVkBindAccelerationStructureMemoryInfoNV
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkBindAccelerationStructureMemoryInfoNV
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkBindAccelerationStructureMemoryInfoNV
instance allocated withBufferUtils
. -
create
Returns a newVkBindAccelerationStructureMemoryInfoNV
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkBindAccelerationStructureMemoryInfoNV.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkBindAccelerationStructureMemoryInfoNV.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkBindAccelerationStructureMemoryInfoNV.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkBindAccelerationStructureMemoryInfoNV.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkBindAccelerationStructureMemoryInfoNV.Buffer createSafe(long address, int capacity) -
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.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
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 VkBindAccelerationStructureMemoryInfoNV.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkBindAccelerationStructureMemoryInfoNV.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkBindAccelerationStructureMemoryInfoNV
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkBindAccelerationStructureMemoryInfoNV
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
public static VkBindAccelerationStructureMemoryInfoNV.Buffer malloc(int capacity, MemoryStack stack) Returns a newVkBindAccelerationStructureMemoryInfoNV.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
public static VkBindAccelerationStructureMemoryInfoNV.Buffer calloc(int capacity, MemoryStack stack) Returns a newVkBindAccelerationStructureMemoryInfoNV.Buffer
instance allocated on the specifiedMemoryStack
and 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()
. -
naccelerationStructure
public static long naccelerationStructure(long struct) Unsafe version ofaccelerationStructure()
. -
nmemory
public static long nmemory(long struct) Unsafe version ofmemory()
. -
nmemoryOffset
public static long nmemoryOffset(long struct) Unsafe version ofmemoryOffset()
. -
ndeviceIndexCount
public static int ndeviceIndexCount(long struct) Unsafe version ofdeviceIndexCount()
. -
npDeviceIndices
Unsafe version ofpDeviceIndices
. -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType
. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext
. -
naccelerationStructure
public static void naccelerationStructure(long struct, long value) Unsafe version ofaccelerationStructure
. -
nmemory
public static void nmemory(long struct, long value) Unsafe version ofmemory
. -
nmemoryOffset
public static void nmemoryOffset(long struct, long value) Unsafe version ofmemoryOffset
. -
ndeviceIndexCount
public static void ndeviceIndexCount(long struct, int value) Sets the specified value to thedeviceIndexCount
field of the specifiedstruct
. -
npDeviceIndices
Unsafe version ofpDeviceIndices
. -
validate
public static void validate(long struct) Validates pointer members that should not beNULL
.- Parameters:
struct
- the struct to validate
-