Package org.lwjgl.vulkan

Class VkSpecializationMapEntry

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSpecializationMapEntry>

org.lwjgl.vulkan.VkSpecializationMapEntry

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkSpecializationMapEntry
extends Struct<VkSpecializationMapEntry>
implements 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

Layout

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkSpecializationMapEntry.Buffer	An array of VkSpecializationMapEntry structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	CONSTANTID	The struct member offsets.
static final int	OFFSET	The struct member offsets.
static final int	SIZE	The struct member offsets.
static final 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	Description
VkSpecializationMapEntry(ByteBuffer container)	Creates a VkSpecializationMapEntry instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	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.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkSpecializationMapEntry.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSpecializationMapEntry	calloc(MemoryStack stack)	Returns a new VkSpecializationMapEntry instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSpecializationMapEntry	callocStack()	Deprecated.
static VkSpecializationMapEntry.Buffer	callocStack(int capacity)	Deprecated.
static VkSpecializationMapEntry.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkSpecializationMapEntry	callocStack(MemoryStack stack)	Deprecated.
int	constantID()	the ID of the specialization constant in SPIR-V.
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.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkSpecializationMapEntry.Buffer instance allocated on the specified MemoryStack.
static VkSpecializationMapEntry	malloc(MemoryStack stack)	Returns a new VkSpecializationMapEntry instance allocated on the specified MemoryStack.
static VkSpecializationMapEntry	mallocStack()	Deprecated.
static VkSpecializationMapEntry.Buffer	mallocStack(int capacity)	Deprecated.
static VkSpecializationMapEntry.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkSpecializationMapEntry	mallocStack(MemoryStack stack)	Deprecated.
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()	the byte offset of the specialization constant value within the supplied data buffer.
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()	the byte size of the specialization constant value within the supplied data buffer.
VkSpecializationMapEntry	size(long value)	Sets the specified value to the size() field.
int	sizeof()	Returns sizeof(struct).

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

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 Details

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 Details

VkSpecializationMapEntry

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkSpecializationMapEntry>

constantID

public int constantID()

the ID of the specialization constant in SPIR-V.

offset

public int offset()

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

size

public long size()

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

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

@Deprecated
public static VkSpecializationMapEntry mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkSpecializationMapEntry callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkSpecializationMapEntry mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkSpecializationMapEntry callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static VkSpecializationMapEntry.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static VkSpecializationMapEntry.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static VkSpecializationMapEntry.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkSpecializationMapEntry.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static VkSpecializationMapEntry malloc(MemoryStack stack)

Returns a new VkSpecializationMapEntry instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - the buffer capacity

stack - the stack from which to allocate

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.