VkSpecializationInfo (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkSpecializationInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying specialization info.
Description

pMapEntries is a pointer to a VkSpecializationMapEntry structure.

Valid Usage
- The offset member of each element of pMapEntries must be less than dataSize
- The size member of each element of pMapEntries must be less than or equal to dataSize minus offset
Valid Usage (Implicit)
- If mapEntryCount is not 0, pMapEntries must be a valid pointer to an array of mapEntryCount valid VkSpecializationMapEntry structures
- If dataSize is not 0, pData must be a valid pointer to an array of dataSize bytes
See Also

VkPipelineShaderStageCreateInfo, VkSpecializationMapEntry

Member documentation
- mapEntryCount – the number of entries in the pMapEntries array.
- pMapEntries – a pointer to an array of VkSpecializationMapEntry structures which map constant IDs to offsets in pData.
- dataSize – the byte size of the pData buffer.
- pData – contains the actual constant values to specialize with.
Layout
```
 struct VkSpecializationInfo {
     uint32_t mapEntryCount;
     VkSpecializationMapEntry const * pMapEntries;
     size_t dataSize;
     void const * pData;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`DATASIZE` The struct member offsets.
`static int`	`MAPENTRYCOUNT` The struct member offsets.
`static int`	`PDATA` The struct member offsets.
`static int`	`PMAPENTRIES` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.

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

Constructor Summary

Constructors
Constructor and Description
`VkSpecializationInfo(java.nio.ByteBuffer container)` Creates a `VkSpecializationInfo` 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 VkSpecializationInfo`	`calloc()` Returns a new `VkSpecializationInfo` instance allocated with `memCalloc`.
`static VkSpecializationInfo.Buffer`	`calloc(int capacity)` Returns a new `VkSpecializationInfo.Buffer` instance allocated with `memCalloc`.
`static VkSpecializationInfo`	`callocStack()` Returns a new `VkSpecializationInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkSpecializationInfo.Buffer`	`callocStack(int capacity)` Returns a new `VkSpecializationInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkSpecializationInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkSpecializationInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSpecializationInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkSpecializationInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSpecializationInfo`	`create()` Returns a new `VkSpecializationInfo` instance allocated with `BufferUtils`.
`static VkSpecializationInfo.Buffer`	`create(int capacity)` Returns a new `VkSpecializationInfo.Buffer` instance allocated with `BufferUtils`.
`static VkSpecializationInfo`	`create(long address)` Returns a new `VkSpecializationInfo` instance for the specified memory address.
`static VkSpecializationInfo.Buffer`	`create(long address, int capacity)` Create a `VkSpecializationInfo.Buffer` instance at the specified memory.
`static VkSpecializationInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkSpecializationInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`long`	`dataSize()` Returns the value of the `dataSize` field.
`static VkSpecializationInfo`	`malloc()` Returns a new `VkSpecializationInfo` instance allocated with `memAlloc`.
`static VkSpecializationInfo.Buffer`	`malloc(int capacity)` Returns a new `VkSpecializationInfo.Buffer` instance allocated with `memAlloc`.
`static VkSpecializationInfo`	`mallocStack()` Returns a new `VkSpecializationInfo` instance allocated on the thread-local `MemoryStack`.
`static VkSpecializationInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VkSpecializationInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkSpecializationInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkSpecializationInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkSpecializationInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkSpecializationInfo` instance allocated on the specified `MemoryStack`.
`int`	`mapEntryCount()` Returns the value of the `mapEntryCount` field.
`static long`	`ndataSize(long struct)` Unsafe version of `dataSize()`.
`static void`	`ndataSize(long struct, long value)` Sets the specified value to the `dataSize` field of the specified `struct`.
`static int`	`nmapEntryCount(long struct)` Unsafe version of `mapEntryCount()`.
`static void`	`nmapEntryCount(long struct, int value)` Sets the specified value to the `mapEntryCount` field of the specified `struct`.
`static java.nio.ByteBuffer`	`npData(long struct)` Unsafe version of `pData`.
`static void`	`npData(long struct, java.nio.ByteBuffer value)` Unsafe version of `pData`.
`static VkSpecializationMapEntry.Buffer`	`npMapEntries(long struct)` Unsafe version of `pMapEntries()`.
`static void`	`npMapEntries(long struct, VkSpecializationMapEntry.Buffer value)` Unsafe version of `pMapEntries`.
`java.nio.ByteBuffer`	`pData()` Returns a `ByteBuffer` view of the data pointed to by the `pData` field.
`VkSpecializationInfo`	`pData(java.nio.ByteBuffer value)` Sets the address of the specified `ByteBuffer` to the `pData` field.
`VkSpecializationMapEntry.Buffer`	`pMapEntries()` Returns a `VkSpecializationMapEntry.Buffer` view of the struct array pointed to by the `pMapEntries` field.
`VkSpecializationInfo`	`pMapEntries(VkSpecializationMapEntry.Buffer value)` Sets the address of the specified `VkSpecializationMapEntry.Buffer` to the `pMapEntries` field.
`VkSpecializationInfo`	`set(VkSpecializationInfo src)` Copies the specified struct data to this struct.
`VkSpecializationInfo`	`set(VkSpecializationMapEntry.Buffer pMapEntries, java.nio.ByteBuffer pData)` Initializes this struct with the specified values.
`int`	`sizeof()`
`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.
  - MAPENTRYCOUNT
```
public static final int MAPENTRYCOUNT
```
    The struct member offsets.
  - PMAPENTRIES
```
public static final int PMAPENTRIES
```
    The struct member offsets.
  - DATASIZE
```
public static final int DATASIZE
```
    The struct member offsets.
  - PDATA
```
public static final int PDATA
```
    The struct member offsets.
- Constructor Detail
  - VkSpecializationInfo
```
public VkSpecializationInfo(java.nio.ByteBuffer container)
```
    Creates a VkSpecializationInfo 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
  - mapEntryCount
```
public int mapEntryCount()
```
    Returns the value of the mapEntryCount field.
  - pMapEntries
```
@Nullable
public VkSpecializationMapEntry.Buffer pMapEntries()
```
    Returns a VkSpecializationMapEntry.Buffer view of the struct array pointed to by the pMapEntries field.
  - dataSize
```
public long dataSize()
```
    Returns the value of the dataSize field.
  - pData
```
@Nullable
public java.nio.ByteBuffer pData()
```
    Returns a ByteBuffer view of the data pointed to by the pData field.
  - pMapEntries
```
public VkSpecializationInfo pMapEntries(@Nullable
                                        VkSpecializationMapEntry.Buffer value)
```
    Sets the address of the specified VkSpecializationMapEntry.Buffer to the pMapEntries field.
  - pData
```
public VkSpecializationInfo pData(@Nullable
                                  java.nio.ByteBuffer value)
```
    Sets the address of the specified ByteBuffer to the pData field.
  - set
```
public VkSpecializationInfo set(@Nullable
                                VkSpecializationMapEntry.Buffer pMapEntries,
                                @Nullable
                                java.nio.ByteBuffer pData)
```
    Initializes this struct with the specified values.
  - set
```
public VkSpecializationInfo set(VkSpecializationInfo src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkSpecializationInfo malloc()
```
    Returns a new VkSpecializationInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkSpecializationInfo calloc()
```
    Returns a new VkSpecializationInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkSpecializationInfo create()
```
    Returns a new VkSpecializationInfo instance allocated with BufferUtils.
  - create
```
public static VkSpecializationInfo create(long address)
```
    Returns a new VkSpecializationInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkSpecializationInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkSpecializationInfo.Buffer malloc(int capacity)
```
    Returns a new VkSpecializationInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkSpecializationInfo.Buffer calloc(int capacity)
```
    Returns a new VkSpecializationInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkSpecializationInfo.Buffer create(int capacity)
```
    Returns a new VkSpecializationInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkSpecializationInfo.Buffer create(long address,
                                                 int capacity)
```
    Create a VkSpecializationInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkSpecializationInfo.Buffer createSafe(long address,
                                                               int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkSpecializationInfo mallocStack()
```
    Returns a new VkSpecializationInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkSpecializationInfo callocStack()
```
    Returns a new VkSpecializationInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkSpecializationInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSpecializationInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkSpecializationInfo callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSpecializationInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkSpecializationInfo.Buffer mallocStack(int capacity)
```
    Returns a new VkSpecializationInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkSpecializationInfo.Buffer callocStack(int capacity)
```
    Returns a new VkSpecializationInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkSpecializationInfo.Buffer mallocStack(int capacity,
                                                      org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSpecializationInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkSpecializationInfo.Buffer callocStack(int capacity,
                                                      org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSpecializationInfo.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
  - nmapEntryCount
```
public static int nmapEntryCount(long struct)
```
    Unsafe version of mapEntryCount().
  - npMapEntries
```
@Nullable
public static VkSpecializationMapEntry.Buffer npMapEntries(long struct)
```
    Unsafe version of pMapEntries().
  - ndataSize
```
public static long ndataSize(long struct)
```
    Unsafe version of dataSize().
  - npData
```
@Nullable
public static java.nio.ByteBuffer npData(long struct)
```
    Unsafe version of pData.
  - nmapEntryCount
```
public static void nmapEntryCount(long struct,
                                  int value)
```
    Sets the specified value to the mapEntryCount field of the specified struct.
  - npMapEntries
```
public static void npMapEntries(long struct,
                                @Nullable
                                VkSpecializationMapEntry.Buffer value)
```
    Unsafe version of pMapEntries.
  - ndataSize
```
public static void ndataSize(long struct,
                             long value)
```
    Sets the specified value to the dataSize field of the specified struct.
  - npData
```
public static void npData(long struct,
                          @Nullable
                          java.nio.ByteBuffer value)
```
    Unsafe version of pData.
  - 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 VkSpecializationInfo

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

MAPENTRYCOUNT

PMAPENTRIES

DATASIZE

PDATA

Constructor Detail

VkSpecializationInfo

Method Detail

sizeof

mapEntryCount

pMapEntries

dataSize

pData

pMapEntries

pData

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nmapEntryCount

npMapEntries

ndataSize

npData

nmapEntryCount

npMapEntries

ndataSize

npData

validate

validate