Package org.lwjgl.vulkan

Class VkPipelineRobustnessCreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPipelineRobustnessCreateInfo>

org.lwjgl.vulkan.VkPipelineRobustnessCreateInfo

All Implemented Interfaces:

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

Direct Known Subclasses:

VkPipelineRobustnessCreateInfoEXT

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

Structure controlling the robustness of a newly created pipeline shader stage.

Description

Resources bound as DESCRIPTOR_TYPE_MUTABLE_EXT will have the robustness behavior that covers its active descriptor type.

The scope of the effect of VkPipelineRobustnessCreateInfo depends on which structure’s pNext chain it is included in.

• VkGraphicsPipelineCreateInfo, VkRayTracingPipelineCreateInfoKHR, VkComputePipelineCreateInfo: The robustness behavior described by VkPipelineRobustnessCreateInfo applies to all accesses through this pipeline
• VkPipelineShaderStageCreateInfo: The robustness behavior described by VkPipelineRobustnessCreateInfo applies to all accesses emanating from the shader code of this shader stage

If VkPipelineRobustnessCreateInfo is specified for both a pipeline and a pipeline stage, the VkPipelineRobustnessCreateInfo specified for the pipeline stage will take precedence.

When VkPipelineRobustnessCreateInfo is specified for a pipeline, it only affects the subset of the pipeline that is specified by the create info, as opposed to subsets linked from pipeline libraries. For VkGraphicsPipelineCreateInfo, that subset is specified by VkGraphicsPipelineLibraryCreateInfoEXT::flags. For VkRayTracingPipelineCreateInfoKHR, that subset is specified by the specific stages in VkRayTracingPipelineCreateInfoKHR::pStages.

Valid Usage

• If the pipelineRobustness feature is not enabled, storageBuffers must be PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_DEVICE_DEFAULT
• If the pipelineRobustness feature is not enabled, uniformBuffers must be PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_DEVICE_DEFAULT
• If the pipelineRobustness feature is not enabled, vertexInputs must be PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_DEVICE_DEFAULT
• If the pipelineRobustness feature is not enabled, images must be PIPELINE_ROBUSTNESS_IMAGE_BEHAVIOR_DEVICE_DEFAULT
• If the robustImageAccess feature is not supported, images must not be PIPELINE_ROBUSTNESS_IMAGE_BEHAVIOR_ROBUST_IMAGE_ACCESS
• If the robustBufferAccess2 feature is not supported, storageBuffers must not be PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS_2
• If the robustBufferAccess2 feature is not supported, uniformBuffers must not be PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS_2
• If the robustBufferAccess2 feature is not supported, vertexInputs must not be PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS_2
• If the robustImageAccess2 feature is not supported, images must not be PIPELINE_ROBUSTNESS_IMAGE_BEHAVIOR_ROBUST_IMAGE_ACCESS_2

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_ROBUSTNESS_CREATE_INFO
• storageBuffers must be a valid VkPipelineRobustnessBufferBehavior value
• uniformBuffers must be a valid VkPipelineRobustnessBufferBehavior value
• vertexInputs must be a valid VkPipelineRobustnessBufferBehavior value
• images must be a valid VkPipelineRobustnessImageBehavior value

