Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkShaderModuleIdentifierEXT

extends Struct<VkShaderModuleIdentifierEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

A unique identifier for a shader module.
Description

Any returned values beyond the first identifierSize bytes are undefined. Implementations must return an identifierSize greater than 0, and less-or-equal to MAX_SHADER_MODULE_IDENTIFIER_SIZE_EXT.

Two identifiers are considered equal if identifierSize is equal and the first identifierSize bytes of identifier compare equal.

Implementations may return a different identifierSize for different modules. Implementations should ensure that identifierSize is large enough to uniquely define a shader module.

Valid Usage (Implicit)
See Also

GetShaderModuleCreateInfoIdentifierEXT, GetShaderModuleIdentifierEXT

Layout


struct VkShaderModuleIdentifierEXT {
    VkStructureType sType;
    void * pNext;
    uint32_t identifierSize;
    uint8_t identifier[VK_MAX_SHADER_MODULE_IDENTIFIER_SIZE_EXT];
}

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
IDENTIFIER

The struct member offsets.

public static final int
IDENTIFIERSIZE

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkShaderModuleIdentifierEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkShaderModuleIdentifierEXT
calloc()

Returns a new VkShaderModuleIdentifierEXT instance allocated with memCalloc.

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

Returns a new VkShaderModuleIdentifierEXT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkShaderModuleIdentifierEXT instance allocated with BufferUtils.

public static VkShaderModuleIdentifierEXT
create(long address)

Returns a new VkShaderModuleIdentifierEXT instance for the specified memory address.

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

Returns a new VkShaderModuleIdentifierEXT.Buffer instance allocated with BufferUtils.

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

Create a VkShaderModuleIdentifierEXT.Buffer instance at the specified memory.

public static VkShaderModuleIdentifierEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public ByteBuffer
identifier()

a buffer of opaque data specifying an identifier.

public byte
identifier(int index)

a buffer of opaque data specifying an identifier.

public int
identifierSize()

the size, in bytes, of valid data returned in identifier.

public static VkShaderModuleIdentifierEXT
malloc()

Returns a new VkShaderModuleIdentifierEXT instance allocated with memAlloc.

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

Returns a new VkShaderModuleIdentifierEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkShaderModuleIdentifierEXT instance allocated on the specified MemoryStack.

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

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

public static ByteBuffer
nidentifier(long struct)

Unsafe version of identifier.

public static byte
nidentifier(long struct, int index)

Unsafe version of identifier.

public static int
nidentifierSize(long struct)

Unsafe version of identifierSize.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkShaderModuleIdentifierEXT
pNext(long value)

Sets the specified value to the pNext field.

public VkShaderModuleIdentifierEXT
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkShaderModuleIdentifierEXT

Returns:

this struct
set
(VkShaderModuleIdentifierEXT
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).
public int
sType()

a VkStructureType value identifying this structure.

public VkShaderModuleIdentifierEXT
sType(int value)

Sets the specified value to the sType field.

public VkShaderModuleIdentifierEXT
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.

IDENTIFIERback to summary
public static final int IDENTIFIER

The struct member offsets.

