Package org.lwjgl.vulkan

Class VkSpecializationInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSpecializationInfo>

org.lwjgl.vulkan.VkSpecializationInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkSpecializationInfo
extends Struct<VkSpecializationInfo>
implements NativeResource

 struct VkSpecializationInfo {
     uint32_t mapEntryCount;
     {@link VkSpecializationMapEntry VkSpecializationMapEntry} const * pMapEntries;
     size_t dataSize;
     void const * pData;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkSpecializationInfo.Buffer	An array of VkSpecializationInfo 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	DATASIZE	The struct member offsets.
static final int	MAPENTRYCOUNT	The struct member offsets.
static final int	PDATA	The struct member offsets.
static final int	PMAPENTRIES	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
VkSpecializationInfo(ByteBuffer container)	Creates a VkSpecializationInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	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.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkSpecializationInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSpecializationInfo	calloc(MemoryStack stack)	Returns a new VkSpecializationInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSpecializationInfo	callocStack()	Deprecated.
static VkSpecializationInfo.Buffer	callocStack(int capacity)	Deprecated.
static VkSpecializationInfo.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkSpecializationInfo	callocStack(MemoryStack stack)	Deprecated.
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 @Nullable VkSpecializationInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkSpecializationInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	dataSize()
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.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkSpecializationInfo.Buffer instance allocated on the specified MemoryStack.
static VkSpecializationInfo	malloc(MemoryStack stack)	Returns a new VkSpecializationInfo instance allocated on the specified MemoryStack.
static VkSpecializationInfo	mallocStack()	Deprecated.
static VkSpecializationInfo.Buffer	mallocStack(int capacity)	Deprecated.
static VkSpecializationInfo.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkSpecializationInfo	mallocStack(MemoryStack stack)	Deprecated.
int	mapEntryCount()
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 @Nullable ByteBuffer	npData(long struct)	Unsafe version of pData.
static void	npData(long struct, @Nullable ByteBuffer value)	Unsafe version of pData.
static @Nullable VkSpecializationMapEntry.Buffer	npMapEntries(long struct)	Unsafe version of pMapEntries().
static void	npMapEntries(long struct, @Nullable VkSpecializationMapEntry.Buffer value)	Unsafe version of pMapEntries.
@Nullable ByteBuffer	pData()
VkSpecializationInfo	pData(@Nullable ByteBuffer value)	Sets the address of the specified ByteBuffer to the pData field.
@Nullable VkSpecializationMapEntry.Buffer	pMapEntries()
VkSpecializationInfo	pMapEntries(@Nullable 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(@Nullable VkSpecializationMapEntry.Buffer pMapEntries, @Nullable ByteBuffer pData)	Initializes this struct with the specified values.
int	sizeof()	Returns sizeof(struct).
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, 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.

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 Details

VkSpecializationInfo

public VkSpecializationInfo(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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkSpecializationInfo>

mapEntryCount

public int mapEntryCount()

Returns:

the value of the mapEntryCount field.

pMapEntries

public @Nullable 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

public @Nullable 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 ByteBuffer value)

Sets the address of the specified ByteBuffer to the pData field.

set

public VkSpecializationInfo set(@Nullable VkSpecializationMapEntry.Buffer pMapEntries,
 @Nullable 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

public static @Nullable 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

public static @Nullable VkSpecializationInfo.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkSpecializationInfo mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkSpecializationInfo callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkSpecializationInfo mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkSpecializationInfo callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

malloc

public static VkSpecializationInfo malloc(MemoryStack stack)

Returns a new VkSpecializationInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkSpecializationInfo calloc(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

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkSpecializationInfo.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new VkSpecializationInfo.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

nmapEntryCount

public static int nmapEntryCount(long struct)

Unsafe version of mapEntryCount().

npMapEntries

public static @Nullable VkSpecializationMapEntry.Buffer npMapEntries(long struct)

Unsafe version of pMapEntries().

ndataSize

public static long ndataSize(long struct)

Unsafe version of dataSize().

npData

public static @Nullable 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 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