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

All Implemented Interfaces:: java.lang.AutoCloseable, NativeResource, Pointer

public class VkPipelineShaderStageCreateInfo
extends Struct

Khronos Reference Page
Vulkan Specification

Contains information about how a shader stage should be created.

Valid Usage

sType must be STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO
pNext must be NULL
flags must be 0
stage must be a valid VkShaderStageFlagBits value
module must be a valid VkShaderModule handle
pName must be a null-terminated string
If pSpecializationInfo is not NULL, pSpecializationInfo must be a pointer to a valid VkSpecializationInfo structure
If the geometry shaders feature is not enabled, stage must not be SHADER_STAGE_GEOMETRY_BIT
If the tessellation shaders feature is not enabled, stage must not be SHADER_STAGE_TESSELLATION_CONTROL_BIT or SHADER_STAGE_TESSELLATION_EVALUATION_BIT
stage must not be SHADER_STAGE_ALL_GRAPHICS, or SHADER_STAGE_ALL
pName must be the name of an OpEntryPoint in module with an execution model that matches stage
If the identified entry point includes any variable in its interface that is declared with the ClipDistance BuiltIn decoration, that variable must not have an array size greater than VkPhysicalDeviceLimits::maxClipDistances
If the identified entry point includes any variable in its interface that is declared with the CullDistance BuiltIn decoration, that variable must not have an array size greater than VkPhysicalDeviceLimits::maxCullDistances
If the identified entry point includes any variables in its interface that are declared with the ClipDistance or CullDistance BuiltIn decoration, those variables must not have array sizes which sum to more than VkPhysicalDeviceLimits::maxCombinedClipAndCullDistances
If the identified entry point includes any variable in its interface that is declared with the SampleMask BuiltIn decoration, that variable must not have an array size greater than VkPhysicalDeviceLimits::maxSampleMaskWords
If stage is SHADER_STAGE_VERTEX_BIT, the identified entry point must not include any input variable in its interface that is decorated with CullDistance
If stage is SHADER_STAGE_TESSELLATION_CONTROL_BIT or SHADER_STAGE_TESSELLATION_EVALUATION_BIT, and the identified entry point has an OpExecutionMode instruction that specifies a patch size with OutputVertices, the patch size must be greater than 0 and less than or equal to VkPhysicalDeviceLimits::maxTessellationPatchSize
If stage is SHADER_STAGE_GEOMETRY_BIT, the identified entry point must have an OpExecutionMode instruction that specifies a maximum output vertex count that is greater than 0 and less than or equal to VkPhysicalDeviceLimits::maxGeometryOutputVertices
If stage is SHADER_STAGE_GEOMETRY_BIT, the identified entry point must have an OpExecutionMode instruction that specifies an invocation count that is greater than 0 and less than or equal to VkPhysicalDeviceLimits::maxGeometryShaderInvocations
If stage is SHADER_STAGE_GEOMETRY_BIT, and the identified entry point writes to Layer for any primitive, it must write the same value to Layer for all vertices of a given primitive
If stage is SHADER_STAGE_GEOMETRY_BIT, and the identified entry point writes to ViewportIndex for any primitive, it must write the same value to ViewportIndex for all vertices of a given primitive
If stage is SHADER_STAGE_FRAGMENT_BIT, the identified entry point must not include any output variables in its interface decorated with CullDistance
If stage is SHADER_STAGE_FRAGMENT_BIT, and the identified entry point writes to FragDepth in any execution path, it must write to FragDepth in all execution paths

Member documentation

sType – the type of this structure. Must be: STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO
pNext – reserved for use by extensions
flags – reserved for future use

stage – a VkShaderStageFlagBits naming the pipeline stage. One or more of:

`SHADER_STAGE_ALL`	`SHADER_STAGE_ALL_GRAPHICS`
`SHADER_STAGE_COMPUTE_BIT`	`SHADER_STAGE_FRAGMENT_BIT`
`SHADER_STAGE_GEOMETRY_BIT`	`SHADER_STAGE_TESSELLATION_CONTROL_BIT`
`SHADER_STAGE_TESSELLATION_EVALUATION_BIT`	`SHADER_STAGE_VERTEX_BIT`

module – a VkShaderModule object that contains the shader for this stage
pName – a pointer to a null-terminated UTF-8 string specifying the entry point name of the shader for this stage
pSpecializationInfo – a pointer to VkSpecializationInfo, can be NULL

Layout

