Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSpecializationMapEntry

extends Struct<VkSpecializationMapEntry>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
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
See Also

VkSpecializationInfo

Layout


struct VkSpecializationMapEntry {
    uint32_t constantID;
    uint32_t offset;
    size_t size;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkSpecializationMapEntry.Buffer

An array of VkSpecializationMapEntry structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CONSTANTID

The struct member offsets.

public static final int
OFFSET

The struct member offsets.

public static final int
SIZE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkSpecializationMapEntry(long address, ByteBuffer container)

public
VkSpecializationMapEntry(ByteBuffer container)

Creates a VkSpecializationMapEntry instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkSpecializationMapEntry
calloc()

Returns a new VkSpecializationMapEntry instance allocated with memCalloc.

public static VkSpecializationMapEntry.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new VkSpecializationMapEntry.Buffer instance allocated with memCalloc.

public static VkSpecializationMapEntry
calloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkSpecializationMapEntry instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkSpecializationMapEntry.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new VkSpecializationMapEntry.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkSpecializationMapEntry
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkSpecializationMapEntry
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSpecializationMapEntry.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSpecializationMapEntry.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public int
constantID()

the ID of the specialization constant in SPIR-V.

public VkSpecializationMapEntry
constantID(int value)

Sets the specified value to the constantID field.

protected VkSpecializationMapEntry
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkSpecializationMapEntry
create()

Returns a new VkSpecializationMapEntry instance allocated with BufferUtils.

public static VkSpecializationMapEntry
create(long address)

Returns a new VkSpecializationMapEntry instance for the specified memory address.

public static VkSpecializationMapEntry.Buffer
create(int
the buffer capacity
capacity)

Returns a new VkSpecializationMapEntry.Buffer instance allocated with BufferUtils.

public static VkSpecializationMapEntry.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Create a VkSpecializationMapEntry.Buffer instance at the specified memory.

public static VkSpecializationMapEntry
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkSpecializationMapEntry.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static VkSpecializationMapEntry
malloc()

Returns a new VkSpecializationMapEntry instance allocated with memAlloc.

public static VkSpecializationMapEntry.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new VkSpecializationMapEntry.Buffer instance allocated with memAlloc.

public static VkSpecializationMapEntry
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkSpecializationMapEntry instance allocated on the specified MemoryStack.

public static VkSpecializationMapEntry.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new VkSpecializationMapEntry.Buffer instance allocated on the specified MemoryStack.

public static VkSpecializationMapEntry
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkSpecializationMapEntry
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSpecializationMapEntry.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSpecializationMapEntry.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
nconstantID(long struct)

Unsafe version of constantID.

public static void
nconstantID(long struct, int value)

Unsafe version of constantID.

public static int
noffset(long struct)

Unsafe version of offset.

public static void
noffset(long struct, int value)

Unsafe version of offset.

public static long
nsize(long struct)

Unsafe version of size.

public static void
nsize(long struct, long value)

Unsafe version of size.

public int
offset()

the byte offset of the specialization constant value within the supplied data buffer.

public VkSpecializationMapEntry
offset(int value)

Sets the specified value to the offset field.

public VkSpecializationMapEntry
set(int constantID, int offset, long size)

Initializes this struct with the specified values.

public VkSpecializationMapEntry

Returns:

this struct
set(VkSpecializationMapEntry
the source struct
src)

Copies the specified struct data to this struct.

public long
size()

the byte size of the specialization constant value within the supplied data buffer.

public VkSpecializationMapEntry
size(long value)

Sets the specified value to the size field.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

CONSTANTIDback to summary
public static final int CONSTANTID

The struct member offsets.

OFFSETback to summary
public static final int OFFSET

The struct member offsets.

SIZEback to summary
public static final int SIZE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

VkSpecializationMapEntryback to summary
protected VkSpecializationMapEntry(long address, ByteBuffer container)
VkSpecializationMapEntryback to summary
public VkSpecializationMapEntry(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

callocback to summary
public static VkSpecializationMapEntry calloc()

Returns a new VkSpecializationMapEntry instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkSpecializationMapEntry.Buffer calloc(int capacity)

Returns a new VkSpecializationMapEntry.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkSpecializationMapEntry calloc(MemoryStack stack)

Returns a new VkSpecializationMapEntry instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkSpecializationMapEntry.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkSpecializationMapEntry.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkSpecializationMapEntry callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkSpecializationMapEntry callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkSpecializationMapEntry.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkSpecializationMapEntry.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
constantIDback to summary
public int constantID()

the ID of the specialization constant in SPIR-V.

Annotations
@NativeType:uint32_t
constantIDback to summary
public VkSpecializationMapEntry constantID(int value)

Sets the specified value to the constantID field.

createback to summary
protected VkSpecializationMapEntry create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkSpecializationMapEntry create()

Returns a new VkSpecializationMapEntry instance allocated with BufferUtils.

createback to summary
public static VkSpecializationMapEntry create(long address)

Returns a new VkSpecializationMapEntry instance for the specified memory address.

createback to summary
public static VkSpecializationMapEntry.Buffer create(int capacity)

Returns a new VkSpecializationMapEntry.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkSpecializationMapEntry.Buffer create(long address, int capacity)

Create a VkSpecializationMapEntry.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkSpecializationMapEntry createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkSpecializationMapEntry.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkSpecializationMapEntry malloc()

Returns a new VkSpecializationMapEntry instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkSpecializationMapEntry.Buffer malloc(int capacity)

Returns a new VkSpecializationMapEntry.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkSpecializationMapEntry malloc(MemoryStack stack)

Returns a new VkSpecializationMapEntry instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkSpecializationMapEntry.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkSpecializationMapEntry.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkSpecializationMapEntry mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkSpecializationMapEntry mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkSpecializationMapEntry.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkSpecializationMapEntry.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nconstantIDback to summary
public static int nconstantID(long struct)

Unsafe version of constantID.

nconstantIDback to summary
public static void nconstantID(long struct, int value)

Unsafe version of constantID.

noffsetback to summary
public static int noffset(long struct)

Unsafe version of offset.

noffsetback to summary
public static void noffset(long struct, int value)

Unsafe version of offset.

nsizeback to summary
public static long nsize(long struct)

Unsafe version of size.

nsizeback to summary
public static void nsize(long struct, long value)

Unsafe version of size.

offsetback to summary
public int offset()

the byte offset of the specialization constant value within the supplied data buffer.

Annotations
@NativeType:uint32_t
offsetback to summary
public VkSpecializationMapEntry offset(int value)

Sets the specified value to the offset field.

setback to summary
public VkSpecializationMapEntry set(int constantID, int offset, long size)

Initializes this struct with the specified values.

setback to summary
public VkSpecializationMapEntry set(VkSpecializationMapEntry src)

Copies the specified struct data to this struct.

Parameters
src:VkSpecializationMapEntry

the source struct

Returns:VkSpecializationMapEntry

this struct

sizeback to summary
public long size()

the byte size of the specialization constant value within the supplied data buffer.

Annotations
@NativeType:size_t
sizeback to summary
public VkSpecializationMapEntry size(long value)

Sets the specified value to the size field.

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
org.lwjgl.vulkan back to summary

public Class VkSpecializationMapEntry.Buffer

extends StructBuffer<VkSpecializationMapEntry, VkSpecializationMapEntry.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of VkSpecializationMapEntry structs.

Field Summary

Modifier and TypeField and Description
private static final VkSpecializationMapEntry
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkSpecializationMapEntry.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the VkSpecializationMapEntry#constantID field.
constantID()

public VkSpecializationMapEntry.Buffer
constantID(int value)

Sets the specified value to the VkSpecializationMapEntry#constantID field.

protected VkSpecializationMapEntry
getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

public int

Returns:

the value of the VkSpecializationMapEntry#offset field.
offset()

public VkSpecializationMapEntry.Buffer
offset(int value)

Sets the specified value to the VkSpecializationMapEntry#offset field.

protected VkSpecializationMapEntry.Buffer
self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

public long

Returns:

the value of the VkSpecializationMapEntry#size field.
size()

public VkSpecializationMapEntry.Buffer
size(long value)

Sets the specified value to the VkSpecializationMapEntry#size field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkSpecializationMapEntry ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkSpecializationMapEntry.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkSpecializationMapEntry#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

constantIDback to summary
public int constantID()
Returns:int

the value of the VkSpecializationMapEntry#constantID field.

Annotations
@NativeType:uint32_t
constantIDback to summary
public VkSpecializationMapEntry.Buffer constantID(int value)

Sets the specified value to the VkSpecializationMapEntry#constantID field.

getElementFactoryback to summary
protected VkSpecializationMapEntry getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
offsetback to summary
public int offset()
Returns:int

the value of the VkSpecializationMapEntry#offset field.

Annotations
@NativeType:uint32_t
offsetback to summary
public VkSpecializationMapEntry.Buffer offset(int value)

Sets the specified value to the VkSpecializationMapEntry#offset field.

selfback to summary
protected VkSpecializationMapEntry.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sizeback to summary
public long size()
Returns:long

the value of the VkSpecializationMapEntry#size field.

Annotations
@NativeType:size_t
sizeback to summary
public VkSpecializationMapEntry.Buffer size(long value)

Sets the specified value to the VkSpecializationMapEntry#size field.