VkComputePipelineCreateInfo (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkComputePipelineCreateInfo

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkComputePipelineCreateInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying parameters of a newly created compute pipeline.
Description

The parameters basePipelineHandle and basePipelineIndex are described in more detail in Pipeline Derivatives.

Valid Usage
- If flags contains the PIPELINE_CREATE_DERIVATIVE_BIT flag, and basePipelineIndex is -1, basePipelineHandle must be a valid handle to a compute VkPipeline
- If flags contains the PIPELINE_CREATE_DERIVATIVE_BIT flag, and basePipelineHandle is NULL_HANDLE, basePipelineIndex must be a valid index into the calling command’s pCreateInfos parameter
- If flags contains the PIPELINE_CREATE_DERIVATIVE_BIT flag, and basePipelineIndex is not -1, basePipelineHandle must be NULL_HANDLE
- If flags contains the PIPELINE_CREATE_DERIVATIVE_BIT flag, and basePipelineHandle is not NULL_HANDLE, basePipelineIndex must be -1
- The stage member of stage must be SHADER_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 the layout of the compute shader specified in stage
- The number of resources in layout accessible to the compute shader stage must be less than or equal to VkPhysicalDeviceLimits::maxPerStageResources
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_COMPUTE_PIPELINE_CREATE_INFO
- Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkPipelineCompilerControlCreateInfoAMD or VkPipelineCreationFeedbackCreateInfoEXT
- Each sType member in the pNext chain must be unique
- flags must be a valid combination of VkPipelineCreateFlagBits values
- stage must be a valid VkPipelineShaderStageCreateInfo structure
- layout must be a valid VkPipelineLayout handle
- Both of basePipelineHandle, and layout that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same VkDevice
See Also

VkPipelineShaderStageCreateInfo, CreateComputePipelines

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- flags – a bitmask of VkPipelineCreateFlagBits specifying how the pipeline will be generated.
- stage – a VkPipelineShaderStageCreateInfo structure describing the compute shader.
- 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 the pCreateInfos parameter to use as a pipeline to derive from
Layout
```
 struct VkComputePipelineCreateInfo {
     VkStructureType sType;
     void const * 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 of VkComputePipelineCreateInfo structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkComputePipelineCreateInfo.Buffer` An array of `VkComputePipelineCreateInfo` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`BASEPIPELINEHANDLE` The struct member offsets.
`static int`	`BASEPIPELINEINDEX` The struct member offsets.
`static int`	`FLAGS` The struct member offsets.
`static int`	`LAYOUT` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STAGE` The struct member offsets.
`static int`	`STYPE` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkComputePipelineCreateInfo(java.nio.ByteBuffer container)` Creates a `VkComputePipelineCreateInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`basePipelineHandle()` Returns the value of the `basePipelineHandle` field.
`VkComputePipelineCreateInfo`	`basePipelineHandle(long value)` Sets the specified value to the `basePipelineHandle` field.
`int`	`basePipelineIndex()` Returns the value of the `basePipelineIndex` field.
`VkComputePipelineCreateInfo`	`basePipelineIndex(int value)` Sets the specified value to the `basePipelineIndex` field.
`static VkComputePipelineCreateInfo`	`calloc()` Returns a new `VkComputePipelineCreateInfo` instance allocated with `memCalloc`.
`static VkComputePipelineCreateInfo.Buffer`	`calloc(int capacity)` Returns a new `VkComputePipelineCreateInfo.Buffer` instance allocated with `memCalloc`.
`static VkComputePipelineCreateInfo`	`callocStack()` Returns a new `VkComputePipelineCreateInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkComputePipelineCreateInfo.Buffer`	`callocStack(int capacity)` Returns a new `VkComputePipelineCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkComputePipelineCreateInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkComputePipelineCreateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkComputePipelineCreateInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkComputePipelineCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkComputePipelineCreateInfo`	`create()` Returns a new `VkComputePipelineCreateInfo` instance allocated with `BufferUtils`.
`static VkComputePipelineCreateInfo.Buffer`	`create(int capacity)` Returns a new `VkComputePipelineCreateInfo.Buffer` instance allocated with `BufferUtils`.
`static VkComputePipelineCreateInfo`	`create(long address)` Returns a new `VkComputePipelineCreateInfo` instance for the specified memory address.
`static VkComputePipelineCreateInfo.Buffer`	`create(long address, int capacity)` Create a `VkComputePipelineCreateInfo.Buffer` instance at the specified memory.
`static VkComputePipelineCreateInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkComputePipelineCreateInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`flags()` Returns the value of the `flags` field.
`VkComputePipelineCreateInfo`	`flags(int value)` Sets the specified value to the `flags` field.
`long`	`layout()` Returns the value of the `layout` field.
`VkComputePipelineCreateInfo`	`layout(long value)` Sets the specified value to the `layout` field.
`static VkComputePipelineCreateInfo`	`malloc()` Returns a new `VkComputePipelineCreateInfo` instance allocated with `memAlloc`.
`static VkComputePipelineCreateInfo.Buffer`	`malloc(int capacity)` Returns a new `VkComputePipelineCreateInfo.Buffer` instance allocated with `memAlloc`.
`static VkComputePipelineCreateInfo`	`mallocStack()` Returns a new `VkComputePipelineCreateInfo` instance allocated on the thread-local `MemoryStack`.
`static VkComputePipelineCreateInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VkComputePipelineCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkComputePipelineCreateInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkComputePipelineCreateInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkComputePipelineCreateInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkComputePipelineCreateInfo` instance allocated on the specified `MemoryStack`.
`static long`	`nbasePipelineHandle(long struct)` Unsafe version of `basePipelineHandle()`.
`static void`	`nbasePipelineHandle(long struct, long value)` Unsafe version of `basePipelineHandle`.
`static int`	`nbasePipelineIndex(long struct)` Unsafe version of `basePipelineIndex()`.
`static void`	`nbasePipelineIndex(long struct, int value)` Unsafe version of `basePipelineIndex`.
`static int`	`nflags(long struct)` Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)` Unsafe version of `flags`.
`static long`	`nlayout(long struct)` Unsafe version of `layout()`.
`static void`	`nlayout(long struct, long value)` Unsafe version of `layout`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static VkPipelineShaderStageCreateInfo`	`nstage(long struct)` Unsafe version of `stage()`.
`static void`	`nstage(long struct, VkPipelineShaderStageCreateInfo value)` Unsafe version of `stage`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkComputePipelineCreateInfo`	`pNext(long value)` Sets the specified value to the `pNext` 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()`
`VkPipelineShaderStageCreateInfo`	`stage()` Returns a `VkPipelineShaderStageCreateInfo` view of the `stage` field.
`VkComputePipelineCreateInfo`	`stage(java.util.function.Consumer<VkPipelineShaderStageCreateInfo> consumer)` Passes the `stage` field to the specified `Consumer`.
`VkComputePipelineCreateInfo`	`stage(VkPipelineShaderStageCreateInfo value)` Copies the specified `VkPipelineShaderStageCreateInfo` to the `stage` field.
`int`	`sType()` Returns the value of the `sType` field.
`VkComputePipelineCreateInfo`	`sType(int value)` Sets the specified value to the `sType` field.
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - STYPE
```
public static final int STYPE
```
    The struct member offsets.
  - PNEXT
