Structure specifying the parameters of an indirect ray tracing command.

Description

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

Valid Usage

width must be less than or equal to VkPhysicalDeviceLimits::maxComputeWorkGroupCount[0] × VkPhysicalDeviceLimits::maxComputeWorkGroupSize[0]
height must be less than or equal to VkPhysicalDeviceLimits::maxComputeWorkGroupCount[1] × VkPhysicalDeviceLimits::maxComputeWorkGroupSize[1]
depth must be less than or equal to VkPhysicalDeviceLimits::maxComputeWorkGroupCount[2] × VkPhysicalDeviceLimits::maxComputeWorkGroupSize[2]
width × height × depth must be less than or equal to VkPhysicalDeviceRayTracingPipelinePropertiesKHR::maxRayDispatchInvocationCount

Layout


struct VkTraceRaysIndirectCommandKHR {
    uint32_t width;
    uint32_t height;
    uint32_t depth;
}

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	VkTraceRaysIndirectCommandKHR.Buffer An array of `VkTraceRaysIndirectCommandKHR` structs.

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	DEPTH The struct member offsets.
public static final int	HEIGHT 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:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	VkTraceRaysIndirectCommandKHR(long address, ByteBuffer container)
public	VkTraceRaysIndirectCommandKHR(ByteBuffer container) Creates a `VkTraceRaysIndirectCommandKHR` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static VkTraceRaysIndirectCommandKHR	calloc() Returns a new `VkTraceRaysIndirectCommandKHR` instance allocated with `memCalloc`.
public static VkTraceRaysIndirectCommandKHR.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkTraceRaysIndirectCommandKHR.Buffer` instance allocated with `memCalloc`.
public static VkTraceRaysIndirectCommandKHR	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkTraceRaysIndirectCommandKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkTraceRaysIndirectCommandKHR.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkTraceRaysIndirectCommandKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected VkTraceRaysIndirectCommandKHR	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 VkTraceRaysIndirectCommandKHR	create() Returns a new `VkTraceRaysIndirectCommandKHR` instance allocated with `BufferUtils`.
public static VkTraceRaysIndirectCommandKHR	create(long address) Returns a new `VkTraceRaysIndirectCommandKHR` instance for the specified memory address.
public static VkTraceRaysIndirectCommandKHR.Buffer	create(int the buffer capacity capacity) Returns a new `VkTraceRaysIndirectCommandKHR.Buffer` instance allocated with `BufferUtils`.
public static VkTraceRaysIndirectCommandKHR.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkTraceRaysIndirectCommandKHR.Buffer` instance at the specified memory.
public static VkTraceRaysIndirectCommandKHR	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkTraceRaysIndirectCommandKHR.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 VkTraceRaysIndirectCommandKHR	depth(int value) Sets the specified value to the `depth` field.
public int	height() height of the ray trace query dimensions.
public VkTraceRaysIndirectCommandKHR	height(int value) Sets the specified value to the `height` field.
public static VkTraceRaysIndirectCommandKHR	malloc() Returns a new `VkTraceRaysIndirectCommandKHR` instance allocated with `memAlloc`.
public static VkTraceRaysIndirectCommandKHR.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkTraceRaysIndirectCommandKHR.Buffer` instance allocated with `memAlloc`.
public static VkTraceRaysIndirectCommandKHR	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkTraceRaysIndirectCommandKHR` instance allocated on the specified `MemoryStack`.
public static VkTraceRaysIndirectCommandKHR.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkTraceRaysIndirectCommandKHR.Buffer` instance allocated on the specified `MemoryStack`.
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 int	nwidth(long struct) Unsafe version of `width`.
public static void	nwidth(long struct, int value) Unsafe version of `width`.
public VkTraceRaysIndirectCommandKHR	set(int width, int height, int depth) Initializes this struct with the specified values.
public VkTraceRaysIndirectCommandKHR	Returns: this struct set(VkTraceRaysIndirectCommandKHR 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 VkTraceRaysIndirectCommandKHR	width(int value) Sets the specified value to the `width` field.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

DEPTH	back to summary
public static final int DEPTH The struct member offsets.

HEIGHT	back to summary
public static final int HEIGHT The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

WIDTH	back to summary
public static final int WIDTH The struct member offsets.

Constructor Detail

VkTraceRaysIndirectCommandKHR	back to summary
protected VkTraceRaysIndirectCommandKHR(long address, ByteBuffer container)

VkTraceRaysIndirectCommandKHR back to summary

VkTraceRaysIndirectCommandKHR	back to summary
public VkTraceRaysIndirectCommandKHR(ByteBuffer container) Creates a `VkTraceRaysIndirectCommandKHR` 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.

public VkTraceRaysIndirectCommandKHR(ByteBuffer container)

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

calloc	back to summary
public static VkTraceRaysIndirectCommandKHR calloc() Returns a new `VkTraceRaysIndirectCommandKHR` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static VkTraceRaysIndirectCommandKHR.Buffer calloc(int capacity) Returns a new `VkTraceRaysIndirectCommandKHR.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkTraceRaysIndirectCommandKHR.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static VkTraceRaysIndirectCommandKHR calloc(MemoryStack stack) Returns a new `VkTraceRaysIndirectCommandKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkTraceRaysIndirectCommandKHR calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static VkTraceRaysIndirectCommandKHR.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkTraceRaysIndirectCommandKHR.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

public static VkTraceRaysIndirectCommandKHR.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkTraceRaysIndirectCommandKHR.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

create back to summary

create	back to summary
protected VkTraceRaysIndirectCommandKHR 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

protected VkTraceRaysIndirectCommandKHR 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

create	back to summary
public static VkTraceRaysIndirectCommandKHR create() Returns a new `VkTraceRaysIndirectCommandKHR` instance allocated with `BufferUtils`.

create	back to summary
public static VkTraceRaysIndirectCommandKHR create(long address) Returns a new `VkTraceRaysIndirectCommandKHR` instance for the specified memory address.

create back to summary

create	back to summary
public static VkTraceRaysIndirectCommandKHR.Buffer create(int capacity) Returns a new `VkTraceRaysIndirectCommandKHR.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static VkTraceRaysIndirectCommandKHR.Buffer create(int capacity)

