Package org.lwjgl.vulkan

Class VkDescriptorSetLayoutBindingFlagsCreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDescriptorSetLayoutBindingFlagsCreateInfo>

org.lwjgl.vulkan.VkDescriptorSetLayoutBindingFlagsCreateInfo

All Implemented Interfaces:

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

Direct Known Subclasses:

VkDescriptorSetLayoutBindingFlagsCreateInfoEXT

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

Structure specifying creation flags for descriptor set layout bindings.

Description

If bindingCount is zero or if this structure is not included in the pNext chain, the VkDescriptorBindingFlags for each descriptor set layout binding is considered to be zero. Otherwise, the descriptor set layout binding at VkDescriptorSetLayoutCreateInfo::pBindings[i] uses the flags in pBindingFlags[i].

Valid Usage

• If bindingCount is not zero, bindingCount must equal VkDescriptorSetLayoutCreateInfo::bindingCount
• If VkDescriptorSetLayoutCreateInfo::flags includes DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT, then all elements of pBindingFlags must not include DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT, DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT, or DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT
• If an element of pBindingFlags includes DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT, then it must be the element with the highest binding number
• If VkPhysicalDeviceDescriptorIndexingFeatures::descriptorBindingUniformBufferUpdateAfterBind is not enabled, all bindings with descriptor type DESCRIPTOR_TYPE_UNIFORM_BUFFER must not use DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT
• If VkPhysicalDeviceDescriptorIndexingFeatures::descriptorBindingSampledImageUpdateAfterBind is not enabled, all bindings with descriptor type DESCRIPTOR_TYPE_SAMPLER, DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, or DESCRIPTOR_TYPE_SAMPLED_IMAGE must not use DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT
• If VkPhysicalDeviceDescriptorIndexingFeatures::descriptorBindingStorageImageUpdateAfterBind is not enabled, all bindings with descriptor type DESCRIPTOR_TYPE_STORAGE_IMAGE must not use DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT
• If VkPhysicalDeviceDescriptorIndexingFeatures::descriptorBindingStorageBufferUpdateAfterBind is not enabled, all bindings with descriptor type DESCRIPTOR_TYPE_STORAGE_BUFFER must not use DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT
• If VkPhysicalDeviceDescriptorIndexingFeatures::descriptorBindingUniformTexelBufferUpdateAfterBind is not enabled, all bindings with descriptor type DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER must not use DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT
• If VkPhysicalDeviceDescriptorIndexingFeatures::descriptorBindingStorageTexelBufferUpdateAfterBind is not enabled, all bindings with descriptor type DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER must not use DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT
• If VkPhysicalDeviceInlineUniformBlockFeatures::descriptorBindingInlineUniformBlockUpdateAfterBind is not enabled, all bindings with descriptor type DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK must not use DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT
• If VkPhysicalDeviceAccelerationStructureFeaturesKHR::descriptorBindingAccelerationStructureUpdateAfterBind is not enabled, all bindings with descriptor type DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR or DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV must not use DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT
• All bindings with descriptor type DESCRIPTOR_TYPE_INPUT_ATTACHMENT, DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, or DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC must not use DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT
• If VkPhysicalDeviceDescriptorIndexingFeatures::descriptorBindingUpdateUnusedWhilePending is not enabled, all elements of pBindingFlags must not include DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT
• If VkPhysicalDeviceDescriptorIndexingFeatures::descriptorBindingPartiallyBound is not enabled, all elements of pBindingFlags must not include DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT
• If VkPhysicalDeviceDescriptorIndexingFeatures::descriptorBindingVariableDescriptorCount is not enabled, all elements of pBindingFlags must not include DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT
• If an element of pBindingFlags includes DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT, that element’s descriptorType must not be DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC or DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_BINDING_FLAGS_CREATE_INFO
• If bindingCount is not 0, pBindingFlags must be a valid pointer to an array of bindingCount valid combinations of VkDescriptorBindingFlagBits values

