Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPipelineShaderStageNodeCreateInfoAMDX

extends Struct<VkPipelineShaderStageNodeCreateInfoAMDX>
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 the shader name and index with an execution graph.
Description

When included in the pNext chain of a VkPipelineShaderStageCreateInfo structure, this structure specifies the shader name and shader index of a node when creating an execution graph pipeline. If this structure is omitted, the shader name is set to the name of the entry point in SPIR-V and the shader index is set to 0.

When dispatching a node from another shader, the name is fixed at pipeline creation, but the index can be set dynamically. By associating multiple shaders with the same name but different indexes, applications can dynamically select different nodes to execute. Applications must ensure each node has a unique name and index.

Valid Usage (Implicit)
See Also

GetExecutionGraphPipelineNodeIndexAMDX

Layout


struct VkPipelineShaderStageNodeCreateInfoAMDX {
    VkStructureType sType;
    void const * pNext;
    char const * pName;
    uint32_t index;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkPipelineShaderStageNodeCreateInfoAMDX.Buffer

An array of VkPipelineShaderStageNodeCreateInfoAMDX structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
INDEX

The struct member offsets.

public static final int
PNAME

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

public
VkPipelineShaderStageNodeCreateInfoAMDX(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkPipelineShaderStageNodeCreateInfoAMDX
calloc()

Returns a new VkPipelineShaderStageNodeCreateInfoAMDX instance allocated with memCalloc.

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

Returns a new VkPipelineShaderStageNodeCreateInfoAMDX.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkPipelineShaderStageNodeCreateInfoAMDX instance allocated with BufferUtils.

public static VkPipelineShaderStageNodeCreateInfoAMDX
create(long address)

Returns a new VkPipelineShaderStageNodeCreateInfoAMDX instance for the specified memory address.

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

Returns a new VkPipelineShaderStageNodeCreateInfoAMDX.Buffer instance allocated with BufferUtils.

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

Create a VkPipelineShaderStageNodeCreateInfoAMDX.Buffer instance at the specified memory.

public static VkPipelineShaderStageNodeCreateInfoAMDX
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
index()

the shader index to use when creating a node in an execution graph.

public VkPipelineShaderStageNodeCreateInfoAMDX
index(int value)

Sets the specified value to the index field.

public static VkPipelineShaderStageNodeCreateInfoAMDX
malloc()

Returns a new VkPipelineShaderStageNodeCreateInfoAMDX instance allocated with memAlloc.

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

Returns a new VkPipelineShaderStageNodeCreateInfoAMDX.Buffer instance allocated with memAlloc.

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

Returns a new VkPipelineShaderStageNodeCreateInfoAMDX instance allocated on the specified MemoryStack.

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

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

public static int
nindex(long struct)

Unsafe version of index.

public static void
nindex(long struct, int value)

Unsafe version of index.

public static ByteBuffer
npName(long struct)

Unsafe version of pName.

public static void
npName(long struct, ByteBuffer value)

Unsafe version of pName.

public static String
npNameString(long struct)

Unsafe version of pNameString.

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
pName()

the shader name to use when creating a node in an execution graph.

public VkPipelineShaderStageNodeCreateInfoAMDX
pName(ByteBuffer value)

Sets the address of the specified encoded string to the pName field.

public String
pNameString()

the shader name to use when creating a node in an execution graph.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkPipelineShaderStageNodeCreateInfoAMDX
pNext(long value)

Sets the specified value to the pNext field.

public VkPipelineShaderStageNodeCreateInfoAMDX
set(int sType, long pNext, ByteBuffer pName, int index)

Initializes this struct with the specified values.

public VkPipelineShaderStageNodeCreateInfoAMDX

Returns:

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

Sets the specified value to the sType field.

public VkPipelineShaderStageNodeCreateInfoAMDX
sType$Default()

Sets the STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_NODE_CREATE_INFO_AMDX value to the sType field.

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.

INDEXback to summary
public static final int INDEX

The struct member offsets.

PNAMEback to summary
public static final int PNAME

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

VkPipelineShaderStageNodeCreateInfoAMDXback to summary
protected VkPipelineShaderStageNodeCreateInfoAMDX(long address, ByteBuffer container)
VkPipelineShaderStageNodeCreateInfoAMDXback to summary
public VkPipelineShaderStageNodeCreateInfoAMDX(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkPipelineShaderStageNodeCreateInfoAMDX calloc(MemoryStack stack)

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

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

Returns a new VkPipelineShaderStageNodeCreateInfoAMDX instance allocated with BufferUtils.

createback to summary
public static VkPipelineShaderStageNodeCreateInfoAMDX create(long address)

Returns a new VkPipelineShaderStageNodeCreateInfoAMDX instance for the specified memory address.

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

Returns a new VkPipelineShaderStageNodeCreateInfoAMDX.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkPipelineShaderStageNodeCreateInfoAMDX.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPipelineShaderStageNodeCreateInfoAMDX createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
indexback to summary
public int index()

the shader index to use when creating a node in an execution graph. If index is SHADER_INDEX_UNUSED_AMDX then the original index is used, either as specified by the ShaderIndexAMDX execution mode, or 0 if that too is not specified.

Annotations
@NativeType:uint32_t
indexback to summary
public VkPipelineShaderStageNodeCreateInfoAMDX index(int value)

Sets the specified value to the index field.

mallocback to summary
public static VkPipelineShaderStageNodeCreateInfoAMDX malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPipelineShaderStageNodeCreateInfoAMDX malloc(MemoryStack stack)

Returns a new VkPipelineShaderStageNodeCreateInfoAMDX instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nindexback to summary
public static int nindex(long struct)

Unsafe version of index.

nindexback to summary
public static void nindex(long struct, int value)

Unsafe version of index.

npNameback to summary
public static ByteBuffer npName(long struct)

Unsafe version of pName.

Annotations
@Nullable
npNameback to summary
public static void npName(long struct, ByteBuffer value)

Unsafe version of pName.

npNameStringback to summary
public static String npNameString(long struct)

Unsafe version of pNameString.

Annotations
@Nullable
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.

pNameback to summary
public ByteBuffer pName()

the shader name to use when creating a node in an execution graph. If pName is NULL, the name of the entry point specified in SPIR-V is used as the shader name.

Annotations
@Nullable
@NativeType:char const *
pNameback to summary
public VkPipelineShaderStageNodeCreateInfoAMDX pName(ByteBuffer value)

Sets the address of the specified encoded string to the pName field.

pNameStringback to summary
public String pNameString()

the shader name to use when creating a node in an execution graph. If pName is NULL, the name of the entry point specified in SPIR-V is used as the shader name.

Annotations
@Nullable
@NativeType:char const *
pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkPipelineShaderStageNodeCreateInfoAMDX set(int sType, long pNext, ByteBuffer pName, int index)

Initializes this struct with the specified values.

setback to summary
public VkPipelineShaderStageNodeCreateInfoAMDX set(VkPipelineShaderStageNodeCreateInfoAMDX src)

Copies the specified struct data to this struct.

Parameters
src:VkPipelineShaderStageNodeCreateInfoAMDX

the source struct

Returns:VkPipelineShaderStageNodeCreateInfoAMDX

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_NODE_CREATE_INFO_AMDX value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkPipelineShaderStageNodeCreateInfoAMDX.Buffer

extends StructBuffer<VkPipelineShaderStageNodeCreateInfoAMDX, VkPipelineShaderStageNodeCreateInfoAMDX.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of VkPipelineShaderStageNodeCreateInfoAMDX structs.

Field Summary

Modifier and TypeField and Description
private static final VkPipelineShaderStageNodeCreateInfoAMDX
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

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

public int

Returns:

the value of the VkPipelineShaderStageNodeCreateInfoAMDX#index field.
index()

public VkPipelineShaderStageNodeCreateInfoAMDX.Buffer
index(int value)

Sets the specified value to the VkPipelineShaderStageNodeCreateInfoAMDX#index field.

public ByteBuffer

Returns:

a ByteBuffer view of the null-terminated string pointed to by the VkPipelineShaderStageNodeCreateInfoAMDX#pName field.
pName()

public VkPipelineShaderStageNodeCreateInfoAMDX.Buffer
pName(ByteBuffer value)

Sets the address of the specified encoded string to the VkPipelineShaderStageNodeCreateInfoAMDX#pName field.

public String

Returns:

the null-terminated string pointed to by the VkPipelineShaderStageNodeCreateInfoAMDX#pName field.
pNameString()

public long

Returns:

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

public VkPipelineShaderStageNodeCreateInfoAMDX.Buffer
pNext(long value)

Sets the specified value to the VkPipelineShaderStageNodeCreateInfoAMDX#pNext field.

protected VkPipelineShaderStageNodeCreateInfoAMDX.Buffer
self()

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

public int

Returns:

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

public VkPipelineShaderStageNodeCreateInfoAMDX.Buffer
sType(int value)

Sets the specified value to the VkPipelineShaderStageNodeCreateInfoAMDX#sType field.

public VkPipelineShaderStageNodeCreateInfoAMDX.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_NODE_CREATE_INFO_AMDX value to the VkPipelineShaderStageNodeCreateInfoAMDX#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPipelineShaderStageNodeCreateInfoAMDX ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
indexback to summary
public int index()
Returns:int

the value of the VkPipelineShaderStageNodeCreateInfoAMDX#index field.

Annotations
@NativeType:uint32_t
indexback to summary
public VkPipelineShaderStageNodeCreateInfoAMDX.Buffer index(int value)

Sets the specified value to the VkPipelineShaderStageNodeCreateInfoAMDX#index field.

pNameback to summary
public ByteBuffer pName()
Returns:ByteBuffer

a ByteBuffer view of the null-terminated string pointed to by the VkPipelineShaderStageNodeCreateInfoAMDX#pName field.

Annotations
@Nullable
@NativeType:char const *
pNameback to summary
public VkPipelineShaderStageNodeCreateInfoAMDX.Buffer pName(ByteBuffer value)

Sets the address of the specified encoded string to the VkPipelineShaderStageNodeCreateInfoAMDX#pName field.

pNameStringback to summary
public String pNameString()
Returns:String

the null-terminated string pointed to by the VkPipelineShaderStageNodeCreateInfoAMDX#pName field.

Annotations
@Nullable
@NativeType:char const *
pNextback to summary
public long pNext()
Returns:long

the value of the VkPipelineShaderStageNodeCreateInfoAMDX#pNext field.

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

Sets the specified value to the VkPipelineShaderStageNodeCreateInfoAMDX#pNext field.

selfback to summary
protected VkPipelineShaderStageNodeCreateInfoAMDX.Buffer self()

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

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

the value of the VkPipelineShaderStageNodeCreateInfoAMDX#sType field.

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

Sets the specified value to the VkPipelineShaderStageNodeCreateInfoAMDX#sType field.

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

Sets the STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_NODE_CREATE_INFO_AMDX value to the VkPipelineShaderStageNodeCreateInfoAMDX#sType field.