Package org.lwjgl.vulkan
Class VkBindAccelerationStructureMemoryInfoNV
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkBindAccelerationStructureMemoryInfoNV
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkBindAccelerationStructureMemoryInfoNV extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying acceleration structure memory binding.Valid Usage
accelerationStructuremust not already be backed by a memory objectmemoryOffsetmust be less than the size ofmemorymemorymust have been allocated using one of the memory types allowed in thememoryTypeBitsmember of theVkMemoryRequirementsstructure returned from a call toGetAccelerationStructureMemoryRequirementsNVwithaccelerationStructureandtypeofACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_OBJECT_NVmemoryOffsetmust be an integer multiple of thealignmentmember of theVkMemoryRequirementsstructure returned from a call toGetAccelerationStructureMemoryRequirementsNVwithaccelerationStructureandtypeofACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_OBJECT_NV- The
sizemember of theVkMemoryRequirementsstructure returned from a call toGetAccelerationStructureMemoryRequirementsNVwithaccelerationStructureandtypeofACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_OBJECT_NVmust be less than or equal to the size ofmemoryminusmemoryOffset
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_BIND_ACCELERATION_STRUCTURE_MEMORY_INFO_NVpNextmust beNULLaccelerationStructuremust be a validVkAccelerationStructureNVhandlememorymust be a validVkDeviceMemoryhandle- If
deviceIndexCountis not 0,pDeviceIndicesmust be a valid pointer to an array ofdeviceIndexCountuint32_tvalues - Both of
accelerationStructure, andmemorymust have been created, allocated, or retrieved from the sameVkDevice
See Also
BindAccelerationStructureMemoryNVLayout
struct VkBindAccelerationStructureMemoryInfoNV { VkStructureTypesType(); void const *pNext(); VkAccelerationStructureNVaccelerationStructure(); VkDeviceMemorymemory(); VkDeviceSizememoryOffset(); uint32_tdeviceIndexCount(); uint32_t const *pDeviceIndices(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkBindAccelerationStructureMemoryInfoNV.BufferAn array ofVkBindAccelerationStructureMemoryInfoNVstructs.
-
Field Summary
Fields Modifier and Type Field Description static intACCELERATIONSTRUCTUREThe struct member offsets.static intALIGNOFThe struct alignment in bytes.static intDEVICEINDEXCOUNT
MEMORY
MEMORYOFFSET
PDEVICEINDICES
PNEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkBindAccelerationStructureMemoryInfoNV(java.nio.ByteBuffer container)Creates aVkBindAccelerationStructureMemoryInfoNVinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description longaccelerationStructure()the acceleration structure to be attached to memory.VkBindAccelerationStructureMemoryInfoNVaccelerationStructure(long value)Sets the specified value to theaccelerationStructure()field.static VkBindAccelerationStructureMemoryInfoNVcalloc()Returns a newVkBindAccelerationStructureMemoryInfoNVinstance allocated withmemCalloc.static VkBindAccelerationStructureMemoryInfoNV.Buffercalloc(int capacity)Returns a newVkBindAccelerationStructureMemoryInfoNV.Bufferinstance allocated withmemCalloc.static VkBindAccelerationStructureMemoryInfoNV.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkBindAccelerationStructureMemoryInfoNV.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkBindAccelerationStructureMemoryInfoNVcalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkBindAccelerationStructureMemoryInfoNVinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkBindAccelerationStructureMemoryInfoNVcallocStack()Deprecated.static VkBindAccelerationStructureMemoryInfoNV.BuffercallocStack(int capacity)Deprecated.static VkBindAccelerationStructureMemoryInfoNV.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkBindAccelerationStructureMemoryInfoNVcallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static VkBindAccelerationStructureMemoryInfoNVcreate()Returns a newVkBindAccelerationStructureMemoryInfoNVinstance allocated withBufferUtils.static VkBindAccelerationStructureMemoryInfoNV.Buffercreate(int capacity)Returns a newVkBindAccelerationStructureMemoryInfoNV.Bufferinstance allocated withBufferUtils.static VkBindAccelerationStructureMemoryInfoNVcreate(long address)Returns a newVkBindAccelerationStructureMemoryInfoNVinstance for the specified memory address.static VkBindAccelerationStructureMemoryInfoNV.Buffercreate(long address, int capacity)Create aVkBindAccelerationStructureMemoryInfoNV.Bufferinstance at the specified memory.static VkBindAccelerationStructureMemoryInfoNVcreateSafe(long address)static VkBindAccelerationStructureMemoryInfoNV.BuffercreateSafe(long address, int capacity)intdeviceIndexCount()the number of elements inpDeviceIndices.static VkBindAccelerationStructureMemoryInfoNVmalloc()Returns a newVkBindAccelerationStructureMemoryInfoNVinstance allocated withmemAlloc.static VkBindAccelerationStructureMemoryInfoNV.Buffermalloc(int capacity)Returns a newVkBindAccelerationStructureMemoryInfoNV.Bufferinstance allocated withmemAlloc.static VkBindAccelerationStructureMemoryInfoNV.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkBindAccelerationStructureMemoryInfoNV.Bufferinstance allocated on the specifiedMemoryStack.static VkBindAccelerationStructureMemoryInfoNVmalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkBindAccelerationStructureMemoryInfoNVinstance allocated on the specifiedMemoryStack.static VkBindAccelerationStructureMemoryInfoNVmallocStack()Deprecated.static VkBindAccelerationStructureMemoryInfoNV.BuffermallocStack(int capacity)Deprecated.static VkBindAccelerationStructureMemoryInfoNV.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkBindAccelerationStructureMemoryInfoNVmallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.longmemory()aVkDeviceMemoryobject describing the device memory to attach.VkBindAccelerationStructureMemoryInfoNVmemory(long value)Sets the specified value to thememory()field.longmemoryOffset()the start offset of the region of memory that is to be bound to the acceleration structure.VkBindAccelerationStructureMemoryInfoNVmemoryOffset(long value)Sets the specified value to thememoryOffset()field.static longnaccelerationStructure(long struct)Unsafe version ofaccelerationStructure().static voidnaccelerationStructure(long struct, long value)Unsafe version ofaccelerationStructure.static intndeviceIndexCount(long struct)Unsafe version ofdeviceIndexCount().static voidndeviceIndexCount(long struct, int value)Sets the specified value to thedeviceIndexCountfield of the specifiedstruct.static longnmemory(long struct)Unsafe version ofmemory().static voidnmemory(long struct, long value)Unsafe version ofmemory.static longnmemoryOffset(long struct)Unsafe version ofmemoryOffset().static voidnmemoryOffset(long struct, long value)Unsafe version ofmemoryOffset.static java.nio.IntBuffernpDeviceIndices(long struct)Unsafe version ofpDeviceIndices.static voidnpDeviceIndices(long struct, java.nio.IntBuffer value)Unsafe version ofpDeviceIndices.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.java.nio.IntBufferpDeviceIndices()a pointer to an array of device indices.VkBindAccelerationStructureMemoryInfoNVpDeviceIndices(java.nio.IntBuffer value)Sets the address of the specifiedIntBufferto thepDeviceIndices()field.longpNext()NULLor a pointer to a structure extending this structure.VkBindAccelerationStructureMemoryInfoNVpNext(long value)Sets the specified value to thepNext()field.VkBindAccelerationStructureMemoryInfoNVset(int sType, long pNext, long accelerationStructure, long memory, long memoryOffset, java.nio.IntBuffer pDeviceIndices)Initializes this struct with the specified values.VkBindAccelerationStructureMemoryInfoNVset(VkBindAccelerationStructureMemoryInfoNV src)Copies the specified struct data to this struct.intsizeof()intsType()the type of this structure.VkBindAccelerationStructureMemoryInfoNVsType(int value)Sets the specified value to thesType()field.VkBindAccelerationStructureMemoryInfoNVsType$Default()Sets theSTRUCTURE_TYPE_BIND_ACCELERATION_STRUCTURE_MEMORY_INFO_NVvalue to thesType()field.static voidvalidate(long struct)Validates pointer members that should not beNULL.
-
-
-
Constructor Detail
-
VkBindAccelerationStructureMemoryInfoNV
public VkBindAccelerationStructureMemoryInfoNV(java.nio.ByteBuffer container)
Creates aVkBindAccelerationStructureMemoryInfoNVinstance 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()
the type of this structure.
-
pNext
public long pNext()
NULLor a pointer to a structure extending this structure.
-
accelerationStructure
public long accelerationStructure()
the acceleration structure to be attached to memory.
-
memory
public long memory()
aVkDeviceMemoryobject 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::sizemember inmemory, starting frommemoryOffsetbytes, will be bound to the specified acceleration structure.
-
deviceIndexCount
public int deviceIndexCount()
the number of elements inpDeviceIndices.
-
pDeviceIndices
@Nullable public java.nio.IntBuffer pDeviceIndices()
a pointer to an array of device indices.
-
sType
public VkBindAccelerationStructureMemoryInfoNV sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkBindAccelerationStructureMemoryInfoNV sType$Default()
Sets theSTRUCTURE_TYPE_BIND_ACCELERATION_STRUCTURE_MEMORY_INFO_NVvalue to thesType()field.
-
pNext
public VkBindAccelerationStructureMemoryInfoNV pNext(long value)
Sets the specified value to thepNext()field.
-
accelerationStructure
public VkBindAccelerationStructureMemoryInfoNV accelerationStructure(long value)
Sets the specified value to theaccelerationStructure()field.
-
memory
public VkBindAccelerationStructureMemoryInfoNV memory(long value)
Sets the specified value to thememory()field.
-
memoryOffset
public VkBindAccelerationStructureMemoryInfoNV memoryOffset(long value)
Sets the specified value to thememoryOffset()field.
-
pDeviceIndices
public VkBindAccelerationStructureMemoryInfoNV pDeviceIndices(@Nullable java.nio.IntBuffer value)
Sets the address of the specifiedIntBufferto thepDeviceIndices()field.
-
set
public VkBindAccelerationStructureMemoryInfoNV set(int sType, long pNext, long accelerationStructure, long memory, long memoryOffset, @Nullable java.nio.IntBuffer pDeviceIndices)
Initializes this struct with the specified values.
-
set
public VkBindAccelerationStructureMemoryInfoNV set(VkBindAccelerationStructureMemoryInfoNV src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkBindAccelerationStructureMemoryInfoNV malloc()
Returns a newVkBindAccelerationStructureMemoryInfoNVinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkBindAccelerationStructureMemoryInfoNV calloc()
Returns a newVkBindAccelerationStructureMemoryInfoNVinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkBindAccelerationStructureMemoryInfoNV create()
Returns a newVkBindAccelerationStructureMemoryInfoNVinstance allocated withBufferUtils.
-
create
public static VkBindAccelerationStructureMemoryInfoNV create(long address)
Returns a newVkBindAccelerationStructureMemoryInfoNVinstance for the specified memory address.
-
createSafe
@Nullable public static VkBindAccelerationStructureMemoryInfoNV createSafe(long address)
-
malloc
public static VkBindAccelerationStructureMemoryInfoNV.Buffer malloc(int capacity)
Returns a newVkBindAccelerationStructureMemoryInfoNV.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkBindAccelerationStructureMemoryInfoNV.Buffer calloc(int capacity)
Returns a newVkBindAccelerationStructureMemoryInfoNV.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkBindAccelerationStructureMemoryInfoNV.Buffer create(int capacity)
Returns a newVkBindAccelerationStructureMemoryInfoNV.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkBindAccelerationStructureMemoryInfoNV.Buffer create(long address, int capacity)
Create aVkBindAccelerationStructureMemoryInfoNV.Bufferinstance 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 public static VkBindAccelerationStructureMemoryInfoNV mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkBindAccelerationStructureMemoryInfoNV callocStack()
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkBindAccelerationStructureMemoryInfoNV mallocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkBindAccelerationStructureMemoryInfoNV callocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkBindAccelerationStructureMemoryInfoNV.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkBindAccelerationStructureMemoryInfoNV.Buffer callocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
mallocStack
@Deprecated public static VkBindAccelerationStructureMemoryInfoNV.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 VkBindAccelerationStructureMemoryInfoNV.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
malloc
public static VkBindAccelerationStructureMemoryInfoNV malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkBindAccelerationStructureMemoryInfoNVinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkBindAccelerationStructureMemoryInfoNV calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkBindAccelerationStructureMemoryInfoNVinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkBindAccelerationStructureMemoryInfoNV.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkBindAccelerationStructureMemoryInfoNV.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkBindAccelerationStructureMemoryInfoNV.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkBindAccelerationStructureMemoryInfoNV.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().
-
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
@Nullable public static java.nio.IntBuffer npDeviceIndices(long struct)
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 thedeviceIndexCountfield of the specifiedstruct.
-
npDeviceIndices
public static void npDeviceIndices(long struct, @Nullable java.nio.IntBuffer value)Unsafe version ofpDeviceIndices.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
-