org.lwjgl.vulkan.VkAccelerationStructureInstanceKHR Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-vulkan Show documentation
Show all versions of lwjgl-vulkan Show documentation
A new generation graphics and compute API that provides high-efficiency, cross-platform access to modern GPUs used in a wide variety of devices from PCs and consoles to mobile phones and embedded platforms.
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.vulkan;
import javax.annotation.*;
import java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Structure specifying a single acceleration structure instance for building into an acceleration structure geometry.
*
* Description
*
* The C language specification does not define the ordering of bit-fields, but in practice, this struct produces the correct layout with existing compilers. The intended bit pattern is for the following:
*
*
* - {@code instanceCustomIndex} and {@code mask} occupy the same memory as if a single {@code uint32_t} was specified in their place
*
*
* - {@code instanceCustomIndex} occupies the 24 least significant bits of that memory
* - {@code mask} occupies the 8 most significant bits of that memory
*
*
* - {@code instanceShaderBindingTableRecordOffset} and {@code flags} occupy the same memory as if a single {@code uint32_t} was specified in their place
*
*
* - {@code instanceShaderBindingTableRecordOffset} occupies the 24 least significant bits of that memory
* - {@code flags} occupies the 8 most significant bits of that memory
*
*
*
*
* If a compiler produces code that diverges from that pattern, applications must employ another method to set values according to the correct bit pattern.
*
* Valid Usage (Implicit)
*
*
* - {@code flags} must be a valid combination of {@code VkGeometryInstanceFlagBitsKHR} values
*
*
* See Also
*
* {@link VkAccelerationStructureMotionInstanceDataNV}, {@link VkTransformMatrixKHR}
*
* Layout
*
*
* struct VkAccelerationStructureInstanceKHR {
* {@link VkTransformMatrixKHR VkTransformMatrixKHR} {@link #transform};
* uint32_t {@link #instanceCustomIndex} : 24;
* uint32_t {@link #mask} : 8;
* uint32_t {@link #instanceShaderBindingTableRecordOffset} : 24;
* VkGeometryInstanceFlagsKHR {@link #flags} : 8;
* uint64_t {@link #accelerationStructureReference};
* }
*/
public class VkAccelerationStructureInstanceKHR extends Struct implements NativeResource {
/** The struct size in bytes. */
public static final int SIZEOF;
/** The struct alignment in bytes. */
public static final int ALIGNOF;
/** The struct member offsets. */
public static final int
TRANSFORM,
BITFIELD0,
BITFIELD1,
ACCELERATIONSTRUCTUREREFERENCE;
static {
Layout layout = __struct(
__member(VkTransformMatrixKHR.SIZEOF, VkTransformMatrixKHR.ALIGNOF),
__member(4),
__member(4),
__member(8)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
TRANSFORM = layout.offsetof(0);
BITFIELD0 = layout.offsetof(1);
BITFIELD1 = layout.offsetof(2);
ACCELERATIONSTRUCTUREREFERENCE = layout.offsetof(3);
}
/**
* Creates a {@code VkAccelerationStructureInstanceKHR} instance at the current position of the specified {@link 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.
*/
public VkAccelerationStructureInstanceKHR(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** a {@link VkTransformMatrixKHR} structure describing a transformation to be applied to the acceleration structure. */
public VkTransformMatrixKHR transform() { return ntransform(address()); }
/** a 24-bit user-specified index value accessible to ray shaders in the {@code InstanceCustomIndexKHR} built-in. */
@NativeType("uint32_t")
public int instanceCustomIndex() { return ninstanceCustomIndex(address()); }
/** an 8-bit visibility mask for the geometry. The instance may only be hit if {@code Cull Mask & instance.mask != 0} */
@NativeType("uint32_t")
public int mask() { return nmask(address()); }
/** a 24-bit offset used in calculating the hit shader binding table index. */
@NativeType("uint32_t")
public int instanceShaderBindingTableRecordOffset() { return ninstanceShaderBindingTableRecordOffset(address()); }
/** an 8-bit mask of {@code VkGeometryInstanceFlagBitsKHR} values to apply to this instance. */
@NativeType("VkGeometryInstanceFlagsKHR")
public int flags() { return nflags(address()); }
/**
* either:
*
*
* - a device address containing the value obtained from {@link KHRAccelerationStructure#vkGetAccelerationStructureDeviceAddressKHR GetAccelerationStructureDeviceAddressKHR} or {@link NVRayTracing#vkGetAccelerationStructureHandleNV GetAccelerationStructureHandleNV} (used by device operations which reference acceleration structures) or,
* - a {@code VkAccelerationStructureKHR} object (used by host operations which reference acceleration structures).
*
*/
@NativeType("uint64_t")
public long accelerationStructureReference() { return naccelerationStructureReference(address()); }
/** Copies the specified {@link VkTransformMatrixKHR} to the {@link #transform} field. */
public VkAccelerationStructureInstanceKHR transform(VkTransformMatrixKHR value) { ntransform(address(), value); return this; }
/** Passes the {@link #transform} field to the specified {@link java.util.function.Consumer Consumer}. */
public VkAccelerationStructureInstanceKHR transform(java.util.function.Consumer consumer) { consumer.accept(transform()); return this; }
/** Sets the specified value to the {@link #instanceCustomIndex} field. */
public VkAccelerationStructureInstanceKHR instanceCustomIndex(@NativeType("uint32_t") int value) { ninstanceCustomIndex(address(), value); return this; }
/** Sets the specified value to the {@link #mask} field. */
public VkAccelerationStructureInstanceKHR mask(@NativeType("uint32_t") int value) { nmask(address(), value); return this; }
/** Sets the specified value to the {@link #instanceShaderBindingTableRecordOffset} field. */
public VkAccelerationStructureInstanceKHR instanceShaderBindingTableRecordOffset(@NativeType("uint32_t") int value) { ninstanceShaderBindingTableRecordOffset(address(), value); return this; }
/** Sets the specified value to the {@link #flags} field. */
public VkAccelerationStructureInstanceKHR flags(@NativeType("VkGeometryInstanceFlagsKHR") int value) { nflags(address(), value); return this; }
/** Sets the specified value to the {@link #accelerationStructureReference} field. */
public VkAccelerationStructureInstanceKHR accelerationStructureReference(@NativeType("uint64_t") long value) { naccelerationStructureReference(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkAccelerationStructureInstanceKHR set(
VkTransformMatrixKHR transform,
int instanceCustomIndex,
int mask,
int instanceShaderBindingTableRecordOffset,
int flags,
long accelerationStructureReference
) {
transform(transform);
instanceCustomIndex(instanceCustomIndex);
mask(mask);
instanceShaderBindingTableRecordOffset(instanceShaderBindingTableRecordOffset);
flags(flags);
accelerationStructureReference(accelerationStructureReference);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkAccelerationStructureInstanceKHR set(VkAccelerationStructureInstanceKHR src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code VkAccelerationStructureInstanceKHR} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkAccelerationStructureInstanceKHR malloc() {
return wrap(VkAccelerationStructureInstanceKHR.class, nmemAllocChecked(SIZEOF));
}
/** Returns a new {@code VkAccelerationStructureInstanceKHR} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkAccelerationStructureInstanceKHR calloc() {
return wrap(VkAccelerationStructureInstanceKHR.class, nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@code VkAccelerationStructureInstanceKHR} instance allocated with {@link BufferUtils}. */
public static VkAccelerationStructureInstanceKHR create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return wrap(VkAccelerationStructureInstanceKHR.class, memAddress(container), container);
}
/** Returns a new {@code VkAccelerationStructureInstanceKHR} instance for the specified memory address. */
public static VkAccelerationStructureInstanceKHR create(long address) {
return wrap(VkAccelerationStructureInstanceKHR.class, address);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkAccelerationStructureInstanceKHR createSafe(long address) {
return address == NULL ? null : wrap(VkAccelerationStructureInstanceKHR.class, address);
}
/**
* Returns a new {@link VkAccelerationStructureInstanceKHR.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkAccelerationStructureInstanceKHR.Buffer malloc(int capacity) {
return wrap(Buffer.class, nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link VkAccelerationStructureInstanceKHR.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkAccelerationStructureInstanceKHR.Buffer calloc(int capacity) {
return wrap(Buffer.class, nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkAccelerationStructureInstanceKHR.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkAccelerationStructureInstanceKHR.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return wrap(Buffer.class, memAddress(container), capacity, container);
}
/**
* Create a {@link VkAccelerationStructureInstanceKHR.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkAccelerationStructureInstanceKHR.Buffer create(long address, int capacity) {
return wrap(Buffer.class, address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkAccelerationStructureInstanceKHR.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : wrap(Buffer.class, address, capacity);
}
/**
* Returns a new {@code VkAccelerationStructureInstanceKHR} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkAccelerationStructureInstanceKHR malloc(MemoryStack stack) {
return wrap(VkAccelerationStructureInstanceKHR.class, stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@code VkAccelerationStructureInstanceKHR} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkAccelerationStructureInstanceKHR calloc(MemoryStack stack) {
return wrap(VkAccelerationStructureInstanceKHR.class, stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkAccelerationStructureInstanceKHR.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkAccelerationStructureInstanceKHR.Buffer malloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkAccelerationStructureInstanceKHR.Buffer} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkAccelerationStructureInstanceKHR.Buffer calloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #transform}. */
public static VkTransformMatrixKHR ntransform(long struct) { return VkTransformMatrixKHR.create(struct + VkAccelerationStructureInstanceKHR.TRANSFORM); }
public static int nbitfield0(long struct) { return UNSAFE.getInt(null, struct + VkAccelerationStructureInstanceKHR.BITFIELD0); }
/** Unsafe version of {@link #instanceCustomIndex}. */
public static int ninstanceCustomIndex(long struct) { return nbitfield0(struct) & 0x00_FF_FF_FF; }
/** Unsafe version of {@link #mask}. */
public static int nmask(long struct) { return nbitfield0(struct) >>> 24; }
public static int nbitfield1(long struct) { return UNSAFE.getInt(null, struct + VkAccelerationStructureInstanceKHR.BITFIELD1); }
/** Unsafe version of {@link #instanceShaderBindingTableRecordOffset}. */
public static int ninstanceShaderBindingTableRecordOffset(long struct) { return nbitfield1(struct) & 0x00_FF_FF_FF; }
/** Unsafe version of {@link #flags}. */
public static int nflags(long struct) { return nbitfield1(struct) >>> 24; }
/** Unsafe version of {@link #accelerationStructureReference}. */
public static long naccelerationStructureReference(long struct) { return UNSAFE.getLong(null, struct + VkAccelerationStructureInstanceKHR.ACCELERATIONSTRUCTUREREFERENCE); }
/** Unsafe version of {@link #transform(VkTransformMatrixKHR) transform}. */
public static void ntransform(long struct, VkTransformMatrixKHR value) { memCopy(value.address(), struct + VkAccelerationStructureInstanceKHR.TRANSFORM, VkTransformMatrixKHR.SIZEOF); }
public static void nbitfield0(long struct, int value) { UNSAFE.putInt(null, struct + VkAccelerationStructureInstanceKHR.BITFIELD0, value); }
/** Unsafe version of {@link #instanceCustomIndex(int) instanceCustomIndex}. */
public static void ninstanceCustomIndex(long struct, int value) { nbitfield0(struct, (nbitfield0(struct) & 0xFF_00_00_00) | (value & 0x00_FF_FF_FF)); }
/** Unsafe version of {@link #mask(int) mask}. */
public static void nmask(long struct, int value) { nbitfield0(struct, (value << 24) | (nbitfield0(struct) & 0x00_FF_FF_FF)); }
public static void nbitfield1(long struct, int value) { UNSAFE.putInt(null, struct + VkAccelerationStructureInstanceKHR.BITFIELD1, value); }
/** Unsafe version of {@link #instanceShaderBindingTableRecordOffset(int) instanceShaderBindingTableRecordOffset}. */
public static void ninstanceShaderBindingTableRecordOffset(long struct, int value) { nbitfield1(struct, (nbitfield1(struct) & 0xFF_00_00_00) | (value & 0x00_FF_FF_FF)); }
/** Unsafe version of {@link #flags(int) flags}. */
public static void nflags(long struct, int value) { nbitfield1(struct, (value << 24) | (nbitfield1(struct) & 0x00_FF_FF_FF)); }
/** Unsafe version of {@link #accelerationStructureReference(long) accelerationStructureReference}. */
public static void naccelerationStructureReference(long struct, long value) { UNSAFE.putLong(null, struct + VkAccelerationStructureInstanceKHR.ACCELERATIONSTRUCTUREREFERENCE, value); }
// -----------------------------------
/** An array of {@link VkAccelerationStructureInstanceKHR} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final VkAccelerationStructureInstanceKHR ELEMENT_FACTORY = VkAccelerationStructureInstanceKHR.create(-1L);
/**
* Creates a new {@code VkAccelerationStructureInstanceKHR.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 {@link VkAccelerationStructureInstanceKHR#SIZEOF}, and its mark will be undefined.
*
* The created buffer instance holds a strong reference to the container object.
*/
public Buffer(ByteBuffer container) {
super(container, container.remaining() / SIZEOF);
}
public Buffer(long address, int cap) {
super(address, null, -1, 0, cap, cap);
}
Buffer(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
super(address, container, mark, pos, lim, cap);
}
@Override
protected Buffer self() {
return this;
}
@Override
protected VkAccelerationStructureInstanceKHR getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return a {@link VkTransformMatrixKHR} view of the {@link VkAccelerationStructureInstanceKHR#transform} field. */
public VkTransformMatrixKHR transform() { return VkAccelerationStructureInstanceKHR.ntransform(address()); }
/** @return the value of the {@link VkAccelerationStructureInstanceKHR#instanceCustomIndex} field. */
@NativeType("uint32_t")
public int instanceCustomIndex() { return VkAccelerationStructureInstanceKHR.ninstanceCustomIndex(address()); }
/** @return the value of the {@link VkAccelerationStructureInstanceKHR#mask} field. */
@NativeType("uint32_t")
public int mask() { return VkAccelerationStructureInstanceKHR.nmask(address()); }
/** @return the value of the {@link VkAccelerationStructureInstanceKHR#instanceShaderBindingTableRecordOffset} field. */
@NativeType("uint32_t")
public int instanceShaderBindingTableRecordOffset() { return VkAccelerationStructureInstanceKHR.ninstanceShaderBindingTableRecordOffset(address()); }
/** @return the value of the {@link VkAccelerationStructureInstanceKHR#flags} field. */
@NativeType("VkGeometryInstanceFlagsKHR")
public int flags() { return VkAccelerationStructureInstanceKHR.nflags(address()); }
/** @return the value of the {@link VkAccelerationStructureInstanceKHR#accelerationStructureReference} field. */
@NativeType("uint64_t")
public long accelerationStructureReference() { return VkAccelerationStructureInstanceKHR.naccelerationStructureReference(address()); }
/** Copies the specified {@link VkTransformMatrixKHR} to the {@link VkAccelerationStructureInstanceKHR#transform} field. */
public VkAccelerationStructureInstanceKHR.Buffer transform(VkTransformMatrixKHR value) { VkAccelerationStructureInstanceKHR.ntransform(address(), value); return this; }
/** Passes the {@link VkAccelerationStructureInstanceKHR#transform} field to the specified {@link java.util.function.Consumer Consumer}. */
public VkAccelerationStructureInstanceKHR.Buffer transform(java.util.function.Consumer consumer) { consumer.accept(transform()); return this; }
/** Sets the specified value to the {@link VkAccelerationStructureInstanceKHR#instanceCustomIndex} field. */
public VkAccelerationStructureInstanceKHR.Buffer instanceCustomIndex(@NativeType("uint32_t") int value) { VkAccelerationStructureInstanceKHR.ninstanceCustomIndex(address(), value); return this; }
/** Sets the specified value to the {@link VkAccelerationStructureInstanceKHR#mask} field. */
public VkAccelerationStructureInstanceKHR.Buffer mask(@NativeType("uint32_t") int value) { VkAccelerationStructureInstanceKHR.nmask(address(), value); return this; }
/** Sets the specified value to the {@link VkAccelerationStructureInstanceKHR#instanceShaderBindingTableRecordOffset} field. */
public VkAccelerationStructureInstanceKHR.Buffer instanceShaderBindingTableRecordOffset(@NativeType("uint32_t") int value) { VkAccelerationStructureInstanceKHR.ninstanceShaderBindingTableRecordOffset(address(), value); return this; }
/** Sets the specified value to the {@link VkAccelerationStructureInstanceKHR#flags} field. */
public VkAccelerationStructureInstanceKHR.Buffer flags(@NativeType("VkGeometryInstanceFlagsKHR") int value) { VkAccelerationStructureInstanceKHR.nflags(address(), value); return this; }
/** Sets the specified value to the {@link VkAccelerationStructureInstanceKHR#accelerationStructureReference} field. */
public VkAccelerationStructureInstanceKHR.Buffer accelerationStructureReference(@NativeType("uint64_t") long value) { VkAccelerationStructureInstanceKHR.naccelerationStructureReference(address(), value); return this; }
}
}