IDENTIFIERSIZEback to summary
public static final int IDENTIFIERSIZE

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkShaderModuleIdentifierEXTback to summary
protected VkShaderModuleIdentifierEXT(long address, ByteBuffer container)
VkShaderModuleIdentifierEXTback to summary
public VkShaderModuleIdentifierEXT(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkShaderModuleIdentifierEXT calloc(MemoryStack stack)

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

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

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

Returns a new VkShaderModuleIdentifierEXT instance allocated with BufferUtils.

createback to summary
public static VkShaderModuleIdentifierEXT create(long address)

Returns a new VkShaderModuleIdentifierEXT instance for the specified memory address.

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

Returns a new VkShaderModuleIdentifierEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkShaderModuleIdentifierEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkShaderModuleIdentifierEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
identifierback to summary
public ByteBuffer identifier()

a buffer of opaque data specifying an identifier.

Annotations
@NativeType:uint8_t[VK_MAX_SHADER_MODULE_IDENTIFIER_SIZE_EXT]
identifierback to summary
public byte identifier(int index)

a buffer of opaque data specifying an identifier.

Annotations
@NativeType:uint8_t
identifierSizeback to summary
public int identifierSize()

the size, in bytes, of valid data returned in identifier.

Annotations
@NativeType:uint32_t
mallocback to summary
public static VkShaderModuleIdentifierEXT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkShaderModuleIdentifierEXT malloc(MemoryStack stack)

Returns a new VkShaderModuleIdentifierEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nidentifierback to summary
public static ByteBuffer nidentifier(long struct)

Unsafe version of identifier.

nidentifierback to summary
public static byte nidentifier(long struct, int index)

Unsafe version of identifier.

nidentifierSizeback to summary
public static int nidentifierSize(long struct)

Unsafe version of identifierSize.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void *
pNextback to summary
public VkShaderModuleIdentifierEXT pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkShaderModuleIdentifierEXT set(int sType, long pNext)

Initializes this struct with the specified values.

setback to summary
public VkShaderModuleIdentifierEXT set(VkShaderModuleIdentifierEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkShaderModuleIdentifierEXT

the source struct

Returns:VkShaderModuleIdentifierEXT

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
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkShaderModuleIdentifierEXT sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkShaderModuleIdentifierEXT sType$Default()

Sets the STRUCTURE_TYPE_SHADER_MODULE_IDENTIFIER_EXT value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkShaderModuleIdentifierEXT.Buffer

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

An array of VkShaderModuleIdentifierEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkShaderModuleIdentifierEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkShaderModuleIdentifierEXT.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
protected VkShaderModuleIdentifierEXT
public ByteBuffer
public byte

Returns:

the value at the specified index of the VkShaderModuleIdentifierEXT#identifier field.
identifier
(int index)

public int
public long

Returns:

the value of the VkShaderModuleIdentifierEXT#pNext field.
pNext
()

public VkShaderModuleIdentifierEXT.Buffer
pNext(long value)

Sets the specified value to the VkShaderModuleIdentifierEXT#pNext field.

protected VkShaderModuleIdentifierEXT.Buffer
public int

Returns:

the value of the VkShaderModuleIdentifierEXT#sType field.
sType
()

public VkShaderModuleIdentifierEXT.Buffer
sType(int value)

Sets the specified value to the VkShaderModuleIdentifierEXT#sType field.

public VkShaderModuleIdentifierEXT.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkShaderModuleIdentifierEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

getElementFactoryback to summary
protected VkShaderModuleIdentifierEXT getElementFactory()

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

Annotations
@Override
identifierback to summary
public ByteBuffer identifier()
Returns:ByteBuffer

a ByteBuffer view of the VkShaderModuleIdentifierEXT#identifier field.

Annotations
@NativeType:uint8_t[VK_MAX_SHADER_MODULE_IDENTIFIER_SIZE_EXT]
identifierback to summary
public byte identifier(int index)
Returns:byte

the value at the specified index of the VkShaderModuleIdentifierEXT#identifier field.

Annotations
@NativeType:uint8_t
identifierSizeback to summary
public int identifierSize()
Returns:int

the value of the VkShaderModuleIdentifierEXT#identifierSize field.

Annotations
@NativeType:uint32_t
pNextback to summary
public long pNext()
Returns:long

the value of the VkShaderModuleIdentifierEXT#pNext field.

Annotations
@NativeType:void *
pNextback to summary
public VkShaderModuleIdentifierEXT.Buffer pNext(long value)

Sets the specified value to the VkShaderModuleIdentifierEXT#pNext field.

selfback to summary
protected VkShaderModuleIdentifierEXT.Buffer self()

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

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkShaderModuleIdentifierEXT#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkShaderModuleIdentifierEXT.Buffer sType(int value)

Sets the specified value to the VkShaderModuleIdentifierEXT#sType field.

sType$Defaultback to summary
public VkShaderModuleIdentifierEXT.Buffer sType$Default()

Sets the STRUCTURE_TYPE_SHADER_MODULE_IDENTIFIER_EXT value to the VkShaderModuleIdentifierEXT#sType field.