Class VkTraceRaysIndirectCommand2KHR

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkTraceRaysIndirectCommand2KHR>
org.lwjgl.vulkan.VkTraceRaysIndirectCommand2KHR
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkTraceRaysIndirectCommand2KHR extends org.lwjgl.system.Struct<VkTraceRaysIndirectCommand2KHR> implements org.lwjgl.system.NativeResource
Structure specifying the parameters of an indirect trace ray command with indirect shader binding tables.
Description

The members of VkTraceRaysIndirectCommand2KHR have the same meaning as the similarly named parameters of CmdTraceRaysKHR.

Indirect shader binding table buffer parameters must satisfy the same memory alignment and binding requirements as their counterparts in CmdTraceRaysIndirectKHR and CmdTraceRaysKHR.

Valid Usage

Layout


 struct VkTraceRaysIndirectCommand2KHR {
     VkDeviceAddress raygenShaderRecordAddress();
     VkDeviceSize raygenShaderRecordSize();
     VkDeviceAddress missShaderBindingTableAddress();
     VkDeviceSize missShaderBindingTableSize();
     VkDeviceSize missShaderBindingTableStride();
     VkDeviceAddress hitShaderBindingTableAddress();
     VkDeviceSize hitShaderBindingTableSize();
     VkDeviceSize hitShaderBindingTableStride();
     VkDeviceAddress callableShaderBindingTableAddress();
     VkDeviceSize callableShaderBindingTableSize();
     VkDeviceSize callableShaderBindingTableStride();
     uint32_t width();
     uint32_t height();
     uint32_t depth();
 }
  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.
    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.
    • RAYGENSHADERRECORDADDRESS

      public static final int RAYGENSHADERRECORDADDRESS
      The struct member offsets.
    • RAYGENSHADERRECORDSIZE

      public static final int RAYGENSHADERRECORDSIZE
      The struct member offsets.
    • MISSSHADERBINDINGTABLEADDRESS

      public static final int MISSSHADERBINDINGTABLEADDRESS
      The struct member offsets.
    • MISSSHADERBINDINGTABLESIZE

      public static final int MISSSHADERBINDINGTABLESIZE
      The struct member offsets.
    • MISSSHADERBINDINGTABLESTRIDE

      public static final int MISSSHADERBINDINGTABLESTRIDE
      The struct member offsets.
    • HITSHADERBINDINGTABLEADDRESS

      public static final int HITSHADERBINDINGTABLEADDRESS
      The struct member offsets.
    • HITSHADERBINDINGTABLESIZE

      public static final int HITSHADERBINDINGTABLESIZE
      The struct member offsets.
    • HITSHADERBINDINGTABLESTRIDE

      public static final int HITSHADERBINDINGTABLESTRIDE
      The struct member offsets.
    • CALLABLESHADERBINDINGTABLEADDRESS

      public static final int CALLABLESHADERBINDINGTABLEADDRESS
      The struct member offsets.
    • CALLABLESHADERBINDINGTABLESIZE

      public static final int CALLABLESHADERBINDINGTABLESIZE
      The struct member offsets.
    • CALLABLESHADERBINDINGTABLESTRIDE

      public static final int CALLABLESHADERBINDINGTABLESTRIDE
      The struct member offsets.
    • WIDTH

      public static final int WIDTH
      The struct member offsets.
    • HEIGHT

      public static final int HEIGHT
      The struct member offsets.
    • DEPTH

      public static final int DEPTH
      The struct member offsets.
  • Constructor Details

    • VkTraceRaysIndirectCommand2KHR

      public VkTraceRaysIndirectCommand2KHR(ByteBuffer container)
      Creates a VkTraceRaysIndirectCommand2KHR 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<VkTraceRaysIndirectCommand2KHR>
    • raygenShaderRecordAddress

      public long raygenShaderRecordAddress()
      a VkDeviceAddress of the ray generation shader binding table record used by this command.
    • raygenShaderRecordSize

      public long raygenShaderRecordSize()
      a VkDeviceSize number of bytes corresponding to the ray generation shader binding table record at base address raygenShaderRecordAddress.
    • missShaderBindingTableAddress

      public long missShaderBindingTableAddress()
      a VkDeviceAddress of the first record in the miss shader binding table used by this command.
    • missShaderBindingTableSize

      public long missShaderBindingTableSize()
      a VkDeviceSize number of bytes corresponding to the total size of the miss shader binding table at missShaderBindingTableAddress that may be accessed by this command.
    • missShaderBindingTableStride

      public long missShaderBindingTableStride()
      a VkDeviceSize number of bytes between records of the miss shader binding table.
    • hitShaderBindingTableAddress

      public long hitShaderBindingTableAddress()
      a VkDeviceAddress of the first record in the hit shader binding table used by this command.
    • hitShaderBindingTableSize

      public long hitShaderBindingTableSize()
      a VkDeviceSize number of bytes corresponding to the total size of the hit shader binding table at hitShaderBindingTableAddress that may be accessed by this command.
    • hitShaderBindingTableStride

      public long hitShaderBindingTableStride()
      a VkDeviceSize number of bytes between records of the hit shader binding table.
    • callableShaderBindingTableAddress

      public long callableShaderBindingTableAddress()
      a VkDeviceAddress of the first record in the callable shader binding table used by this command.
    • callableShaderBindingTableSize

      public long callableShaderBindingTableSize()
      a VkDeviceSize number of bytes corresponding to the total size of the callable shader binding table at callableShaderBindingTableAddress that may be accessed by this command.
    • callableShaderBindingTableStride

      public long callableShaderBindingTableStride()
      a VkDeviceSize number of bytes between records of the callable shader binding table.
    • width

      public int width()
      the width of the ray trace query dimensions.
    • height

      public int height()
      height of the ray trace query dimensions.
    • depth

      public int depth()
      depth of the ray trace query dimensions.
    • raygenShaderRecordAddress

      public VkTraceRaysIndirectCommand2KHR raygenShaderRecordAddress(long value)
      Sets the specified value to the raygenShaderRecordAddress() field.
    • raygenShaderRecordSize

      public VkTraceRaysIndirectCommand2KHR raygenShaderRecordSize(long value)
      Sets the specified value to the raygenShaderRecordSize() field.
    • missShaderBindingTableAddress

      public VkTraceRaysIndirectCommand2KHR missShaderBindingTableAddress(long value)
      Sets the specified value to the missShaderBindingTableAddress() field.
    • missShaderBindingTableSize

      public VkTraceRaysIndirectCommand2KHR missShaderBindingTableSize(long value)
      Sets the specified value to the missShaderBindingTableSize() field.
    • missShaderBindingTableStride

      public VkTraceRaysIndirectCommand2KHR missShaderBindingTableStride(long value)
      Sets the specified value to the missShaderBindingTableStride() field.
    • hitShaderBindingTableAddress

      public VkTraceRaysIndirectCommand2KHR hitShaderBindingTableAddress(long value)
      Sets the specified value to the hitShaderBindingTableAddress() field.
    • hitShaderBindingTableSize

      public VkTraceRaysIndirectCommand2KHR hitShaderBindingTableSize(long value)
      Sets the specified value to the hitShaderBindingTableSize() field.
    • hitShaderBindingTableStride

      public VkTraceRaysIndirectCommand2KHR hitShaderBindingTableStride(long value)
      Sets the specified value to the hitShaderBindingTableStride() field.
    • callableShaderBindingTableAddress

      public VkTraceRaysIndirectCommand2KHR callableShaderBindingTableAddress(long value)
      Sets the specified value to the callableShaderBindingTableAddress() field.
    • callableShaderBindingTableSize

      public VkTraceRaysIndirectCommand2KHR callableShaderBindingTableSize(long value)
      Sets the specified value to the callableShaderBindingTableSize() field.
    • callableShaderBindingTableStride

      public VkTraceRaysIndirectCommand2KHR callableShaderBindingTableStride(long value)
      Sets the specified value to the callableShaderBindingTableStride() field.
    • width

      public VkTraceRaysIndirectCommand2KHR width(int value)
      Sets the specified value to the width() field.
    • height

      public VkTraceRaysIndirectCommand2KHR height(int value)
      Sets the specified value to the height() field.
    • depth

      public VkTraceRaysIndirectCommand2KHR depth(int value)
      Sets the specified value to the depth() field.
    • set

      public VkTraceRaysIndirectCommand2KHR set(long raygenShaderRecordAddress, long raygenShaderRecordSize, long missShaderBindingTableAddress, long missShaderBindingTableSize, long missShaderBindingTableStride, long hitShaderBindingTableAddress, long hitShaderBindingTableSize, long hitShaderBindingTableStride, long callableShaderBindingTableAddress, long callableShaderBindingTableSize, long callableShaderBindingTableStride, int width, int height, int depth)
      Initializes this struct with the specified values.
    • set

      Copies the specified struct data to this struct.
      Parameters:
      src - the source struct
      Returns:
      this struct
    • malloc

      public static VkTraceRaysIndirectCommand2KHR malloc()
      Returns a new VkTraceRaysIndirectCommand2KHR instance allocated with memAlloc. The instance must be explicitly freed.
    • calloc

      public static VkTraceRaysIndirectCommand2KHR calloc()
      Returns a new VkTraceRaysIndirectCommand2KHR instance allocated with memCalloc. The instance must be explicitly freed.
    • create

      public static VkTraceRaysIndirectCommand2KHR create()
      Returns a new VkTraceRaysIndirectCommand2KHR instance allocated with BufferUtils.
    • create

      public static VkTraceRaysIndirectCommand2KHR create(long address)
      Returns a new VkTraceRaysIndirectCommand2KHR instance for the specified memory address.
    • createSafe

      public static @Nullable VkTraceRaysIndirectCommand2KHR createSafe(long address)
      Like create, but returns null if address is NULL.
    • malloc

      public static VkTraceRaysIndirectCommand2KHR.Buffer malloc(int capacity)
      Returns a new VkTraceRaysIndirectCommand2KHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity
    • calloc

      public static VkTraceRaysIndirectCommand2KHR.Buffer calloc(int capacity)
      Returns a new VkTraceRaysIndirectCommand2KHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity
    • create

      public static VkTraceRaysIndirectCommand2KHR.Buffer create(int capacity)
      Returns a new VkTraceRaysIndirectCommand2KHR.Buffer instance allocated with BufferUtils.
      Parameters:
      capacity - the buffer capacity
    • create

      public static VkTraceRaysIndirectCommand2KHR.Buffer create(long address, int capacity)
      Create a VkTraceRaysIndirectCommand2KHR.Buffer instance at the specified memory.
      Parameters:
      address - the memory address
      capacity - the buffer capacity
    • createSafe

      public static @Nullable VkTraceRaysIndirectCommand2KHR.Buffer createSafe(long address, int capacity)
      Like create, but returns null if address is NULL.
    • malloc

      public static VkTraceRaysIndirectCommand2KHR malloc(org.lwjgl.system.MemoryStack stack)
      Returns a new VkTraceRaysIndirectCommand2KHR instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate
    • calloc

      public static VkTraceRaysIndirectCommand2KHR calloc(org.lwjgl.system.MemoryStack stack)
      Returns a new VkTraceRaysIndirectCommand2KHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      stack - the stack from which to allocate
    • malloc

      public static VkTraceRaysIndirectCommand2KHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new VkTraceRaysIndirectCommand2KHR.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate
    • calloc

      public static VkTraceRaysIndirectCommand2KHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new VkTraceRaysIndirectCommand2KHR.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
    • nraygenShaderRecordAddress

      public static long nraygenShaderRecordAddress(long struct)
      Unsafe version of raygenShaderRecordAddress().
    • nraygenShaderRecordSize

      public static long nraygenShaderRecordSize(long struct)
      Unsafe version of raygenShaderRecordSize().
    • nmissShaderBindingTableAddress

      public static long nmissShaderBindingTableAddress(long struct)
    • nmissShaderBindingTableSize

      public static long nmissShaderBindingTableSize(long struct)
      Unsafe version of missShaderBindingTableSize().
    • nmissShaderBindingTableStride

      public static long nmissShaderBindingTableStride(long struct)
    • nhitShaderBindingTableAddress

      public static long nhitShaderBindingTableAddress(long struct)
    • nhitShaderBindingTableSize

      public static long nhitShaderBindingTableSize(long struct)
      Unsafe version of hitShaderBindingTableSize().
    • nhitShaderBindingTableStride

      public static long nhitShaderBindingTableStride(long struct)
    • ncallableShaderBindingTableAddress

      public static long ncallableShaderBindingTableAddress(long struct)
    • ncallableShaderBindingTableSize

      public static long ncallableShaderBindingTableSize(long struct)
    • ncallableShaderBindingTableStride

      public static long ncallableShaderBindingTableStride(long struct)
    • nwidth

      public static int nwidth(long struct)
      Unsafe version of width().
    • nheight

      public static int nheight(long struct)
      Unsafe version of height().
    • ndepth

      public static int ndepth(long struct)
      Unsafe version of depth().
    • nraygenShaderRecordAddress

      public static void nraygenShaderRecordAddress(long struct, long value)
      Unsafe version of raygenShaderRecordAddress.
    • nraygenShaderRecordSize

      public static void nraygenShaderRecordSize(long struct, long value)
      Unsafe version of raygenShaderRecordSize.
    • nmissShaderBindingTableAddress

      public static void nmissShaderBindingTableAddress(long struct, long value)
    • nmissShaderBindingTableSize

      public static void nmissShaderBindingTableSize(long struct, long value)
      Unsafe version of missShaderBindingTableSize.
    • nmissShaderBindingTableStride

      public static void nmissShaderBindingTableStride(long struct, long value)
      Unsafe version of missShaderBindingTableStride.
    • nhitShaderBindingTableAddress

      public static void nhitShaderBindingTableAddress(long struct, long value)
      Unsafe version of hitShaderBindingTableAddress.
    • nhitShaderBindingTableSize

      public static void nhitShaderBindingTableSize(long struct, long value)
      Unsafe version of hitShaderBindingTableSize.
    • nhitShaderBindingTableStride

      public static void nhitShaderBindingTableStride(long struct, long value)
      Unsafe version of hitShaderBindingTableStride.
    • ncallableShaderBindingTableAddress

      public static void ncallableShaderBindingTableAddress(long struct, long value)
    • ncallableShaderBindingTableSize

      public static void ncallableShaderBindingTableSize(long struct, long value)
    • ncallableShaderBindingTableStride

      public static void ncallableShaderBindingTableStride(long struct, long value)
    • nwidth

      public static void nwidth(long struct, int value)
      Unsafe version of width.
    • nheight

      public static void nheight(long struct, int value)
      Unsafe version of height.
    • ndepth

      public static void ndepth(long struct, int value)
      Unsafe version of depth.