Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPipelineShaderStageModuleIdentifierCreateInfoEXT

extends Struct<VkPipelineShaderStageModuleIdentifierCreateInfoEXT>
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 an identifier for a shader module.
Description

Any identifier can be used. If the pipeline being created with identifier requires compilation to complete the pipeline creation call, pipeline compilation must fail as defined by PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT.

pIdentifier and identifierSize can be obtained from an VkShaderModuleIdentifierEXT queried earlier.

Valid Usage
Valid Usage (Implicit)

Layout


struct VkPipelineShaderStageModuleIdentifierCreateInfoEXT {
    VkStructureType sType;
    void const * pNext;
    uint32_t identifierSize;
    uint8_t const * pIdentifier;
}

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
IDENTIFIERSIZE

The struct member offsets.

public static final int
PIDENTIFIER

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
public
VkPipelineShaderStageModuleIdentifierCreateInfoEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkPipelineShaderStageModuleIdentifierCreateInfoEXT
calloc()

Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT instance allocated with memCalloc.

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

Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT instance allocated with BufferUtils.

public static VkPipelineShaderStageModuleIdentifierCreateInfoEXT
create(long address)

Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT instance for the specified memory address.

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

Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer instance allocated with BufferUtils.

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

Create a VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer instance at the specified memory.

public static VkPipelineShaderStageModuleIdentifierCreateInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
identifierSize()

the size, in bytes, of the buffer pointed to by pIdentifier.

public static VkPipelineShaderStageModuleIdentifierCreateInfoEXT
malloc()

Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT instance allocated with memAlloc.

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

Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT instance allocated on the specified MemoryStack.

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

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

public static int
nidentifierSize(long struct)

Unsafe version of identifierSize.

public static void
nidentifierSize(long struct, int value)

Sets the specified value to the identifierSize field of the specified struct.

public static ByteBuffer
npIdentifier(long struct)

Unsafe version of pIdentifier.

public static void
npIdentifier(long struct, ByteBuffer value)

Unsafe version of pIdentifier.

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 ByteBuffer
pIdentifier()

a pointer to a buffer of opaque data specifying an identifier.

public VkPipelineShaderStageModuleIdentifierCreateInfoEXT
pIdentifier(ByteBuffer value)

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

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkPipelineShaderStageModuleIdentifierCreateInfoEXT
pNext(long value)

Sets the specified value to the pNext field.

public VkPipelineShaderStageModuleIdentifierCreateInfoEXT
set(int sType, long pNext, ByteBuffer pIdentifier)

Initializes this struct with the specified values.

public VkPipelineShaderStageModuleIdentifierCreateInfoEXT

Returns:

