Package org.lwjgl.vulkan

Class VkPhysicalDeviceRayTracingPipelineFeaturesKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceRayTracingPipelineFeaturesKHR>

org.lwjgl.vulkan.VkPhysicalDeviceRayTracingPipelineFeaturesKHR

All Implemented Interfaces:

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

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

Structure describing the ray tracing features that can be supported by an implementation.

Description

If the VkPhysicalDeviceRayTracingPipelineFeaturesKHR structure is included in the pNext chain of the VkPhysicalDeviceFeatures2 structure passed to GetPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. VkPhysicalDeviceRayTracingPipelineFeaturesKHR can also be used in the pNext chain of VkDeviceCreateInfo to selectively enable these features.

Valid Usage

• If rayTracingPipelineShaderGroupHandleCaptureReplayMixed is TRUE, rayTracingPipelineShaderGroupHandleCaptureReplay must also be TRUE

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_RAY_TRACING_PIPELINE_FEATURES_KHR

Layout

 struct VkPhysicalDeviceRayTracingPipelineFeaturesKHR {
     VkStructureType sType();
     void * pNext();
     VkBool32 rayTracingPipeline();
     VkBool32 rayTracingPipelineShaderGroupHandleCaptureReplay();
     VkBool32 rayTracingPipelineShaderGroupHandleCaptureReplayMixed();
     VkBool32 rayTracingPipelineTraceRaysIndirect();
     VkBool32 rayTraversalPrimitiveCulling();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPhysicalDeviceRayTracingPipelineFeaturesKHR.Buffer	An array of VkPhysicalDeviceRayTracingPipelineFeaturesKHR 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	PNEXT	The struct member offsets.
static final int	RAYTRACINGPIPELINE	The struct member offsets.
static final int	RAYTRACINGPIPELINESHADERGROUPHANDLECAPTUREREPLAY	The struct member offsets.
static final int	RAYTRACINGPIPELINESHADERGROUPHANDLECAPTUREREPLAYMIXED	The struct member offsets.
static final int	RAYTRACINGPIPELINETRACERAYSINDIRECT	The struct member offsets.
static final int	RAYTRAVERSALPRIMITIVECULLING	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	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
VkPhysicalDeviceRayTracingPipelineFeaturesKHR(ByteBuffer container)	Creates a VkPhysicalDeviceRayTracingPipelineFeaturesKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceRayTracingPipelineFeaturesKHR	calloc()	Returns a new VkPhysicalDeviceRayTracingPipelineFeaturesKHR instance allocated with memCalloc.
static VkPhysicalDeviceRayTracingPipelineFeaturesKHR.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceRayTracingPipelineFeaturesKHR.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceRayTracingPipelineFeaturesKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceRayTracingPipelineFeaturesKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceRayTracingPipelineFeaturesKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceRayTracingPipelineFeaturesKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceRayTracingPipelineFeaturesKHR	create()	Returns a new VkPhysicalDeviceRayTracingPipelineFeaturesKHR instance allocated with BufferUtils.
static VkPhysicalDeviceRayTracingPipelineFeaturesKHR.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceRayTracingPipelineFeaturesKHR.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceRayTracingPipelineFeaturesKHR	create(long address)	Returns a new VkPhysicalDeviceRayTracingPipelineFeaturesKHR instance for the specified memory address.
static VkPhysicalDeviceRayTracingPipelineFeaturesKHR.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceRayTracingPipelineFeaturesKHR.Buffer instance at the specified memory.
static @Nullable VkPhysicalDeviceRayTracingPipelineFeaturesKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceRayTracingPipelineFeaturesKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkPhysicalDeviceRayTracingPipelineFeaturesKHR	malloc()	Returns a new VkPhysicalDeviceRayTracingPipelineFeaturesKHR instance allocated with memAlloc.
static VkPhysicalDeviceRayTracingPipelineFeaturesKHR.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceRayTracingPipelineFeaturesKHR.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceRayTracingPipelineFeaturesKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceRayTracingPipelineFeaturesKHR.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceRayTracingPipelineFeaturesKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceRayTracingPipelineFeaturesKHR instance allocated on the specified MemoryStack.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nrayTracingPipeline(long struct)	Unsafe version of rayTracingPipeline().
static void	nrayTracingPipeline(long struct, int value)	Unsafe version of rayTracingPipeline.
static int	nrayTracingPipelineShaderGroupHandleCaptureReplay(long struct)	Unsafe version of rayTracingPipelineShaderGroupHandleCaptureReplay().
static void	nrayTracingPipelineShaderGroupHandleCaptureReplay(long struct, int value)	Unsafe version of rayTracingPipelineShaderGroupHandleCaptureReplay.
static int	nrayTracingPipelineShaderGroupHandleCaptureReplayMixed(long struct)	Unsafe version of rayTracingPipelineShaderGroupHandleCaptureReplayMixed().
static void	nrayTracingPipelineShaderGroupHandleCaptureReplayMixed(long struct, int value)	Unsafe version of rayTracingPipelineShaderGroupHandleCaptureReplayMixed.
static int	nrayTracingPipelineTraceRaysIndirect(long struct)	Unsafe version of rayTracingPipelineTraceRaysIndirect().
static void	nrayTracingPipelineTraceRaysIndirect(long struct, int value)	Unsafe version of rayTracingPipelineTraceRaysIndirect.
static int	nrayTraversalPrimitiveCulling(long struct)	Unsafe version of rayTraversalPrimitiveCulling().
static void	nrayTraversalPrimitiveCulling(long struct, int value)	Unsafe version of rayTraversalPrimitiveCulling.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkPhysicalDeviceRayTracingPipelineFeaturesKHR	pNext(long value)	Sets the specified value to the pNext() field.
boolean	rayTracingPipeline()	indicates whether the implementation supports the ray tracing pipeline functionality.
VkPhysicalDeviceRayTracingPipelineFeaturesKHR	rayTracingPipeline(boolean value)	Sets the specified value to the rayTracingPipeline() field.
boolean	rayTracingPipelineShaderGroupHandleCaptureReplay()	indicates whether the implementation supports saving and reusing shader group handles, e.g.
VkPhysicalDeviceRayTracingPipelineFeaturesKHR	rayTracingPipelineShaderGroupHandleCaptureReplay(boolean value)	Sets the specified value to the rayTracingPipelineShaderGroupHandleCaptureReplay() field.
boolean	rayTracingPipelineShaderGroupHandleCaptureReplayMixed()	indicates whether the implementation supports reuse of shader group handles being arbitrarily mixed with creation of non-reused shader group handles.
VkPhysicalDeviceRayTracingPipelineFeaturesKHR	rayTracingPipelineShaderGroupHandleCaptureReplayMixed(boolean value)	Sets the specified value to the rayTracingPipelineShaderGroupHandleCaptureReplayMixed() field.
boolean	rayTracingPipelineTraceRaysIndirect()	indicates whether the implementation supports indirect ray tracing commands, e.g.
VkPhysicalDeviceRayTracingPipelineFeaturesKHR	rayTracingPipelineTraceRaysIndirect(boolean value)	Sets the specified value to the rayTracingPipelineTraceRaysIndirect() field.
boolean	rayTraversalPrimitiveCulling()	indicates whether the implementation supports primitive culling during ray traversal.
VkPhysicalDeviceRayTracingPipelineFeaturesKHR	rayTraversalPrimitiveCulling(boolean value)	Sets the specified value to the rayTraversalPrimitiveCulling() field.
VkPhysicalDeviceRayTracingPipelineFeaturesKHR	set(int sType, long pNext, boolean rayTracingPipeline, boolean rayTracingPipelineShaderGroupHandleCaptureReplay, boolean rayTracingPipelineShaderGroupHandleCaptureReplayMixed, boolean rayTracingPipelineTraceRaysIndirect, boolean rayTraversalPrimitiveCulling)	Initializes this struct with the specified values.
VkPhysicalDeviceRayTracingPipelineFeaturesKHR	set(VkPhysicalDeviceRayTracingPipelineFeaturesKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPhysicalDeviceRayTracingPipelineFeaturesKHR	sType(int value)	Sets the specified value to the sType() field.
VkPhysicalDeviceRayTracingPipelineFeaturesKHR	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_RAY_TRACING_PIPELINE_FEATURES_KHR value to the sType() 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.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

RAYTRACINGPIPELINE

public static final int RAYTRACINGPIPELINE

The struct member offsets.

RAYTRACINGPIPELINESHADERGROUPHANDLECAPTUREREPLAY

public static final int RAYTRACINGPIPELINESHADERGROUPHANDLECAPTUREREPLAY

The struct member offsets.

RAYTRACINGPIPELINESHADERGROUPHANDLECAPTUREREPLAYMIXED

public static final int RAYTRACINGPIPELINESHADERGROUPHANDLECAPTUREREPLAYMIXED

The struct member offsets.

RAYTRACINGPIPELINETRACERAYSINDIRECT

public static final int RAYTRACINGPIPELINETRACERAYSINDIRECT

The struct member offsets.

RAYTRAVERSALPRIMITIVECULLING

public static final int RAYTRAVERSALPRIMITIVECULLING

The struct member offsets.

Constructor Details

VkPhysicalDeviceRayTracingPipelineFeaturesKHR

public VkPhysicalDeviceRayTracingPipelineFeaturesKHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

rayTracingPipeline

public boolean rayTracingPipeline()

indicates whether the implementation supports the ray tracing pipeline functionality. See Ray Tracing.

rayTracingPipelineShaderGroupHandleCaptureReplay

public boolean rayTracingPipelineShaderGroupHandleCaptureReplay()

indicates whether the implementation supports saving and reusing shader group handles, e.g. for trace capture and replay.

rayTracingPipelineShaderGroupHandleCaptureReplayMixed

public boolean rayTracingPipelineShaderGroupHandleCaptureReplayMixed()

indicates whether the implementation supports reuse of shader group handles being arbitrarily mixed with creation of non-reused shader group handles. If this is FALSE, all reused shader group handles must be specified before any non-reused handles may be created.

rayTracingPipelineTraceRaysIndirect

public boolean rayTracingPipelineTraceRaysIndirect()

indicates whether the implementation supports indirect ray tracing commands, e.g. CmdTraceRaysIndirectKHR.

rayTraversalPrimitiveCulling

public boolean rayTraversalPrimitiveCulling()

indicates whether the implementation supports primitive culling during ray traversal.

sType

public VkPhysicalDeviceRayTracingPipelineFeaturesKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPhysicalDeviceRayTracingPipelineFeaturesKHR sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_RAY_TRACING_PIPELINE_FEATURES_KHR value to the sType() field.

pNext

public VkPhysicalDeviceRayTracingPipelineFeaturesKHR pNext(long value)

Sets the specified value to the pNext() field.

rayTracingPipeline

public VkPhysicalDeviceRayTracingPipelineFeaturesKHR rayTracingPipeline(boolean value)

Sets the specified value to the rayTracingPipeline() field.

rayTracingPipelineShaderGroupHandleCaptureReplay

public VkPhysicalDeviceRayTracingPipelineFeaturesKHR rayTracingPipelineShaderGroupHandleCaptureReplay(boolean value)

Sets the specified value to the rayTracingPipelineShaderGroupHandleCaptureReplay() field.

rayTracingPipelineShaderGroupHandleCaptureReplayMixed

public VkPhysicalDeviceRayTracingPipelineFeaturesKHR rayTracingPipelineShaderGroupHandleCaptureReplayMixed(boolean value)

Sets the specified value to the rayTracingPipelineShaderGroupHandleCaptureReplayMixed() field.

rayTracingPipelineTraceRaysIndirect

public VkPhysicalDeviceRayTracingPipelineFeaturesKHR rayTracingPipelineTraceRaysIndirect(boolean value)

Sets the specified value to the rayTracingPipelineTraceRaysIndirect() field.

rayTraversalPrimitiveCulling

public VkPhysicalDeviceRayTracingPipelineFeaturesKHR rayTraversalPrimitiveCulling(boolean value)

Sets the specified value to the rayTraversalPrimitiveCulling() field.

set

public VkPhysicalDeviceRayTracingPipelineFeaturesKHR set(int sType,
 long pNext,
 boolean rayTracingPipeline,
 boolean rayTracingPipelineShaderGroupHandleCaptureReplay,
 boolean rayTracingPipelineShaderGroupHandleCaptureReplayMixed,
 boolean rayTracingPipelineTraceRaysIndirect,
 boolean rayTraversalPrimitiveCulling)

Initializes this struct with the specified values.

set

public VkPhysicalDeviceRayTracingPipelineFeaturesKHR set(VkPhysicalDeviceRayTracingPipelineFeaturesKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceRayTracingPipelineFeaturesKHR malloc()

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

calloc

public static VkPhysicalDeviceRayTracingPipelineFeaturesKHR calloc()

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

create

public static VkPhysicalDeviceRayTracingPipelineFeaturesKHR create()

Returns a new VkPhysicalDeviceRayTracingPipelineFeaturesKHR instance allocated with BufferUtils.

create

public static VkPhysicalDeviceRayTracingPipelineFeaturesKHR create(long address)

Returns a new VkPhysicalDeviceRayTracingPipelineFeaturesKHR instance for the specified memory address.

createSafe

public static @Nullable VkPhysicalDeviceRayTracingPipelineFeaturesKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceRayTracingPipelineFeaturesKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceRayTracingPipelineFeaturesKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceRayTracingPipelineFeaturesKHR.Buffer create(int capacity)

Returns a new VkPhysicalDeviceRayTracingPipelineFeaturesKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceRayTracingPipelineFeaturesKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkPhysicalDeviceRayTracingPipelineFeaturesKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nrayTracingPipeline

public static int nrayTracingPipeline(long struct)

Unsafe version of rayTracingPipeline().

nrayTracingPipelineShaderGroupHandleCaptureReplay

public static int nrayTracingPipelineShaderGroupHandleCaptureReplay(long struct)

Unsafe version of rayTracingPipelineShaderGroupHandleCaptureReplay().

nrayTracingPipelineShaderGroupHandleCaptureReplayMixed

public static int nrayTracingPipelineShaderGroupHandleCaptureReplayMixed(long struct)

Unsafe version of rayTracingPipelineShaderGroupHandleCaptureReplayMixed().

nrayTracingPipelineTraceRaysIndirect

public static int nrayTracingPipelineTraceRaysIndirect(long struct)

Unsafe version of rayTracingPipelineTraceRaysIndirect().

nrayTraversalPrimitiveCulling

public static int nrayTraversalPrimitiveCulling(long struct)

Unsafe version of rayTraversalPrimitiveCulling().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

nrayTracingPipeline

public static void nrayTracingPipeline(long struct,
 int value)

Unsafe version of rayTracingPipeline.

nrayTracingPipelineShaderGroupHandleCaptureReplay

public static void nrayTracingPipelineShaderGroupHandleCaptureReplay(long struct,
 int value)

Unsafe version of rayTracingPipelineShaderGroupHandleCaptureReplay.

nrayTracingPipelineShaderGroupHandleCaptureReplayMixed

public static void nrayTracingPipelineShaderGroupHandleCaptureReplayMixed(long struct,
 int value)

Unsafe version of rayTracingPipelineShaderGroupHandleCaptureReplayMixed.

nrayTracingPipelineTraceRaysIndirect

public static void nrayTracingPipelineTraceRaysIndirect(long struct,
 int value)

Unsafe version of rayTracingPipelineTraceRaysIndirect.

nrayTraversalPrimitiveCulling

public static void nrayTraversalPrimitiveCulling(long struct,
 int value)

Unsafe version of rayTraversalPrimitiveCulling.