```
public static final int PNEXT
```
    The struct member offsets.
  - FLAGS
```
public static final int FLAGS
```
    The struct member offsets.
  - STAGE
```
public static final int STAGE
```
    The struct member offsets.
  - LAYOUT
```
public static final int LAYOUT
```
    The struct member offsets.
  - BASEPIPELINEHANDLE
```
public static final int BASEPIPELINEHANDLE
```
    The struct member offsets.
  - BASEPIPELINEINDEX
```
public static final int BASEPIPELINEINDEX
```
    The struct member offsets.
- Constructor Detail
  - VkComputePipelineCreateInfo
```
public VkComputePipelineCreateInfo(java.nio.ByteBuffer container)
```
    Creates a VkComputePipelineCreateInfo instance at the current position of the specified ByteBuffer 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 class org.lwjgl.system.Struct
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - flags
```
public int flags()
```
    Returns the value of the flags field.
  - stage
```
public VkPipelineShaderStageCreateInfo stage()
```
    Returns a VkPipelineShaderStageCreateInfo view of the stage field.
  - layout
```
public long layout()
```
    Returns the value of the layout field.
  - basePipelineHandle
```
public long basePipelineHandle()
```
    Returns the value of the basePipelineHandle field.
  - basePipelineIndex
```
public int basePipelineIndex()
```
    Returns the value of the basePipelineIndex field.
  - sType
```
public VkComputePipelineCreateInfo sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkComputePipelineCreateInfo pNext(long value)
```
    Sets the specified value to the pNext field.
  - flags
```
public VkComputePipelineCreateInfo flags(int value)
```
    Sets the specified value to the flags field.
  - stage
```
public VkComputePipelineCreateInfo stage(VkPipelineShaderStageCreateInfo value)
```
    Copies the specified VkPipelineShaderStageCreateInfo to the stage field.
  - stage
