Top Description Inners Fields Constructors Methods
org.lwjgl.util.spvc

public Class SpvcSpecializationConstant

extends Struct<SpvcSpecializationConstant>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct spvc_specialization_constant
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Layout


struct spvc_specialization_constant {
    spvc_constant_id id;
    unsigned int constant_id;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CONSTANT_ID

The struct member offsets.

public static final int
ID

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
SpvcSpecializationConstant(long address, ByteBuffer container)

public
SpvcSpecializationConstant(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static SpvcSpecializationConstant
calloc()

Returns a new SpvcSpecializationConstant instance allocated with memCalloc.

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

Returns a new SpvcSpecializationConstant.Buffer instance allocated with memCalloc.

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

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

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

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

public int
constant_id()

the constant ID of the constant, used in Vulkan during pipeline creation

public SpvcSpecializationConstant
constant_id(int value)

Sets the specified value to the constant_id field.

protected SpvcSpecializationConstant
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 SpvcSpecializationConstant
create()

Returns a new SpvcSpecializationConstant instance allocated with BufferUtils.

public static SpvcSpecializationConstant
create(long address)

Returns a new SpvcSpecializationConstant instance for the specified memory address.

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

Returns a new SpvcSpecializationConstant.Buffer instance allocated with BufferUtils.

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

Create a SpvcSpecializationConstant.Buffer instance at the specified memory.

public static SpvcSpecializationConstant
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
id()

the ID of the specialization constant

public SpvcSpecializationConstant
id(int value)

Sets the specified value to the id field.

public static SpvcSpecializationConstant
malloc()

Returns a new SpvcSpecializationConstant instance allocated with memAlloc.

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

Returns a new SpvcSpecializationConstant.Buffer instance allocated with memAlloc.

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

Returns a new SpvcSpecializationConstant instance allocated on the specified MemoryStack.

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

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

public static int
nconstant_id(long struct)

Unsafe version of constant_id.

public static void
nconstant_id(long struct, int value)

Unsafe version of constant_id.

public static int
nid(long struct)

Unsafe version of id.

public static void
nid(long struct, int value)

Unsafe version of id.

public SpvcSpecializationConstant
set(int id, int constant_id)

Initializes this struct with the specified values.

public SpvcSpecializationConstant

Returns:

this struct
set
(SpvcSpecializationConstant
the source struct
src
)

Copies the specified struct data to this struct.

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.

CONSTANT_IDback to summary
public static final int CONSTANT_ID

The struct member offsets.

IDback to summary
public static final int ID

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

SpvcSpecializationConstantback to summary
protected SpvcSpecializationConstant(long address, ByteBuffer container)
SpvcSpecializationConstantback to summary
public SpvcSpecializationConstant(ByteBuffer container)

Creates a SpvcSpecializationConstant 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 SpvcSpecializationConstant calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static SpvcSpecializationConstant calloc(MemoryStack stack)

Returns a new SpvcSpecializationConstant 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 SpvcSpecializationConstant.Buffer calloc(int capacity, MemoryStack stack)

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

constant_idback to summary
public int constant_id()

the constant ID of the constant, used in Vulkan during pipeline creation

Annotations
@NativeType:unsigned int
constant_idback to summary
public SpvcSpecializationConstant constant_id(int value)

Sets the specified value to the constant_id field.

createback to summary
protected SpvcSpecializationConstant 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 SpvcSpecializationConstant create()

Returns a new SpvcSpecializationConstant instance allocated with BufferUtils.

createback to summary
public static SpvcSpecializationConstant create(long address)

Returns a new SpvcSpecializationConstant instance for the specified memory address.

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

Returns a new SpvcSpecializationConstant.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a SpvcSpecializationConstant.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static SpvcSpecializationConstant createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
idback to summary
public int id()

the ID of the specialization constant

Annotations
@NativeType:spvc_constant_id
idback to summary
public SpvcSpecializationConstant id(int value)

Sets the specified value to the id field.

mallocback to summary
public static SpvcSpecializationConstant malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static SpvcSpecializationConstant malloc(MemoryStack stack)

Returns a new SpvcSpecializationConstant instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nconstant_idback to summary
public static int nconstant_id(long struct)

Unsafe version of constant_id.

nconstant_idback to summary
public static void nconstant_id(long struct, int value)

Unsafe version of constant_id.

nidback to summary
public static int nid(long struct)

Unsafe version of id.

nidback to summary
public static void nid(long struct, int value)

Unsafe version of id.

setback to summary
public SpvcSpecializationConstant set(int id, int constant_id)

Initializes this struct with the specified values.

setback to summary
public SpvcSpecializationConstant set(SpvcSpecializationConstant src)

Copies the specified struct data to this struct.

Parameters
src:SpvcSpecializationConstant

the source struct

Returns:SpvcSpecializationConstant

this struct

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.util.spvc back to summary

public Class SpvcSpecializationConstant.Buffer

extends StructBuffer<SpvcSpecializationConstant, SpvcSpecializationConstant.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of SpvcSpecializationConstant structs.

Field Summary

Modifier and TypeField and Description
private static final SpvcSpecializationConstant

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new SpvcSpecializationConstant.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 SpvcSpecializationConstant#constant_id field.
constant_id
()

public SpvcSpecializationConstant.Buffer
constant_id(int value)

Sets the specified value to the SpvcSpecializationConstant#constant_id field.

protected SpvcSpecializationConstant
public int

Returns:

the value of the SpvcSpecializationConstant#id field.
id
()

public SpvcSpecializationConstant.Buffer
id(int value)

Sets the specified value to the SpvcSpecializationConstant#id field.

protected SpvcSpecializationConstant.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final SpvcSpecializationConstant ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new SpvcSpecializationConstant.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 SpvcSpecializationConstant#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

constant_idback to summary
public int constant_id()
Returns:int

the value of the SpvcSpecializationConstant#constant_id field.

Annotations
@NativeType:unsigned int
constant_idback to summary
public SpvcSpecializationConstant.Buffer constant_id(int value)

Sets the specified value to the SpvcSpecializationConstant#constant_id field.

getElementFactoryback to summary
protected SpvcSpecializationConstant getElementFactory()

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

Annotations
@Override
idback to summary
public int id()
Returns:int

the value of the SpvcSpecializationConstant#id field.

Annotations
@NativeType:spvc_constant_id
idback to summary
public SpvcSpecializationConstant.Buffer id(int value)

Sets the specified value to the SpvcSpecializationConstant#id field.

selfback to summary
protected SpvcSpecializationConstant.Buffer self()

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

Annotations
@Override