Package org.lwjgl.vulkan

Class VkWriteIndirectExecutionSetShaderEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkWriteIndirectExecutionSetShaderEXT>

org.lwjgl.vulkan.VkWriteIndirectExecutionSetShaderEXT

All Implemented Interfaces:

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

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

Struct specifying shader object update information for an indirect execution set.

Description

Shaders need not be stored in the Indirect Execution Set according to their stage. The only restriction for shader indices within a set is that the value of the index must be less than the maximum number of shaders in the set.

Valid Usage

• index must be less than VkIndirectExecutionSetShaderInfoEXT::maxShaderCount
• shader must have been created with SHADER_CREATE_INDIRECT_BINDABLE_BIT_EXT
• A shader created with the same VkShaderStageFlagBits must have been passed in the VkIndirectExecutionSetShaderInfoEXT::pInitialShaders array
• index must not be in use by submitted command buffers

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_WRITE_INDIRECT_EXECUTION_SET_SHADER_EXT
• shader must be a valid VkShaderEXT handle

See Also

UpdateIndirectExecutionSetShaderEXT

Layout

 struct VkWriteIndirectExecutionSetShaderEXT {
     VkStructureType sType();
     void const * pNext();
     uint32_t index();
     VkShaderEXT shader();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkWriteIndirectExecutionSetShaderEXT.Buffer	An array of VkWriteIndirectExecutionSetShaderEXT 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	INDEX	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SHADER	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
VkWriteIndirectExecutionSetShaderEXT(ByteBuffer container)	Creates a VkWriteIndirectExecutionSetShaderEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkWriteIndirectExecutionSetShaderEXT	calloc()	Returns a new VkWriteIndirectExecutionSetShaderEXT instance allocated with memCalloc.
static VkWriteIndirectExecutionSetShaderEXT.Buffer	calloc(int capacity)	Returns a new VkWriteIndirectExecutionSetShaderEXT.Buffer instance allocated with memCalloc.
static VkWriteIndirectExecutionSetShaderEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkWriteIndirectExecutionSetShaderEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkWriteIndirectExecutionSetShaderEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkWriteIndirectExecutionSetShaderEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkWriteIndirectExecutionSetShaderEXT	create()	Returns a new VkWriteIndirectExecutionSetShaderEXT instance allocated with BufferUtils.
static VkWriteIndirectExecutionSetShaderEXT.Buffer	create(int capacity)	Returns a new VkWriteIndirectExecutionSetShaderEXT.Buffer instance allocated with BufferUtils.
static VkWriteIndirectExecutionSetShaderEXT	create(long address)	Returns a new VkWriteIndirectExecutionSetShaderEXT instance for the specified memory address.
static VkWriteIndirectExecutionSetShaderEXT.Buffer	create(long address, int capacity)	Create a VkWriteIndirectExecutionSetShaderEXT.Buffer instance at the specified memory.
static @Nullable VkWriteIndirectExecutionSetShaderEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkWriteIndirectExecutionSetShaderEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	index()	the element of the set to update
VkWriteIndirectExecutionSetShaderEXT	index(int value)	Sets the specified value to the index() field.
static VkWriteIndirectExecutionSetShaderEXT	malloc()	Returns a new VkWriteIndirectExecutionSetShaderEXT instance allocated with memAlloc.
static VkWriteIndirectExecutionSetShaderEXT.Buffer	malloc(int capacity)	Returns a new VkWriteIndirectExecutionSetShaderEXT.Buffer instance allocated with memAlloc.
static VkWriteIndirectExecutionSetShaderEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkWriteIndirectExecutionSetShaderEXT.Buffer instance allocated on the specified MemoryStack.
static VkWriteIndirectExecutionSetShaderEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkWriteIndirectExecutionSetShaderEXT instance allocated on the specified MemoryStack.
static int	nindex(long struct)	Unsafe version of index().
static void	nindex(long struct, int value)	Unsafe version of index.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static long	nshader(long struct)	Unsafe version of shader().
static void	nshader(long struct, long value)	Unsafe version of shader.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkWriteIndirectExecutionSetShaderEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkWriteIndirectExecutionSetShaderEXT	set(int sType, long pNext, int index, long shader)	Initializes this struct with the specified values.
VkWriteIndirectExecutionSetShaderEXT	set(VkWriteIndirectExecutionSetShaderEXT src)	Copies the specified struct data to this struct.
long	shader()	the shader to store in the indirect execution set
VkWriteIndirectExecutionSetShaderEXT	shader(long value)	Sets the specified value to the shader() field.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkWriteIndirectExecutionSetShaderEXT	sType(int value)	Sets the specified value to the sType() field.
VkWriteIndirectExecutionSetShaderEXT	sType$Default()	Sets the STRUCTURE_TYPE_WRITE_INDIRECT_EXECUTION_SET_SHADER_EXT value to the sType() field.

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.

INDEX

public static final int INDEX

The struct member offsets.

SHADER

public static final int SHADER

The struct member offsets.

Constructor Details

VkWriteIndirectExecutionSetShaderEXT

public VkWriteIndirectExecutionSetShaderEXT(ByteBuffer container)

Creates a VkWriteIndirectExecutionSetShaderEXT 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<VkWriteIndirectExecutionSetShaderEXT>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

index

public int index()

the element of the set to update

shader

public long shader()

the shader to store in the indirect execution set

sType

public VkWriteIndirectExecutionSetShaderEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkWriteIndirectExecutionSetShaderEXT sType$Default()

Sets the STRUCTURE_TYPE_WRITE_INDIRECT_EXECUTION_SET_SHADER_EXT value to the sType() field.

pNext

public VkWriteIndirectExecutionSetShaderEXT pNext(long value)

Sets the specified value to the pNext() field.

index

public VkWriteIndirectExecutionSetShaderEXT index(int value)

Sets the specified value to the index() field.

shader

public VkWriteIndirectExecutionSetShaderEXT shader(long value)

Sets the specified value to the shader() field.

set

public VkWriteIndirectExecutionSetShaderEXT set(int sType,
 long pNext,
 int index,
 long shader)

Initializes this struct with the specified values.

set

public VkWriteIndirectExecutionSetShaderEXT set(VkWriteIndirectExecutionSetShaderEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkWriteIndirectExecutionSetShaderEXT malloc()

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

calloc

public static VkWriteIndirectExecutionSetShaderEXT calloc()

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

create

public static VkWriteIndirectExecutionSetShaderEXT create()

Returns a new VkWriteIndirectExecutionSetShaderEXT instance allocated with BufferUtils.

create

public static VkWriteIndirectExecutionSetShaderEXT create(long address)

Returns a new VkWriteIndirectExecutionSetShaderEXT instance for the specified memory address.

createSafe

public static @Nullable VkWriteIndirectExecutionSetShaderEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkWriteIndirectExecutionSetShaderEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkWriteIndirectExecutionSetShaderEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkWriteIndirectExecutionSetShaderEXT.Buffer create(int capacity)

Returns a new VkWriteIndirectExecutionSetShaderEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkWriteIndirectExecutionSetShaderEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkWriteIndirectExecutionSetShaderEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nindex

public static int nindex(long struct)

Unsafe version of index().

nshader

public static long nshader(long struct)

Unsafe version of shader().

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.

nindex

public static void nindex(long struct,
 int value)

Unsafe version of index.

nshader

public static void nshader(long struct,
 long value)

Unsafe version of shader.