Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkAccelerationStructureGeometryKHR

extends Struct<VkAccelerationStructureGeometryKHR>
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 geometries to be built into an acceleration structure.
Valid Usage (Implicit)
See Also

VkAccelerationStructureBuildGeometryInfoKHR, VkAccelerationStructureGeometryDataKHR

Layout


struct VkAccelerationStructureGeometryKHR {
    VkStructureType sType;
    void const * pNext;
    VkGeometryTypeKHR geometryType;
    VkAccelerationStructureGeometryDataKHR geometry;
    VkGeometryFlagsKHR flags;
}

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
FLAGS

The struct member offsets.

public static final int
GEOMETRY

The struct member offsets.

public static final int
GEOMETRYTYPE

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

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

Method Summary

Modifier and TypeMethod and Description
public static VkAccelerationStructureGeometryKHR
calloc()

Returns a new VkAccelerationStructureGeometryKHR instance allocated with memCalloc.

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

Returns a new VkAccelerationStructureGeometryKHR.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkAccelerationStructureGeometryKHR instance allocated with BufferUtils.

public static VkAccelerationStructureGeometryKHR
create(long address)

Returns a new VkAccelerationStructureGeometryKHR instance for the specified memory address.

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

Returns a new VkAccelerationStructureGeometryKHR.Buffer instance allocated with BufferUtils.

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

Create a VkAccelerationStructureGeometryKHR.Buffer instance at the specified memory.

public static VkAccelerationStructureGeometryKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
flags()

a bitmask of VkGeometryFlagBitsKHR values describing additional properties of how the geometry should be built.

public VkAccelerationStructureGeometryKHR
flags(int value)

Sets the specified value to the flags field.

public VkAccelerationStructureGeometryDataKHR
geometry()

a VkAccelerationStructureGeometryDataKHR union describing the geometry data for the relevant geometry type.

public VkAccelerationStructureGeometryKHR
public VkAccelerationStructureGeometryKHR
geometry(Consumer<VkAccelerationStructureGeometryDataKHR> consumer)

Passes the geometry field to the specified Consumer.

public int
geometryType()

describes which type of geometry this VkAccelerationStructureGeometryKHR refers to.

public VkAccelerationStructureGeometryKHR
geometryType(int value)

Sets the specified value to the geometryType field.

public static VkAccelerationStructureGeometryKHR
malloc()

Returns a new VkAccelerationStructureGeometryKHR instance allocated with memAlloc.

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

Returns a new VkAccelerationStructureGeometryKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkAccelerationStructureGeometryKHR instance allocated on the specified MemoryStack.

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

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

public static int
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static VkAccelerationStructureGeometryDataKHR
ngeometry(long struct)

Unsafe version of geometry.

public static void
ngeometry(long struct, VkAccelerationStructureGeometryDataKHR value)

Unsafe version of geometry.

public static int
ngeometryType(long struct)

Unsafe version of geometryType.

public static void
ngeometryType(long struct, int value)

Unsafe version of geometryType.

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

Sets the specified value to the pNext field.

public VkAccelerationStructureGeometryKHR
set(int sType, long pNext, int geometryType, VkAccelerationStructureGeometryDataKHR geometry, int flags)

Initializes this struct with the specified values.

public VkAccelerationStructureGeometryKHR

Returns:

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

Sets the specified value to the sType field.

public VkAccelerationStructureGeometryKHR
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.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

GEOMETRYback to summary
public static final int GEOMETRY

The struct member offsets.

GEOMETRYTYPEback to summary
public static final int GEOMETRYTYPE

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

VkAccelerationStructureGeometryKHRback to summary
protected VkAccelerationStructureGeometryKHR(long address, ByteBuffer container)
VkAccelerationStructureGeometryKHRback to summary
public VkAccelerationStructureGeometryKHR(ByteBuffer container)

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

callocback to summary
public static VkAccelerationStructureGeometryKHR calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkAccelerationStructureGeometryKHR calloc(MemoryStack stack)

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

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

Returns a new VkAccelerationStructureGeometryKHR instance allocated with BufferUtils.

createback to summary
public static VkAccelerationStructureGeometryKHR create(long address)

Returns a new VkAccelerationStructureGeometryKHR instance for the specified memory address.

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

Returns a new VkAccelerationStructureGeometryKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkAccelerationStructureGeometryKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkAccelerationStructureGeometryKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public int flags()

a bitmask of VkGeometryFlagBitsKHR values describing additional properties of how the geometry should be built.

Annotations
@NativeType:VkGeometryFlagsKHR
flagsback to summary
public VkAccelerationStructureGeometryKHR flags(int value)

Sets the specified value to the flags field.

geometryback to summary
public VkAccelerationStructureGeometryDataKHR geometry()

a VkAccelerationStructureGeometryDataKHR union describing the geometry data for the relevant geometry type.

geometryback to summary
public VkAccelerationStructureGeometryKHR geometry(VkAccelerationStructureGeometryDataKHR value)

Copies the specified VkAccelerationStructureGeometryDataKHR to the geometry field.

geometryback to summary
public VkAccelerationStructureGeometryKHR geometry(Consumer<VkAccelerationStructureGeometryDataKHR> consumer)

