VkShaderModuleCreateInfo (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkShaderModuleCreateInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying parameters of a newly created shader module.
Valid Usage
- codeSize must be greater than 0
- If pCode is a pointer to SPIR-V code, codeSize must be a multiple of 4
- pCode must point to either valid SPIR-V code, formatted and packed as described by the Khronos SPIR-V Specification or valid GLSL code which must be written to the GL_KHR_vulkan_glsl extension specification
- If pCode is a pointer to SPIR-V code, that code must adhere to the validation rules described by the Validation Rules within a Module section of the SPIR-V Environment appendix
- If pCode is a pointer to GLSL code, it must be valid GLSL code written to the GL_KHR_vulkan_glsl GLSL extension specification
- pCode must declare the Shader capability for SPIR-V code
- pCode must not declare any capability that is not supported by the API, as described by the Capabilities section of the SPIR-V Environment appendix
- If pCode declares any of the capabilities listed as optional: in the SPIR-V Environment appendix, the corresponding feature(s) must be enabled.
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO
- pNext must be NULL or a pointer to a valid instance of VkShaderModuleValidationCacheCreateInfoEXT
- flags must be 0
- pCode must be a valid pointer to an array of codeSize / 4 uint32_t values
See Also

CreateShaderModule

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- flags – reserved for future use.
- codeSize – the size, in bytes, of the code pointed to by pCode.
- pCode – points to code that is used to create the shader module
Layout
```
 struct VkShaderModuleCreateInfo {
     VkStructureType sType;
     void const * pNext;
     VkShaderModuleCreateFlags flags;
     size_t codeSize;
     uint32_t const * pCode;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkShaderModuleCreateInfo.Buffer
An array of VkShaderModuleCreateInfo 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`	`VkShaderModuleCreateInfo.Buffer` An array of `VkShaderModuleCreateInfo` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`CODESIZE` The struct member offsets.
`static int`	`FLAGS` The struct member offsets.
`static int`	`PCODE` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`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
`VkShaderModuleCreateInfo(java.nio.ByteBuffer container)` Creates a `VkShaderModuleCreateInfo` 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 VkShaderModuleCreateInfo`	`calloc()` Returns a new `VkShaderModuleCreateInfo` instance allocated with `memCalloc`.
`static VkShaderModuleCreateInfo.Buffer`	`calloc(int capacity)` Returns a new `VkShaderModuleCreateInfo.Buffer` instance allocated with `memCalloc`.
`static VkShaderModuleCreateInfo`	`callocStack()` Returns a new `VkShaderModuleCreateInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkShaderModuleCreateInfo.Buffer`	`callocStack(int capacity)` Returns a new `VkShaderModuleCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkShaderModuleCreateInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkShaderModuleCreateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkShaderModuleCreateInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkShaderModuleCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`long`	`codeSize()` Returns the value of the `codeSize` field.
`static VkShaderModuleCreateInfo`	`create()` Returns a new `VkShaderModuleCreateInfo` instance allocated with `BufferUtils`.
`static VkShaderModuleCreateInfo.Buffer`	`create(int capacity)` Returns a new `VkShaderModuleCreateInfo.Buffer` instance allocated with `BufferUtils`.
`static VkShaderModuleCreateInfo`	`create(long address)` Returns a new `VkShaderModuleCreateInfo` instance for the specified memory address.
`static VkShaderModuleCreateInfo.Buffer`	`create(long address, int capacity)` Create a `VkShaderModuleCreateInfo.Buffer` instance at the specified memory.
`static VkShaderModuleCreateInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkShaderModuleCreateInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`flags()` Returns the value of the `flags` field.
`VkShaderModuleCreateInfo`	`flags(int value)` Sets the specified value to the `flags` field.
`static VkShaderModuleCreateInfo`	`malloc()` Returns a new `VkShaderModuleCreateInfo` instance allocated with `memAlloc`.
`static VkShaderModuleCreateInfo.Buffer`	`malloc(int capacity)` Returns a new `VkShaderModuleCreateInfo.Buffer` instance allocated with `memAlloc`.
`static VkShaderModuleCreateInfo`	`mallocStack()` Returns a new `VkShaderModuleCreateInfo` instance allocated on the thread-local `MemoryStack`.
`static VkShaderModuleCreateInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VkShaderModuleCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkShaderModuleCreateInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkShaderModuleCreateInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkShaderModuleCreateInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkShaderModuleCreateInfo` instance allocated on the specified `MemoryStack`.
`static long`	`ncodeSize(long struct)` Unsafe version of `codeSize()`.
`static void`	`ncodeSize(long struct, long value)` Sets the specified value to the `codeSize` field of the specified `struct`.
`static int`	`nflags(long struct)` Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)` Unsafe version of `flags`.
`static java.nio.ByteBuffer`	`npCode(long struct)` Unsafe version of `pCode`.
`static void`	`npCode(long struct, java.nio.ByteBuffer value)` Unsafe version of `pCode`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`java.nio.ByteBuffer`	`pCode()` Returns a `ByteBuffer` view of the data pointed to by the `pCode` field.
`VkShaderModuleCreateInfo`	`pCode(java.nio.ByteBuffer value)` Sets the address of the specified `ByteBuffer` to the `pCode` field.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkShaderModuleCreateInfo`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkShaderModuleCreateInfo`	`set(int sType, long pNext, int flags, java.nio.ByteBuffer pCode)` Initializes this struct with the specified values.
`VkShaderModuleCreateInfo`	`set(VkShaderModuleCreateInfo src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkShaderModuleCreateInfo`	`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.
  - CODESIZE
```
public static final int CODESIZE
```
    The struct member offsets.
  - PCODE
```
public static final int PCODE
```
    The struct member offsets.
- Constructor Detail
  - VkShaderModuleCreateInfo
```
public VkShaderModuleCreateInfo(java.nio.ByteBuffer container)
```
    Creates a VkShaderModuleCreateInfo 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.
  - codeSize
```
public long codeSize()
```
    Returns the value of the codeSize field.
  - pCode
```
public java.nio.ByteBuffer pCode()
```
    Returns a ByteBuffer view of the data pointed to by the pCode field.
  - sType
```
public VkShaderModuleCreateInfo sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkShaderModuleCreateInfo pNext(long value)
```
    Sets the specified value to the pNext field.
  - flags
```
public VkShaderModuleCreateInfo flags(int value)
```
    Sets the specified value to the flags field.
  - pCode
```
public VkShaderModuleCreateInfo pCode(java.nio.ByteBuffer value)
```
    Sets the address of the specified ByteBuffer to the pCode field.
  - set
```
public VkShaderModuleCreateInfo set(int sType,
                                    long pNext,
                                    int flags,
                                    java.nio.ByteBuffer pCode)
```
    Initializes this struct with the specified values.
  - set
```
public VkShaderModuleCreateInfo set(VkShaderModuleCreateInfo src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkShaderModuleCreateInfo malloc()
```
    Returns a new VkShaderModuleCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkShaderModuleCreateInfo calloc()
```
    Returns a new VkShaderModuleCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkShaderModuleCreateInfo create()
```
    Returns a new VkShaderModuleCreateInfo instance allocated with BufferUtils.
  - create
```
public static VkShaderModuleCreateInfo create(long address)
```
    Returns a new VkShaderModuleCreateInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkShaderModuleCreateInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkShaderModuleCreateInfo.Buffer malloc(int capacity)
```
    Returns a new VkShaderModuleCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkShaderModuleCreateInfo.Buffer calloc(int capacity)
```
    Returns a new VkShaderModuleCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkShaderModuleCreateInfo.Buffer create(int capacity)
```
    Returns a new VkShaderModuleCreateInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkShaderModuleCreateInfo.Buffer create(long address,
                                                     int capacity)
```
    Create a VkShaderModuleCreateInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkShaderModuleCreateInfo.Buffer createSafe(long address,
                                                                   int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkShaderModuleCreateInfo mallocStack()
```
    Returns a new VkShaderModuleCreateInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkShaderModuleCreateInfo callocStack()
```
    Returns a new VkShaderModuleCreateInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkShaderModuleCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkShaderModuleCreateInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkShaderModuleCreateInfo callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkShaderModuleCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkShaderModuleCreateInfo.Buffer mallocStack(int capacity)
```
    Returns a new VkShaderModuleCreateInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkShaderModuleCreateInfo.Buffer callocStack(int capacity)
```
    Returns a new VkShaderModuleCreateInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkShaderModuleCreateInfo.Buffer mallocStack(int capacity,
                                                          org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkShaderModuleCreateInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkShaderModuleCreateInfo.Buffer callocStack(int capacity,
                                                          org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkShaderModuleCreateInfo.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().
  - ncodeSize
```
public static long ncodeSize(long struct)
```
    Unsafe version of codeSize().
  - npCode
```
public static java.nio.ByteBuffer npCode(long struct)
```
    Unsafe version of pCode.
  - 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.
  - ncodeSize
```
public static void ncodeSize(long struct,
                             long value)
```
    Sets the specified value to the codeSize field of the specified struct.
  - npCode
```
public static void npCode(long struct,
                          java.nio.ByteBuffer value)
```
    Unsafe version of pCode.
  - 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 VkShaderModuleCreateInfo

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

CODESIZE

PCODE

Constructor Detail

VkShaderModuleCreateInfo

Method Detail

sizeof

sType

pNext

flags

codeSize

pCode

sType

pNext

flags

pCode

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nflags

ncodeSize

npCode

nsType

npNext

nflags

ncodeSize

npCode

validate

validate