Package org.lwjgl.vulkan

Class VkPipelineCreationFeedbackCreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPipelineCreationFeedbackCreateInfo>

org.lwjgl.vulkan.VkPipelineCreationFeedbackCreateInfo

All Implemented Interfaces:

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

Direct Known Subclasses:

VkPipelineCreationFeedbackCreateInfoEXT

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

Request for feedback about the creation of a pipeline.

Description

An implementation should write pipeline creation feedback to pPipelineCreationFeedback and may write pipeline stage creation feedback to pPipelineStageCreationFeedbacks. An implementation must set or clear the PIPELINE_CREATION_FEEDBACK_VALID_BIT in VkPipelineCreationFeedback::flags for pPipelineCreationFeedback and every element of pPipelineStageCreationFeedbacks.

Note

One common scenario for an implementation to skip per-stage feedback is when PIPELINE_CREATION_FEEDBACK_APPLICATION_PIPELINE_CACHE_HIT_BIT is set in pPipelineCreationFeedback.

When chained to VkRayTracingPipelineCreateInfoKHR, VkRayTracingPipelineCreateInfoNV, or VkGraphicsPipelineCreateInfo, the i element of pPipelineStageCreationFeedbacks corresponds to the i element of VkRayTracingPipelineCreateInfoKHR::pStages, VkRayTracingPipelineCreateInfoNV::pStages, or VkGraphicsPipelineCreateInfo::pStages. When chained to VkComputePipelineCreateInfo, the first element of pPipelineStageCreationFeedbacks corresponds to VkComputePipelineCreateInfo::stage.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_CREATION_FEEDBACK_CREATE_INFO
• pPipelineCreationFeedback must be a valid pointer to a VkPipelineCreationFeedback structure
• If pipelineStageCreationFeedbackCount is not 0, pPipelineStageCreationFeedbacks must be a valid pointer to an array of pipelineStageCreationFeedbackCount VkPipelineCreationFeedback structures

See Also

VkComputePipelineCreateInfo, VkGraphicsPipelineCreateInfo, VkPipelineCreationFeedback, VkRayTracingPipelineCreateInfoKHR, VkRayTracingPipelineCreateInfoNV