Returns a new VkTraceRaysIndirectCommandKHR.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static VkTraceRaysIndirectCommandKHR.Buffer create(long address, int capacity) Create a `VkTraceRaysIndirectCommandKHR.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

public static VkTraceRaysIndirectCommandKHR.Buffer create(long address, int capacity)

Create a VkTraceRaysIndirectCommandKHR.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VkTraceRaysIndirectCommandKHR createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkTraceRaysIndirectCommandKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VkTraceRaysIndirectCommandKHR.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

depth	back to summary
public int depth() depth of the ray trace query dimensions. Annotations @NativeType:uint32_t

depth

back to summary

public int depth()

depth of the ray trace query dimensions.

Annotations

@NativeType:uint32_t

depth	back to summary
public VkTraceRaysIndirectCommandKHR depth(int value) Sets the specified value to the `depth` field.

height	back to summary
public int height() height of the ray trace query dimensions. Annotations @NativeType:uint32_t

height

back to summary

public int height()

height of the ray trace query dimensions.

Annotations

@NativeType:uint32_t

height	back to summary
public VkTraceRaysIndirectCommandKHR height(int value) Sets the specified value to the `height` field.

malloc	back to summary
public static VkTraceRaysIndirectCommandKHR malloc() Returns a new `VkTraceRaysIndirectCommandKHR` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static VkTraceRaysIndirectCommandKHR.Buffer malloc(int capacity) Returns a new `VkTraceRaysIndirectCommandKHR.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkTraceRaysIndirectCommandKHR.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static VkTraceRaysIndirectCommandKHR malloc(MemoryStack stack) Returns a new `VkTraceRaysIndirectCommandKHR` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkTraceRaysIndirectCommandKHR malloc(MemoryStack stack)

Returns a new VkTraceRaysIndirectCommandKHR instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static VkTraceRaysIndirectCommandKHR.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkTraceRaysIndirectCommandKHR.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static VkTraceRaysIndirectCommandKHR.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

ndepth	back to summary
public static int ndepth(long struct) Unsafe version of `depth`.

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

nheight	back to summary
public static int nheight(long struct) Unsafe version of `height`.