struct VkPipelineShaderStageCreateInfo {
    VkStructureType sType;
    const void * pNext;
    VkPipelineShaderStageCreateFlags flags;
    VkShaderStageFlagBits stage;
    VkShaderModule module;
    const char * pName;
    const VkSpecializationInfo * pSpecializationInfo;
}

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkPipelineShaderStageCreateInfo.Buffer
An array of VkPipelineShaderStageCreateInfo 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
`VkPipelineShaderStageCreateInfo(java.nio.ByteBuffer container)` Creates a `VkPipelineShaderStageCreateInfo` 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
`static VkPipelineShaderStageCreateInfo`	`calloc()` Returns a new `VkPipelineShaderStageCreateInfo` instance allocated with `memCalloc`.
`static VkPipelineShaderStageCreateInfo.Buffer`	`calloc(int capacity)` Returns a new `VkPipelineShaderStageCreateInfo.Buffer` instance allocated with `memCalloc`.
`static VkPipelineShaderStageCreateInfo`	`callocStack()` Returns a new `VkPipelineShaderStageCreateInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPipelineShaderStageCreateInfo.Buffer`	`callocStack(int capacity)` Returns a new `VkPipelineShaderStageCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPipelineShaderStageCreateInfo.Buffer`	`callocStack(int capacity, MemoryStack stack)` Returns a new `VkPipelineShaderStageCreateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPipelineShaderStageCreateInfo`	`callocStack(MemoryStack stack)` Returns a new `VkPipelineShaderStageCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPipelineShaderStageCreateInfo`	`create()` Returns a new `VkPipelineShaderStageCreateInfo` instance allocated with `BufferUtils`.
`static VkPipelineShaderStageCreateInfo.Buffer`	`create(int capacity)` Returns a new `VkPipelineShaderStageCreateInfo.Buffer` instance allocated with `BufferUtils`.
`static VkPipelineShaderStageCreateInfo`	`create(long address)` Returns a new `VkPipelineShaderStageCreateInfo` instance for the specified memory address or `null` if the address is `NULL`.
`static VkPipelineShaderStageCreateInfo.Buffer`	`create(long address, int capacity)` Create a `VkPipelineShaderStageCreateInfo.Buffer` instance at the specified memory.
`int`	`flags()` Returns the value of the `flags` field.
`VkPipelineShaderStageCreateInfo`	`flags(int value)` Sets the specified value to the `flags` field.
`static VkPipelineShaderStageCreateInfo`	`malloc()` Returns a new `VkPipelineShaderStageCreateInfo` instance allocated with `memAlloc`.
`static VkPipelineShaderStageCreateInfo.Buffer`	`malloc(int capacity)` Returns a new `VkPipelineShaderStageCreateInfo.Buffer` instance allocated with `memAlloc`.
`static VkPipelineShaderStageCreateInfo`	`mallocStack()` Returns a new `VkPipelineShaderStageCreateInfo` instance allocated on the thread-local `MemoryStack`.
`static VkPipelineShaderStageCreateInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VkPipelineShaderStageCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkPipelineShaderStageCreateInfo.Buffer`	`mallocStack(int capacity, MemoryStack stack)` Returns a new `VkPipelineShaderStageCreateInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkPipelineShaderStageCreateInfo`	`mallocStack(MemoryStack stack)` Returns a new `VkPipelineShaderStageCreateInfo` instance allocated on the specified `MemoryStack`.
`long`	`module()` Returns the value of the `module` field.
`VkPipelineShaderStageCreateInfo`	`module(long value)` Sets the specified value to the `module` field.
`VkPipelineShaderStageCreateInfo`	`nset(long struct)` Unsafe version of `set`.
`java.nio.ByteBuffer`	`pName()` Returns a `ByteBuffer` view of the null-terminated string pointed to by the `pName` field.
`VkPipelineShaderStageCreateInfo`	`pName(java.nio.ByteBuffer value)` Sets the address of the specified encoded string to the `pName` field.
`java.lang.String`	`pNameString()` Decodes the null-terminated string pointed to by the `pName` field.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkPipelineShaderStageCreateInfo`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkSpecializationInfo`	`pSpecializationInfo()` Returns a `VkSpecializationInfo` view of the struct pointed to by the `pSpecializationInfo` field.
`VkPipelineShaderStageCreateInfo`	`pSpecializationInfo(VkSpecializationInfo value)` Sets the address of the specified `VkSpecializationInfo` to the `pSpecializationInfo` field.
`VkPipelineShaderStageCreateInfo`	`set(int sType, long pNext, int flags, int stage, long module, java.nio.ByteBuffer pName, VkSpecializationInfo pSpecializationInfo)` Initializes this struct with the specified values.
`VkPipelineShaderStageCreateInfo`	`set(VkPipelineShaderStageCreateInfo src)` Copies the specified struct data to this struct.
`int`	`sizeof()` Returns the `sizeof(struct)`.
`int`	`stage()` Returns the value of the `stage` field.
`VkPipelineShaderStageCreateInfo`	`stage(int value)` Sets the specified value to the `stage` field.
`int`	`sType()` Returns the value of the `sType` field.
`VkPipelineShaderStageCreateInfo`	`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 `VkPipelineShaderStageCreateInfo.validate(long)` for each struct contained in the specified struct array.

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

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
- Constructor Detail
  - VkPipelineShaderStageCreateInfo
```
public VkPipelineShaderStageCreateInfo(java.nio.ByteBuffer container)
```
    Creates a VkPipelineShaderStageCreateInfo 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()
```
    Description copied from class: Struct
    
    Returns the sizeof(struct).
    
    Specified by:
    
    sizeof in class 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 int stage()
