Package org.lwjgl.vulkan
Class VkComputePipelineCreateInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkComputePipelineCreateInfo
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkComputePipelineCreateInfo extends Struct
Khronos Reference Page
Vulkan SpecificationContains information about how a compute pipeline should be created.
Valid Usage
sType
must beSTRUCTURE_TYPE_COMPUTE_PIPELINE_CREATE_INFO
pNext
must beNULL
flags
must be a valid combination ofVkPipelineCreateFlagBits
valuesstage
must be a validVkPipelineShaderStageCreateInfo
structurelayout
must be a validVkPipelineLayout
handle- Each of
layout
andbasePipelineHandle
that are valid handles must have been created, allocated or retrieved from the sameVkDevice
- If
flags
contains thePIPELINE_CREATE_DERIVATIVE_BIT
flag, andbasePipelineIndex
is not-1
,basePipelineHandle
must beNULL_HANDLE
- If
flags
contains thePIPELINE_CREATE_DERIVATIVE_BIT
flag, andbasePipelineIndex
is not-1
, it must be a valid index into the calling command'spCreateInfos
parameter - If
flags
contains thePIPELINE_CREATE_DERIVATIVE_BIT
flag, andbasePipelineHandle
is notNULL_HANDLE
,basePipelineIndex
must be-1
- If
flags
contains thePIPELINE_CREATE_DERIVATIVE_BIT
flag, andbasePipelineHandle
is notNULL_HANDLE
,basePipelineHandle
must be a validVkPipeline
handle - If
flags
contains thePIPELINE_CREATE_DERIVATIVE_BIT
flag, andbasePipelineHandle
is notNULL_HANDLE
, it must be a valid handle to a computeVkPipeline
- 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 layout
must be consistent with all shaders specified inpStages
Member documentation
sType
– the type of this structure. Must be:STRUCTURE_TYPE_COMPUTE_PIPELINE_CREATE_INFO
pNext
– reserved for use by extensionsflags
– provides options for pipeline creation, and is of typeVkPipelineCreateFlagBits
. One or more of:PIPELINE_CREATE_ALLOW_DERIVATIVES_BIT
PIPELINE_CREATE_DERIVATIVE_BIT
PIPELINE_CREATE_DISABLE_OPTIMIZATION_BIT
stage
– aVkPipelineShaderStageCreateInfo
describing the compute shaderlayout
– the description of binding locations used by both the pipeline and descriptor sets used with the pipelinebasePipelineHandle
– a pipeline to derive frombasePipelineIndex
– an index into thepCreateInfos
parameter to use as a pipeline to derive from
Layout
struct VkComputePipelineCreateInfo { VkStructureType sType; const void * pNext; VkPipelineCreateFlags flags;
VkPipelineShaderStageCreateInfo
stage; VkPipelineLayout layout; VkPipeline basePipelineHandle; int32_t basePipelineIndex; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkComputePipelineCreateInfo.Buffer
An array ofVkComputePipelineCreateInfo
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and Description VkComputePipelineCreateInfo(java.nio.ByteBuffer container)
Creates aVkComputePipelineCreateInfo
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description long
basePipelineHandle()
Returns the value of thebasePipelineHandle
field.VkComputePipelineCreateInfo
basePipelineHandle(long value)
Sets the specified value to thebasePipelineHandle
field.int
basePipelineIndex()
Returns the value of thebasePipelineIndex
field.VkComputePipelineCreateInfo
basePipelineIndex(int value)
Sets the specified value to thebasePipelineIndex
field.static VkComputePipelineCreateInfo
calloc()
Returns a newVkComputePipelineCreateInfo
instance allocated withmemCalloc
.static VkComputePipelineCreateInfo.Buffer
calloc(int capacity)
Returns a newVkComputePipelineCreateInfo.Buffer
instance allocated withmemCalloc
.static VkComputePipelineCreateInfo
callocStack()
Returns a newVkComputePipelineCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkComputePipelineCreateInfo.Buffer
callocStack(int capacity)
Returns a newVkComputePipelineCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkComputePipelineCreateInfo.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkComputePipelineCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkComputePipelineCreateInfo
callocStack(MemoryStack stack)
Returns a newVkComputePipelineCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkComputePipelineCreateInfo
create()
Returns a newVkComputePipelineCreateInfo
instance allocated withBufferUtils
.static VkComputePipelineCreateInfo.Buffer
create(int capacity)
Returns a newVkComputePipelineCreateInfo.Buffer
instance allocated withBufferUtils
.static VkComputePipelineCreateInfo
create(long address)
Returns a newVkComputePipelineCreateInfo
instance for the specified memory address ornull
if the address isNULL
.static VkComputePipelineCreateInfo.Buffer
create(long address, int capacity)
Create aVkComputePipelineCreateInfo.Buffer
instance at the specified memory.int
flags()
Returns the value of theflags
field.VkComputePipelineCreateInfo
flags(int value)
Sets the specified value to theflags
field.long
layout()
Returns the value of thelayout
field.VkComputePipelineCreateInfo
layout(long value)
Sets the specified value to thelayout
field.static VkComputePipelineCreateInfo
malloc()
Returns a newVkComputePipelineCreateInfo
instance allocated withmemAlloc
.static VkComputePipelineCreateInfo.Buffer
malloc(int capacity)
Returns a newVkComputePipelineCreateInfo.Buffer
instance allocated withmemAlloc
.static VkComputePipelineCreateInfo
mallocStack()
Returns a newVkComputePipelineCreateInfo
instance allocated on the thread-localMemoryStack
.static VkComputePipelineCreateInfo.Buffer
mallocStack(int capacity)
Returns a newVkComputePipelineCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkComputePipelineCreateInfo.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkComputePipelineCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkComputePipelineCreateInfo
mallocStack(MemoryStack stack)
Returns a newVkComputePipelineCreateInfo
instance allocated on the specifiedMemoryStack
.VkComputePipelineCreateInfo
nset(long struct)
Unsafe version ofset
.long
pNext()
Returns the value of thepNext
field.VkComputePipelineCreateInfo
pNext(long value)
Sets the specified value to thepNext
field.VkComputePipelineCreateInfo
set(int sType, long pNext, int flags, VkPipelineShaderStageCreateInfo stage, long layout, long basePipelineHandle, int basePipelineIndex)
Initializes this struct with the specified values.VkComputePipelineCreateInfo
set(VkComputePipelineCreateInfo src)
Copies the specified struct data to this struct.int
sizeof()
Returns thesizeof(struct)
.VkPipelineShaderStageCreateInfo
stage()
Returns aVkPipelineShaderStageCreateInfo
view of thestage
field.VkComputePipelineCreateInfo
stage(VkPipelineShaderStageCreateInfo value)
Copies the specifiedVkPipelineShaderStageCreateInfo
to thestage
field.int
sType()
Returns the value of thesType
field.VkComputePipelineCreateInfo
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)
CallsVkComputePipelineCreateInfo.validate(long)
for each struct contained in the specified struct array.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkComputePipelineCreateInfo
public VkComputePipelineCreateInfo(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
Description copied from class:Struct
Returns thesizeof(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.
-
stage
public VkPipelineShaderStageCreateInfo stage()
Returns aVkPipelineShaderStageCreateInfo
view of thestage
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 VkComputePipelineCreateInfo sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkComputePipelineCreateInfo pNext(long value)
Sets the specified value to thepNext
field.
-
flags
public VkComputePipelineCreateInfo flags(int value)
Sets the specified value to theflags
field.
-
stage
public VkComputePipelineCreateInfo stage(VkPipelineShaderStageCreateInfo value)
Copies the specifiedVkPipelineShaderStageCreateInfo
to thestage
field.
-
layout
public VkComputePipelineCreateInfo layout(long value)
Sets the specified value to thelayout
field.
-
basePipelineHandle
public VkComputePipelineCreateInfo basePipelineHandle(long value)
Sets the specified value to thebasePipelineHandle
field.
-
basePipelineIndex
public VkComputePipelineCreateInfo basePipelineIndex(int value)
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.
-
nset
public VkComputePipelineCreateInfo nset(long struct)
Unsafe version ofset
.
-
set
public VkComputePipelineCreateInfo set(VkComputePipelineCreateInfo src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkComputePipelineCreateInfo malloc()
Returns a newVkComputePipelineCreateInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkComputePipelineCreateInfo calloc()
Returns a newVkComputePipelineCreateInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkComputePipelineCreateInfo create()
Returns a newVkComputePipelineCreateInfo
instance allocated withBufferUtils
.
-
create
public static VkComputePipelineCreateInfo create(long address)
Returns a newVkComputePipelineCreateInfo
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkComputePipelineCreateInfo.Buffer malloc(int capacity)
Returns a newVkComputePipelineCreateInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkComputePipelineCreateInfo.Buffer calloc(int capacity)
Returns a newVkComputePipelineCreateInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkComputePipelineCreateInfo.Buffer create(int capacity)
Returns a newVkComputePipelineCreateInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkComputePipelineCreateInfo.Buffer create(long address, int capacity)
Create aVkComputePipelineCreateInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkComputePipelineCreateInfo mallocStack()
Returns a newVkComputePipelineCreateInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkComputePipelineCreateInfo callocStack()
Returns a newVkComputePipelineCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkComputePipelineCreateInfo mallocStack(MemoryStack stack)
Returns a newVkComputePipelineCreateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkComputePipelineCreateInfo callocStack(MemoryStack stack)
Returns a newVkComputePipelineCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkComputePipelineCreateInfo.Buffer mallocStack(int capacity)
Returns a newVkComputePipelineCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkComputePipelineCreateInfo.Buffer callocStack(int capacity)
Returns a newVkComputePipelineCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkComputePipelineCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkComputePipelineCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkComputePipelineCreateInfo.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkComputePipelineCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
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)
CallsVkComputePipelineCreateInfo.validate(long)
for each struct contained in the specified struct array.- Parameters:
array
- the struct array to validatecount
- the number of structs inarray
-
-