Package org.lwjgl.vulkan

Class VkPhysicalDeviceRayTracingPipelinePropertiesKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceRayTracingPipelinePropertiesKHR>

org.lwjgl.vulkan.VkPhysicalDeviceRayTracingPipelinePropertiesKHR

All Implemented Interfaces:

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

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

Properties of the physical device for ray tracing.

Description

If the VkPhysicalDeviceRayTracingPipelinePropertiesKHR structure is included in the pNext chain of the VkPhysicalDeviceProperties2 structure passed to GetPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

Limits specified by this structure must match those specified with the same name in VkPhysicalDeviceRayTracingPropertiesNV.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_RAY_TRACING_PIPELINE_PROPERTIES_KHR

Layout

 struct VkPhysicalDeviceRayTracingPipelinePropertiesKHR {
     VkStructureType sType();
     void * pNext();
     uint32_t shaderGroupHandleSize();
     uint32_t maxRayRecursionDepth();
     uint32_t maxShaderGroupStride();
     uint32_t shaderGroupBaseAlignment();
     uint32_t shaderGroupHandleCaptureReplaySize();
     uint32_t maxRayDispatchInvocationCount();
     uint32_t shaderGroupHandleAlignment();
     uint32_t maxRayHitAttributeSize();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPhysicalDeviceRayTracingPipelinePropertiesKHR.Buffer	An array of VkPhysicalDeviceRayTracingPipelinePropertiesKHR 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	MAXRAYDISPATCHINVOCATIONCOUNT	The struct member offsets.
static final int	MAXRAYHITATTRIBUTESIZE	The struct member offsets.
static final int	MAXRAYRECURSIONDEPTH	The struct member offsets.
static final int	MAXSHADERGROUPSTRIDE	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SHADERGROUPBASEALIGNMENT	The struct member offsets.
static final int	SHADERGROUPHANDLEALIGNMENT	The struct member offsets.
static final int	SHADERGROUPHANDLECAPTUREREPLAYSIZE	The struct member offsets.
static final int	SHADERGROUPHANDLESIZE	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
VkPhysicalDeviceRayTracingPipelinePropertiesKHR(ByteBuffer container)	Creates a VkPhysicalDeviceRayTracingPipelinePropertiesKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceRayTracingPipelinePropertiesKHR	calloc()	Returns a new VkPhysicalDeviceRayTracingPipelinePropertiesKHR instance allocated with memCalloc.
static VkPhysicalDeviceRayTracingPipelinePropertiesKHR.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceRayTracingPipelinePropertiesKHR.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceRayTracingPipelinePropertiesKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceRayTracingPipelinePropertiesKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceRayTracingPipelinePropertiesKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceRayTracingPipelinePropertiesKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceRayTracingPipelinePropertiesKHR	create()	Returns a new VkPhysicalDeviceRayTracingPipelinePropertiesKHR instance allocated with BufferUtils.
static VkPhysicalDeviceRayTracingPipelinePropertiesKHR.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceRayTracingPipelinePropertiesKHR.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceRayTracingPipelinePropertiesKHR	create(long address)	Returns a new VkPhysicalDeviceRayTracingPipelinePropertiesKHR instance for the specified memory address.
static VkPhysicalDeviceRayTracingPipelinePropertiesKHR.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceRayTracingPipelinePropertiesKHR.Buffer instance at the specified memory.
static @Nullable VkPhysicalDeviceRayTracingPipelinePropertiesKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceRayTracingPipelinePropertiesKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkPhysicalDeviceRayTracingPipelinePropertiesKHR	malloc()	Returns a new VkPhysicalDeviceRayTracingPipelinePropertiesKHR instance allocated with memAlloc.
static VkPhysicalDeviceRayTracingPipelinePropertiesKHR.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceRayTracingPipelinePropertiesKHR.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceRayTracingPipelinePropertiesKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceRayTracingPipelinePropertiesKHR.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceRayTracingPipelinePropertiesKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceRayTracingPipelinePropertiesKHR instance allocated on the specified MemoryStack.
int	maxRayDispatchInvocationCount()	the maximum number of ray generation shader invocations which may be produced by a single CmdTraceRaysIndirectKHR or CmdTraceRaysKHR command.
int	maxRayHitAttributeSize()	the maximum size in bytes for a ray attribute structure
int	maxRayRecursionDepth()	the maximum number of levels of ray recursion allowed in a trace command.
int	maxShaderGroupStride()	the maximum stride in bytes allowed between shader groups in the shader binding table.
static int	nmaxRayDispatchInvocationCount(long struct)	Unsafe version of maxRayDispatchInvocationCount().
static int	nmaxRayHitAttributeSize(long struct)	Unsafe version of maxRayHitAttributeSize().
static int	nmaxRayRecursionDepth(long struct)	Unsafe version of maxRayRecursionDepth().
static int	nmaxShaderGroupStride(long struct)	Unsafe version of maxShaderGroupStride().
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nshaderGroupBaseAlignment(long struct)	Unsafe version of shaderGroupBaseAlignment().
static int	nshaderGroupHandleAlignment(long struct)	Unsafe version of shaderGroupHandleAlignment().
static int	nshaderGroupHandleCaptureReplaySize(long struct)	Unsafe version of shaderGroupHandleCaptureReplaySize().
static int	nshaderGroupHandleSize(long struct)	Unsafe version of shaderGroupHandleSize().
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.
VkPhysicalDeviceRayTracingPipelinePropertiesKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkPhysicalDeviceRayTracingPipelinePropertiesKHR	set(int sType, long pNext)	Initializes this struct with the specified values.
VkPhysicalDeviceRayTracingPipelinePropertiesKHR	set(VkPhysicalDeviceRayTracingPipelinePropertiesKHR src)	Copies the specified struct data to this struct.
int	shaderGroupBaseAlignment()	the required alignment in bytes for the base of the shader binding table.
int	shaderGroupHandleAlignment()	the required alignment in bytes for each entry in a shader binding table.
int	shaderGroupHandleCaptureReplaySize()	the number of bytes for the information required to do capture and replay for shader group handles.
int	shaderGroupHandleSize()	the size in bytes of the shader header.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPhysicalDeviceRayTracingPipelinePropertiesKHR	sType(int value)	Sets the specified value to the sType() field.
VkPhysicalDeviceRayTracingPipelinePropertiesKHR	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_RAY_TRACING_PIPELINE_PROPERTIES_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.

SHADERGROUPHANDLESIZE

public static final int SHADERGROUPHANDLESIZE

The struct member offsets.

MAXRAYRECURSIONDEPTH

public static final int MAXRAYRECURSIONDEPTH

The struct member offsets.

MAXSHADERGROUPSTRIDE

public static final int MAXSHADERGROUPSTRIDE

The struct member offsets.

SHADERGROUPBASEALIGNMENT

public static final int SHADERGROUPBASEALIGNMENT

The struct member offsets.

SHADERGROUPHANDLECAPTUREREPLAYSIZE

public static final int SHADERGROUPHANDLECAPTUREREPLAYSIZE

The struct member offsets.

MAXRAYDISPATCHINVOCATIONCOUNT

public static final int MAXRAYDISPATCHINVOCATIONCOUNT

The struct member offsets.

SHADERGROUPHANDLEALIGNMENT

public static final int SHADERGROUPHANDLEALIGNMENT

The struct member offsets.

MAXRAYHITATTRIBUTESIZE

public static final int MAXRAYHITATTRIBUTESIZE

The struct member offsets.

Constructor Details

VkPhysicalDeviceRayTracingPipelinePropertiesKHR

public VkPhysicalDeviceRayTracingPipelinePropertiesKHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

shaderGroupHandleSize

public int shaderGroupHandleSize()

the size in bytes of the shader header.

maxRayRecursionDepth

public int maxRayRecursionDepth()

the maximum number of levels of ray recursion allowed in a trace command.

maxShaderGroupStride

public int maxShaderGroupStride()

the maximum stride in bytes allowed between shader groups in the shader binding table.

shaderGroupBaseAlignment

public int shaderGroupBaseAlignment()

the required alignment in bytes for the base of the shader binding table.

shaderGroupHandleCaptureReplaySize

public int shaderGroupHandleCaptureReplaySize()

the number of bytes for the information required to do capture and replay for shader group handles.

maxRayDispatchInvocationCount

public int maxRayDispatchInvocationCount()

the maximum number of ray generation shader invocations which may be produced by a single CmdTraceRaysIndirectKHR or CmdTraceRaysKHR command.

shaderGroupHandleAlignment

public int shaderGroupHandleAlignment()

the required alignment in bytes for each entry in a shader binding table. The value must be a power of two.

maxRayHitAttributeSize

public int maxRayHitAttributeSize()

the maximum size in bytes for a ray attribute structure

sType

public VkPhysicalDeviceRayTracingPipelinePropertiesKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPhysicalDeviceRayTracingPipelinePropertiesKHR sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_RAY_TRACING_PIPELINE_PROPERTIES_KHR value to the sType() field.

pNext

public VkPhysicalDeviceRayTracingPipelinePropertiesKHR pNext(long value)

Sets the specified value to the pNext() field.

set

public VkPhysicalDeviceRayTracingPipelinePropertiesKHR set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkPhysicalDeviceRayTracingPipelinePropertiesKHR set(VkPhysicalDeviceRayTracingPipelinePropertiesKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceRayTracingPipelinePropertiesKHR malloc()

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

calloc

public static VkPhysicalDeviceRayTracingPipelinePropertiesKHR calloc()

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

create

public static VkPhysicalDeviceRayTracingPipelinePropertiesKHR create()

Returns a new VkPhysicalDeviceRayTracingPipelinePropertiesKHR instance allocated with BufferUtils.

create

public static VkPhysicalDeviceRayTracingPipelinePropertiesKHR create(long address)

Returns a new VkPhysicalDeviceRayTracingPipelinePropertiesKHR instance for the specified memory address.

createSafe

public static @Nullable VkPhysicalDeviceRayTracingPipelinePropertiesKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceRayTracingPipelinePropertiesKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceRayTracingPipelinePropertiesKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceRayTracingPipelinePropertiesKHR.Buffer create(int capacity)

Returns a new VkPhysicalDeviceRayTracingPipelinePropertiesKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceRayTracingPipelinePropertiesKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkPhysicalDeviceRayTracingPipelinePropertiesKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkPhysicalDeviceRayTracingPipelinePropertiesKHR.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().

nshaderGroupHandleSize

public static int nshaderGroupHandleSize(long struct)

Unsafe version of shaderGroupHandleSize().

nmaxRayRecursionDepth

public static int nmaxRayRecursionDepth(long struct)

Unsafe version of maxRayRecursionDepth().

nmaxShaderGroupStride

public static int nmaxShaderGroupStride(long struct)

Unsafe version of maxShaderGroupStride().

nshaderGroupBaseAlignment

public static int nshaderGroupBaseAlignment(long struct)

Unsafe version of shaderGroupBaseAlignment().

nshaderGroupHandleCaptureReplaySize

public static int nshaderGroupHandleCaptureReplaySize(long struct)

Unsafe version of shaderGroupHandleCaptureReplaySize().

nmaxRayDispatchInvocationCount

public static int nmaxRayDispatchInvocationCount(long struct)

Unsafe version of maxRayDispatchInvocationCount().

nshaderGroupHandleAlignment

public static int nshaderGroupHandleAlignment(long struct)

Unsafe version of shaderGroupHandleAlignment().

nmaxRayHitAttributeSize

public static int nmaxRayHitAttributeSize(long struct)

Unsafe version of maxRayHitAttributeSize().

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.