Package org.lwjgl.vulkan

Class VkTraceRaysIndirectCommandKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkTraceRaysIndirectCommandKHR>

org.lwjgl.vulkan.VkTraceRaysIndirectCommandKHR

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkTraceRaysIndirectCommandKHR
extends org.lwjgl.system.Struct<VkTraceRaysIndirectCommandKHR>
implements org.lwjgl.system.NativeResource

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 Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	DEPTH	The struct member offsets.
static final int	HEIGHT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	WIDTH	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkTraceRaysIndirectCommandKHR(ByteBuffer container)	Creates a VkTraceRaysIndirectCommandKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkTraceRaysIndirectCommandKHR	calloc()	Returns a new VkTraceRaysIndirectCommandKHR instance allocated with memCalloc.
static VkTraceRaysIndirectCommandKHR.Buffer	calloc(int capacity)	Returns a new VkTraceRaysIndirectCommandKHR.Buffer instance allocated with memCalloc.
static VkTraceRaysIndirectCommandKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkTraceRaysIndirectCommandKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkTraceRaysIndirectCommandKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkTraceRaysIndirectCommandKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkTraceRaysIndirectCommandKHR	create()	Returns a new VkTraceRaysIndirectCommandKHR instance allocated with BufferUtils.
static VkTraceRaysIndirectCommandKHR.Buffer	create(int capacity)	Returns a new VkTraceRaysIndirectCommandKHR.Buffer instance allocated with BufferUtils.
static VkTraceRaysIndirectCommandKHR	create(long address)	Returns a new VkTraceRaysIndirectCommandKHR instance for the specified memory address.
static VkTraceRaysIndirectCommandKHR.Buffer	create(long address, int capacity)	Create a VkTraceRaysIndirectCommandKHR.Buffer instance at the specified memory.
static @Nullable VkTraceRaysIndirectCommandKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkTraceRaysIndirectCommandKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	depth()	depth of the ray trace query dimensions.
VkTraceRaysIndirectCommandKHR	depth(int value)	Sets the specified value to the depth() field.
int	height()	height of the ray trace query dimensions.
VkTraceRaysIndirectCommandKHR	height(int value)	Sets the specified value to the height() field.
static VkTraceRaysIndirectCommandKHR	malloc()	Returns a new VkTraceRaysIndirectCommandKHR instance allocated with memAlloc.
static VkTraceRaysIndirectCommandKHR.Buffer	malloc(int capacity)	Returns a new VkTraceRaysIndirectCommandKHR.Buffer instance allocated with memAlloc.
static VkTraceRaysIndirectCommandKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkTraceRaysIndirectCommandKHR.Buffer instance allocated on the specified MemoryStack.
static VkTraceRaysIndirectCommandKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkTraceRaysIndirectCommandKHR instance allocated on the specified MemoryStack.
static int	ndepth(long struct)	Unsafe version of depth().
static void	ndepth(long struct, int value)	Unsafe version of depth.
static int	nheight(long struct)	Unsafe version of height().
static void	nheight(long struct, int value)	Unsafe version of height.
static int	nwidth(long struct)	Unsafe version of width().
static void	nwidth(long struct, int value)	Unsafe version of width.
VkTraceRaysIndirectCommandKHR	set(int width, int height, int depth)	Initializes this struct with the specified values.
VkTraceRaysIndirectCommandKHR	set(VkTraceRaysIndirectCommandKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	width()	the width of the ray trace query dimensions.
VkTraceRaysIndirectCommandKHR	width(int value)	Sets the specified value to the width() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

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

VkTraceRaysIndirectCommandKHR

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkTraceRaysIndirectCommandKHR>

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.

width

public VkTraceRaysIndirectCommandKHR width(int value)

Sets the specified value to the width() field.

height

public VkTraceRaysIndirectCommandKHR height(int value)

Sets the specified value to the height() field.

depth

public VkTraceRaysIndirectCommandKHR depth(int value)

Sets the specified value to the depth() field.

set

public VkTraceRaysIndirectCommandKHR set(int width,
 int height,
 int depth)

Initializes this struct with the specified values.

set

public VkTraceRaysIndirectCommandKHR set(VkTraceRaysIndirectCommandKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkTraceRaysIndirectCommandKHR malloc()

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

calloc

public static VkTraceRaysIndirectCommandKHR calloc()

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

create

public static VkTraceRaysIndirectCommandKHR create()

Returns a new VkTraceRaysIndirectCommandKHR instance allocated with BufferUtils.

create

public static VkTraceRaysIndirectCommandKHR create(long address)

Returns a new VkTraceRaysIndirectCommandKHR instance for the specified memory address.

createSafe

public static @Nullable VkTraceRaysIndirectCommandKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkTraceRaysIndirectCommandKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkTraceRaysIndirectCommandKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkTraceRaysIndirectCommandKHR.Buffer create(int capacity)

Returns a new VkTraceRaysIndirectCommandKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkTraceRaysIndirectCommandKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkTraceRaysIndirectCommandKHR malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkTraceRaysIndirectCommandKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkTraceRaysIndirectCommandKHR calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

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().

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.