Layout

 struct VkPipelineRobustnessCreateInfo {
     VkStructureType sType();
     void const * pNext();
     VkPipelineRobustnessBufferBehavior storageBuffers();
     VkPipelineRobustnessBufferBehavior uniformBuffers();
     VkPipelineRobustnessBufferBehavior vertexInputs();
     VkPipelineRobustnessImageBehavior images();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPipelineRobustnessCreateInfo.Buffer	An array of VkPipelineRobustnessCreateInfo 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	IMAGES	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STORAGEBUFFERS	The struct member offsets.
static final int	STYPE	The struct member offsets.
static final int	UNIFORMBUFFERS	The struct member offsets.
static final int	VERTEXINPUTS	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
VkPipelineRobustnessCreateInfo(ByteBuffer container)	Creates a VkPipelineRobustnessCreateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPipelineRobustnessCreateInfo	calloc()	Returns a new VkPipelineRobustnessCreateInfo instance allocated with memCalloc.
static VkPipelineRobustnessCreateInfo.Buffer	calloc(int capacity)	Returns a new VkPipelineRobustnessCreateInfo.Buffer instance allocated with memCalloc.
static VkPipelineRobustnessCreateInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineRobustnessCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineRobustnessCreateInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineRobustnessCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineRobustnessCreateInfo	create()	Returns a new VkPipelineRobustnessCreateInfo instance allocated with BufferUtils.
static VkPipelineRobustnessCreateInfo.Buffer	create(int capacity)	Returns a new VkPipelineRobustnessCreateInfo.Buffer instance allocated with BufferUtils.
static VkPipelineRobustnessCreateInfo	create(long address)	Returns a new VkPipelineRobustnessCreateInfo instance for the specified memory address.
static VkPipelineRobustnessCreateInfo.Buffer	create(long address, int capacity)	Create a VkPipelineRobustnessCreateInfo.Buffer instance at the specified memory.
static @Nullable VkPipelineRobustnessCreateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPipelineRobustnessCreateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	images()	describes the behavior of out of bounds accesses made to resources bound as: DESCRIPTOR_TYPE_SAMPLED_IMAGE DESCRIPTOR_TYPE_STORAGE_IMAGE
VkPipelineRobustnessCreateInfo	images(int value)	Sets the specified value to the images() field.
static VkPipelineRobustnessCreateInfo	malloc()	Returns a new VkPipelineRobustnessCreateInfo instance allocated with memAlloc.
static VkPipelineRobustnessCreateInfo.Buffer	malloc(int capacity)	Returns a new VkPipelineRobustnessCreateInfo.Buffer instance allocated with memAlloc.
static VkPipelineRobustnessCreateInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineRobustnessCreateInfo.Buffer instance allocated on the specified MemoryStack.
static VkPipelineRobustnessCreateInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineRobustnessCreateInfo instance allocated on the specified MemoryStack.
static int	nimages(long struct)	Unsafe version of images().
static void	nimages(long struct, int value)	Unsafe version of images.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nstorageBuffers(long struct)	Unsafe version of storageBuffers().
static void	nstorageBuffers(long struct, int value)	Unsafe version of storageBuffers.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static int	nuniformBuffers(long struct)	Unsafe version of uniformBuffers().
static void	nuniformBuffers(long struct, int value)	Unsafe version of uniformBuffers.
static int	nvertexInputs(long struct)	Unsafe version of vertexInputs().
static void	nvertexInputs(long struct, int value)	Unsafe version of vertexInputs.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkPipelineRobustnessCreateInfo	pNext(long value)	Sets the specified value to the pNext() field.
VkPipelineRobustnessCreateInfo	set(int sType, long pNext, int storageBuffers, int uniformBuffers, int vertexInputs, int images)	Initializes this struct with the specified values.
VkPipelineRobustnessCreateInfo	set(VkPipelineRobustnessCreateInfo src)	Copies the specified struct data to this struct.
int	sizeof()
int	storageBuffers()	sets the behavior of out of bounds accesses made to resources bound as: DESCRIPTOR_TYPE_STORAGE_BUFFER DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC
VkPipelineRobustnessCreateInfo	storageBuffers(int value)	Sets the specified value to the storageBuffers() field.
int	sType()	a VkStructureType value identifying this structure.
VkPipelineRobustnessCreateInfo	sType(int value)	Sets the specified value to the sType() field.
VkPipelineRobustnessCreateInfo	sType$Default()	Sets the STRUCTURE_TYPE_PIPELINE_ROBUSTNESS_CREATE_INFO value to the sType() field.
int	uniformBuffers()	describes the behavior of out of bounds accesses made to resources bound as: DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER DESCRIPTOR_TYPE_UNIFORM_BUFFER DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK
VkPipelineRobustnessCreateInfo	uniformBuffers(int value)	Sets the specified value to the uniformBuffers() field.
int	vertexInputs()	describes the behavior of out of bounds accesses made to vertex input attributes
VkPipelineRobustnessCreateInfo	vertexInputs(int value)	Sets the specified value to the vertexInputs() 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.

STORAGEBUFFERS

public static final int STORAGEBUFFERS

The struct member offsets.

UNIFORMBUFFERS

public static final int UNIFORMBUFFERS

The struct member offsets.

VERTEXINPUTS

public static final int VERTEXINPUTS

The struct member offsets.

IMAGES

public static final int IMAGES

The struct member offsets.

Constructor Details

VkPipelineRobustnessCreateInfo

public VkPipelineRobustnessCreateInfo(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

storageBuffers

public int storageBuffers()

sets the behavior of out of bounds accesses made to resources bound as:

• DESCRIPTOR_TYPE_STORAGE_BUFFER
• DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER
• DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC

uniformBuffers

public int uniformBuffers()

describes the behavior of out of bounds accesses made to resources bound as:

• DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER
• DESCRIPTOR_TYPE_UNIFORM_BUFFER
• DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC
• DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK

vertexInputs

public int vertexInputs()

describes the behavior of out of bounds accesses made to vertex input attributes

images

public int images()

describes the behavior of out of bounds accesses made to resources bound as:

• DESCRIPTOR_TYPE_SAMPLED_IMAGE
• DESCRIPTOR_TYPE_STORAGE_IMAGE

sType

public VkPipelineRobustnessCreateInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPipelineRobustnessCreateInfo sType$Default()

Sets the STRUCTURE_TYPE_PIPELINE_ROBUSTNESS_CREATE_INFO value to the sType() field.

pNext

public VkPipelineRobustnessCreateInfo pNext(long value)

Sets the specified value to the pNext() field.

storageBuffers

public VkPipelineRobustnessCreateInfo storageBuffers(int value)

Sets the specified value to the storageBuffers() field.

uniformBuffers

public VkPipelineRobustnessCreateInfo uniformBuffers(int value)

Sets the specified value to the uniformBuffers() field.

vertexInputs

public VkPipelineRobustnessCreateInfo vertexInputs(int value)

Sets the specified value to the vertexInputs() field.

images

public VkPipelineRobustnessCreateInfo images(int value)

Sets the specified value to the images() field.

set

public VkPipelineRobustnessCreateInfo set(int sType,
 long pNext,
 int storageBuffers,
 int uniformBuffers,
 int vertexInputs,
 int images)

Initializes this struct with the specified values.

set

public VkPipelineRobustnessCreateInfo set(VkPipelineRobustnessCreateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPipelineRobustnessCreateInfo malloc()

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

calloc

public static VkPipelineRobustnessCreateInfo calloc()

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

create

public static VkPipelineRobustnessCreateInfo create()

Returns a new VkPipelineRobustnessCreateInfo instance allocated with BufferUtils.

create

public static VkPipelineRobustnessCreateInfo create(long address)

Returns a new VkPipelineRobustnessCreateInfo instance for the specified memory address.

createSafe

public static @Nullable VkPipelineRobustnessCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPipelineRobustnessCreateInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPipelineRobustnessCreateInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPipelineRobustnessCreateInfo.Buffer create(int capacity)

Returns a new VkPipelineRobustnessCreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPipelineRobustnessCreateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkPipelineRobustnessCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nstorageBuffers

public static int nstorageBuffers(long struct)

Unsafe version of storageBuffers().

nuniformBuffers

public static int nuniformBuffers(long struct)

Unsafe version of uniformBuffers().

nvertexInputs

public static int nvertexInputs(long struct)

Unsafe version of vertexInputs().

nimages

public static int nimages(long struct)

Unsafe version of images().

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.

nstorageBuffers

public static void nstorageBuffers(long struct,
 int value)

Unsafe version of storageBuffers.

nuniformBuffers

public static void nuniformBuffers(long struct,
 int value)

Unsafe version of uniformBuffers.

nvertexInputs

public static void nvertexInputs(long struct,
 int value)

Unsafe version of vertexInputs.

nimages

public static void nimages(long struct,
 int value)

Unsafe version of images.