Package org.lwjgl.vulkan
Class VkRayTracingPipelineCreateInfoNV
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkRayTracingPipelineCreateInfoNV
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkRayTracingPipelineCreateInfoNV extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying parameters of a newly created ray tracing pipeline.Description
The parameters
basePipelineHandleandbasePipelineIndexare described in more detail in Pipeline Derivatives.Valid Usage
- If
flagscontains thePIPELINE_CREATE_DERIVATIVE_BITflag, andbasePipelineIndexis-1,basePipelineHandlemust be a valid handle to a ray tracingVkPipeline - If
flagscontains thePIPELINE_CREATE_DERIVATIVE_BITflag, andbasePipelineHandleisNULL_HANDLE,basePipelineIndexmust be a valid index into the calling command’spCreateInfosparameter - If
flagscontains thePIPELINE_CREATE_DERIVATIVE_BITflag, andbasePipelineIndexis not-1,basePipelineHandlemust beNULL_HANDLE - If
flagscontains thePIPELINE_CREATE_DERIVATIVE_BITflag, andbasePipelineHandleis notNULL_HANDLE,basePipelineIndexmust be-1 - The
stagemember of one element ofpStagesmust beSHADER_STAGE_RAYGEN_BIT_NV - The shader code for the entry points identified by
pStages, and the rest of the state identified by this structure must adhere to the pipeline linking rules described in the Shader Interfaces chapter layoutmust be consistent with all shaders specified inpStages- The number of resources in
layoutaccessible to each shader stage that is used by the pipeline must be less than or equal toVkPhysicalDeviceLimits::maxPerStageResources maxRecursionDepthmust be less than or equal toVkPhysicalDeviceRayTracingPropertiesNV::maxRecursionDepth
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_RAY_TRACING_PIPELINE_CREATE_INFO_NVpNextmust beNULLor a pointer to a valid instance ofVkPipelineCreationFeedbackCreateInfoEXTflagsmust be a valid combination ofVkPipelineCreateFlagBitsvaluespStagesmust be a valid pointer to an array ofstageCountvalidVkPipelineShaderStageCreateInfostructurespGroupsmust be a valid pointer to an array ofgroupCountvalidVkRayTracingShaderGroupCreateInfoNVstructureslayoutmust be a validVkPipelineLayouthandlestageCountmust be greater than 0groupCountmust be greater than 0- Both of
basePipelineHandle, andlayoutthat are valid handles must have been created, allocated, or retrieved from the sameVkDevice
See Also
VkPipelineShaderStageCreateInfo,VkRayTracingShaderGroupCreateInfoNV,CreateRayTracingPipelinesNVMember documentation
sType– the type of this structure.pNext–NULLor a pointer to an extension-specific structure.flags– a bitmask ofVkPipelineCreateFlagBitsspecifying how the pipeline will be generated.stageCount– the number of entries in thepStagesarray.pStages– an array of sizestageCountstructures of typeVkPipelineShaderStageCreateInfodescribing the set of the shader stages to be included in the ray tracing pipeline.groupCount– the number of entries in thepGroupsarray.pGroups– an array of sizegroupCountstructures of typeVkRayTracingShaderGroupCreateInfoNVdescribing the set of the shader stages to be included in each shader group in the ray tracing pipeline.maxRecursionDepth– the maximum recursion that will be called from this pipeline.layout– the description of binding locations used by both the pipeline and descriptor sets used with the pipeline.basePipelineHandle– a pipeline to derive from.basePipelineIndex– an index into thepCreateInfosparameter to use as a pipeline to derive from.
Layout
struct VkRayTracingPipelineCreateInfoNV { VkStructureType sType; void const * pNext; VkPipelineCreateFlags flags; uint32_t stageCount;VkPipelineShaderStageCreateInfoconst * pStages; uint32_t groupCount;VkRayTracingShaderGroupCreateInfoNVconst * pGroups; uint32_t maxRecursionDepth; VkPipelineLayout layout; VkPipeline basePipelineHandle; int32_t basePipelineIndex; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkRayTracingPipelineCreateInfoNV.BufferAn array ofVkRayTracingPipelineCreateInfoNVstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intBASEPIPELINEHANDLE
BASEPIPELINEINDEX
FLAGS
GROUPCOUNT
LAYOUT
MAXRECURSIONDEPTH
PGROUPS
PNEXT
PSTAGESThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTAGECOUNT
STYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkRayTracingPipelineCreateInfoNV(java.nio.ByteBuffer container)Creates aVkRayTracingPipelineCreateInfoNVinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description longbasePipelineHandle()Returns the value of thebasePipelineHandlefield.VkRayTracingPipelineCreateInfoNVbasePipelineHandle(long value)Sets the specified value to thebasePipelineHandlefield.intbasePipelineIndex()Returns the value of thebasePipelineIndexfield.VkRayTracingPipelineCreateInfoNVbasePipelineIndex(int value)Sets the specified value to thebasePipelineIndexfield.static VkRayTracingPipelineCreateInfoNVcalloc()Returns a newVkRayTracingPipelineCreateInfoNVinstance allocated withmemCalloc.static VkRayTracingPipelineCreateInfoNV.Buffercalloc(int capacity)Returns a newVkRayTracingPipelineCreateInfoNV.Bufferinstance allocated withmemCalloc.static VkRayTracingPipelineCreateInfoNVcallocStack()Returns a newVkRayTracingPipelineCreateInfoNVinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkRayTracingPipelineCreateInfoNV.BuffercallocStack(int capacity)Returns a newVkRayTracingPipelineCreateInfoNV.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkRayTracingPipelineCreateInfoNV.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkRayTracingPipelineCreateInfoNV.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkRayTracingPipelineCreateInfoNVcallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkRayTracingPipelineCreateInfoNVinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkRayTracingPipelineCreateInfoNVcreate()Returns a newVkRayTracingPipelineCreateInfoNVinstance allocated withBufferUtils.static VkRayTracingPipelineCreateInfoNV.Buffercreate(int capacity)Returns a newVkRayTracingPipelineCreateInfoNV.Bufferinstance allocated withBufferUtils.static VkRayTracingPipelineCreateInfoNVcreate(long address)Returns a newVkRayTracingPipelineCreateInfoNVinstance for the specified memory address.static VkRayTracingPipelineCreateInfoNV.Buffercreate(long address, int capacity)Create aVkRayTracingPipelineCreateInfoNV.Bufferinstance at the specified memory.static VkRayTracingPipelineCreateInfoNVcreateSafe(long address)static VkRayTracingPipelineCreateInfoNV.BuffercreateSafe(long address, int capacity)intflags()Returns the value of theflagsfield.VkRayTracingPipelineCreateInfoNVflags(int value)Sets the specified value to theflagsfield.intgroupCount()Returns the value of thegroupCountfield.longlayout()Returns the value of thelayoutfield.VkRayTracingPipelineCreateInfoNVlayout(long value)Sets the specified value to thelayoutfield.static VkRayTracingPipelineCreateInfoNVmalloc()Returns a newVkRayTracingPipelineCreateInfoNVinstance allocated withmemAlloc.static VkRayTracingPipelineCreateInfoNV.Buffermalloc(int capacity)Returns a newVkRayTracingPipelineCreateInfoNV.Bufferinstance allocated withmemAlloc.static VkRayTracingPipelineCreateInfoNVmallocStack()Returns a newVkRayTracingPipelineCreateInfoNVinstance allocated on the thread-localMemoryStack.static VkRayTracingPipelineCreateInfoNV.BuffermallocStack(int capacity)Returns a newVkRayTracingPipelineCreateInfoNV.Bufferinstance allocated on the thread-localMemoryStack.static VkRayTracingPipelineCreateInfoNV.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkRayTracingPipelineCreateInfoNV.Bufferinstance allocated on the specifiedMemoryStack.static VkRayTracingPipelineCreateInfoNVmallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkRayTracingPipelineCreateInfoNVinstance allocated on the specifiedMemoryStack.intmaxRecursionDepth()Returns the value of themaxRecursionDepthfield.VkRayTracingPipelineCreateInfoNVmaxRecursionDepth(int value)Sets the specified value to themaxRecursionDepthfield.static longnbasePipelineHandle(long struct)Unsafe version ofbasePipelineHandle().static voidnbasePipelineHandle(long struct, long value)Unsafe version ofbasePipelineHandle.static intnbasePipelineIndex(long struct)Unsafe version ofbasePipelineIndex().static voidnbasePipelineIndex(long struct, int value)Unsafe version ofbasePipelineIndex.static intnflags(long struct)Unsafe version offlags().static voidnflags(long struct, int value)Unsafe version offlags.static intngroupCount(long struct)Unsafe version ofgroupCount().static voidngroupCount(long struct, int value)Sets the specified value to thegroupCountfield of the specifiedstruct.static longnlayout(long struct)Unsafe version oflayout().static voidnlayout(long struct, long value)Unsafe version oflayout.static intnmaxRecursionDepth(long struct)Unsafe version ofmaxRecursionDepth().static voidnmaxRecursionDepth(long struct, int value)Unsafe version ofmaxRecursionDepth.static VkRayTracingShaderGroupCreateInfoNV.BuffernpGroups(long struct)Unsafe version ofpGroups().static voidnpGroups(long struct, VkRayTracingShaderGroupCreateInfoNV.Buffer value)Unsafe version ofpGroups.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static VkPipelineShaderStageCreateInfo.BuffernpStages(long struct)Unsafe version ofpStages().static voidnpStages(long struct, VkPipelineShaderStageCreateInfo.Buffer value)Unsafe version ofpStages.static intnstageCount(long struct)Unsafe version ofstageCount().static voidnstageCount(long struct, int value)Sets the specified value to thestageCountfield of the specifiedstruct.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.VkRayTracingShaderGroupCreateInfoNV.BufferpGroups()Returns aVkRayTracingShaderGroupCreateInfoNV.Bufferview of the struct array pointed to by thepGroupsfield.VkRayTracingPipelineCreateInfoNVpGroups(VkRayTracingShaderGroupCreateInfoNV.Buffer value)Sets the address of the specifiedVkRayTracingShaderGroupCreateInfoNV.Bufferto thepGroupsfield.longpNext()Returns the value of thepNextfield.VkRayTracingPipelineCreateInfoNVpNext(long value)Sets the specified value to thepNextfield.VkPipelineShaderStageCreateInfo.BufferpStages()Returns aVkPipelineShaderStageCreateInfo.Bufferview of the struct array pointed to by thepStagesfield.VkRayTracingPipelineCreateInfoNVpStages(VkPipelineShaderStageCreateInfo.Buffer value)Sets the address of the specifiedVkPipelineShaderStageCreateInfo.Bufferto thepStagesfield.VkRayTracingPipelineCreateInfoNVset(int sType, long pNext, int flags, VkPipelineShaderStageCreateInfo.Buffer pStages, VkRayTracingShaderGroupCreateInfoNV.Buffer pGroups, int maxRecursionDepth, long layout, long basePipelineHandle, int basePipelineIndex)Initializes this struct with the specified values.VkRayTracingPipelineCreateInfoNVset(VkRayTracingPipelineCreateInfoNV src)Copies the specified struct data to this struct.intsizeof()intstageCount()Returns the value of thestageCountfield.intsType()Returns the value of thesTypefield.VkRayTracingPipelineCreateInfoNVsType(int value)Sets the specified value to thesTypefield.static voidvalidate(long struct)Validates pointer members that should not beNULL.static voidvalidate(long array, int count)Callsvalidate(long)for each struct contained in the specified struct array.
-
-
-
Constructor Detail
-
VkRayTracingPipelineCreateInfoNV
public VkRayTracingPipelineCreateInfoNV(java.nio.ByteBuffer container)
Creates aVkRayTracingPipelineCreateInfoNVinstance 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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
flags
public int flags()
Returns the value of theflagsfield.
-
stageCount
public int stageCount()
Returns the value of thestageCountfield.
-
pStages
public VkPipelineShaderStageCreateInfo.Buffer pStages()
Returns aVkPipelineShaderStageCreateInfo.Bufferview of the struct array pointed to by thepStagesfield.
-
groupCount
public int groupCount()
Returns the value of thegroupCountfield.
-
pGroups
public VkRayTracingShaderGroupCreateInfoNV.Buffer pGroups()
Returns aVkRayTracingShaderGroupCreateInfoNV.Bufferview of the struct array pointed to by thepGroupsfield.
-
maxRecursionDepth
public int maxRecursionDepth()
Returns the value of themaxRecursionDepthfield.
-
layout
public long layout()
Returns the value of thelayoutfield.
-
basePipelineHandle
public long basePipelineHandle()
Returns the value of thebasePipelineHandlefield.
-
basePipelineIndex
public int basePipelineIndex()
Returns the value of thebasePipelineIndexfield.
-
sType
public VkRayTracingPipelineCreateInfoNV sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkRayTracingPipelineCreateInfoNV pNext(long value)
Sets the specified value to thepNextfield.
-
flags
public VkRayTracingPipelineCreateInfoNV flags(int value)
Sets the specified value to theflagsfield.
-
pStages
public VkRayTracingPipelineCreateInfoNV pStages(VkPipelineShaderStageCreateInfo.Buffer value)
Sets the address of the specifiedVkPipelineShaderStageCreateInfo.Bufferto thepStagesfield.
-
pGroups
public VkRayTracingPipelineCreateInfoNV pGroups(VkRayTracingShaderGroupCreateInfoNV.Buffer value)
Sets the address of the specifiedVkRayTracingShaderGroupCreateInfoNV.Bufferto thepGroupsfield.
-
maxRecursionDepth
public VkRayTracingPipelineCreateInfoNV maxRecursionDepth(int value)
Sets the specified value to themaxRecursionDepthfield.
-
layout
public VkRayTracingPipelineCreateInfoNV layout(long value)
Sets the specified value to thelayoutfield.
-
basePipelineHandle
public VkRayTracingPipelineCreateInfoNV basePipelineHandle(long value)
Sets the specified value to thebasePipelineHandlefield.
-
basePipelineIndex
public VkRayTracingPipelineCreateInfoNV basePipelineIndex(int value)
Sets the specified value to thebasePipelineIndexfield.
-
set
public VkRayTracingPipelineCreateInfoNV set(int sType, long pNext, int flags, VkPipelineShaderStageCreateInfo.Buffer pStages, VkRayTracingShaderGroupCreateInfoNV.Buffer pGroups, int maxRecursionDepth, long layout, long basePipelineHandle, int basePipelineIndex)
Initializes this struct with the specified values.
-
set
public VkRayTracingPipelineCreateInfoNV set(VkRayTracingPipelineCreateInfoNV src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkRayTracingPipelineCreateInfoNV malloc()
Returns a newVkRayTracingPipelineCreateInfoNVinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkRayTracingPipelineCreateInfoNV calloc()
Returns a newVkRayTracingPipelineCreateInfoNVinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkRayTracingPipelineCreateInfoNV create()
Returns a newVkRayTracingPipelineCreateInfoNVinstance allocated withBufferUtils.
-
create
public static VkRayTracingPipelineCreateInfoNV create(long address)
Returns a newVkRayTracingPipelineCreateInfoNVinstance for the specified memory address.
-
createSafe
@Nullable public static VkRayTracingPipelineCreateInfoNV createSafe(long address)
-
malloc
public static VkRayTracingPipelineCreateInfoNV.Buffer malloc(int capacity)
Returns a newVkRayTracingPipelineCreateInfoNV.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkRayTracingPipelineCreateInfoNV.Buffer calloc(int capacity)
Returns a newVkRayTracingPipelineCreateInfoNV.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkRayTracingPipelineCreateInfoNV.Buffer create(int capacity)
Returns a newVkRayTracingPipelineCreateInfoNV.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkRayTracingPipelineCreateInfoNV.Buffer create(long address, int capacity)
Create aVkRayTracingPipelineCreateInfoNV.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkRayTracingPipelineCreateInfoNV.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkRayTracingPipelineCreateInfoNV mallocStack()
Returns a newVkRayTracingPipelineCreateInfoNVinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkRayTracingPipelineCreateInfoNV callocStack()
Returns a newVkRayTracingPipelineCreateInfoNVinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkRayTracingPipelineCreateInfoNV mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkRayTracingPipelineCreateInfoNVinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkRayTracingPipelineCreateInfoNV callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkRayTracingPipelineCreateInfoNVinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkRayTracingPipelineCreateInfoNV.Buffer mallocStack(int capacity)
Returns a newVkRayTracingPipelineCreateInfoNV.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkRayTracingPipelineCreateInfoNV.Buffer callocStack(int capacity)
Returns a newVkRayTracingPipelineCreateInfoNV.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkRayTracingPipelineCreateInfoNV.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkRayTracingPipelineCreateInfoNV.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkRayTracingPipelineCreateInfoNV.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkRayTracingPipelineCreateInfoNV.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType().
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext().
-
nflags
public static int nflags(long struct)
Unsafe version offlags().
-
nstageCount
public static int nstageCount(long struct)
Unsafe version ofstageCount().
-
npStages
public static VkPipelineShaderStageCreateInfo.Buffer npStages(long struct)
Unsafe version ofpStages().
-
ngroupCount
public static int ngroupCount(long struct)
Unsafe version ofgroupCount().
-
npGroups
public static VkRayTracingShaderGroupCreateInfoNV.Buffer npGroups(long struct)
Unsafe version ofpGroups().
-
nmaxRecursionDepth
public static int nmaxRecursionDepth(long struct)
Unsafe version ofmaxRecursionDepth().
-
nlayout
public static long nlayout(long struct)
Unsafe version oflayout().
-
nbasePipelineHandle
public static long nbasePipelineHandle(long struct)
Unsafe version ofbasePipelineHandle().
-
nbasePipelineIndex
public static int nbasePipelineIndex(long struct)
Unsafe version ofbasePipelineIndex().
-
nsType
public static void nsType(long struct, int value)Unsafe version ofsType.
-
npNext
public static void npNext(long struct, long value)Unsafe version ofpNext.
-
nflags
public static void nflags(long struct, int value)Unsafe version offlags.
-
nstageCount
public static void nstageCount(long struct, int value)Sets the specified value to thestageCountfield of the specifiedstruct.
-
npStages
public static void npStages(long struct, VkPipelineShaderStageCreateInfo.Buffer value)Unsafe version ofpStages.
-
ngroupCount
public static void ngroupCount(long struct, int value)Sets the specified value to thegroupCountfield of the specifiedstruct.
-
npGroups
public static void npGroups(long struct, VkRayTracingShaderGroupCreateInfoNV.Buffer value)Unsafe version ofpGroups.
-
nmaxRecursionDepth
public static void nmaxRecursionDepth(long struct, int value)Unsafe version ofmaxRecursionDepth.
-
nlayout
public static void nlayout(long struct, long value)Unsafe version oflayout.
-
nbasePipelineHandle
public static void nbasePipelineHandle(long struct, long value)Unsafe version ofbasePipelineHandle.
-
nbasePipelineIndex
public static void nbasePipelineIndex(long struct, int value)Unsafe version ofbasePipelineIndex.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
validate
public static void validate(long array, int count)Callsvalidate(long)for each struct contained in the specified struct array.- Parameters:
array- the struct array to validatecount- the number of structs inarray
-
-