Package org.lwjgl.vulkan

Class VkRayTracingShaderGroupCreateInfoNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkRayTracingShaderGroupCreateInfoNV>

org.lwjgl.vulkan.VkRayTracingShaderGroupCreateInfoNV

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkRayTracingShaderGroupCreateInfoNV
extends Struct<VkRayTracingShaderGroupCreateInfoNV>
implements NativeResource

Structure specifying shaders in a shader group.

Valid Usage

• If type is RAY_TRACING_SHADER_GROUP_TYPE_GENERAL_NV then generalShader must be a valid index into VkRayTracingPipelineCreateInfoNV::pStages referring to a shader of SHADER_STAGE_RAYGEN_BIT_NV, SHADER_STAGE_MISS_BIT_NV, or SHADER_STAGE_CALLABLE_BIT_NV
• If type is RAY_TRACING_SHADER_GROUP_TYPE_GENERAL_NV then closestHitShader, anyHitShader, and intersectionShader must be SHADER_UNUSED_NV
• If type is RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_NV then intersectionShader must be a valid index into VkRayTracingPipelineCreateInfoNV::pStages referring to a shader of SHADER_STAGE_INTERSECTION_BIT_NV
• If type is RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_NV then intersectionShader must be SHADER_UNUSED_NV
• closestHitShader must be either SHADER_UNUSED_NV or a valid index into VkRayTracingPipelineCreateInfoNV::pStages referring to a shader of SHADER_STAGE_CLOSEST_HIT_BIT_NV
• anyHitShader must be either SHADER_UNUSED_NV or a valid index into VkRayTracingPipelineCreateInfoNV::pStages referring to a shader of SHADER_STAGE_ANY_HIT_BIT_NV

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RAY_TRACING_SHADER_GROUP_CREATE_INFO_NV
• pNext must be NULL
• type must be a valid VkRayTracingShaderGroupTypeKHR value

See Also

VkRayTracingPipelineCreateInfoNV

Layout

 struct VkRayTracingShaderGroupCreateInfoNV {
     VkStructureType sType();
     void const * pNext();
     VkRayTracingShaderGroupTypeKHR type();
     uint32_t generalShader();
     uint32_t closestHitShader();
     uint32_t anyHitShader();
     uint32_t intersectionShader();
 }

Nested Class Summary

Nested Classes

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

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

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	ANYHITSHADER	The struct member offsets.
static final int	CLOSESTHITSHADER	The struct member offsets.
static final int	GENERALSHADER	The struct member offsets.
static final int	INTERSECTIONSHADER	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.
static final int	TYPE	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
VkRayTracingShaderGroupCreateInfoNV(ByteBuffer container)	Creates a VkRayTracingShaderGroupCreateInfoNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
int	anyHitShader()	the optional index of the any-hit shader from VkRayTracingPipelineCreateInfoNV::pStages in the group if the shader group has type of RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_NV or RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_NV, and SHADER_UNUSED_NV otherwise.
VkRayTracingShaderGroupCreateInfoNV	anyHitShader(int value)	Sets the specified value to the anyHitShader() field.
static VkRayTracingShaderGroupCreateInfoNV	calloc()	Returns a new VkRayTracingShaderGroupCreateInfoNV instance allocated with memCalloc.
static VkRayTracingShaderGroupCreateInfoNV.Buffer	calloc(int capacity)	Returns a new VkRayTracingShaderGroupCreateInfoNV.Buffer instance allocated with memCalloc.
static VkRayTracingShaderGroupCreateInfoNV.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkRayTracingShaderGroupCreateInfoNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkRayTracingShaderGroupCreateInfoNV	calloc(MemoryStack stack)	Returns a new VkRayTracingShaderGroupCreateInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkRayTracingShaderGroupCreateInfoNV	callocStack()	Deprecated.
static VkRayTracingShaderGroupCreateInfoNV.Buffer	callocStack(int capacity)	Deprecated.
static VkRayTracingShaderGroupCreateInfoNV.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkRayTracingShaderGroupCreateInfoNV	callocStack(MemoryStack stack)	Deprecated.
int	closestHitShader()	the optional index of the closest hit shader from VkRayTracingPipelineCreateInfoNV::pStages in the group if the shader group has type of RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_NV or RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_NV, and SHADER_UNUSED_NV otherwise.
VkRayTracingShaderGroupCreateInfoNV	closestHitShader(int value)	Sets the specified value to the closestHitShader() field.
static VkRayTracingShaderGroupCreateInfoNV	create()	Returns a new VkRayTracingShaderGroupCreateInfoNV instance allocated with BufferUtils.
static VkRayTracingShaderGroupCreateInfoNV.Buffer	create(int capacity)	Returns a new VkRayTracingShaderGroupCreateInfoNV.Buffer instance allocated with BufferUtils.
static VkRayTracingShaderGroupCreateInfoNV	create(long address)	Returns a new VkRayTracingShaderGroupCreateInfoNV instance for the specified memory address.
static VkRayTracingShaderGroupCreateInfoNV.Buffer	create(long address, int capacity)	Create a VkRayTracingShaderGroupCreateInfoNV.Buffer instance at the specified memory.
static VkRayTracingShaderGroupCreateInfoNV	createSafe(long address)	Like create, but returns null if address is NULL.
static VkRayTracingShaderGroupCreateInfoNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	generalShader()	the index of the ray generation, miss, or callable shader from VkRayTracingPipelineCreateInfoNV::pStages in the group if the shader group has type of RAY_TRACING_SHADER_GROUP_TYPE_GENERAL_NV, and SHADER_UNUSED_NV otherwise.
VkRayTracingShaderGroupCreateInfoNV	generalShader(int value)	Sets the specified value to the generalShader() field.
int	intersectionShader()	the index of the intersection shader from VkRayTracingPipelineCreateInfoNV::pStages in the group if the shader group has type of RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_NV, and SHADER_UNUSED_NV otherwise.
VkRayTracingShaderGroupCreateInfoNV	intersectionShader(int value)	Sets the specified value to the intersectionShader() field.
static VkRayTracingShaderGroupCreateInfoNV	malloc()	Returns a new VkRayTracingShaderGroupCreateInfoNV instance allocated with memAlloc.
static VkRayTracingShaderGroupCreateInfoNV.Buffer	malloc(int capacity)	Returns a new VkRayTracingShaderGroupCreateInfoNV.Buffer instance allocated with memAlloc.
static VkRayTracingShaderGroupCreateInfoNV.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkRayTracingShaderGroupCreateInfoNV.Buffer instance allocated on the specified MemoryStack.
static VkRayTracingShaderGroupCreateInfoNV	malloc(MemoryStack stack)	Returns a new VkRayTracingShaderGroupCreateInfoNV instance allocated on the specified MemoryStack.
static VkRayTracingShaderGroupCreateInfoNV	mallocStack()	Deprecated.
static VkRayTracingShaderGroupCreateInfoNV.Buffer	mallocStack(int capacity)	Deprecated.
static VkRayTracingShaderGroupCreateInfoNV.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkRayTracingShaderGroupCreateInfoNV	mallocStack(MemoryStack stack)	Deprecated.
static int	nanyHitShader(long struct)	Unsafe version of anyHitShader().
static void	nanyHitShader(long struct, int value)	Unsafe version of anyHitShader.
static int	nclosestHitShader(long struct)	Unsafe version of closestHitShader().
static void	nclosestHitShader(long struct, int value)	Unsafe version of closestHitShader.
static int	ngeneralShader(long struct)	Unsafe version of generalShader().
static void	ngeneralShader(long struct, int value)	Unsafe version of generalShader.
static int	nintersectionShader(long struct)	Unsafe version of intersectionShader().
static void	nintersectionShader(long struct, int value)	Unsafe version of intersectionShader.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkRayTracingShaderGroupCreateInfoNV	pNext(long value)	Sets the specified value to the pNext() field.
VkRayTracingShaderGroupCreateInfoNV	set(int sType, long pNext, int type, int generalShader, int closestHitShader, int anyHitShader, int intersectionShader)	Initializes this struct with the specified values.
VkRayTracingShaderGroupCreateInfoNV	set(VkRayTracingShaderGroupCreateInfoNV src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()	a VkStructureType value identifying this structure.
VkRayTracingShaderGroupCreateInfoNV	sType(int value)	Sets the specified value to the sType() field.
VkRayTracingShaderGroupCreateInfoNV	sType$Default()	Sets the STRUCTURE_TYPE_RAY_TRACING_SHADER_GROUP_CREATE_INFO_NV value to the sType() field.
int	type()	the type of hit group specified in this structure.
VkRayTracingShaderGroupCreateInfoNV	type(int value)	Sets the specified value to the type() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, 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.

TYPE

public static final int TYPE

The struct member offsets.

GENERALSHADER

public static final int GENERALSHADER

The struct member offsets.

CLOSESTHITSHADER

public static final int CLOSESTHITSHADER

The struct member offsets.

ANYHITSHADER

public static final int ANYHITSHADER

The struct member offsets.

INTERSECTIONSHADER

public static final int INTERSECTIONSHADER

The struct member offsets.

Constructor Details

VkRayTracingShaderGroupCreateInfoNV

public VkRayTracingShaderGroupCreateInfoNV(ByteBuffer container)

Creates a VkRayTracingShaderGroupCreateInfoNV 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()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkRayTracingShaderGroupCreateInfoNV>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

type

public int type()

the type of hit group specified in this structure.

generalShader

public int generalShader()

the index of the ray generation, miss, or callable shader from VkRayTracingPipelineCreateInfoNV::pStages in the group if the shader group has type of RAY_TRACING_SHADER_GROUP_TYPE_GENERAL_NV, and SHADER_UNUSED_NV otherwise.

closestHitShader

public int closestHitShader()

the optional index of the closest hit shader from VkRayTracingPipelineCreateInfoNV::pStages in the group if the shader group has type of RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_NV or RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_NV, and SHADER_UNUSED_NV otherwise.

anyHitShader

public int anyHitShader()

the optional index of the any-hit shader from VkRayTracingPipelineCreateInfoNV::pStages in the group if the shader group has type of RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_NV or RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_NV, and SHADER_UNUSED_NV otherwise.

intersectionShader

public int intersectionShader()

the index of the intersection shader from VkRayTracingPipelineCreateInfoNV::pStages in the group if the shader group has type of RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_NV, and SHADER_UNUSED_NV otherwise.

sType

public VkRayTracingShaderGroupCreateInfoNV sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkRayTracingShaderGroupCreateInfoNV sType$Default()

Sets the STRUCTURE_TYPE_RAY_TRACING_SHADER_GROUP_CREATE_INFO_NV value to the sType() field.

pNext

public VkRayTracingShaderGroupCreateInfoNV pNext(long value)

Sets the specified value to the pNext() field.

type

public VkRayTracingShaderGroupCreateInfoNV type(int value)

Sets the specified value to the type() field.

generalShader

public VkRayTracingShaderGroupCreateInfoNV generalShader(int value)

Sets the specified value to the generalShader() field.

closestHitShader

public VkRayTracingShaderGroupCreateInfoNV closestHitShader(int value)

Sets the specified value to the closestHitShader() field.

anyHitShader

public VkRayTracingShaderGroupCreateInfoNV anyHitShader(int value)

Sets the specified value to the anyHitShader() field.

intersectionShader

public VkRayTracingShaderGroupCreateInfoNV intersectionShader(int value)

Sets the specified value to the intersectionShader() field.

set

public VkRayTracingShaderGroupCreateInfoNV set(int sType,
 long pNext,
 int type,
 int generalShader,
 int closestHitShader,
 int anyHitShader,
 int intersectionShader)

Initializes this struct with the specified values.

set

public VkRayTracingShaderGroupCreateInfoNV set(VkRayTracingShaderGroupCreateInfoNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkRayTracingShaderGroupCreateInfoNV malloc()

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

calloc

public static VkRayTracingShaderGroupCreateInfoNV calloc()

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

create

public static VkRayTracingShaderGroupCreateInfoNV create()

Returns a new VkRayTracingShaderGroupCreateInfoNV instance allocated with BufferUtils.

create

public static VkRayTracingShaderGroupCreateInfoNV create(long address)

Returns a new VkRayTracingShaderGroupCreateInfoNV instance for the specified memory address.

createSafe

@Nullable
public static VkRayTracingShaderGroupCreateInfoNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkRayTracingShaderGroupCreateInfoNV.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkRayTracingShaderGroupCreateInfoNV.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkRayTracingShaderGroupCreateInfoNV.Buffer create(int capacity)

Returns a new VkRayTracingShaderGroupCreateInfoNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkRayTracingShaderGroupCreateInfoNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkRayTracingShaderGroupCreateInfoNV mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkRayTracingShaderGroupCreateInfoNV callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkRayTracingShaderGroupCreateInfoNV mallocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkRayTracingShaderGroupCreateInfoNV callocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkRayTracingShaderGroupCreateInfoNV.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkRayTracingShaderGroupCreateInfoNV.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VkRayTracingShaderGroupCreateInfoNV.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkRayTracingShaderGroupCreateInfoNV.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static VkRayTracingShaderGroupCreateInfoNV malloc(MemoryStack stack)

Returns a new VkRayTracingShaderGroupCreateInfoNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkRayTracingShaderGroupCreateInfoNV calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ntype

public static int ntype(long struct)

Unsafe version of type().

ngeneralShader

public static int ngeneralShader(long struct)

Unsafe version of generalShader().

nclosestHitShader

public static int nclosestHitShader(long struct)

Unsafe version of closestHitShader().

nanyHitShader

public static int nanyHitShader(long struct)

Unsafe version of anyHitShader().

nintersectionShader

public static int nintersectionShader(long struct)

Unsafe version of intersectionShader().

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.

ntype

public static void ntype(long struct,
 int value)

Unsafe version of type.

ngeneralShader

public static void ngeneralShader(long struct,
 int value)

Unsafe version of generalShader.

nclosestHitShader

public static void nclosestHitShader(long struct,
 int value)

Unsafe version of closestHitShader.

nanyHitShader

public static void nanyHitShader(long struct,
 int value)

Unsafe version of anyHitShader.

nintersectionShader

public static void nintersectionShader(long struct,
 int value)

Unsafe version of intersectionShader.