Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkTraceRaysIndirectCommand2KHR

extends Struct<VkTraceRaysIndirectCommand2KHR>
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 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;
}

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
CALLABLESHADERBINDINGTABLEADDRESS

The struct member offsets.

public static final int
CALLABLESHADERBINDINGTABLESIZE

The struct member offsets.

public static final int
CALLABLESHADERBINDINGTABLESTRIDE

The struct member offsets.

public static final int
DEPTH

The struct member offsets.

public static final int
HEIGHT

The struct member offsets.

public static final int
HITSHADERBINDINGTABLEADDRESS

The struct member offsets.

public static final int
HITSHADERBINDINGTABLESIZE

The struct member offsets.

public static final int
HITSHADERBINDINGTABLESTRIDE

The struct member offsets.

public static final int
MISSSHADERBINDINGTABLEADDRESS

The struct member offsets.

public static final int
MISSSHADERBINDINGTABLESIZE

The struct member offsets.

public static final int
MISSSHADERBINDINGTABLESTRIDE

The struct member offsets.

public static final int
RAYGENSHADERRECORDADDRESS

The struct member offsets.

public static final int
RAYGENSHADERRECORDSIZE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
WIDTH

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkTraceRaysIndirectCommand2KHR(long address, ByteBuffer container)

public
VkTraceRaysIndirectCommand2KHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public long
callableShaderBindingTableAddress()

a VkDeviceAddress of the first record in the callable shader binding table used by this command.

public VkTraceRaysIndirectCommand2KHR
callableShaderBindingTableAddress(long value)

Sets the specified value to the callableShaderBindingTableAddress field.

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.

public VkTraceRaysIndirectCommand2KHR
callableShaderBindingTableSize(long value)

Sets the specified value to the callableShaderBindingTableSize field.

public long
callableShaderBindingTableStride()

a VkDeviceSize number of bytes between records of the callable shader binding table.

public VkTraceRaysIndirectCommand2KHR
callableShaderBindingTableStride(long value)

Sets the specified value to the callableShaderBindingTableStride field.

public static VkTraceRaysIndirectCommand2KHR
calloc()

Returns a new VkTraceRaysIndirectCommand2KHR instance allocated with memCalloc.

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

Returns a new VkTraceRaysIndirectCommand2KHR.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkTraceRaysIndirectCommand2KHR instance allocated with BufferUtils.

public static VkTraceRaysIndirectCommand2KHR
create(long address)

Returns a new VkTraceRaysIndirectCommand2KHR instance for the specified memory address.

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

Returns a new VkTraceRaysIndirectCommand2KHR.Buffer instance allocated with BufferUtils.

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

Create a VkTraceRaysIndirectCommand2KHR.Buffer instance at the specified memory.

public static VkTraceRaysIndirectCommand2KHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
depth()

depth of the ray trace query dimensions.

public VkTraceRaysIndirectCommand2KHR
depth(int value)

Sets the specified value to the depth field.

public int
height()

height of the ray trace query dimensions.

public VkTraceRaysIndirectCommand2KHR
height(int value)

Sets the specified value to the height field.

public long
hitShaderBindingTableAddress()

a VkDeviceAddress of the first record in the hit shader binding table used by this command.

public VkTraceRaysIndirectCommand2KHR
hitShaderBindingTableAddress(long value)

Sets the specified value to the hitShaderBindingTableAddress field.

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.

public VkTraceRaysIndirectCommand2KHR
hitShaderBindingTableSize(long value)

Sets the specified value to the hitShaderBindingTableSize field.

public long
hitShaderBindingTableStride()

a VkDeviceSize number of bytes between records of the hit shader binding table.

public VkTraceRaysIndirectCommand2KHR
hitShaderBindingTableStride(long value)

Sets the specified value to the hitShaderBindingTableStride field.

public static VkTraceRaysIndirectCommand2KHR
malloc()

Returns a new VkTraceRaysIndirectCommand2KHR instance allocated with memAlloc.

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

Returns a new VkTraceRaysIndirectCommand2KHR.Buffer instance allocated with memAlloc.

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

Returns a new VkTraceRaysIndirectCommand2KHR instance allocated on the specified MemoryStack.

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

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

public long
missShaderBindingTableAddress()

a VkDeviceAddress of the first record in the miss shader binding table used by this command.

public VkTraceRaysIndirectCommand2KHR
missShaderBindingTableAddress(long value)

Sets the specified value to the missShaderBindingTableAddress field.

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.

public VkTraceRaysIndirectCommand2KHR
missShaderBindingTableSize(long value)

Sets the specified value to the missShaderBindingTableSize field.

public long
missShaderBindingTableStride()

a VkDeviceSize number of bytes between records of the miss shader binding table.

public VkTraceRaysIndirectCommand2KHR
missShaderBindingTableStride(long value)

Sets the specified value to the missShaderBindingTableStride field.

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

Unsafe version of callableShaderBindingTableAddress.

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

Unsafe version of callableShaderBindingTableSize.

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

Unsafe version of callableShaderBindingTableStride.

public static int
ndepth(long struct)

Unsafe version of depth.

public static void
ndepth(long struct, int value)

Unsafe version of depth.

public static int
nheight(long struct)

Unsafe version of height.

public static void
nheight(long struct, int value)

Unsafe version of height.

public static long
public static void
nhitShaderBindingTableAddress(long struct, long value)

Unsafe version of hitShaderBindingTableAddress.

public static long
public static void
nhitShaderBindingTableSize(long struct, long value)

Unsafe version of hitShaderBindingTableSize.

public static long
public static void
nhitShaderBindingTableStride(long struct, long value)

Unsafe version of hitShaderBindingTableStride.

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

Unsafe version of missShaderBindingTableAddress.

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

Unsafe version of missShaderBindingTableSize.

public static long
public static void
nmissShaderBindingTableStride(long struct, long value)

Unsafe version of missShaderBindingTableStride.

public static long
public static void
nraygenShaderRecordAddress(long struct, long value)

Unsafe version of raygenShaderRecordAddress.

public static long
nraygenShaderRecordSize(long struct)

Unsafe version of raygenShaderRecordSize.

public static void
nraygenShaderRecordSize(long struct, long value)

Unsafe version of raygenShaderRecordSize.

public static int
nwidth(long struct)

Unsafe version of width.

public static void
nwidth(long struct, int value)

Unsafe version of width.

public long
raygenShaderRecordAddress()

a VkDeviceAddress of the ray generation shader binding table record used by this command.

public VkTraceRaysIndirectCommand2KHR
raygenShaderRecordAddress(long value)

Sets the specified value to the raygenShaderRecordAddress field.

public long
raygenShaderRecordSize()

a VkDeviceSize number of bytes corresponding to the ray generation shader binding table record at base address raygenShaderRecordAddress.

public VkTraceRaysIndirectCommand2KHR
raygenShaderRecordSize(long value)

Sets the specified value to the raygenShaderRecordSize field.

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.

public VkTraceRaysIndirectCommand2KHR

Returns:

this struct
set
(VkTraceRaysIndirectCommand2KHR
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
width()

the width of the ray trace query dimensions.

public VkTraceRaysIndirectCommand2KHR
width(int value)

Sets the specified value to the width field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate