Package org.lwjgl.vulkan
Class VkRayTracingShaderGroupCreateInfoKHR
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkRayTracingShaderGroupCreateInfoKHR>
org.lwjgl.vulkan.VkRayTracingShaderGroupCreateInfoKHR
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkRayTracingShaderGroupCreateInfoKHR
extends org.lwjgl.system.Struct<VkRayTracingShaderGroupCreateInfoKHR>
implements org.lwjgl.system.NativeResource
Structure specifying shaders in a shader group.
Description
If the pipeline is created with PIPELINE_CREATE_LIBRARY_BIT_KHR and the pipelineLibraryGroupHandles feature is enabled, pShaderGroupCaptureReplayHandle is inherited by all pipelines which link against this pipeline and remains bitwise identical for any pipeline which references this pipeline library.
Valid Usage
- If
typeisRAY_TRACING_SHADER_GROUP_TYPE_GENERAL_KHRthengeneralShadermust be a valid index intoVkRayTracingPipelineCreateInfoKHR::pStagesreferring to a shader ofSHADER_STAGE_RAYGEN_BIT_KHR,SHADER_STAGE_MISS_BIT_KHR, orSHADER_STAGE_CALLABLE_BIT_KHR - If
typeisRAY_TRACING_SHADER_GROUP_TYPE_GENERAL_KHRthenclosestHitShader,anyHitShader, andintersectionShadermust beSHADER_UNUSED_KHR - If
typeisRAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_KHRthenintersectionShadermust be a valid index intoVkRayTracingPipelineCreateInfoKHR::pStagesreferring to a shader ofSHADER_STAGE_INTERSECTION_BIT_KHR - If
typeisRAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_KHRthenintersectionShadermust beSHADER_UNUSED_KHR closestHitShadermust be eitherSHADER_UNUSED_KHRor a valid index intoVkRayTracingPipelineCreateInfoKHR::pStagesreferring to a shader ofSHADER_STAGE_CLOSEST_HIT_BIT_KHRanyHitShadermust be eitherSHADER_UNUSED_KHRor a valid index intoVkRayTracingPipelineCreateInfoKHR::pStagesreferring to a shader ofSHADER_STAGE_ANY_HIT_BIT_KHR- If
VkPhysicalDeviceRayTracingPipelineFeaturesKHR::rayTracingPipelineShaderGroupHandleCaptureReplayMixedisFALSEthenpShaderGroupCaptureReplayHandlemust not be provided if it has not been provided on a previous call to ray tracing pipeline creation - If
VkPhysicalDeviceRayTracingPipelineFeaturesKHR::rayTracingPipelineShaderGroupHandleCaptureReplayMixedisFALSEthen the caller must guarantee that no ray tracing pipeline creation commands withpShaderGroupCaptureReplayHandleprovided execute simultaneously with ray tracing pipeline creation commands withoutpShaderGroupCaptureReplayHandleprovided
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_RAY_TRACING_SHADER_GROUP_CREATE_INFO_KHRpNextmust beNULLtypemust be a validVkRayTracingShaderGroupTypeKHRvalue
See Also
VkRayTracingPipelineCreateInfoKHR
Layout
struct VkRayTracingShaderGroupCreateInfoKHR {
VkStructureType sType();
void const * pNext();
VkRayTracingShaderGroupTypeKHR type();
uint32_t generalShader();
uint32_t closestHitShader();
uint32_t anyHitShader();
uint32_t intersectionShader();
void const * pShaderGroupCaptureReplayHandle();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkRayTracingShaderGroupCreateInfoKHRstructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkRayTracingShaderGroupCreateInfoKHR(ByteBuffer container) Creates aVkRayTracingShaderGroupCreateInfoKHRinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionintthe optional index of the any-hit shader fromVkRayTracingPipelineCreateInfoKHR::pStagesin the group if the shader group hastypeofRAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_KHRorRAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_KHR, andSHADER_UNUSED_KHRotherwise.anyHitShader(int value) Sets the specified value to theanyHitShader()field.calloc()Returns a newVkRayTracingShaderGroupCreateInfoKHRinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkRayTracingShaderGroupCreateInfoKHR.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkRayTracingShaderGroupCreateInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkRayTracingShaderGroupCreateInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.intthe optional index of the closest hit shader fromVkRayTracingPipelineCreateInfoKHR::pStagesin the group if the shader group hastypeofRAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_KHRorRAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_KHR, andSHADER_UNUSED_KHRotherwise.closestHitShader(int value) Sets the specified value to theclosestHitShader()field.create()Returns a newVkRayTracingShaderGroupCreateInfoKHRinstance allocated withBufferUtils.create(int capacity) Returns a newVkRayTracingShaderGroupCreateInfoKHR.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkRayTracingShaderGroupCreateInfoKHRinstance for the specified memory address.create(long address, int capacity) Create aVkRayTracingShaderGroupCreateInfoKHR.Bufferinstance at the specified memory.static @Nullable VkRayTracingShaderGroupCreateInfoKHRcreateSafe(long address) static @Nullable VkRayTracingShaderGroupCreateInfoKHR.BuffercreateSafe(long address, int capacity) intthe index of the ray generation, miss, or callable shader fromVkRayTracingPipelineCreateInfoKHR::pStagesin the group if the shader group hastypeofRAY_TRACING_SHADER_GROUP_TYPE_GENERAL_KHR, andSHADER_UNUSED_KHRotherwise.generalShader(int value) Sets the specified value to thegeneralShader()field.intthe index of the intersection shader fromVkRayTracingPipelineCreateInfoKHR::pStagesin the group if the shader group hastypeofRAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_KHR, andSHADER_UNUSED_KHRotherwise.intersectionShader(int value) Sets the specified value to theintersectionShader()field.malloc()Returns a newVkRayTracingShaderGroupCreateInfoKHRinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkRayTracingShaderGroupCreateInfoKHR.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkRayTracingShaderGroupCreateInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkRayTracingShaderGroupCreateInfoKHRinstance allocated on the specifiedMemoryStack.static intnanyHitShader(long struct) Unsafe version ofanyHitShader().static voidnanyHitShader(long struct, int value) Unsafe version ofanyHitShader.static intnclosestHitShader(long struct) Unsafe version ofclosestHitShader().static voidnclosestHitShader(long struct, int value) Unsafe version ofclosestHitShader.static intngeneralShader(long struct) Unsafe version ofgeneralShader().static voidngeneralShader(long struct, int value) Unsafe version ofgeneralShader.static intnintersectionShader(long struct) Unsafe version ofintersectionShader().static voidnintersectionShader(long struct, int value) Unsafe version ofintersectionShader.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static longnpShaderGroupCaptureReplayHandle(long struct) Unsafe version ofpShaderGroupCaptureReplayHandle().static voidnpShaderGroupCaptureReplayHandle(long struct, long value) Unsafe version ofpShaderGroupCaptureReplayHandle.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.static intntype(long struct) Unsafe version oftype().static voidntype(long struct, int value) Unsafe version oftype.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.longNULLor a pointer to replay information for this shader group queried fromGetRayTracingCaptureReplayShaderGroupHandlesKHR, as described in Ray Tracing Capture Replay.pShaderGroupCaptureReplayHandle(long value) Sets the specified value to thepShaderGroupCaptureReplayHandle()field.set(int sType, long pNext, int type, int generalShader, int closestHitShader, int anyHitShader, int intersectionShader, long pShaderGroupCaptureReplayHandle) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_RAY_TRACING_SHADER_GROUP_CREATE_INFO_KHRvalue to thesType()field.inttype()the type of hit group specified in this structure.type(int value) Sets the specified value to thetype()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
TYPE
public static final int TYPEThe struct member offsets. -
GENERALSHADER
public static final int GENERALSHADERThe struct member offsets. -
CLOSESTHITSHADER
public static final int CLOSESTHITSHADERThe struct member offsets. -
ANYHITSHADER
public static final int ANYHITSHADERThe struct member offsets. -
INTERSECTIONSHADER
public static final int INTERSECTIONSHADERThe struct member offsets. -
PSHADERGROUPCAPTUREREPLAYHANDLE
public static final int PSHADERGROUPCAPTUREREPLAYHANDLEThe struct member offsets.
-
-
Constructor Details
-
VkRayTracingShaderGroupCreateInfoKHR
Creates aVkRayTracingShaderGroupCreateInfoKHRinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct<VkRayTracingShaderGroupCreateInfoKHR>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor 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 fromVkRayTracingPipelineCreateInfoKHR::pStagesin the group if the shader group hastypeofRAY_TRACING_SHADER_GROUP_TYPE_GENERAL_KHR, andSHADER_UNUSED_KHRotherwise. -
closestHitShader
public int closestHitShader()the optional index of the closest hit shader fromVkRayTracingPipelineCreateInfoKHR::pStagesin the group if the shader group hastypeofRAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_KHRorRAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_KHR, andSHADER_UNUSED_KHRotherwise. -
anyHitShader
public int anyHitShader()the optional index of the any-hit shader fromVkRayTracingPipelineCreateInfoKHR::pStagesin the group if the shader group hastypeofRAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_KHRorRAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_KHR, andSHADER_UNUSED_KHRotherwise. -
intersectionShader
public int intersectionShader()the index of the intersection shader fromVkRayTracingPipelineCreateInfoKHR::pStagesin the group if the shader group hastypeofRAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_KHR, andSHADER_UNUSED_KHRotherwise. -
pShaderGroupCaptureReplayHandle
public long pShaderGroupCaptureReplayHandle()NULLor a pointer to replay information for this shader group queried fromGetRayTracingCaptureReplayShaderGroupHandlesKHR, as described in Ray Tracing Capture Replay. Ignored ifVkPhysicalDeviceRayTracingPipelineFeaturesKHR::rayTracingPipelineShaderGroupHandleCaptureReplayisFALSE. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_RAY_TRACING_SHADER_GROUP_CREATE_INFO_KHRvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
type
Sets the specified value to thetype()field. -
generalShader
Sets the specified value to thegeneralShader()field. -
closestHitShader
Sets the specified value to theclosestHitShader()field. -
anyHitShader
Sets the specified value to theanyHitShader()field. -
intersectionShader
Sets the specified value to theintersectionShader()field. -
pShaderGroupCaptureReplayHandle
Sets the specified value to thepShaderGroupCaptureReplayHandle()field. -
set
public VkRayTracingShaderGroupCreateInfoKHR set(int sType, long pNext, int type, int generalShader, int closestHitShader, int anyHitShader, int intersectionShader, long pShaderGroupCaptureReplayHandle) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkRayTracingShaderGroupCreateInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkRayTracingShaderGroupCreateInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkRayTracingShaderGroupCreateInfoKHRinstance allocated withBufferUtils. -
create
Returns a newVkRayTracingShaderGroupCreateInfoKHRinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkRayTracingShaderGroupCreateInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkRayTracingShaderGroupCreateInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkRayTracingShaderGroupCreateInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkRayTracingShaderGroupCreateInfoKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkRayTracingShaderGroupCreateInfoKHR.Buffer createSafe(long address, int capacity) -
malloc
Returns a newVkRayTracingShaderGroupCreateInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkRayTracingShaderGroupCreateInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkRayTracingShaderGroupCreateInfoKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkRayTracingShaderGroupCreateInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkRayTracingShaderGroupCreateInfoKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkRayTracingShaderGroupCreateInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
ntype
public static int ntype(long struct) Unsafe version oftype(). -
ngeneralShader
public static int ngeneralShader(long struct) Unsafe version ofgeneralShader(). -
nclosestHitShader
public static int nclosestHitShader(long struct) Unsafe version ofclosestHitShader(). -
nanyHitShader
public static int nanyHitShader(long struct) Unsafe version ofanyHitShader(). -
nintersectionShader
public static int nintersectionShader(long struct) Unsafe version ofintersectionShader(). -
npShaderGroupCaptureReplayHandle
public static long npShaderGroupCaptureReplayHandle(long struct) Unsafe version ofpShaderGroupCaptureReplayHandle(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
ntype
public static void ntype(long struct, int value) Unsafe version oftype. -
ngeneralShader
public static void ngeneralShader(long struct, int value) Unsafe version ofgeneralShader. -
nclosestHitShader
public static void nclosestHitShader(long struct, int value) Unsafe version ofclosestHitShader. -
nanyHitShader
public static void nanyHitShader(long struct, int value) Unsafe version ofanyHitShader. -
nintersectionShader
public static void nintersectionShader(long struct, int value) Unsafe version ofintersectionShader. -
npShaderGroupCaptureReplayHandle
public static void npShaderGroupCaptureReplayHandle(long struct, long value) Unsafe version ofpShaderGroupCaptureReplayHandle.
-