Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkWriteDescriptorSetAccelerationStructureKHR

extends Struct<VkWriteDescriptorSetAccelerationStructureKHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying acceleration structure descriptor information.
Valid Usage
Valid Usage (Implicit)

Layout


struct VkWriteDescriptorSetAccelerationStructureKHR {
    VkStructureType sType;
    void const * pNext;
    uint32_t accelerationStructureCount;
    VkAccelerationStructureKHR const * pAccelerationStructures;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ACCELERATIONSTRUCTURECOUNT

The struct member offsets.

public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PACCELERATIONSTRUCTURES

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkWriteDescriptorSetAccelerationStructureKHR(ByteBuffer container)

Creates a VkWriteDescriptorSetAccelerationStructureKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public int
accelerationStructureCount()

the number of elements in pAccelerationStructures.

public VkWriteDescriptorSetAccelerationStructureKHR
accelerationStructureCount(int value)

Sets the specified value to the accelerationStructureCount field.

public static VkWriteDescriptorSetAccelerationStructureKHR
calloc()

Returns a new VkWriteDescriptorSetAccelerationStructureKHR instance allocated with memCalloc.

public static VkWriteDescriptorSetAccelerationStructureKHR.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkWriteDescriptorSetAccelerationStructureKHR.Buffer instance allocated with memCalloc.

public static VkWriteDescriptorSetAccelerationStructureKHR
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkWriteDescriptorSetAccelerationStructureKHR.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected VkWriteDescriptorSetAccelerationStructureKHR
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkWriteDescriptorSetAccelerationStructureKHR
create()

Returns a new VkWriteDescriptorSetAccelerationStructureKHR instance allocated with BufferUtils.

public static VkWriteDescriptorSetAccelerationStructureKHR
create(long address)

Returns a new VkWriteDescriptorSetAccelerationStructureKHR instance for the specified memory address.

public static VkWriteDescriptorSetAccelerationStructureKHR.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkWriteDescriptorSetAccelerationStructureKHR.Buffer instance allocated with BufferUtils.

public static VkWriteDescriptorSetAccelerationStructureKHR.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkWriteDescriptorSetAccelerationStructureKHR.Buffer instance at the specified memory.

public static VkWriteDescriptorSetAccelerationStructureKHR
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkWriteDescriptorSetAccelerationStructureKHR.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static VkWriteDescriptorSetAccelerationStructureKHR
malloc()

Returns a new VkWriteDescriptorSetAccelerationStructureKHR instance allocated with memAlloc.

public static VkWriteDescriptorSetAccelerationStructureKHR.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkWriteDescriptorSetAccelerationStructureKHR.Buffer instance allocated with memAlloc.

public static VkWriteDescriptorSetAccelerationStructureKHR
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkWriteDescriptorSetAccelerationStructureKHR instance allocated on the specified MemoryStack.

public static VkWriteDescriptorSetAccelerationStructureKHR.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static int
public static void
naccelerationStructureCount(long struct, int value)

Sets the specified value to the accelerationStructureCount field of the specified struct.

public static LongBuffer
npAccelerationStructures(long struct)

Unsafe version of pAccelerationStructures.

public static void
npAccelerationStructures(long struct, LongBuffer value)

Unsafe version of pAccelerationStructures.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public LongBuffer
pAccelerationStructures()

a pointer to an array of VkAccelerationStructureKHR structures specifying the acceleration structures to update.

public VkWriteDescriptorSetAccelerationStructureKHR
pAccelerationStructures(LongBuffer value)

Sets the address of the specified LongBuffer to the pAccelerationStructures field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkWriteDescriptorSetAccelerationStructureKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkWriteDescriptorSetAccelerationStructureKHR
set(int sType, long pNext, int accelerationStructureCount, LongBuffer pAccelerationStructures)

Initializes this struct with the specified values.

public VkWriteDescriptorSetAccelerationStructureKHR

Returns:

this struct
set
(VkWriteDescriptorSetAccelerationStructureKHR
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkWriteDescriptorSetAccelerationStructureKHR
sType(int value)

Sets the specified value to the sType field.

public VkWriteDescriptorSetAccelerationStructureKHR
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ACCELERATIONSTRUCTURECOUNTback to summary
public static final int ACCELERATIONSTRUCTURECOUNT

The struct member offsets.

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

PACCELERATIONSTRUCTURESback to summary
public static final int PACCELERATIONSTRUCTURES

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkWriteDescriptorSetAccelerationStructureKHRback to summary
protected VkWriteDescriptorSetAccelerationStructureKHR(long address, ByteBuffer container)
VkWriteDescriptorSetAccelerationStructureKHRback to summary
public VkWriteDescriptorSetAccelerationStructureKHR(ByteBuffer container)

Creates a VkWriteDescriptorSetAccelerationStructureKHR 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 Detail

accelerationStructureCountback to summary
public int accelerationStructureCount()

the number of elements in pAccelerationStructures.

Annotations
@NativeType:uint32_t
accelerationStructureCountback to summary
public VkWriteDescriptorSetAccelerationStructureKHR accelerationStructureCount(int value)

Sets the specified value to the accelerationStructureCount field.

callocback to summary
public static VkWriteDescriptorSetAccelerationStructureKHR calloc()

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

callocback to summary
public static VkWriteDescriptorSetAccelerationStructureKHR.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkWriteDescriptorSetAccelerationStructureKHR calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkWriteDescriptorSetAccelerationStructureKHR.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected VkWriteDescriptorSetAccelerationStructureKHR create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkWriteDescriptorSetAccelerationStructureKHR create()

Returns a new VkWriteDescriptorSetAccelerationStructureKHR instance allocated with BufferUtils.

createback to summary
public static VkWriteDescriptorSetAccelerationStructureKHR create(long address)

Returns a new VkWriteDescriptorSetAccelerationStructureKHR instance for the specified memory address.

createback to summary
public static VkWriteDescriptorSetAccelerationStructureKHR.Buffer create(int capacity)

Returns a new VkWriteDescriptorSetAccelerationStructureKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkWriteDescriptorSetAccelerationStructureKHR.Buffer create(long address, int capacity)

Create a VkWriteDescriptorSetAccelerationStructureKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkWriteDescriptorSetAccelerationStructureKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkWriteDescriptorSetAccelerationStructureKHR.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkWriteDescriptorSetAccelerationStructureKHR malloc()

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

mallocback to summary
public static VkWriteDescriptorSetAccelerationStructureKHR.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkWriteDescriptorSetAccelerationStructureKHR malloc(MemoryStack stack)

Returns a new VkWriteDescriptorSetAccelerationStructureKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkWriteDescriptorSetAccelerationStructureKHR.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

naccelerationStructureCountback to summary
public static int naccelerationStructureCount(long struct)

Unsafe version of accelerationStructureCount.

naccelerationStructureCountback to summary
public static void naccelerationStructureCount(long struct, int value)

Sets the specified value to the accelerationStructureCount field of the specified struct.

npAccelerationStructuresback to summary
public static LongBuffer npAccelerationStructures(long struct)

Unsafe version of pAccelerationStructures.

Annotations
@Nullable
npAccelerationStructuresback to summary
public static void npAccelerationStructures(long struct, LongBuffer value)

Unsafe version of pAccelerationStructures.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pAccelerationStructuresback to summary
public LongBuffer pAccelerationStructures()

a pointer to an array of VkAccelerationStructureKHR structures specifying the acceleration structures to update.

Annotations
@Nullable
@NativeType:VkAccelerationStructureKHR const *
pAccelerationStructuresback to summary
public VkWriteDescriptorSetAccelerationStructureKHR pAccelerationStructures(LongBuffer value)

Sets the address of the specified LongBuffer to the pAccelerationStructures field.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkWriteDescriptorSetAccelerationStructureKHR pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkWriteDescriptorSetAccelerationStructureKHR set(int sType, long pNext, int accelerationStructureCount, LongBuffer pAccelerationStructures)

Initializes this struct with the specified values.

setback to summary
public VkWriteDescriptorSetAccelerationStructureKHR set(VkWriteDescriptorSetAccelerationStructureKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkWriteDescriptorSetAccelerationStructureKHR

the source struct

Returns:VkWriteDescriptorSetAccelerationStructureKHR

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkWriteDescriptorSetAccelerationStructureKHR sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkWriteDescriptorSetAccelerationStructureKHR sType$Default()

Sets the STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET_ACCELERATION_STRUCTURE_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkWriteDescriptorSetAccelerationStructureKHR.Buffer

extends StructBuffer<VkWriteDescriptorSetAccelerationStructureKHR, VkWriteDescriptorSetAccelerationStructureKHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkWriteDescriptorSetAccelerationStructureKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkWriteDescriptorSetAccelerationStructureKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkWriteDescriptorSetAccelerationStructureKHR.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public int
public VkWriteDescriptorSetAccelerationStructureKHR.Buffer
protected VkWriteDescriptorSetAccelerationStructureKHR
public LongBuffer
public VkWriteDescriptorSetAccelerationStructureKHR.Buffer
public long
public VkWriteDescriptorSetAccelerationStructureKHR.Buffer
pNext(long value)

Sets the specified value to the VkWriteDescriptorSetAccelerationStructureKHR#pNext field.

protected VkWriteDescriptorSetAccelerationStructureKHR.Buffer
public int
public VkWriteDescriptorSetAccelerationStructureKHR.Buffer
sType(int value)

Sets the specified value to the VkWriteDescriptorSetAccelerationStructureKHR#sType field.

public VkWriteDescriptorSetAccelerationStructureKHR.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkWriteDescriptorSetAccelerationStructureKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkWriteDescriptorSetAccelerationStructureKHR.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkWriteDescriptorSetAccelerationStructureKHR#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

accelerationStructureCountback to summary
public int accelerationStructureCount()
Returns:int

the value of the VkWriteDescriptorSetAccelerationStructureKHR#accelerationStructureCount field.

Annotations
@NativeType:uint32_t
accelerationStructureCountback to summary
public VkWriteDescriptorSetAccelerationStructureKHR.Buffer accelerationStructureCount(int value)

Sets the specified value to the VkWriteDescriptorSetAccelerationStructureKHR#accelerationStructureCount field.

getElementFactoryback to summary
protected VkWriteDescriptorSetAccelerationStructureKHR getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pAccelerationStructuresback to summary
public LongBuffer pAccelerationStructures()
Returns:LongBuffer

a LongBuffer view of the data pointed to by the VkWriteDescriptorSetAccelerationStructureKHR#pAccelerationStructures field.

Annotations
@Nullable
@NativeType:VkAccelerationStructureKHR const *
pAccelerationStructuresback to summary
public VkWriteDescriptorSetAccelerationStructureKHR.Buffer pAccelerationStructures(LongBuffer value)

Sets the address of the specified LongBuffer to the VkWriteDescriptorSetAccelerationStructureKHR#pAccelerationStructures field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkWriteDescriptorSetAccelerationStructureKHR#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkWriteDescriptorSetAccelerationStructureKHR.Buffer pNext(long value)

Sets the specified value to the VkWriteDescriptorSetAccelerationStructureKHR#pNext field.

selfback to summary
protected VkWriteDescriptorSetAccelerationStructureKHR.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkWriteDescriptorSetAccelerationStructureKHR#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkWriteDescriptorSetAccelerationStructureKHR.Buffer sType(int value)

Sets the specified value to the VkWriteDescriptorSetAccelerationStructureKHR#sType field.

sType$Defaultback to summary
public VkWriteDescriptorSetAccelerationStructureKHR.Buffer sType$Default()

Sets the STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET_ACCELERATION_STRUCTURE_KHR value to the VkWriteDescriptorSetAccelerationStructureKHR#sType field.