Package org.lwjgl.vulkan
Class VkComputePipelineCreateInfo
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
public class VkComputePipelineCreateInfo
extends Struct<VkComputePipelineCreateInfo>
implements NativeResource
Structure specifying parameters of a newly created compute pipeline.
Description
The parameters basePipelineHandle
and basePipelineIndex
are described in more detail in Pipeline Derivatives.
If a VkPipelineCreateFlags2CreateInfoKHR
structure is present in the pNext
chain, VkPipelineCreateFlags2CreateInfoKHR
::flags
from that structure is used instead of flags
from this structure.
Valid Usage
- If
flags
contains thePIPELINE_CREATE_DERIVATIVE_BIT
flag, andbasePipelineIndex
is -1,basePipelineHandle
must be a valid computeVkPipeline
handle - 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,basePipelineIndex
must be -1 orbasePipelineHandle
must beNULL_HANDLE
- If a push constant block is declared in a shader, a push constant range in
layout
must match both the shader stage and range - If a resource variables is declared in a shader, a descriptor slot in
layout
must match the shader stage - If a resource variables is declared in a shader, and the descriptor type is not
DESCRIPTOR_TYPE_MUTABLE_EXT
, a descriptor slot inlayout
must match the descriptor type - If a resource variables is declared in a shader as an array, a descriptor slot in
layout
must match the descriptor count
flags
must not includePIPELINE_CREATE_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR
flags
must not includePIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR
flags
must not includePIPELINE_CREATE_RAY_TRACING_NO_NULL_MISS_SHADERS_BIT_KHR
flags
must not includePIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR
flags
must not includePIPELINE_CREATE_RAY_TRACING_SKIP_TRIANGLES_BIT_KHR
flags
must not includePIPELINE_CREATE_RAY_TRACING_SKIP_AABBS_BIT_KHR
flags
must not includePIPELINE_CREATE_RAY_TRACING_SHADER_GROUP_HANDLE_CAPTURE_REPLAY_BIT_KHR
flags
must not includePIPELINE_CREATE_RAY_TRACING_ALLOW_MOTION_BIT_NV
- If
flags
includesPIPELINE_CREATE_INDIRECT_BINDABLE_BIT_NV
, then theVkPhysicalDeviceDeviceGeneratedCommandsComputeFeaturesNV
::deviceGeneratedComputePipelines
feature must be enabled - If
flags
includesPIPELINE_CREATE_INDIRECT_BINDABLE_BIT_NV
, then thepNext
chain must include a pointer to a valid instance ofVkComputePipelineIndirectBufferInfoNV
specifying the address where the pipeline’s metadata will be saved - If the
pipelineCreationCacheControl
feature is not enabled,flags
must not includePIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT
orPIPELINE_CREATE_EARLY_RETURN_ON_FAILURE_BIT
- The
stage
member ofstage
must beSHADER_STAGE_COMPUTE_BIT
- The shader code for the entry point identified by
stage
and the rest of the state identified by this structure must adhere to the pipeline linking rules described in the Shader Interfaces chapter - The number of resources in
layout
accessible to the compute shader stage must be less than or equal toVkPhysicalDeviceLimits
::maxPerStageResources
- If
shaderEnqueue
is not enabled,flags
must not includePIPELINE_CREATE_LIBRARY_BIT_KHR
- If
flags
does not includePIPELINE_CREATE_LIBRARY_BIT_KHR
, the shader specified bystage
must not declare theShaderEnqueueAMDX
capability - If
VkPipelineCreationFeedbackCreateInfo
::pipelineStageCreationFeedbackCount
is not 0, it must be 1 flags
must not includePIPELINE_CREATE_RAY_TRACING_OPACITY_MICROMAP_BIT_EXT
flags
must not includePIPELINE_CREATE_RAY_TRACING_DISPLACEMENT_MICROMAP_BIT_NV
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_COMPUTE_PIPELINE_CREATE_INFO
- Each
pNext
member of any structure (including this one) in thepNext
chain must be eitherNULL
or a pointer to a valid instance ofVkPipelineCompilerControlCreateInfoAMD
,VkPipelineCreateFlags2CreateInfoKHR
,VkPipelineCreationFeedbackCreateInfo
,VkPipelineRobustnessCreateInfoEXT
, orVkSubpassShadingPipelineCreateInfoHUAWEI
- The
sType
value of each struct in thepNext
chain must be unique flags
must be a valid combination ofVkPipelineCreateFlagBits
valuesstage
must be a validVkPipelineShaderStageCreateInfo
structurelayout
must be a validVkPipelineLayout
handle- Both of
basePipelineHandle
, andlayout
that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the sameVkDevice
See Also
VkPipelineShaderStageCreateInfo
, CreateComputePipelines
, GetPipelineIndirectMemoryRequirementsNV
Layout
struct VkComputePipelineCreateInfo {
VkStructureType sType()
;
void const * pNext()
;
VkPipelineCreateFlags flags()
;
VkPipelineShaderStageCreateInfo
stage()
;
VkPipelineLayout layout()
;
VkPipeline basePipelineHandle()
;
int32_t basePipelineIndex()
;
}
-
Nested Class Summary
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
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionVkComputePipelineCreateInfo
(ByteBuffer container) Creates aVkComputePipelineCreateInfo
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionlong
a pipeline to derive from.basePipelineHandle
(long value) Sets the specified value to thebasePipelineHandle()
field.int
an index into thepCreateInfos
parameter to use as a pipeline to derive from.basePipelineIndex
(int value) Sets the specified value to thebasePipelineIndex()
field.static VkComputePipelineCreateInfo
calloc()
Returns a newVkComputePipelineCreateInfo
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkComputePipelineCreateInfo.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkComputePipelineCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkComputePipelineCreateInfo
calloc
(MemoryStack stack) Returns a newVkComputePipelineCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkComputePipelineCreateInfo
Deprecated.callocStack
(int capacity) Deprecated.callocStack
(int capacity, MemoryStack stack) Deprecated.static VkComputePipelineCreateInfo
callocStack
(MemoryStack stack) Deprecated.static VkComputePipelineCreateInfo
create()
Returns a newVkComputePipelineCreateInfo
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkComputePipelineCreateInfo.Buffer
instance allocated withBufferUtils
.static VkComputePipelineCreateInfo
create
(long address) Returns a newVkComputePipelineCreateInfo
instance for the specified memory address.create
(long address, int capacity) Create aVkComputePipelineCreateInfo.Buffer
instance at the specified memory.static VkComputePipelineCreateInfo
createSafe
(long address) createSafe
(long address, int capacity) int
flags()
a bitmask ofVkPipelineCreateFlagBits
specifying how the pipeline will be generated.flags
(int value) Sets the specified value to theflags()
field.long
layout()
the description of binding locations used by both the pipeline and descriptor sets used with the pipeline.layout
(long value) Sets the specified value to thelayout()
field.static VkComputePipelineCreateInfo
malloc()
Returns a newVkComputePipelineCreateInfo
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkComputePipelineCreateInfo.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkComputePipelineCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkComputePipelineCreateInfo
malloc
(MemoryStack stack) Returns a newVkComputePipelineCreateInfo
instance allocated on the specifiedMemoryStack
.static VkComputePipelineCreateInfo
Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.static VkComputePipelineCreateInfo
mallocStack
(MemoryStack stack) Deprecated.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 long
nlayout
(long struct) Unsafe version oflayout()
.static void
nlayout
(long struct, long value) Unsafe version oflayout
.static long
npNext
(long struct) Unsafe version ofpNext()
.static void
npNext
(long struct, long value) Unsafe version ofpNext
.nstage
(long struct) Unsafe version ofstage()
.static void
nstage
(long struct, VkPipelineShaderStageCreateInfo value) Unsafe version ofstage
.static int
nsType
(long struct) Unsafe version ofsType()
.static void
nsType
(long struct, int value) Unsafe version ofsType
.long
pNext()
NULL
or a pointer to a structure extending this structure.pNext
(long value) Sets the specified value to thepNext()
field.Prepends the specifiedVkPipelineCompilerControlCreateInfoAMD
value to thepNext
chain.Prepends the specifiedVkPipelineCreateFlags2CreateInfoKHR
value to thepNext
chain.Prepends the specifiedVkPipelineCreationFeedbackCreateInfo
value to thepNext
chain.Prepends the specifiedVkPipelineCreationFeedbackCreateInfoEXT
value to thepNext
chain.Prepends the specifiedVkPipelineRobustnessCreateInfoEXT
value to thepNext
chain.Prepends the specifiedVkSubpassShadingPipelineCreateInfoHUAWEI
value to thepNext
chain.set
(int sType, long pNext, int flags, VkPipelineShaderStageCreateInfo stage, long layout, long basePipelineHandle, int basePipelineIndex) Initializes this struct with the specified values.Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.stage()
aVkPipelineShaderStageCreateInfo
structure describing the compute shader.stage
(Consumer<VkPipelineShaderStageCreateInfo> consumer) Copies the specifiedVkPipelineShaderStageCreateInfo
to thestage()
field.int
sType()
aVkStructureType
value identifying this structure.sType
(int value) Sets the specified value to thesType()
field.Sets theSTRUCTURE_TYPE_COMPUTE_PIPELINE_CREATE_INFO
value to thesType()
field.static void
validate
(long struct) Validates pointer members that should not beNULL
.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods 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. -
FLAGS
public static final int FLAGSThe struct member offsets. -
STAGE
public static final int STAGEThe struct member offsets. -
LAYOUT
public static final int LAYOUTThe struct member offsets. -
BASEPIPELINEHANDLE
public static final int BASEPIPELINEHANDLEThe struct member offsets. -
BASEPIPELINEINDEX
public static final int BASEPIPELINEINDEXThe struct member offsets.
-
-
Constructor Details
-
VkComputePipelineCreateInfo
Creates aVkComputePipelineCreateInfo
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 Details
-
sizeof
public int sizeof()Description copied from class:Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkComputePipelineCreateInfo>
-
sType
public int sType()aVkStructureType
value identifying this structure. -
pNext
public long pNext()NULL
or a pointer to a structure extending this structure. -
flags
public int flags()a bitmask ofVkPipelineCreateFlagBits
specifying how the pipeline will be generated. -
stage
aVkPipelineShaderStageCreateInfo
structure describing the compute shader. -
layout
public long layout()the description of binding locations used by both the pipeline and descriptor sets used with the pipeline. -
basePipelineHandle
public long basePipelineHandle()a pipeline to derive from. -
basePipelineIndex
public int basePipelineIndex()an index into thepCreateInfos
parameter to use as a pipeline to derive from. -
sType
Sets the specified value to thesType()
field. -
sType$Default
Sets theSTRUCTURE_TYPE_COMPUTE_PIPELINE_CREATE_INFO
value to thesType()
field. -
pNext
Sets the specified value to thepNext()
field. -
pNext
Prepends the specifiedVkPipelineCompilerControlCreateInfoAMD
value to thepNext
chain. -
pNext
Prepends the specifiedVkPipelineCreateFlags2CreateInfoKHR
value to thepNext
chain. -
pNext
Prepends the specifiedVkPipelineCreationFeedbackCreateInfo
value to thepNext
chain. -
pNext
Prepends the specifiedVkPipelineCreationFeedbackCreateInfoEXT
value to thepNext
chain. -
pNext
Prepends the specifiedVkPipelineRobustnessCreateInfoEXT
value to thepNext
chain. -
pNext
Prepends the specifiedVkSubpassShadingPipelineCreateInfoHUAWEI
value to thepNext
chain. -
flags
Sets the specified value to theflags()
field. -
stage
Copies the specifiedVkPipelineShaderStageCreateInfo
to thestage()
field. -
stage
-
layout
Sets the specified value to thelayout()
field. -
basePipelineHandle
Sets the specified value to thebasePipelineHandle()
field. -
basePipelineIndex
Sets the specified value to thebasePipelineIndex()
field. -
set
public VkComputePipelineCreateInfo set(int sType, long pNext, int flags, VkPipelineShaderStageCreateInfo stage, long layout, long basePipelineHandle, int basePipelineIndex) 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 newVkComputePipelineCreateInfo
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkComputePipelineCreateInfo
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkComputePipelineCreateInfo
instance allocated withBufferUtils
. -
create
Returns a newVkComputePipelineCreateInfo
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkComputePipelineCreateInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkComputePipelineCreateInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkComputePipelineCreateInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkComputePipelineCreateInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
@Deprecated public static VkComputePipelineCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkComputePipelineCreateInfo.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkComputePipelineCreateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkComputePipelineCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkComputePipelineCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkComputePipelineCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and 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()
. -
nflags
public static int nflags(long struct) Unsafe version offlags()
. -
nstage
Unsafe version ofstage()
. -
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
. -
nstage
Unsafe version ofstage
. -
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
-