VkSpecializationMapEntry (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkSpecializationMapEntry
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying a specialization map entry.
Description

If a constantID value is not a specialization constant ID used in the shader, that map entry does not affect the behavior of the pipeline.

Valid Usage
- For a constantID specialization constant declared in a shader, size must match the byte size of the constantID. If the specialization constant is of type boolean, size must be the byte size of VkBool32
See Also

VkSpecializationInfo

Member documentation
- constantID – the ID of the specialization constant in SPIR-V.
- offset – the byte offset of the specialization constant value within the supplied data buffer.
- size – the byte size of the specialization constant value within the supplied data buffer.
Layout
```
 struct VkSpecializationMapEntry {
     uint32_t constantID;
     uint32_t offset;
     size_t size;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`CONSTANTID` The struct member offsets.
`static int`	`OFFSET` The struct member offsets.
`static int`	`SIZE` 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
`VkSpecializationMapEntry(java.nio.ByteBuffer container)` Creates a `VkSpecializationMapEntry` 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 VkSpecializationMapEntry`	`calloc()` Returns a new `VkSpecializationMapEntry` instance allocated with `memCalloc`.
`static VkSpecializationMapEntry.Buffer`	`calloc(int capacity)` Returns a new `VkSpecializationMapEntry.Buffer` instance allocated with `memCalloc`.
`static VkSpecializationMapEntry`	`callocStack()` Returns a new `VkSpecializationMapEntry` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkSpecializationMapEntry.Buffer`	`callocStack(int capacity)` Returns a new `VkSpecializationMapEntry.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkSpecializationMapEntry.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkSpecializationMapEntry.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSpecializationMapEntry`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkSpecializationMapEntry` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`int`	`constantID()` Returns the value of the `constantID` field.
`VkSpecializationMapEntry`	`constantID(int value)` Sets the specified value to the `constantID` field.
`static VkSpecializationMapEntry`	`create()` Returns a new `VkSpecializationMapEntry` instance allocated with `BufferUtils`.
`static VkSpecializationMapEntry.Buffer`	`create(int capacity)` Returns a new `VkSpecializationMapEntry.Buffer` instance allocated with `BufferUtils`.
`static VkSpecializationMapEntry`	`create(long address)` Returns a new `VkSpecializationMapEntry` instance for the specified memory address.
`static VkSpecializationMapEntry.Buffer`	`create(long address, int capacity)` Create a `VkSpecializationMapEntry.Buffer` instance at the specified memory.
`static VkSpecializationMapEntry`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkSpecializationMapEntry.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkSpecializationMapEntry`	`malloc()` Returns a new `VkSpecializationMapEntry` instance allocated with `memAlloc`.
`static VkSpecializationMapEntry.Buffer`	`malloc(int capacity)` Returns a new `VkSpecializationMapEntry.Buffer` instance allocated with `memAlloc`.
`static VkSpecializationMapEntry`	`mallocStack()` Returns a new `VkSpecializationMapEntry` instance allocated on the thread-local `MemoryStack`.
`static VkSpecializationMapEntry.Buffer`	`mallocStack(int capacity)` Returns a new `VkSpecializationMapEntry.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkSpecializationMapEntry.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkSpecializationMapEntry.Buffer` instance allocated on the specified `MemoryStack`.
`static VkSpecializationMapEntry`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkSpecializationMapEntry` instance allocated on the specified `MemoryStack`.
`static int`	`nconstantID(long struct)` Unsafe version of `constantID()`.
`static void`	`nconstantID(long struct, int value)` Unsafe version of `constantID`.
`static int`	`noffset(long struct)` Unsafe version of `offset()`.
`static void`	`noffset(long struct, int value)` Unsafe version of `offset`.
`static long`	`nsize(long struct)` Unsafe version of `size()`.
`static void`	`nsize(long struct, long value)` Unsafe version of `size`.
`int`	`offset()` Returns the value of the `offset` field.
`VkSpecializationMapEntry`	`offset(int value)` Sets the specified value to the `offset` field.
`VkSpecializationMapEntry`	`set(int constantID, int offset, long size)` Initializes this struct with the specified values.
`VkSpecializationMapEntry`	`set(VkSpecializationMapEntry src)` Copies the specified struct data to this struct.
`long`	`size()` Returns the value of the `size` field.
`VkSpecializationMapEntry`	`size(long value)` Sets the specified value to the `size` field.
`int`	`sizeof()`

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.
  - CONSTANTID
```
public static final int CONSTANTID
```
    The struct member offsets.
  - OFFSET
```
public static final int OFFSET
```
    The struct member offsets.
  - SIZE
```
public static final int SIZE
```
    The struct member offsets.
- Constructor Detail
  - VkSpecializationMapEntry
```
public VkSpecializationMapEntry(java.nio.ByteBuffer container)
```
    Creates a VkSpecializationMapEntry 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
  - constantID
```
public int constantID()
```
    Returns the value of the constantID field.
  - offset
```
public int offset()
```
    Returns the value of the offset field.
  - size
```
public long size()
```
    Returns the value of the size field.
  - constantID
```
public VkSpecializationMapEntry constantID(int value)
```
    Sets the specified value to the constantID field.
  - offset
```
public VkSpecializationMapEntry offset(int value)
```
    Sets the specified value to the offset field.
  - size
```
public VkSpecializationMapEntry size(long value)
```
    Sets the specified value to the size field.
  - set
```
public VkSpecializationMapEntry set(int constantID,
                                    int offset,
                                    long size)
```
    Initializes this struct with the specified values.
  - set
```
public VkSpecializationMapEntry set(VkSpecializationMapEntry src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkSpecializationMapEntry malloc()
```
    Returns a new VkSpecializationMapEntry instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkSpecializationMapEntry calloc()
```
    Returns a new VkSpecializationMapEntry instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkSpecializationMapEntry create()
```
    Returns a new VkSpecializationMapEntry instance allocated with BufferUtils.
  - create
```
public static VkSpecializationMapEntry create(long address)
```
    Returns a new VkSpecializationMapEntry instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkSpecializationMapEntry createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkSpecializationMapEntry.Buffer malloc(int capacity)
```
    Returns a new VkSpecializationMapEntry.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkSpecializationMapEntry.Buffer calloc(int capacity)
```
    Returns a new VkSpecializationMapEntry.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkSpecializationMapEntry.Buffer create(int capacity)
```
    Returns a new VkSpecializationMapEntry.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkSpecializationMapEntry.Buffer create(long address,
                                                     int capacity)
```
    Create a VkSpecializationMapEntry.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkSpecializationMapEntry.Buffer createSafe(long address,
                                                                   int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkSpecializationMapEntry mallocStack()
```
    Returns a new VkSpecializationMapEntry instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkSpecializationMapEntry callocStack()
```
    Returns a new VkSpecializationMapEntry instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkSpecializationMapEntry mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSpecializationMapEntry instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkSpecializationMapEntry callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSpecializationMapEntry instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkSpecializationMapEntry.Buffer mallocStack(int capacity)
```
    Returns a new VkSpecializationMapEntry.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkSpecializationMapEntry.Buffer callocStack(int capacity)
```
    Returns a new VkSpecializationMapEntry.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkSpecializationMapEntry.Buffer mallocStack(int capacity,
                                                          org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSpecializationMapEntry.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkSpecializationMapEntry.Buffer callocStack(int capacity,
                                                          org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSpecializationMapEntry.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
  - nconstantID
```
public static int nconstantID(long struct)
```
    Unsafe version of constantID().
  - noffset
```
public static int noffset(long struct)
```
    Unsafe version of offset().
  - nsize
```
public static long nsize(long struct)
```
    Unsafe version of size().
  - nconstantID
```
public static void nconstantID(long struct,
                               int value)
```
    Unsafe version of constantID.
  - noffset
```
public static void noffset(long struct,
                           int value)
```
    Unsafe version of offset.
  - nsize
```
public static void nsize(long struct,
                         long value)
```
    Unsafe version of size.

Class VkSpecializationMapEntry

Description

Valid Usage

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

CONSTANTID

OFFSET

SIZE

Constructor Detail

VkSpecializationMapEntry

Method Detail

sizeof

constantID

offset

size

constantID

offset

size

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nconstantID

noffset

nsize

nconstantID

noffset

nsize