Package org.lwjgl.vulkan

Class VkAccelerationStructureCreateInfoNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkAccelerationStructureCreateInfoNV>

org.lwjgl.vulkan.VkAccelerationStructureCreateInfoNV

All Implemented Interfaces:

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

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

Structure specifying the parameters of a newly created acceleration structure object.

Valid Usage

• If compactedSize is not 0 then both info.geometryCount and info.instanceCount must be 0

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ACCELERATION_STRUCTURE_CREATE_INFO_NV
• pNext must be NULL or a pointer to a valid instance of VkOpaqueCaptureDescriptorDataCreateInfoEXT
• The sType value of each struct in the pNext chain must be unique
• info must be a valid VkAccelerationStructureInfoNV structure

See Also

VkAccelerationStructureInfoNV, CreateAccelerationStructureNV

Layout

 struct VkAccelerationStructureCreateInfoNV {
     VkStructureType sType();
     void const * pNext();
     VkDeviceSize compactedSize();
     VkAccelerationStructureInfoNV info();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkAccelerationStructureCreateInfoNV.Buffer	An array of VkAccelerationStructureCreateInfoNV 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	ALIGNOF	The struct alignment in bytes.
static final int	COMPACTEDSIZE	The struct member offsets.
static final int	INFO	The struct member offsets.
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.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkAccelerationStructureCreateInfoNV	calloc()	Returns a new VkAccelerationStructureCreateInfoNV instance allocated with memCalloc.
static VkAccelerationStructureCreateInfoNV.Buffer	calloc(int capacity)	Returns a new VkAccelerationStructureCreateInfoNV.Buffer instance allocated with memCalloc.
static VkAccelerationStructureCreateInfoNV.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureCreateInfoNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAccelerationStructureCreateInfoNV	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureCreateInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAccelerationStructureCreateInfoNV	callocStack()	Deprecated.
static VkAccelerationStructureCreateInfoNV.Buffer	callocStack(int capacity)	Deprecated.
static VkAccelerationStructureCreateInfoNV.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkAccelerationStructureCreateInfoNV	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
long	compactedSize()	the size from the result of CmdWriteAccelerationStructuresPropertiesNV if this acceleration structure is going to be the target of a compacting copy.
VkAccelerationStructureCreateInfoNV	compactedSize(long value)	Sets the specified value to the compactedSize() field.
static VkAccelerationStructureCreateInfoNV	create()	Returns a new VkAccelerationStructureCreateInfoNV instance allocated with BufferUtils.
static VkAccelerationStructureCreateInfoNV.Buffer	create(int capacity)	Returns a new VkAccelerationStructureCreateInfoNV.Buffer instance allocated with BufferUtils.
static VkAccelerationStructureCreateInfoNV	create(long address)	Returns a new VkAccelerationStructureCreateInfoNV instance for the specified memory address.
static VkAccelerationStructureCreateInfoNV.Buffer	create(long address, int capacity)	Create a VkAccelerationStructureCreateInfoNV.Buffer instance at the specified memory.
static @Nullable VkAccelerationStructureCreateInfoNV	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkAccelerationStructureCreateInfoNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkAccelerationStructureInfoNV	info()	the VkAccelerationStructureInfoNV structure specifying further parameters of the created acceleration structure.
VkAccelerationStructureCreateInfoNV	info(Consumer<VkAccelerationStructureInfoNV> consumer)	Passes the info() field to the specified Consumer.
VkAccelerationStructureCreateInfoNV	info(VkAccelerationStructureInfoNV value)	Copies the specified VkAccelerationStructureInfoNV to the info() field.
static VkAccelerationStructureCreateInfoNV	malloc()	Returns a new VkAccelerationStructureCreateInfoNV instance allocated with memAlloc.
static VkAccelerationStructureCreateInfoNV.Buffer	malloc(int capacity)	Returns a new VkAccelerationStructureCreateInfoNV.Buffer instance allocated with memAlloc.
static VkAccelerationStructureCreateInfoNV.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureCreateInfoNV.Buffer instance allocated on the specified MemoryStack.
static VkAccelerationStructureCreateInfoNV	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAccelerationStructureCreateInfoNV instance allocated on the specified MemoryStack.
static VkAccelerationStructureCreateInfoNV	mallocStack()	Deprecated.
static VkAccelerationStructureCreateInfoNV.Buffer	mallocStack(int capacity)	Deprecated.
static VkAccelerationStructureCreateInfoNV.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkAccelerationStructureCreateInfoNV	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static long	ncompactedSize(long struct)	Unsafe version of compactedSize().
static void	ncompactedSize(long struct, long value)	Unsafe version of compactedSize.
static VkAccelerationStructureInfoNV	ninfo(long struct)	Unsafe version of info().
static void	ninfo(long struct, VkAccelerationStructureInfoNV value)	Unsafe version of info.
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.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkAccelerationStructureCreateInfoNV	pNext(long value)	Sets the specified value to the pNext() field.
VkAccelerationStructureCreateInfoNV	pNext(VkOpaqueCaptureDescriptorDataCreateInfoEXT value)	Prepends the specified VkOpaqueCaptureDescriptorDataCreateInfoEXT value to the pNext chain.
VkAccelerationStructureCreateInfoNV	set(int sType, long pNext, long compactedSize, VkAccelerationStructureInfoNV info)	Initializes this struct with the specified values.
VkAccelerationStructureCreateInfoNV	set(VkAccelerationStructureCreateInfoNV src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkAccelerationStructureCreateInfoNV	sType(int value)	Sets the specified value to the sType() field.
VkAccelerationStructureCreateInfoNV	sType$Default()	Sets the STRUCTURE_TYPE_ACCELERATION_STRUCTURE_CREATE_INFO_NV value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

COMPACTEDSIZE

public static final int COMPACTEDSIZE

The struct member offsets.

INFO

public static final int INFO

The struct member offsets.

Constructor Details

VkAccelerationStructureCreateInfoNV

public VkAccelerationStructureCreateInfoNV(ByteBuffer container)

Creates a VkAccelerationStructureCreateInfoNV 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<VkAccelerationStructureCreateInfoNV>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

compactedSize

public long compactedSize()

the size from the result of CmdWriteAccelerationStructuresPropertiesNV if this acceleration structure is going to be the target of a compacting copy.

info

public VkAccelerationStructureInfoNV info()

the VkAccelerationStructureInfoNV structure specifying further parameters of the created acceleration structure.

sType

public VkAccelerationStructureCreateInfoNV sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkAccelerationStructureCreateInfoNV sType$Default()

Sets the STRUCTURE_TYPE_ACCELERATION_STRUCTURE_CREATE_INFO_NV value to the sType() field.

pNext

public VkAccelerationStructureCreateInfoNV pNext(long value)

Sets the specified value to the pNext() field.

pNext

public VkAccelerationStructureCreateInfoNV pNext(VkOpaqueCaptureDescriptorDataCreateInfoEXT value)

Prepends the specified VkOpaqueCaptureDescriptorDataCreateInfoEXT value to the pNext chain.

compactedSize

public VkAccelerationStructureCreateInfoNV compactedSize(long value)

Sets the specified value to the compactedSize() field.

info

public VkAccelerationStructureCreateInfoNV info(VkAccelerationStructureInfoNV value)

Copies the specified VkAccelerationStructureInfoNV to the info() field.

info

public VkAccelerationStructureCreateInfoNV info(Consumer<VkAccelerationStructureInfoNV> consumer)

Passes the info() field to the specified Consumer.

set

public VkAccelerationStructureCreateInfoNV set(int sType,
 long pNext,
 long compactedSize,
 VkAccelerationStructureInfoNV info)

Initializes this struct with the specified values.

set

public VkAccelerationStructureCreateInfoNV set(VkAccelerationStructureCreateInfoNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkAccelerationStructureCreateInfoNV malloc()

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

calloc

public static VkAccelerationStructureCreateInfoNV calloc()

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

create

public static VkAccelerationStructureCreateInfoNV create()

Returns a new VkAccelerationStructureCreateInfoNV instance allocated with BufferUtils.

create

public static VkAccelerationStructureCreateInfoNV create(long address)

Returns a new VkAccelerationStructureCreateInfoNV instance for the specified memory address.

createSafe

public static @Nullable VkAccelerationStructureCreateInfoNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkAccelerationStructureCreateInfoNV.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkAccelerationStructureCreateInfoNV.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkAccelerationStructureCreateInfoNV.Buffer create(int capacity)

Returns a new VkAccelerationStructureCreateInfoNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkAccelerationStructureCreateInfoNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkAccelerationStructureCreateInfoNV mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkAccelerationStructureCreateInfoNV callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkAccelerationStructureCreateInfoNV.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 VkAccelerationStructureCreateInfoNV.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 VkAccelerationStructureCreateInfoNV malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkAccelerationStructureCreateInfoNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkAccelerationStructureCreateInfoNV.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().

ncompactedSize

public static long ncompactedSize(long struct)

Unsafe version of compactedSize().

ninfo

public static VkAccelerationStructureInfoNV ninfo(long struct)

Unsafe version of info().

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.

ncompactedSize

public static void ncompactedSize(long struct,
 long value)

Unsafe version of compactedSize.

ninfo

public static void ninfo(long struct,
 VkAccelerationStructureInfoNV value)

Unsafe version of info.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate