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.NativeResource
Structure specifying parameters of a newly created ray tracing pipeline.Description
The parameters
basePipelineHandle
andbasePipelineIndex
are described in more detail in Pipeline Derivatives.Valid Usage
- If
flags
contains thePIPELINE_CREATE_DERIVATIVE_BIT
flag, andbasePipelineIndex
is-1
,basePipelineHandle
must be a valid handle to a ray tracingVkPipeline
- If
flags
contains thePIPELINE_CREATE_DERIVATIVE_BIT
flag, andbasePipelineHandle
isNULL_HANDLE
,basePipelineIndex
must be a valid index into the calling command’spCreateInfos
parameter - If
flags
contains thePIPELINE_CREATE_DERIVATIVE_BIT
flag, andbasePipelineIndex
is not-1
,basePipelineHandle
must beNULL_HANDLE
- If
flags
contains thePIPELINE_CREATE_DERIVATIVE_BIT
flag, andbasePipelineHandle
is notNULL_HANDLE
,basePipelineIndex
must be-1
- The
stage
member of one element ofpStages
must 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 layout
must be consistent with all shaders specified inpStages
- The number of resources in
layout
accessible to each shader stage that is used by the pipeline must be less than or equal toVkPhysicalDeviceLimits
::maxPerStageResources
maxRecursionDepth
must be less than or equal toVkPhysicalDeviceRayTracingPropertiesNV
::maxRecursionDepth
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_RAY_TRACING_PIPELINE_CREATE_INFO_NV
pNext
must beNULL
or a pointer to a valid instance ofVkPipelineCreationFeedbackCreateInfoEXT
flags
must be a valid combination ofVkPipelineCreateFlagBits
valuespStages
must be a valid pointer to an array ofstageCount
validVkPipelineShaderStageCreateInfo
structurespGroups
must be a valid pointer to an array ofgroupCount
validVkRayTracingShaderGroupCreateInfoNV
structureslayout
must be a validVkPipelineLayout
handlestageCount
must be greater than 0groupCount
must be greater than 0- Both of
basePipelineHandle
, andlayout
that are valid handles must have been created, allocated, or retrieved from the sameVkDevice
See Also
VkPipelineShaderStageCreateInfo
,VkRayTracingShaderGroupCreateInfoNV
,CreateRayTracingPipelinesNV
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.flags
– a bitmask ofVkPipelineCreateFlagBits
specifying how the pipeline will be generated.stageCount
– the number of entries in thepStages
array.pStages
– an array of sizestageCount
structures of typeVkPipelineShaderStageCreateInfo
describing the set of the shader stages to be included in the ray tracing pipeline.groupCount
– the number of entries in thepGroups
array.pGroups
– an array of sizegroupCount
structures of typeVkRayTracingShaderGroupCreateInfoNV
describing 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 thepCreateInfos
parameter to use as a pipeline to derive from.
Layout
struct VkRayTracingPipelineCreateInfoNV { VkStructureType sType; void const * pNext; VkPipelineCreateFlags flags; uint32_t stageCount;
VkPipelineShaderStageCreateInfo
const * pStages; uint32_t groupCount;VkRayTracingShaderGroupCreateInfoNV
const * pGroups; uint32_t maxRecursionDepth; VkPipelineLayout layout; VkPipeline basePipelineHandle; int32_t basePipelineIndex; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkRayTracingPipelineCreateInfoNV.Buffer
An array ofVkRayTracingPipelineCreateInfoNV
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
BASEPIPELINEHANDLE
BASEPIPELINEINDEX
FLAGS
GROUPCOUNT
LAYOUT
MAXRECURSIONDEPTH
PGROUPS
PNEXT
PSTAGESThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STAGECOUNT
STYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkRayTracingPipelineCreateInfoNV(java.nio.ByteBuffer container)
Creates aVkRayTracingPipelineCreateInfoNV
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description long
basePipelineHandle()
Returns the value of thebasePipelineHandle
field.VkRayTracingPipelineCreateInfoNV
basePipelineHandle(long value)
Sets the specified value to thebasePipelineHandle
field.int
basePipelineIndex()
Returns the value of thebasePipelineIndex
field.VkRayTracingPipelineCreateInfoNV
basePipelineIndex(int value)
Sets the specified value to thebasePipelineIndex
field.static VkRayTracingPipelineCreateInfoNV
calloc()
Returns a newVkRayTracingPipelineCreateInfoNV
instance allocated withmemCalloc
.static VkRayTracingPipelineCreateInfoNV.Buffer
calloc(int capacity)
Returns a newVkRayTracingPipelineCreateInfoNV.Buffer
instance allocated withmemCalloc
.static VkRayTracingPipelineCreateInfoNV
callocStack()
Returns a newVkRayTracingPipelineCreateInfoNV
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkRayTracingPipelineCreateInfoNV.Buffer
callocStack(int capacity)
Returns a newVkRayTracingPipelineCreateInfoNV.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkRayTracingPipelineCreateInfoNV.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkRayTracingPipelineCreateInfoNV.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkRayTracingPipelineCreateInfoNV
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkRayTracingPipelineCreateInfoNV
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkRayTracingPipelineCreateInfoNV
create()
Returns a newVkRayTracingPipelineCreateInfoNV
instance allocated withBufferUtils
.static VkRayTracingPipelineCreateInfoNV.Buffer
create(int capacity)
Returns a newVkRayTracingPipelineCreateInfoNV.Buffer
instance allocated withBufferUtils
.static VkRayTracingPipelineCreateInfoNV
create(long address)
Returns a newVkRayTracingPipelineCreateInfoNV
instance for the specified memory address.static VkRayTracingPipelineCreateInfoNV.Buffer
create(long address, int capacity)
Create aVkRayTracingPipelineCreateInfoNV.Buffer
instance at the specified memory.static VkRayTracingPipelineCreateInfoNV
createSafe(long address)
static VkRayTracingPipelineCreateInfoNV.Buffer
createSafe(long address, int capacity)
int
flags()
Returns the value of theflags
field.VkRayTracingPipelineCreateInfoNV
flags(int value)
Sets the specified value to theflags
field.int
groupCount()
Returns the value of thegroupCount
field.long
layout()
Returns the value of thelayout
field.VkRayTracingPipelineCreateInfoNV
layout(long value)
Sets the specified value to thelayout
field.static VkRayTracingPipelineCreateInfoNV
malloc()
Returns a newVkRayTracingPipelineCreateInfoNV
instance allocated withmemAlloc
.static VkRayTracingPipelineCreateInfoNV.Buffer
malloc(int capacity)
Returns a newVkRayTracingPipelineCreateInfoNV.Buffer
instance allocated withmemAlloc
.static VkRayTracingPipelineCreateInfoNV
mallocStack()
Returns a newVkRayTracingPipelineCreateInfoNV
instance allocated on the thread-localMemoryStack
.static VkRayTracingPipelineCreateInfoNV.Buffer
mallocStack(int capacity)
Returns a newVkRayTracingPipelineCreateInfoNV.Buffer
instance allocated on the thread-localMemoryStack
.static VkRayTracingPipelineCreateInfoNV.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkRayTracingPipelineCreateInfoNV.Buffer
instance allocated on the specifiedMemoryStack
.static VkRayTracingPipelineCreateInfoNV
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkRayTracingPipelineCreateInfoNV
instance allocated on the specifiedMemoryStack
.int
maxRecursionDepth()
Returns the value of themaxRecursionDepth
field.VkRayTracingPipelineCreateInfoNV
maxRecursionDepth(int value)
Sets the specified value to themaxRecursionDepth
field.static long
nbasePipelineHandle(long struct)
Unsafe version ofbasePipelineHandle()
.static void
nbasePipelineHandle(long struct, long value)
Unsafe version ofbasePipelineHandle
.static int
nbasePipelineIndex(long struct)
Unsafe version ofbasePipelineIndex()
.static void
nbasePipelineIndex(long struct, int value)
Unsafe version ofbasePipelineIndex
.static int
nflags(long struct)
Unsafe version offlags()
.static void
nflags(long struct, int value)
Unsafe version offlags
.static int
ngroupCount(long struct)
Unsafe version ofgroupCount()
.static void
ngroupCount(long struct, int value)
Sets the specified value to thegroupCount
field of the specifiedstruct
.static long
nlayout(long struct)
Unsafe version oflayout()
.static void
nlayout(long struct, long value)
Unsafe version oflayout
.static int
nmaxRecursionDepth(long struct)
Unsafe version ofmaxRecursionDepth()
.static void
nmaxRecursionDepth(long struct, int value)
Unsafe version ofmaxRecursionDepth
.static VkRayTracingShaderGroupCreateInfoNV.Buffer
npGroups(long struct)
Unsafe version ofpGroups()
.static void
npGroups(long struct, VkRayTracingShaderGroupCreateInfoNV.Buffer value)
Unsafe version ofpGroups
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static VkPipelineShaderStageCreateInfo.Buffer
npStages(long struct)
Unsafe version ofpStages()
.static void
npStages(long struct, VkPipelineShaderStageCreateInfo.Buffer value)
Unsafe version ofpStages
.static int
nstageCount(long struct)
Unsafe version ofstageCount()
.static void
nstageCount(long struct, int value)
Sets the specified value to thestageCount
field of the specifiedstruct
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.VkRayTracingShaderGroupCreateInfoNV.Buffer
pGroups()
Returns aVkRayTracingShaderGroupCreateInfoNV.Buffer
view of the struct array pointed to by thepGroups
field.VkRayTracingPipelineCreateInfoNV
pGroups(VkRayTracingShaderGroupCreateInfoNV.Buffer value)
Sets the address of the specifiedVkRayTracingShaderGroupCreateInfoNV.Buffer
to thepGroups
field.long
pNext()
Returns the value of thepNext
field.VkRayTracingPipelineCreateInfoNV
pNext(long value)
Sets the specified value to thepNext
field.VkPipelineShaderStageCreateInfo.Buffer
pStages()
Returns aVkPipelineShaderStageCreateInfo.Buffer
view of the struct array pointed to by thepStages
field.VkRayTracingPipelineCreateInfoNV
pStages(VkPipelineShaderStageCreateInfo.Buffer value)
Sets the address of the specifiedVkPipelineShaderStageCreateInfo.Buffer
to thepStages
field.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.VkRayTracingPipelineCreateInfoNV
set(VkRayTracingPipelineCreateInfoNV src)
Copies the specified struct data to this struct.int
sizeof()
int
stageCount()
Returns the value of thestageCount
field.int
sType()
Returns the value of thesType
field.VkRayTracingPipelineCreateInfoNV
sType(int value)
Sets the specified value to thesType
field.static void
validate(long struct)
Validates pointer members that should not beNULL
.static void
validate(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 aVkRayTracingPipelineCreateInfoNV
instance at the current position of the specifiedByteBuffer
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
flags
public int flags()
Returns the value of theflags
field.
-
stageCount
public int stageCount()
Returns the value of thestageCount
field.
-
pStages
public VkPipelineShaderStageCreateInfo.Buffer pStages()
Returns aVkPipelineShaderStageCreateInfo.Buffer
view of the struct array pointed to by thepStages
field.
-
groupCount
public int groupCount()
Returns the value of thegroupCount
field.
-
pGroups
public VkRayTracingShaderGroupCreateInfoNV.Buffer pGroups()
Returns aVkRayTracingShaderGroupCreateInfoNV.Buffer
view of the struct array pointed to by thepGroups
field.
-
maxRecursionDepth
public int maxRecursionDepth()
Returns the value of themaxRecursionDepth
field.
-
layout
public long layout()
Returns the value of thelayout
field.
-
basePipelineHandle
public long basePipelineHandle()
Returns the value of thebasePipelineHandle
field.
-
basePipelineIndex
public int basePipelineIndex()
Returns the value of thebasePipelineIndex
field.
-
sType
public VkRayTracingPipelineCreateInfoNV sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkRayTracingPipelineCreateInfoNV pNext(long value)
Sets the specified value to thepNext
field.
-
flags
public VkRayTracingPipelineCreateInfoNV flags(int value)
Sets the specified value to theflags
field.
-
pStages
public VkRayTracingPipelineCreateInfoNV pStages(VkPipelineShaderStageCreateInfo.Buffer value)
Sets the address of the specifiedVkPipelineShaderStageCreateInfo.Buffer
to thepStages
field.
-
pGroups
public VkRayTracingPipelineCreateInfoNV pGroups(VkRayTracingShaderGroupCreateInfoNV.Buffer value)
Sets the address of the specifiedVkRayTracingShaderGroupCreateInfoNV.Buffer
to thepGroups
field.
-
maxRecursionDepth
public VkRayTracingPipelineCreateInfoNV maxRecursionDepth(int value)
Sets the specified value to themaxRecursionDepth
field.
-
layout
public VkRayTracingPipelineCreateInfoNV layout(long value)
Sets the specified value to thelayout
field.
-
basePipelineHandle
public VkRayTracingPipelineCreateInfoNV basePipelineHandle(long value)
Sets the specified value to thebasePipelineHandle
field.
-
basePipelineIndex
public VkRayTracingPipelineCreateInfoNV basePipelineIndex(int value)
Sets the specified value to thebasePipelineIndex
field.
-
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 newVkRayTracingPipelineCreateInfoNV
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkRayTracingPipelineCreateInfoNV calloc()
Returns a newVkRayTracingPipelineCreateInfoNV
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkRayTracingPipelineCreateInfoNV create()
Returns a newVkRayTracingPipelineCreateInfoNV
instance allocated withBufferUtils
.
-
create
public static VkRayTracingPipelineCreateInfoNV create(long address)
Returns a newVkRayTracingPipelineCreateInfoNV
instance for the specified memory address.
-
createSafe
@Nullable public static VkRayTracingPipelineCreateInfoNV createSafe(long address)
-
malloc
public static VkRayTracingPipelineCreateInfoNV.Buffer malloc(int capacity)
Returns a newVkRayTracingPipelineCreateInfoNV.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkRayTracingPipelineCreateInfoNV.Buffer calloc(int capacity)
Returns a newVkRayTracingPipelineCreateInfoNV.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkRayTracingPipelineCreateInfoNV.Buffer create(int capacity)
Returns a newVkRayTracingPipelineCreateInfoNV.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkRayTracingPipelineCreateInfoNV.Buffer create(long address, int capacity)
Create aVkRayTracingPipelineCreateInfoNV.Buffer
instance 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 newVkRayTracingPipelineCreateInfoNV
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkRayTracingPipelineCreateInfoNV callocStack()
Returns a newVkRayTracingPipelineCreateInfoNV
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkRayTracingPipelineCreateInfoNV mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkRayTracingPipelineCreateInfoNV
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkRayTracingPipelineCreateInfoNV callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkRayTracingPipelineCreateInfoNV
instance allocated on the specifiedMemoryStack
and 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.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkRayTracingPipelineCreateInfoNV.Buffer callocStack(int capacity)
Returns a newVkRayTracingPipelineCreateInfoNV.Buffer
instance allocated on the thread-localMemoryStack
and 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.Buffer
instance 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.Buffer
instance allocated on the specifiedMemoryStack
and 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 thestageCount
field 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 thegroupCount
field 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
-
-