```
    Returns the value of the stage field.
  - module
```
public long module()
```
    Returns the value of the module field.
  - pName
```
public java.nio.ByteBuffer pName()
```
    Returns a ByteBuffer view of the null-terminated string pointed to by the pName field.
  - pNameString
```
public java.lang.String pNameString()
```
    Decodes the null-terminated string pointed to by the pName field.
  - pSpecializationInfo
```
public VkSpecializationInfo pSpecializationInfo()
```
    Returns a VkSpecializationInfo view of the struct pointed to by the pSpecializationInfo field.
  - sType
```
public VkPipelineShaderStageCreateInfo sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkPipelineShaderStageCreateInfo pNext(long value)
```
    Sets the specified value to the pNext field.
  - flags
```
public VkPipelineShaderStageCreateInfo flags(int value)
```
    Sets the specified value to the flags field.
  - stage
```
public VkPipelineShaderStageCreateInfo stage(int value)
```
    Sets the specified value to the stage field.
  - module
```
public VkPipelineShaderStageCreateInfo module(long value)
```
    Sets the specified value to the module field.
  - pName
```
public VkPipelineShaderStageCreateInfo pName(java.nio.ByteBuffer value)
```
    Sets the address of the specified encoded string to the pName field.
  - pSpecializationInfo
```
public VkPipelineShaderStageCreateInfo pSpecializationInfo(VkSpecializationInfo value)
```
    Sets the address of the specified VkSpecializationInfo to the pSpecializationInfo field.
  - set
```
public VkPipelineShaderStageCreateInfo set(int sType,
                                           long pNext,
                                           int flags,
                                           int stage,
                                           long module,
                                           java.nio.ByteBuffer pName,
                                           VkSpecializationInfo pSpecializationInfo)
```
    Initializes this struct with the specified values.
  - nset
```
public VkPipelineShaderStageCreateInfo nset(long struct)
```
    Unsafe version of set.
  - set
```
public VkPipelineShaderStageCreateInfo set(VkPipelineShaderStageCreateInfo src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkPipelineShaderStageCreateInfo malloc()
```
    Returns a new VkPipelineShaderStageCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkPipelineShaderStageCreateInfo calloc()
```
    Returns a new VkPipelineShaderStageCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkPipelineShaderStageCreateInfo create()
```
    Returns a new VkPipelineShaderStageCreateInfo instance allocated with BufferUtils.
  - create
```
public static VkPipelineShaderStageCreateInfo create(long address)
```
    Returns a new VkPipelineShaderStageCreateInfo instance for the specified memory address or null if the address is NULL.
  - malloc
```
public static VkPipelineShaderStageCreateInfo.Buffer malloc(int capacity)
```
    Returns a new VkPipelineShaderStageCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkPipelineShaderStageCreateInfo.Buffer calloc(int capacity)
```
    Returns a new VkPipelineShaderStageCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPipelineShaderStageCreateInfo.Buffer create(int capacity)
```
    Returns a new VkPipelineShaderStageCreateInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPipelineShaderStageCreateInfo.Buffer create(long address,
                                                            int capacity)
```
    Create a VkPipelineShaderStageCreateInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkPipelineShaderStageCreateInfo mallocStack()
```
    Returns a new VkPipelineShaderStageCreateInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkPipelineShaderStageCreateInfo callocStack()
```
    Returns a new VkPipelineShaderStageCreateInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkPipelineShaderStageCreateInfo mallocStack(MemoryStack stack)
```
    Returns a new VkPipelineShaderStageCreateInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkPipelineShaderStageCreateInfo callocStack(MemoryStack stack)
```
    Returns a new VkPipelineShaderStageCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkPipelineShaderStageCreateInfo.Buffer mallocStack(int capacity)
```
    Returns a new VkPipelineShaderStageCreateInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPipelineShaderStageCreateInfo.Buffer callocStack(int capacity)
```
    Returns a new VkPipelineShaderStageCreateInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkPipelineShaderStageCreateInfo.Buffer mallocStack(int capacity,
                                                                 MemoryStack stack)
```
    Returns a new VkPipelineShaderStageCreateInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPipelineShaderStageCreateInfo.Buffer callocStack(int capacity,
                                                                 MemoryStack stack)
```
    Returns a new VkPipelineShaderStageCreateInfo.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
  - 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 VkPipelineShaderStageCreateInfo.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 VkPipelineShaderStageCreateInfo

Valid Usage

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

Constructor Detail

VkPipelineShaderStageCreateInfo

Method Detail

sizeof

sType

pNext

flags

stage

module

pName

pNameString

pSpecializationInfo

sType

pNext

flags

stage

module

pName

pSpecializationInfo

set

nset

set

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

validate

validate