Layout

 struct VkDescriptorSetLayoutBindingFlagsCreateInfo {
     VkStructureType sType();
     void const * pNext();
     uint32_t bindingCount();
     VkDescriptorBindingFlags const * pBindingFlags();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
int	bindingCount()	zero or the number of elements in pBindingFlags.
VkDescriptorSetLayoutBindingFlagsCreateInfo	bindingCount(int value)	Sets the specified value to the bindingCount() field.
static VkDescriptorSetLayoutBindingFlagsCreateInfo	calloc()	Returns a new VkDescriptorSetLayoutBindingFlagsCreateInfo instance allocated with memCalloc.
static VkDescriptorSetLayoutBindingFlagsCreateInfo.Buffer	calloc(int capacity)	Returns a new VkDescriptorSetLayoutBindingFlagsCreateInfo.Buffer instance allocated with memCalloc.
static VkDescriptorSetLayoutBindingFlagsCreateInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDescriptorSetLayoutBindingFlagsCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDescriptorSetLayoutBindingFlagsCreateInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDescriptorSetLayoutBindingFlagsCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDescriptorSetLayoutBindingFlagsCreateInfo	create()	Returns a new VkDescriptorSetLayoutBindingFlagsCreateInfo instance allocated with BufferUtils.
static VkDescriptorSetLayoutBindingFlagsCreateInfo.Buffer	create(int capacity)	Returns a new VkDescriptorSetLayoutBindingFlagsCreateInfo.Buffer instance allocated with BufferUtils.
static VkDescriptorSetLayoutBindingFlagsCreateInfo	create(long address)	Returns a new VkDescriptorSetLayoutBindingFlagsCreateInfo instance for the specified memory address.
static VkDescriptorSetLayoutBindingFlagsCreateInfo.Buffer	create(long address, int capacity)	Create a VkDescriptorSetLayoutBindingFlagsCreateInfo.Buffer instance at the specified memory.
static @Nullable VkDescriptorSetLayoutBindingFlagsCreateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDescriptorSetLayoutBindingFlagsCreateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkDescriptorSetLayoutBindingFlagsCreateInfo	malloc()	Returns a new VkDescriptorSetLayoutBindingFlagsCreateInfo instance allocated with memAlloc.
static VkDescriptorSetLayoutBindingFlagsCreateInfo.Buffer	malloc(int capacity)	Returns a new VkDescriptorSetLayoutBindingFlagsCreateInfo.Buffer instance allocated with memAlloc.
static VkDescriptorSetLayoutBindingFlagsCreateInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDescriptorSetLayoutBindingFlagsCreateInfo.Buffer instance allocated on the specified MemoryStack.
static VkDescriptorSetLayoutBindingFlagsCreateInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDescriptorSetLayoutBindingFlagsCreateInfo instance allocated on the specified MemoryStack.
static int	nbindingCount(long struct)	Unsafe version of bindingCount().
static void	nbindingCount(long struct, int value)	Sets the specified value to the bindingCount field of the specified struct.
static @Nullable IntBuffer	npBindingFlags(long struct)	Unsafe version of pBindingFlags.
static void	npBindingFlags(long struct, @Nullable IntBuffer value)	Unsafe version of pBindingFlags.
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 IntBuffer	pBindingFlags()	a pointer to an array of VkDescriptorBindingFlags bitfields, one for each descriptor set layout binding.
VkDescriptorSetLayoutBindingFlagsCreateInfo	pBindingFlags(@Nullable IntBuffer value)	Sets the address of the specified IntBuffer to the pBindingFlags() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkDescriptorSetLayoutBindingFlagsCreateInfo	pNext(long value)	Sets the specified value to the pNext() field.
VkDescriptorSetLayoutBindingFlagsCreateInfo	set(int sType, long pNext, int bindingCount, @Nullable IntBuffer pBindingFlags)	Initializes this struct with the specified values.
VkDescriptorSetLayoutBindingFlagsCreateInfo	set(VkDescriptorSetLayoutBindingFlagsCreateInfo src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkDescriptorSetLayoutBindingFlagsCreateInfo	sType(int value)	Sets the specified value to the sType() field.
VkDescriptorSetLayoutBindingFlagsCreateInfo	sType$Default()	Sets the STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_BINDING_FLAGS_CREATE_INFO 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.

BINDINGCOUNT

public static final int BINDINGCOUNT

The struct member offsets.

PBINDINGFLAGS

public static final int PBINDINGFLAGS

The struct member offsets.

Constructor Details

VkDescriptorSetLayoutBindingFlagsCreateInfo

public VkDescriptorSetLayoutBindingFlagsCreateInfo(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

bindingCount

public int bindingCount()

zero or the number of elements in pBindingFlags.

pBindingFlags

public @Nullable IntBuffer pBindingFlags()

a pointer to an array of VkDescriptorBindingFlags bitfields, one for each descriptor set layout binding.

sType

public VkDescriptorSetLayoutBindingFlagsCreateInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkDescriptorSetLayoutBindingFlagsCreateInfo sType$Default()

Sets the STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_BINDING_FLAGS_CREATE_INFO value to the sType() field.

pNext

public VkDescriptorSetLayoutBindingFlagsCreateInfo pNext(long value)

Sets the specified value to the pNext() field.

bindingCount

public VkDescriptorSetLayoutBindingFlagsCreateInfo bindingCount(int value)

Sets the specified value to the bindingCount() field.

pBindingFlags

public VkDescriptorSetLayoutBindingFlagsCreateInfo pBindingFlags(@Nullable IntBuffer value)

Sets the address of the specified IntBuffer to the pBindingFlags() field.

set

public VkDescriptorSetLayoutBindingFlagsCreateInfo set(int sType,
 long pNext,
 int bindingCount,
 @Nullable IntBuffer pBindingFlags)

Initializes this struct with the specified values.

set

public VkDescriptorSetLayoutBindingFlagsCreateInfo set(VkDescriptorSetLayoutBindingFlagsCreateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDescriptorSetLayoutBindingFlagsCreateInfo malloc()

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

calloc

public static VkDescriptorSetLayoutBindingFlagsCreateInfo calloc()

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

create

public static VkDescriptorSetLayoutBindingFlagsCreateInfo create()

Returns a new VkDescriptorSetLayoutBindingFlagsCreateInfo instance allocated with BufferUtils.

create

public static VkDescriptorSetLayoutBindingFlagsCreateInfo create(long address)

Returns a new VkDescriptorSetLayoutBindingFlagsCreateInfo instance for the specified memory address.

createSafe

public static @Nullable VkDescriptorSetLayoutBindingFlagsCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDescriptorSetLayoutBindingFlagsCreateInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDescriptorSetLayoutBindingFlagsCreateInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDescriptorSetLayoutBindingFlagsCreateInfo.Buffer create(int capacity)

Returns a new VkDescriptorSetLayoutBindingFlagsCreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDescriptorSetLayoutBindingFlagsCreateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkDescriptorSetLayoutBindingFlagsCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nbindingCount

public static int nbindingCount(long struct)

Unsafe version of bindingCount().

npBindingFlags

public static @Nullable IntBuffer npBindingFlags(long struct)

Unsafe version of pBindingFlags.

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.

nbindingCount

public static void nbindingCount(long struct,
 int value)

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

npBindingFlags

public static void npBindingFlags(long struct,
 @Nullable IntBuffer value)

Unsafe version of pBindingFlags.