Passes the geometry field to the specified Consumer.

geometryTypeback to summary
public int geometryType()

describes which type of geometry this VkAccelerationStructureGeometryKHR refers to.

Annotations
@NativeType:VkGeometryTypeKHR
geometryTypeback to summary
public VkAccelerationStructureGeometryKHR geometryType(int value)

Sets the specified value to the geometryType field.

mallocback to summary
public static VkAccelerationStructureGeometryKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkAccelerationStructureGeometryKHR malloc(MemoryStack stack)

Returns a new VkAccelerationStructureGeometryKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nflagsback to summary
public static int nflags(long struct)

Unsafe version of flags.

nflagsback to summary
public static void nflags(long struct, int value)

Unsafe version of flags.

ngeometryback to summary
public static VkAccelerationStructureGeometryDataKHR ngeometry(long struct)

Unsafe version of geometry.

ngeometryback to summary
public static void ngeometry(long struct, VkAccelerationStructureGeometryDataKHR value)

Unsafe version of geometry.

ngeometryTypeback to summary
public static int ngeometryType(long struct)

Unsafe version of geometryType.

ngeometryTypeback to summary
public static void ngeometryType(long struct, int value)

Unsafe version of geometryType.

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

Sets the specified value to the pNext field.

setback to summary
public VkAccelerationStructureGeometryKHR set(int sType, long pNext, int geometryType, VkAccelerationStructureGeometryDataKHR geometry, int flags)

Initializes this struct with the specified values.

setback to summary
public VkAccelerationStructureGeometryKHR set(VkAccelerationStructureGeometryKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkAccelerationStructureGeometryKHR

the source struct

Returns:VkAccelerationStructureGeometryKHR

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkAccelerationStructureGeometryKHR.Buffer

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

An array of VkAccelerationStructureGeometryKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkAccelerationStructureGeometryKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

the value of the VkAccelerationStructureGeometryKHR#flags field.
flags
()

public VkAccelerationStructureGeometryKHR.Buffer
flags(int value)

Sets the specified value to the VkAccelerationStructureGeometryKHR#flags field.

public VkAccelerationStructureGeometryDataKHR
public VkAccelerationStructureGeometryKHR.Buffer
public VkAccelerationStructureGeometryKHR.Buffer
public int
public VkAccelerationStructureGeometryKHR.Buffer
geometryType(int value)

Sets the specified value to the VkAccelerationStructureGeometryKHR#geometryType field.

protected VkAccelerationStructureGeometryKHR
public long

Returns:

the value of the VkAccelerationStructureGeometryKHR#pNext field.
pNext
()

public VkAccelerationStructureGeometryKHR.Buffer
pNext(long value)

Sets the specified value to the VkAccelerationStructureGeometryKHR#pNext field.

protected VkAccelerationStructureGeometryKHR.Buffer
public int

Returns:

the value of the VkAccelerationStructureGeometryKHR#sType field.
sType
()

public VkAccelerationStructureGeometryKHR.Buffer
sType(int value)

Sets the specified value to the VkAccelerationStructureGeometryKHR#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkAccelerationStructureGeometryKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

flagsback to summary
public int flags()
Returns:int

the value of the VkAccelerationStructureGeometryKHR#flags field.

Annotations
@NativeType:VkGeometryFlagsKHR
flagsback to summary
public VkAccelerationStructureGeometryKHR.Buffer flags(int value)

Sets the specified value to the VkAccelerationStructureGeometryKHR#flags field.

geometryback to summary
public VkAccelerationStructureGeometryDataKHR geometry()
Returns:VkAccelerationStructureGeometryDataKHR

a VkAccelerationStructureGeometryDataKHR view of the VkAccelerationStructureGeometryKHR#geometry field.

geometryback to summary
public VkAccelerationStructureGeometryKHR.Buffer geometry(VkAccelerationStructureGeometryDataKHR value)

Copies the specified VkAccelerationStructureGeometryDataKHR to the VkAccelerationStructureGeometryKHR#geometry field.

geometryback to summary
public VkAccelerationStructureGeometryKHR.Buffer geometry(Consumer<VkAccelerationStructureGeometryDataKHR> consumer)

Passes the VkAccelerationStructureGeometryKHR#geometry field to the specified Consumer.

geometryTypeback to summary
public int geometryType()
Returns:int

the value of the VkAccelerationStructureGeometryKHR#geometryType field.

Annotations
@NativeType:VkGeometryTypeKHR
geometryTypeback to summary
public VkAccelerationStructureGeometryKHR.Buffer geometryType(int value)

Sets the specified value to the VkAccelerationStructureGeometryKHR#geometryType field.

getElementFactoryback to summary
protected VkAccelerationStructureGeometryKHR getElementFactory()

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

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

the value of the VkAccelerationStructureGeometryKHR#pNext field.

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

Sets the specified value to the VkAccelerationStructureGeometryKHR#pNext field.

selfback to summary
protected VkAccelerationStructureGeometryKHR.Buffer self()

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

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

the value of the VkAccelerationStructureGeometryKHR#sType field.

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

Sets the specified value to the VkAccelerationStructureGeometryKHR#sType field.

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

Sets the STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_KHR value to the VkAccelerationStructureGeometryKHR#sType field.