nheight	back to summary
public static void nheight(long struct, int value) Unsafe version of `height`.

nwidth	back to summary
public static int nwidth(long struct) Unsafe version of `width`.

nwidth	back to summary
public static void nwidth(long struct, int value) Unsafe version of `width`.

set	back to summary
public VkTraceRaysIndirectCommandKHR set(int width, int height, int depth) Initializes this struct with the specified values.

set	back to summary
public VkTraceRaysIndirectCommandKHR set(VkTraceRaysIndirectCommandKHR src) Copies the specified struct data to this struct. Parameters src:VkTraceRaysIndirectCommandKHR the source struct Returns:VkTraceRaysIndirectCommandKHR this struct

set

back to summary

public VkTraceRaysIndirectCommandKHR set(VkTraceRaysIndirectCommandKHR src)

Copies the specified struct data to this struct.

Parameters

src:VkTraceRaysIndirectCommandKHR: the source struct

Returns:VkTraceRaysIndirectCommandKHR

this struct

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

width	back to summary
public int width() the width of the ray trace query dimensions. Annotations @NativeType:uint32_t

width

back to summary

public int width()

the width of the ray trace query dimensions.

Annotations

@NativeType:uint32_t

width	back to summary
public VkTraceRaysIndirectCommandKHR width(int value) Sets the specified value to the `width` field.

org.lwjgl.vulkan back to summary

public Class VkTraceRaysIndirectCommandKHR.Buffer

Class Inheritance

extends StructBuffer<VkTraceRaysIndirectCommandKHR, VkTraceRaysIndirectCommandKHR.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkTraceRaysIndirectCommandKHR.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkTraceRaysIndirectCommandKHR structs.

Field Summary

Modifier and Type	Field and Description
private static final VkTraceRaysIndirectCommandKHR	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkTraceRaysIndirectCommandKHR.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 Type	Method and Description
public int	Returns: the value of the `VkTraceRaysIndirectCommandKHR#depth` field. depth()
public VkTraceRaysIndirectCommandKHR.Buffer	depth(int value) Sets the specified value to the `VkTraceRaysIndirectCommandKHR#depth` field.
protected VkTraceRaysIndirectCommandKHR	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public int	Returns: the value of the `VkTraceRaysIndirectCommandKHR#height` field. height()
public VkTraceRaysIndirectCommandKHR.Buffer	height(int value) Sets the specified value to the `VkTraceRaysIndirectCommandKHR#height` field.
protected VkTraceRaysIndirectCommandKHR.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `VkTraceRaysIndirectCommandKHR#width` field. width()
public VkTraceRaysIndirectCommandKHR.Buffer	width(int value) Sets the specified value to the `VkTraceRaysIndirectCommandKHR#width` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VkTraceRaysIndirectCommandKHR ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `VkTraceRaysIndirectCommandKHR.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 `VkTraceRaysIndirectCommandKHR#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

Creates a new VkTraceRaysIndirectCommandKHR.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 VkTraceRaysIndirectCommandKHR#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

depth	back to summary
public int depth() Returns:int the value of the `VkTraceRaysIndirectCommandKHR#depth` field. Annotations @NativeType:uint32_t

depth	back to summary
public VkTraceRaysIndirectCommandKHR.Buffer depth(int value) Sets the specified value to the `VkTraceRaysIndirectCommandKHR#depth` field.

getElementFactory

back to summary

protected VkTraceRaysIndirectCommandKHR getElementFactory()

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

Annotations

@Override

height	back to summary
public int height() Returns:int the value of the `VkTraceRaysIndirectCommandKHR#height` field. Annotations @NativeType:uint32_t

height	back to summary
public VkTraceRaysIndirectCommandKHR.Buffer height(int value) Sets the specified value to the `VkTraceRaysIndirectCommandKHR#height` field.

self

back to summary

protected VkTraceRaysIndirectCommandKHR.Buffer self()

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

Annotations

@Override

width	back to summary
public int width() Returns:int the value of the `VkTraceRaysIndirectCommandKHR#width` field. Annotations @NativeType:uint32_t

width	back to summary
public VkTraceRaysIndirectCommandKHR.Buffer width(int value) Sets the specified value to the `VkTraceRaysIndirectCommandKHR#width` field.