```
public VkComputePipelineCreateInfo stage(java.util.function.Consumer<VkPipelineShaderStageCreateInfo> consumer)
```
    Passes the stage field to the specified Consumer.
  - layout
```
public VkComputePipelineCreateInfo layout(long value)
```
    Sets the specified value to the layout field.
  - basePipelineHandle
```
public VkComputePipelineCreateInfo basePipelineHandle(long value)
```
    Sets the specified value to the basePipelineHandle field.
  - basePipelineIndex
```
public VkComputePipelineCreateInfo basePipelineIndex(int value)
```
    Sets the specified value to the basePipelineIndex 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
```
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 new VkComputePipelineCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkComputePipelineCreateInfo calloc()
```
    Returns a new VkComputePipelineCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkComputePipelineCreateInfo create()
```
    Returns a new VkComputePipelineCreateInfo instance allocated with BufferUtils.
  - create
```
public static VkComputePipelineCreateInfo create(long address)
```
    Returns a new VkComputePipelineCreateInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkComputePipelineCreateInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkComputePipelineCreateInfo.Buffer malloc(int capacity)
```
    Returns a new VkComputePipelineCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkComputePipelineCreateInfo.Buffer calloc(int capacity)
```
    Returns a new VkComputePipelineCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkComputePipelineCreateInfo.Buffer create(int capacity)
```
    Returns a new VkComputePipelineCreateInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkComputePipelineCreateInfo.Buffer create(long address,
                                                        int capacity)
```
    Create a VkComputePipelineCreateInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkComputePipelineCreateInfo.Buffer createSafe(long address,
                                                                      int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkComputePipelineCreateInfo mallocStack()
```
    Returns a new VkComputePipelineCreateInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkComputePipelineCreateInfo callocStack()
```
    Returns a new VkComputePipelineCreateInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkComputePipelineCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkComputePipelineCreateInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkComputePipelineCreateInfo callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkComputePipelineCreateInfo instance allocated on the specified MemoryStack 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 new VkComputePipelineCreateInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkComputePipelineCreateInfo.Buffer callocStack(int capacity)
```
    Returns a new VkComputePipelineCreateInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkComputePipelineCreateInfo.Buffer mallocStack(int capacity,
                                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkComputePipelineCreateInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkComputePipelineCreateInfo.Buffer callocStack(int capacity,
                                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkComputePipelineCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - nflags
```
public static int nflags(long struct)
```
    Unsafe version of flags().
  - nstage
```
public static VkPipelineShaderStageCreateInfo nstage(long struct)
```
    Unsafe version of stage().
  - nlayout
```
public static long nlayout(long struct)
```
    Unsafe version of layout().
  - nbasePipelineHandle
```
public static long nbasePipelineHandle(long struct)
```
    Unsafe version of basePipelineHandle().
  - nbasePipelineIndex
```
public static int nbasePipelineIndex(long struct)
```
    Unsafe version of basePipelineIndex().
  - nsType
```
public static void nsType(long struct,
                          int value)
```
    Unsafe version of sType.
  - npNext
```
public static void npNext(long struct,
                          long value)
```
    Unsafe version of pNext.
  - nflags
```
public static void nflags(long struct,
                          int value)
```
    Unsafe version of flags.
  - nstage
```
public static void nstage(long struct,
                          VkPipelineShaderStageCreateInfo value)
```
    Unsafe version of stage.
  - nlayout
```
public static void nlayout(long struct,
                           long value)
```
    Unsafe version of layout.
  - nbasePipelineHandle
```
public static void nbasePipelineHandle(long struct,
                                       long value)
```
    Unsafe version of basePipelineHandle.
  - nbasePipelineIndex
```
public static void nbasePipelineIndex(long struct,
                                      int value)
```
    Unsafe version of basePipelineIndex.
  - validate
```
public static void validate(long struct)
```
    Validates pointer members that should not be NULL.
    
    Parameters:
    
    struct - the struct to validate
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class VkComputePipelineCreateInfo

Description

Valid Usage

Valid Usage (Implicit)

See Also

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

FLAGS

STAGE

LAYOUT

BASEPIPELINEHANDLE

BASEPIPELINEINDEX

Constructor Detail

VkComputePipelineCreateInfo

Method Detail

sizeof

sType

pNext

flags

stage

layout

basePipelineHandle

basePipelineIndex

sType

pNext

flags

stage

stage

layout

basePipelineHandle

basePipelineIndex

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nflags

nstage

nlayout

nbasePipelineHandle

nbasePipelineIndex

nsType

npNext

nflags

nstage

nlayout

nbasePipelineHandle

nbasePipelineIndex