Layout

 struct VkPipelineCreationFeedbackCreateInfo {
     VkStructureType sType();
     void const * pNext();
     VkPipelineCreationFeedback * pPipelineCreationFeedback();
     uint32_t pipelineStageCreationFeedbackCount();
     VkPipelineCreationFeedback * pPipelineStageCreationFeedbacks();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkPipelineCreationFeedbackCreateInfo	calloc()	Returns a new VkPipelineCreationFeedbackCreateInfo instance allocated with memCalloc.
static VkPipelineCreationFeedbackCreateInfo.Buffer	calloc(int capacity)	Returns a new VkPipelineCreationFeedbackCreateInfo.Buffer instance allocated with memCalloc.
static VkPipelineCreationFeedbackCreateInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineCreationFeedbackCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineCreationFeedbackCreateInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineCreationFeedbackCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineCreationFeedbackCreateInfo	create()	Returns a new VkPipelineCreationFeedbackCreateInfo instance allocated with BufferUtils.
static VkPipelineCreationFeedbackCreateInfo.Buffer	create(int capacity)	Returns a new VkPipelineCreationFeedbackCreateInfo.Buffer instance allocated with BufferUtils.
static VkPipelineCreationFeedbackCreateInfo	create(long address)	Returns a new VkPipelineCreationFeedbackCreateInfo instance for the specified memory address.
static VkPipelineCreationFeedbackCreateInfo.Buffer	create(long address, int capacity)	Create a VkPipelineCreationFeedbackCreateInfo.Buffer instance at the specified memory.
static @Nullable VkPipelineCreationFeedbackCreateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPipelineCreationFeedbackCreateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkPipelineCreationFeedbackCreateInfo	malloc()	Returns a new VkPipelineCreationFeedbackCreateInfo instance allocated with memAlloc.
static VkPipelineCreationFeedbackCreateInfo.Buffer	malloc(int capacity)	Returns a new VkPipelineCreationFeedbackCreateInfo.Buffer instance allocated with memAlloc.
static VkPipelineCreationFeedbackCreateInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineCreationFeedbackCreateInfo.Buffer instance allocated on the specified MemoryStack.
static VkPipelineCreationFeedbackCreateInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineCreationFeedbackCreateInfo instance allocated on the specified MemoryStack.
static int	npipelineStageCreationFeedbackCount(long struct)	Unsafe version of pipelineStageCreationFeedbackCount().
static void	npipelineStageCreationFeedbackCount(long struct, int value)	Sets the specified value to the pipelineStageCreationFeedbackCount field of the specified struct.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static VkPipelineCreationFeedback	npPipelineCreationFeedback(long struct)	Unsafe version of pPipelineCreationFeedback().
static void	npPipelineCreationFeedback(long struct, VkPipelineCreationFeedback value)	Unsafe version of pPipelineCreationFeedback.
static @Nullable VkPipelineCreationFeedback.Buffer	npPipelineStageCreationFeedbacks(long struct)	Unsafe version of pPipelineStageCreationFeedbacks().
static void	npPipelineStageCreationFeedbacks(long struct, @Nullable VkPipelineCreationFeedback.Buffer value)	Unsafe version of pPipelineStageCreationFeedbacks.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
int	pipelineStageCreationFeedbackCount()	the number of elements in pPipelineStageCreationFeedbacks.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkPipelineCreationFeedbackCreateInfo	pNext(long value)	Sets the specified value to the pNext() field.
VkPipelineCreationFeedback	pPipelineCreationFeedback()	a pointer to a VkPipelineCreationFeedback structure.
VkPipelineCreationFeedbackCreateInfo	pPipelineCreationFeedback(VkPipelineCreationFeedback value)	Sets the address of the specified VkPipelineCreationFeedback to the pPipelineCreationFeedback() field.
@Nullable VkPipelineCreationFeedback.Buffer	pPipelineStageCreationFeedbacks()	a pointer to an array of pipelineStageCreationFeedbackCount VkPipelineCreationFeedback structures.
VkPipelineCreationFeedbackCreateInfo	pPipelineStageCreationFeedbacks(@Nullable VkPipelineCreationFeedback.Buffer value)	Sets the address of the specified VkPipelineCreationFeedback.Buffer to the pPipelineStageCreationFeedbacks() field.
VkPipelineCreationFeedbackCreateInfo	set(int sType, long pNext, VkPipelineCreationFeedback pPipelineCreationFeedback, @Nullable VkPipelineCreationFeedback.Buffer pPipelineStageCreationFeedbacks)	Initializes this struct with the specified values.
VkPipelineCreationFeedbackCreateInfo	set(VkPipelineCreationFeedbackCreateInfo src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPipelineCreationFeedbackCreateInfo	sType(int value)	Sets the specified value to the sType() field.
VkPipelineCreationFeedbackCreateInfo	sType$Default()	Sets the STRUCTURE_TYPE_PIPELINE_CREATION_FEEDBACK_CREATE_INFO 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.

PPIPELINECREATIONFEEDBACK

public static final int PPIPELINECREATIONFEEDBACK

The struct member offsets.

PIPELINESTAGECREATIONFEEDBACKCOUNT

public static final int PIPELINESTAGECREATIONFEEDBACKCOUNT

The struct member offsets.

PPIPELINESTAGECREATIONFEEDBACKS

public static final int PPIPELINESTAGECREATIONFEEDBACKS

The struct member offsets.

Constructor Details

VkPipelineCreationFeedbackCreateInfo

public VkPipelineCreationFeedbackCreateInfo(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

pPipelineCreationFeedback

public VkPipelineCreationFeedback pPipelineCreationFeedback()

a pointer to a VkPipelineCreationFeedback structure.

pipelineStageCreationFeedbackCount

public int pipelineStageCreationFeedbackCount()

the number of elements in pPipelineStageCreationFeedbacks.

pPipelineStageCreationFeedbacks

public @Nullable VkPipelineCreationFeedback.Buffer pPipelineStageCreationFeedbacks()

a pointer to an array of pipelineStageCreationFeedbackCount VkPipelineCreationFeedback structures.

sType

public VkPipelineCreationFeedbackCreateInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPipelineCreationFeedbackCreateInfo sType$Default()

Sets the STRUCTURE_TYPE_PIPELINE_CREATION_FEEDBACK_CREATE_INFO value to the sType() field.

pNext

public VkPipelineCreationFeedbackCreateInfo pNext(long value)

Sets the specified value to the pNext() field.

pPipelineCreationFeedback

public VkPipelineCreationFeedbackCreateInfo pPipelineCreationFeedback(VkPipelineCreationFeedback value)

Sets the address of the specified VkPipelineCreationFeedback to the pPipelineCreationFeedback() field.

pPipelineStageCreationFeedbacks

public VkPipelineCreationFeedbackCreateInfo pPipelineStageCreationFeedbacks(@Nullable VkPipelineCreationFeedback.Buffer value)

Sets the address of the specified VkPipelineCreationFeedback.Buffer to the pPipelineStageCreationFeedbacks() field.

set

public VkPipelineCreationFeedbackCreateInfo set(int sType,
 long pNext,
 VkPipelineCreationFeedback pPipelineCreationFeedback,
 @Nullable VkPipelineCreationFeedback.Buffer pPipelineStageCreationFeedbacks)

Initializes this struct with the specified values.

set

public VkPipelineCreationFeedbackCreateInfo set(VkPipelineCreationFeedbackCreateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPipelineCreationFeedbackCreateInfo malloc()

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

calloc

public static VkPipelineCreationFeedbackCreateInfo calloc()

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

create

public static VkPipelineCreationFeedbackCreateInfo create()

Returns a new VkPipelineCreationFeedbackCreateInfo instance allocated with BufferUtils.

create

public static VkPipelineCreationFeedbackCreateInfo create(long address)

Returns a new VkPipelineCreationFeedbackCreateInfo instance for the specified memory address.

createSafe

public static @Nullable VkPipelineCreationFeedbackCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPipelineCreationFeedbackCreateInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPipelineCreationFeedbackCreateInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPipelineCreationFeedbackCreateInfo.Buffer create(int capacity)

Returns a new VkPipelineCreationFeedbackCreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPipelineCreationFeedbackCreateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkPipelineCreationFeedbackCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

npPipelineCreationFeedback

public static VkPipelineCreationFeedback npPipelineCreationFeedback(long struct)

Unsafe version of pPipelineCreationFeedback().

npipelineStageCreationFeedbackCount

public static int npipelineStageCreationFeedbackCount(long struct)

Unsafe version of pipelineStageCreationFeedbackCount().

npPipelineStageCreationFeedbacks

public static @Nullable VkPipelineCreationFeedback.Buffer npPipelineStageCreationFeedbacks(long struct)

Unsafe version of pPipelineStageCreationFeedbacks().

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.

npPipelineCreationFeedback

public static void npPipelineCreationFeedback(long struct,
 VkPipelineCreationFeedback value)

Unsafe version of pPipelineCreationFeedback.

npipelineStageCreationFeedbackCount

public static void npipelineStageCreationFeedbackCount(long struct,
 int value)

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

npPipelineStageCreationFeedbacks

public static void npPipelineStageCreationFeedbacks(long struct,
 @Nullable VkPipelineCreationFeedback.Buffer value)

Unsafe version of pPipelineStageCreationFeedbacks.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate