Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkAccelerationStructureGeometryInstancesDataKHR

extends Struct<VkAccelerationStructureGeometryInstancesDataKHR>
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 a geometry consisting of instances of other acceleration structures.
Valid Usage (Implicit)
See Also

VkAccelerationStructureGeometryDataKHR, VkDeviceOrHostAddressConstKHR

Layout


struct VkAccelerationStructureGeometryInstancesDataKHR {
    VkStructureType sType;
    void const * pNext;
    VkBool32 arrayOfPointers;
    VkDeviceOrHostAddressConstKHR data;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
ARRAYOFPOINTERS

The struct member offsets.

public static final int
DATA

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
VkAccelerationStructureGeometryInstancesDataKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public boolean
arrayOfPointers()

specifies whether data is used as an array of addresses or just an array.

public VkAccelerationStructureGeometryInstancesDataKHR
arrayOfPointers(boolean value)

Sets the specified value to the arrayOfPointers field.

public static VkAccelerationStructureGeometryInstancesDataKHR
calloc()

Returns a new VkAccelerationStructureGeometryInstancesDataKHR instance allocated with memCalloc.

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

Returns a new VkAccelerationStructureGeometryInstancesDataKHR.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkAccelerationStructureGeometryInstancesDataKHR
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 VkAccelerationStructureGeometryInstancesDataKHR
create()

Returns a new VkAccelerationStructureGeometryInstancesDataKHR instance allocated with BufferUtils.

public static VkAccelerationStructureGeometryInstancesDataKHR
create(long address)

Returns a new VkAccelerationStructureGeometryInstancesDataKHR instance for the specified memory address.

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

Returns a new VkAccelerationStructureGeometryInstancesDataKHR.Buffer instance allocated with BufferUtils.

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

Create a VkAccelerationStructureGeometryInstancesDataKHR.Buffer instance at the specified memory.

public static VkAccelerationStructureGeometryInstancesDataKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public VkDeviceOrHostAddressConstKHR
data()

either the address of an array of device or host addresses referencing individual VkAccelerationStructureInstanceKHR structures or packed motion instance information as described in motion instances if arrayOfPointers is TRUE, or the address of an array of VkAccelerationStructureInstanceKHR or VkAccelerationStructureMotionInstanceNV structures.

public VkAccelerationStructureGeometryInstancesDataKHR
data(VkDeviceOrHostAddressConstKHR value)

Copies the specified VkDeviceOrHostAddressConstKHR to the data field.

public VkAccelerationStructureGeometryInstancesDataKHR
data(Consumer<VkDeviceOrHostAddressConstKHR> consumer)

Passes the data field to the specified Consumer.

public static VkAccelerationStructureGeometryInstancesDataKHR
malloc()

Returns a new VkAccelerationStructureGeometryInstancesDataKHR instance allocated with memAlloc.

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

Returns a new VkAccelerationStructureGeometryInstancesDataKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkAccelerationStructureGeometryInstancesDataKHR instance allocated on the specified MemoryStack.

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

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

public static int
narrayOfPointers(long struct)

Unsafe version of arrayOfPointers.

public static void
narrayOfPointers(long struct, int value)

Unsafe version of arrayOfPointers.

public static VkDeviceOrHostAddressConstKHR
ndata(long struct)

Unsafe version of data.

public static void
ndata(long struct, VkDeviceOrHostAddressConstKHR value)

Unsafe version of data.

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 long
pNext()

NULL or a pointer to a structure extending this structure.

public VkAccelerationStructureGeometryInstancesDataKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkAccelerationStructureGeometryInstancesDataKHR
set(int sType, long pNext, boolean arrayOfPointers, VkDeviceOrHostAddressConstKHR data)

Initializes this struct with the specified values.

public VkAccelerationStructureGeometryInstancesDataKHR

Returns:

this struct
set
(VkAccelerationStructureGeometryInstancesDataKHR
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 VkAccelerationStructureGeometryInstancesDataKHR
sType(int value)

Sets the specified value to the sType field.

public VkAccelerationStructureGeometryInstancesDataKHR
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

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

ARRAYOFPOINTERSback to summary
public static final int ARRAYOFPOINTERS

The struct member offsets.

DATAback to summary
public static final int DATA

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

VkAccelerationStructureGeometryInstancesDataKHRback to summary
protected VkAccelerationStructureGeometryInstancesDataKHR(long address, ByteBuffer container)
VkAccelerationStructureGeometryInstancesDataKHRback to summary
public VkAccelerationStructureGeometryInstancesDataKHR(ByteBuffer container)

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

arrayOfPointersback to summary
public boolean arrayOfPointers()

specifies whether data is used as an array of addresses or just an array.

Annotations
@NativeType:VkBool32
arrayOfPointersback to summary
public VkAccelerationStructureGeometryInstancesDataKHR arrayOfPointers(boolean value)

Sets the specified value to the arrayOfPointers field.

callocback to summary
public static VkAccelerationStructureGeometryInstancesDataKHR calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkAccelerationStructureGeometryInstancesDataKHR calloc(MemoryStack stack)

Returns a new VkAccelerationStructureGeometryInstancesDataKHR 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 VkAccelerationStructureGeometryInstancesDataKHR.Buffer calloc(int capacity, MemoryStack stack)

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

Returns a new VkAccelerationStructureGeometryInstancesDataKHR instance allocated with BufferUtils.

createback to summary
public static VkAccelerationStructureGeometryInstancesDataKHR create(long address)

Returns a new VkAccelerationStructureGeometryInstancesDataKHR instance for the specified memory address.

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

Returns a new VkAccelerationStructureGeometryInstancesDataKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkAccelerationStructureGeometryInstancesDataKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkAccelerationStructureGeometryInstancesDataKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
databack to summary
public VkDeviceOrHostAddressConstKHR data()

either the address of an array of device or host addresses referencing individual VkAccelerationStructureInstanceKHR structures or packed motion instance information as described in motion instances if arrayOfPointers is TRUE, or the address of an array of VkAccelerationStructureInstanceKHR or VkAccelerationStructureMotionInstanceNV structures. Addresses and VkAccelerationStructureInstanceKHR structures are tightly packed. VkAccelerationStructureMotionInstanceNV structures have a stride of 160 bytes.

databack to summary
public VkAccelerationStructureGeometryInstancesDataKHR data(VkDeviceOrHostAddressConstKHR value)

Copies the specified VkDeviceOrHostAddressConstKHR to the data field.

databack to summary
public VkAccelerationStructureGeometryInstancesDataKHR data(Consumer<VkDeviceOrHostAddressConstKHR> consumer)

Passes the data field to the specified Consumer.

mallocback to summary
public static VkAccelerationStructureGeometryInstancesDataKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkAccelerationStructureGeometryInstancesDataKHR malloc(MemoryStack stack)

Returns a new VkAccelerationStructureGeometryInstancesDataKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

narrayOfPointersback to summary
public static int narrayOfPointers(long struct)

Unsafe version of arrayOfPointers.

narrayOfPointersback to summary
public static void narrayOfPointers(long struct, int value)

Unsafe version of arrayOfPointers.

ndataback to summary
public static VkDeviceOrHostAddressConstKHR ndata(long struct)

Unsafe version of data.

ndataback to summary
public static void ndata(long struct, VkDeviceOrHostAddressConstKHR value)

Unsafe version of data.

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.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkAccelerationStructureGeometryInstancesDataKHR set(int sType, long pNext, boolean arrayOfPointers, VkDeviceOrHostAddressConstKHR data)

Initializes this struct with the specified values.

setback to summary
public VkAccelerationStructureGeometryInstancesDataKHR set(VkAccelerationStructureGeometryInstancesDataKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkAccelerationStructureGeometryInstancesDataKHR

the source struct

Returns:VkAccelerationStructureGeometryInstancesDataKHR

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 VkAccelerationStructureGeometryInstancesDataKHR sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_INSTANCES_DATA_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkAccelerationStructureGeometryInstancesDataKHR.Buffer

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

An array of VkAccelerationStructureGeometryInstancesDataKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkAccelerationStructureGeometryInstancesDataKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkAccelerationStructureGeometryInstancesDataKHR.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 boolean
public VkAccelerationStructureGeometryInstancesDataKHR.Buffer
arrayOfPointers(boolean value)

Sets the specified value to the VkAccelerationStructureGeometryInstancesDataKHR#arrayOfPointers field.

public VkDeviceOrHostAddressConstKHR
public VkAccelerationStructureGeometryInstancesDataKHR.Buffer
public VkAccelerationStructureGeometryInstancesDataKHR.Buffer
protected VkAccelerationStructureGeometryInstancesDataKHR
public long
public VkAccelerationStructureGeometryInstancesDataKHR.Buffer
pNext(long value)

Sets the specified value to the VkAccelerationStructureGeometryInstancesDataKHR#pNext field.

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

Sets the specified value to the VkAccelerationStructureGeometryInstancesDataKHR#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkAccelerationStructureGeometryInstancesDataKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkAccelerationStructureGeometryInstancesDataKHR.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 VkAccelerationStructureGeometryInstancesDataKHR#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

arrayOfPointersback to summary
public boolean arrayOfPointers()
Returns:boolean

the value of the VkAccelerationStructureGeometryInstancesDataKHR#arrayOfPointers field.

Annotations
@NativeType:VkBool32
arrayOfPointersback to summary
public VkAccelerationStructureGeometryInstancesDataKHR.Buffer arrayOfPointers(boolean value)

Sets the specified value to the VkAccelerationStructureGeometryInstancesDataKHR#arrayOfPointers field.

databack to summary
public VkDeviceOrHostAddressConstKHR data()
Returns:VkDeviceOrHostAddressConstKHR

a VkDeviceOrHostAddressConstKHR view of the VkAccelerationStructureGeometryInstancesDataKHR#data field.

databack to summary
public VkAccelerationStructureGeometryInstancesDataKHR.Buffer data(VkDeviceOrHostAddressConstKHR value)

Copies the specified VkDeviceOrHostAddressConstKHR to the VkAccelerationStructureGeometryInstancesDataKHR#data field.

databack to summary
public VkAccelerationStructureGeometryInstancesDataKHR.Buffer data(Consumer<VkDeviceOrHostAddressConstKHR> consumer)

Passes the VkAccelerationStructureGeometryInstancesDataKHR#data field to the specified Consumer.

getElementFactoryback to summary
protected VkAccelerationStructureGeometryInstancesDataKHR getElementFactory()

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

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkAccelerationStructureGeometryInstancesDataKHR#pNext field.

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

Sets the specified value to the VkAccelerationStructureGeometryInstancesDataKHR#pNext field.

selfback to summary
protected VkAccelerationStructureGeometryInstancesDataKHR.Buffer self()

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

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

the value of the VkAccelerationStructureGeometryInstancesDataKHR#sType field.

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

Sets the specified value to the VkAccelerationStructureGeometryInstancesDataKHR#sType field.

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

Sets the STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_INSTANCES_DATA_KHR value to the VkAccelerationStructureGeometryInstancesDataKHR#sType field.