Package org.lwjgl.vulkan

Class VkPipelineShaderStageModuleIdentifierCreateInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPipelineShaderStageModuleIdentifierCreateInfoEXT>

org.lwjgl.vulkan.VkPipelineShaderStageModuleIdentifierCreateInfoEXT

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkPipelineShaderStageModuleIdentifierCreateInfoEXT
extends org.lwjgl.system.Struct<VkPipelineShaderStageModuleIdentifierCreateInfoEXT>
implements org.lwjgl.system.NativeResource

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

• If this structure is included in a pNext chain and identifierSize is not equal to 0, the shaderModuleIdentifier feature must be enabled
• If this struct is included in a pNext chain of VkPipelineShaderStageCreateInfo and identifierSize is not equal to 0, the pipeline must be created with the PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT flag set
• identifierSize must be less-or-equal to MAX_SHADER_MODULE_IDENTIFIER_SIZE_EXT

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_MODULE_IDENTIFIER_CREATE_INFO_EXT
• If identifierSize is not 0, pIdentifier must be a valid pointer to an array of identifierSize uint8_t values

Layout

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

Nested Class Summary

Nested Classes

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

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

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	IDENTIFIERSIZE	The struct member offsets.
static final int	PIDENTIFIER	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkPipelineShaderStageModuleIdentifierCreateInfoEXT(ByteBuffer container)	Creates a VkPipelineShaderStageModuleIdentifierCreateInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPipelineShaderStageModuleIdentifierCreateInfoEXT	calloc()	Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT instance allocated with memCalloc.
static VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer	calloc(int capacity)	Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer instance allocated with memCalloc.
static VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineShaderStageModuleIdentifierCreateInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineShaderStageModuleIdentifierCreateInfoEXT	create()	Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT instance allocated with BufferUtils.
static VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer	create(int capacity)	Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer instance allocated with BufferUtils.
static VkPipelineShaderStageModuleIdentifierCreateInfoEXT	create(long address)	Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT instance for the specified memory address.
static VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer	create(long address, int capacity)	Create a VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer instance at the specified memory.
static @Nullable VkPipelineShaderStageModuleIdentifierCreateInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	identifierSize()	the size, in bytes, of the buffer pointed to by pIdentifier.
static VkPipelineShaderStageModuleIdentifierCreateInfoEXT	malloc()	Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT instance allocated with memAlloc.
static VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer	malloc(int capacity)	Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer instance allocated with memAlloc.
static VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkPipelineShaderStageModuleIdentifierCreateInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT instance allocated on the specified MemoryStack.
static int	nidentifierSize(long struct)	Unsafe version of identifierSize().
static void	nidentifierSize(long struct, int value)	Sets the specified value to the identifierSize field of the specified struct.
static @Nullable ByteBuffer	npIdentifier(long struct)	Unsafe version of pIdentifier.
static void	npIdentifier(long struct, @Nullable ByteBuffer value)	Unsafe version of pIdentifier.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
@Nullable ByteBuffer	pIdentifier()	a pointer to a buffer of opaque data specifying an identifier.
VkPipelineShaderStageModuleIdentifierCreateInfoEXT	pIdentifier(@Nullable ByteBuffer value)	Sets the address of the specified ByteBuffer to the pIdentifier() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkPipelineShaderStageModuleIdentifierCreateInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkPipelineShaderStageModuleIdentifierCreateInfoEXT	set(int sType, long pNext, @Nullable ByteBuffer pIdentifier)	Initializes this struct with the specified values.
VkPipelineShaderStageModuleIdentifierCreateInfoEXT	set(VkPipelineShaderStageModuleIdentifierCreateInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPipelineShaderStageModuleIdentifierCreateInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkPipelineShaderStageModuleIdentifierCreateInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_MODULE_IDENTIFIER_CREATE_INFO_EXT value to the sType() field.
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.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

IDENTIFIERSIZE

public static final int IDENTIFIERSIZE

The struct member offsets.

PIDENTIFIER

public static final int PIDENTIFIER

The struct member offsets.

Constructor Details

VkPipelineShaderStageModuleIdentifierCreateInfoEXT

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkPipelineShaderStageModuleIdentifierCreateInfoEXT>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

identifierSize

public int identifierSize()

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

pIdentifier

public @Nullable ByteBuffer pIdentifier()

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

sType

public VkPipelineShaderStageModuleIdentifierCreateInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPipelineShaderStageModuleIdentifierCreateInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_MODULE_IDENTIFIER_CREATE_INFO_EXT value to the sType() field.

pNext

public VkPipelineShaderStageModuleIdentifierCreateInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

pIdentifier

public VkPipelineShaderStageModuleIdentifierCreateInfoEXT pIdentifier(@Nullable ByteBuffer value)

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

set

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

Initializes this struct with the specified values.

set

public VkPipelineShaderStageModuleIdentifierCreateInfoEXT set(VkPipelineShaderStageModuleIdentifierCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPipelineShaderStageModuleIdentifierCreateInfoEXT malloc()

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

calloc

public static VkPipelineShaderStageModuleIdentifierCreateInfoEXT calloc()

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

create

public static VkPipelineShaderStageModuleIdentifierCreateInfoEXT create()

Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT instance allocated with BufferUtils.

create

public static VkPipelineShaderStageModuleIdentifierCreateInfoEXT create(long address)

Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkPipelineShaderStageModuleIdentifierCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer create(int capacity)

Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkPipelineShaderStageModuleIdentifierCreateInfoEXT malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkPipelineShaderStageModuleIdentifierCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkPipelineShaderStageModuleIdentifierCreateInfoEXT calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkPipelineShaderStageModuleIdentifierCreateInfoEXT.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nidentifierSize

public static int nidentifierSize(long struct)

Unsafe version of identifierSize().

npIdentifier

public static @Nullable ByteBuffer npIdentifier(long struct)

Unsafe version of pIdentifier.

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

nidentifierSize

public static void nidentifierSize(long struct,
 int value)

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

npIdentifier

public static void npIdentifier(long struct,
 @Nullable ByteBuffer value)

Unsafe version of pIdentifier.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate