Package org.lwjgl.vulkan

Class VkAccelerationStructureMemoryRequirementsInfoNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkAccelerationStructureMemoryRequirementsInfoNV>

org.lwjgl.vulkan.VkAccelerationStructureMemoryRequirementsInfoNV

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkAccelerationStructureMemoryRequirementsInfoNV
extends org.lwjgl.system.Struct<VkAccelerationStructureMemoryRequirementsInfoNV>
implements org.lwjgl.system.NativeResource

Structure specifying acceleration to query for memory requirements.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_INFO_NV
• pNext must be NULL
• type must be a valid VkAccelerationStructureMemoryRequirementsTypeNV value
• accelerationStructure must be a valid VkAccelerationStructureNV handle

See Also

GetAccelerationStructureMemoryRequirementsNV

Layout

 struct VkAccelerationStructureMemoryRequirementsInfoNV {
     VkStructureType sType();
     void const * pNext();
     VkAccelerationStructureMemoryRequirementsTypeNV type();
     VkAccelerationStructureNV accelerationStructure();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkAccelerationStructureMemoryRequirementsInfoNV.Buffer	An array of VkAccelerationStructureMemoryRequirementsInfoNV structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ACCELERATIONSTRUCTURE	The struct member offsets.
static final int	ALIGNOF	The struct alignment in bytes.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.
static final int	TYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkAccelerationStructureMemoryRequirementsInfoNV(ByteBuffer container)	Creates a VkAccelerationStructureMemoryRequirementsInfoNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
long	accelerationStructure()	the acceleration structure to be queried for memory requirements.
VkAccelerationStructureMemoryRequirementsInfoNV	accelerationStructure(long value)	Sets the specified value to the accelerationStructure() field.
static VkAccelerationStructureMemoryRequirementsInfoNV	calloc()	Returns a new VkAccelerationStructureMemoryRequirementsInfoNV instance allocated with memCalloc.
static VkAccelerationStructureMemoryRequirementsInfoNV.Buffer	calloc(int capacity)	Returns a new VkAccelerationStructureMemoryRequirementsInfoNV.Buffer instance allocated with memCalloc.
static VkAccelerationStructureMemoryRequirementsInfoNV.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureMemoryRequirementsInfoNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAccelerationStructureMemoryRequirementsInfoNV	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureMemoryRequirementsInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAccelerationStructureMemoryRequirementsInfoNV	callocStack()	Deprecated.
static VkAccelerationStructureMemoryRequirementsInfoNV.Buffer	callocStack(int capacity)	Deprecated.
static VkAccelerationStructureMemoryRequirementsInfoNV.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkAccelerationStructureMemoryRequirementsInfoNV	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkAccelerationStructureMemoryRequirementsInfoNV	create()	Returns a new VkAccelerationStructureMemoryRequirementsInfoNV instance allocated with BufferUtils.
static VkAccelerationStructureMemoryRequirementsInfoNV.Buffer	create(int capacity)	Returns a new VkAccelerationStructureMemoryRequirementsInfoNV.Buffer instance allocated with BufferUtils.
static VkAccelerationStructureMemoryRequirementsInfoNV	create(long address)	Returns a new VkAccelerationStructureMemoryRequirementsInfoNV instance for the specified memory address.
static VkAccelerationStructureMemoryRequirementsInfoNV.Buffer	create(long address, int capacity)	Create a VkAccelerationStructureMemoryRequirementsInfoNV.Buffer instance at the specified memory.
static @Nullable VkAccelerationStructureMemoryRequirementsInfoNV	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkAccelerationStructureMemoryRequirementsInfoNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkAccelerationStructureMemoryRequirementsInfoNV	malloc()	Returns a new VkAccelerationStructureMemoryRequirementsInfoNV instance allocated with memAlloc.
static VkAccelerationStructureMemoryRequirementsInfoNV.Buffer	malloc(int capacity)	Returns a new VkAccelerationStructureMemoryRequirementsInfoNV.Buffer instance allocated with memAlloc.
static VkAccelerationStructureMemoryRequirementsInfoNV.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureMemoryRequirementsInfoNV.Buffer instance allocated on the specified MemoryStack.
static VkAccelerationStructureMemoryRequirementsInfoNV	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureMemoryRequirementsInfoNV instance allocated on the specified MemoryStack.
static VkAccelerationStructureMemoryRequirementsInfoNV	mallocStack()	Deprecated.
static VkAccelerationStructureMemoryRequirementsInfoNV.Buffer	mallocStack(int capacity)	Deprecated.
static VkAccelerationStructureMemoryRequirementsInfoNV.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkAccelerationStructureMemoryRequirementsInfoNV	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static long	naccelerationStructure(long struct)	Unsafe version of accelerationStructure().
static void	naccelerationStructure(long struct, long value)	Unsafe version of accelerationStructure.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkAccelerationStructureMemoryRequirementsInfoNV	pNext(long value)	Sets the specified value to the pNext() field.
VkAccelerationStructureMemoryRequirementsInfoNV	set(int sType, long pNext, int type, long accelerationStructure)	Initializes this struct with the specified values.
VkAccelerationStructureMemoryRequirementsInfoNV	set(VkAccelerationStructureMemoryRequirementsInfoNV src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkAccelerationStructureMemoryRequirementsInfoNV	sType(int value)	Sets the specified value to the sType() field.
VkAccelerationStructureMemoryRequirementsInfoNV	sType$Default()	Sets the STRUCTURE_TYPE_ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_INFO_NV value to the sType() field.
int	type()	selects the type of memory requirement being queried.
VkAccelerationStructureMemoryRequirementsInfoNV	type(int value)	Sets the specified value to the type() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

TYPE

public static final int TYPE

The struct member offsets.

ACCELERATIONSTRUCTURE

public static final int ACCELERATIONSTRUCTURE

The struct member offsets.

Constructor Details

VkAccelerationStructureMemoryRequirementsInfoNV

public VkAccelerationStructureMemoryRequirementsInfoNV(ByteBuffer container)

Creates a VkAccelerationStructureMemoryRequirementsInfoNV instance at the current position of the specified ByteBuffer 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()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkAccelerationStructureMemoryRequirementsInfoNV>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

type

public int type()

selects the type of memory requirement being queried. ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_OBJECT_NV returns the memory requirements for the object itself. ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_BUILD_SCRATCH_NV returns the memory requirements for the scratch memory when doing a build. ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_UPDATE_SCRATCH_NV returns the memory requirements for the scratch memory when doing an update.

accelerationStructure

public long accelerationStructure()

the acceleration structure to be queried for memory requirements.

sType

public VkAccelerationStructureMemoryRequirementsInfoNV sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkAccelerationStructureMemoryRequirementsInfoNV sType$Default()

Sets the STRUCTURE_TYPE_ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_INFO_NV value to the sType() field.

pNext

public VkAccelerationStructureMemoryRequirementsInfoNV pNext(long value)

Sets the specified value to the pNext() field.

type

public VkAccelerationStructureMemoryRequirementsInfoNV type(int value)

Sets the specified value to the type() field.

accelerationStructure

public VkAccelerationStructureMemoryRequirementsInfoNV accelerationStructure(long value)

Sets the specified value to the accelerationStructure() field.

set

public VkAccelerationStructureMemoryRequirementsInfoNV set(int sType,
 long pNext,
 int type,
 long accelerationStructure)

Initializes this struct with the specified values.

set

public VkAccelerationStructureMemoryRequirementsInfoNV set(VkAccelerationStructureMemoryRequirementsInfoNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkAccelerationStructureMemoryRequirementsInfoNV malloc()

Returns a new VkAccelerationStructureMemoryRequirementsInfoNV instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkAccelerationStructureMemoryRequirementsInfoNV calloc()

Returns a new VkAccelerationStructureMemoryRequirementsInfoNV instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkAccelerationStructureMemoryRequirementsInfoNV create()

Returns a new VkAccelerationStructureMemoryRequirementsInfoNV instance allocated with BufferUtils.

create

public static VkAccelerationStructureMemoryRequirementsInfoNV create(long address)

Returns a new VkAccelerationStructureMemoryRequirementsInfoNV instance for the specified memory address.

createSafe

public static @Nullable VkAccelerationStructureMemoryRequirementsInfoNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkAccelerationStructureMemoryRequirementsInfoNV.Buffer malloc(int capacity)

Returns a new VkAccelerationStructureMemoryRequirementsInfoNV.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkAccelerationStructureMemoryRequirementsInfoNV.Buffer calloc(int capacity)

Returns a new VkAccelerationStructureMemoryRequirementsInfoNV.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkAccelerationStructureMemoryRequirementsInfoNV.Buffer create(int capacity)

Returns a new VkAccelerationStructureMemoryRequirementsInfoNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkAccelerationStructureMemoryRequirementsInfoNV.Buffer create(long address,
 int capacity)

Create a VkAccelerationStructureMemoryRequirementsInfoNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkAccelerationStructureMemoryRequirementsInfoNV.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkAccelerationStructureMemoryRequirementsInfoNV mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkAccelerationStructureMemoryRequirementsInfoNV callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkAccelerationStructureMemoryRequirementsInfoNV mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkAccelerationStructureMemoryRequirementsInfoNV callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkAccelerationStructureMemoryRequirementsInfoNV.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkAccelerationStructureMemoryRequirementsInfoNV.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VkAccelerationStructureMemoryRequirementsInfoNV.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkAccelerationStructureMemoryRequirementsInfoNV.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static VkAccelerationStructureMemoryRequirementsInfoNV malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkAccelerationStructureMemoryRequirementsInfoNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkAccelerationStructureMemoryRequirementsInfoNV calloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkAccelerationStructureMemoryRequirementsInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static VkAccelerationStructureMemoryRequirementsInfoNV.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkAccelerationStructureMemoryRequirementsInfoNV.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkAccelerationStructureMemoryRequirementsInfoNV.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkAccelerationStructureMemoryRequirementsInfoNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

ntype

public static int ntype(long struct)

Unsafe version of type().

naccelerationStructure

public static long naccelerationStructure(long struct)

Unsafe version of accelerationStructure().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

ntype

public static void ntype(long struct,
 int value)

Unsafe version of type.

naccelerationStructure

public static void naccelerationStructure(long struct,
 long value)

Unsafe version of accelerationStructure.