this struct
set
(VkPipelineShaderStageModuleIdentifierCreateInfoEXT
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 VkPipelineShaderStageModuleIdentifierCreateInfoEXT
sType(int value)

Sets the specified value to the sType field.

public VkPipelineShaderStageModuleIdentifierCreateInfoEXT
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

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.

IDENTIFIERSIZEback to summary
public static final int IDENTIFIERSIZE

The struct member offsets.

PIDENTIFIERback to summary
public static final int PIDENTIFIER

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

VkPipelineShaderStageModuleIdentifierCreateInfoEXTback to summary
protected VkPipelineShaderStageModuleIdentifierCreateInfoEXT(long address, ByteBuffer container)
VkPipelineShaderStageModuleIdentifierCreateInfoEXTback to summary
public VkPipelineShaderStageModuleIdentifierCreateInfoEXT(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkPipelineShaderStageModuleIdentifierCreateInfoEXT calloc(MemoryStack stack)

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

Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT.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 VkPipelineShaderStageModuleIdentifierCreateInfoEXT 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 VkPipelineShaderStageModuleIdentifierCreateInfoEXT create()

Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkPipelineShaderStageModuleIdentifierCreateInfoEXT create(long address)

Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT instance for the specified memory address.

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

Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPipelineShaderStageModuleIdentifierCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
identifierSizeback to summary
public int identifierSize()

the size, in bytes, of the buffer pointed to by pIdentifier.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPipelineShaderStageModuleIdentifierCreateInfoEXT malloc(MemoryStack stack)

Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nidentifierSizeback to summary
public static int nidentifierSize(long struct)

Unsafe version of identifierSize.

nidentifierSizeback to summary
public static void nidentifierSize(long struct, int value)

Sets the specified value to the identifierSize field of the specified struct.

npIdentifierback to summary
public static ByteBuffer npIdentifier(long struct)

Unsafe version of pIdentifier.

Annotations
@Nullable
npIdentifierback to summary
public static void npIdentifier(long struct, ByteBuffer value)

Unsafe version of pIdentifier.

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.

pIdentifierback to summary
public ByteBuffer pIdentifier()

a pointer to a buffer of opaque data specifying an identifier.

Annotations
@Nullable
@NativeType:uint8_t const *
pIdentifierback to summary
public VkPipelineShaderStageModuleIdentifierCreateInfoEXT pIdentifier(ByteBuffer value)

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

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkPipelineShaderStageModuleIdentifierCreateInfoEXT set(int sType, long pNext, ByteBuffer pIdentifier)

Initializes this struct with the specified values.

setback to summary
public VkPipelineShaderStageModuleIdentifierCreateInfoEXT set(VkPipelineShaderStageModuleIdentifierCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkPipelineShaderStageModuleIdentifierCreateInfoEXT

the source struct

Returns:VkPipelineShaderStageModuleIdentifierCreateInfoEXT

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 VkPipelineShaderStageModuleIdentifierCreateInfoEXT sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_MODULE_IDENTIFIER_CREATE_INFO_EXT value to the sType field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer

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

An array of VkPipelineShaderStageModuleIdentifierCreateInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkPipelineShaderStageModuleIdentifierCreateInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT.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 VkPipelineShaderStageModuleIdentifierCreateInfoEXT
public int
public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the VkPipelineShaderStageModuleIdentifierCreateInfoEXT#pIdentifier field.
pIdentifier
()

public VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer
public long
public VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkPipelineShaderStageModuleIdentifierCreateInfoEXT#pNext field.

protected VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer
public int
public VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkPipelineShaderStageModuleIdentifierCreateInfoEXT#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPipelineShaderStageModuleIdentifierCreateInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT.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 VkPipelineShaderStageModuleIdentifierCreateInfoEXT#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 VkPipelineShaderStageModuleIdentifierCreateInfoEXT getElementFactory()

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

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

the value of the VkPipelineShaderStageModuleIdentifierCreateInfoEXT#identifierSize field.

Annotations
@NativeType:uint32_t
pIdentifierback to summary
public ByteBuffer pIdentifier()
Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the VkPipelineShaderStageModuleIdentifierCreateInfoEXT#pIdentifier field.

Annotations
@Nullable
@NativeType:uint8_t const *
pIdentifierback to summary
public VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer pIdentifier(ByteBuffer value)

Sets the address of the specified ByteBuffer to the VkPipelineShaderStageModuleIdentifierCreateInfoEXT#pIdentifier field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkPipelineShaderStageModuleIdentifierCreateInfoEXT#pNext field.

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

Sets the specified value to the VkPipelineShaderStageModuleIdentifierCreateInfoEXT#pNext field.

selfback to summary
protected VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer self()

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

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

the value of the VkPipelineShaderStageModuleIdentifierCreateInfoEXT#sType field.

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

Sets the specified value to the VkPipelineShaderStageModuleIdentifierCreateInfoEXT#sType field.

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

Sets the STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_MODULE_IDENTIFIER_CREATE_INFO_EXT value to the VkPipelineShaderStageModuleIdentifierCreateInfoEXT#sType field.