Package org.lwjgl.vulkan
Class VkDescriptorSetLayoutCreateInfo
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkDescriptorSetLayoutCreateInfo>
org.lwjgl.vulkan.VkDescriptorSetLayoutCreateInfo
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkDescriptorSetLayoutCreateInfo
extends org.lwjgl.system.Struct<VkDescriptorSetLayoutCreateInfo>
implements org.lwjgl.system.NativeResource
Structure specifying parameters of a newly created descriptor set layout.
Valid Usage
- If the
perStageDescriptorSetfeature is not enabled, orflagsdoes not containDESCRIPTOR_SET_LAYOUT_CREATE_PER_STAGE_BIT_NV, then theVkDescriptorSetLayoutBinding::bindingmembers of the elements of thepBindingsarray must each have different values - If
flagscontainsDESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT, then all elements ofpBindingsmust not have adescriptorTypeofDESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMICorDESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC - If
flagscontainsDESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT, then all elements ofpBindingsmust not have adescriptorTypeofDESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK - If
flagscontainsDESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT, then the total number of elements of all bindings must be less than or equal toVkPhysicalDevicePushDescriptorProperties::maxPushDescriptors - If
flagscontainsDESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT,flagsmust not containDESCRIPTOR_SET_LAYOUT_CREATE_HOST_ONLY_POOL_BIT_EXT - If
flagscontainsDESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT,pBindingsmust not have adescriptorTypeofDESCRIPTOR_TYPE_MUTABLE_EXT - If any binding has the
DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BITbit set,flagsmust includeDESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT - If any binding has the
DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BITbit set, then all bindings must not havedescriptorTypeofDESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMICorDESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC - If
flagscontainsDESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT,flagsmust not containDESCRIPTOR_SET_LAYOUT_CREATE_HOST_ONLY_POOL_BIT_EXT - If any element
pBindings[i] has adescriptorTypeofDESCRIPTOR_TYPE_MUTABLE_EXT, then thepNextchain must include aVkMutableDescriptorTypeCreateInfoEXTstructure, andmutableDescriptorTypeListCountmust be greater than i - If a binding has a
descriptorTypevalue ofDESCRIPTOR_TYPE_MUTABLE_EXT, thenpImmutableSamplersmust beNULL - If
VkPhysicalDeviceMutableDescriptorTypeFeaturesEXT::mutableDescriptorTypeis not enabled,pBindingsmust not contain adescriptorTypeofDESCRIPTOR_TYPE_MUTABLE_EXT - If
flagscontainsDESCRIPTOR_SET_LAYOUT_CREATE_HOST_ONLY_POOL_BIT_EXT,VkPhysicalDeviceMutableDescriptorTypeFeaturesEXT::mutableDescriptorTypemust be enabled - If
flagscontainsDESCRIPTOR_SET_LAYOUT_CREATE_DESCRIPTOR_BUFFER_BIT_EXT, then all elements ofpBindingsmust not have adescriptorTypeofDESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMICorDESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC - If
flagscontainsDESCRIPTOR_SET_LAYOUT_CREATE_EMBEDDED_IMMUTABLE_SAMPLERS_BIT_EXT,flagsmust also containDESCRIPTOR_SET_LAYOUT_CREATE_DESCRIPTOR_BUFFER_BIT_EXT - If
flagscontainsDESCRIPTOR_SET_LAYOUT_CREATE_DESCRIPTOR_BUFFER_BIT_EXT, thenflagsmust not containDESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT - If
flagscontainsDESCRIPTOR_SET_LAYOUT_CREATE_DESCRIPTOR_BUFFER_BIT_EXT, thenflagsmust not containDESCRIPTOR_SET_LAYOUT_CREATE_HOST_ONLY_POOL_BIT_VALVE - If
flagscontainsDESCRIPTOR_SET_LAYOUT_CREATE_PER_STAGE_BIT_NV, thenperStageDescriptorSetmust be enabled - If
flagscontainsDESCRIPTOR_SET_LAYOUT_CREATE_PER_STAGE_BIT_NV, then there must not be any two elements of thepBindingsarray with the sameVkDescriptorSetLayoutBinding::bindingvalue and theirVkDescriptorSetLayoutBinding::stageFlagscontaining the same bit
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO- Each
pNextmember of any structure (including this one) in thepNextchain must be eitherNULLor a pointer to a valid instance ofVkDescriptorSetLayoutBindingFlagsCreateInfoorVkMutableDescriptorTypeCreateInfoEXT - The
sTypevalue of each struct in thepNextchain must be unique flagsmust be a valid combination ofVkDescriptorSetLayoutCreateFlagBitsvalues- If
bindingCountis not 0,pBindingsmust be a valid pointer to an array ofbindingCountvalidVkDescriptorSetLayoutBindingstructures
See Also
VkDescriptorSetLayoutBinding, CreateDescriptorSetLayout, GetDescriptorSetLayoutSupport, GetDescriptorSetLayoutSupportKHR
Layout
struct VkDescriptorSetLayoutCreateInfo {
VkStructureType sType();
void const * pNext();
VkDescriptorSetLayoutCreateFlags flags();
uint32_t bindingCount();
VkDescriptorSetLayoutBinding const * pBindings();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkDescriptorSetLayoutCreateInfostructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkDescriptorSetLayoutCreateInfo(ByteBuffer container) Creates aVkDescriptorSetLayoutCreateInfoinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionintthe number of elements inpBindings.calloc()Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkDescriptorSetLayoutCreateInfo.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkDescriptorSetLayoutCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.Deprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.create()Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated withBufferUtils.create(int capacity) Returns a newVkDescriptorSetLayoutCreateInfo.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkDescriptorSetLayoutCreateInfoinstance for the specified memory address.create(long address, int capacity) Create aVkDescriptorSetLayoutCreateInfo.Bufferinstance at the specified memory.static @Nullable VkDescriptorSetLayoutCreateInfocreateSafe(long address) static @Nullable VkDescriptorSetLayoutCreateInfo.BuffercreateSafe(long address, int capacity) intflags()a bitmask ofVkDescriptorSetLayoutCreateFlagBitsspecifying options for descriptor set layout creation.flags(int value) Sets the specified value to theflags()field.malloc()Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkDescriptorSetLayoutCreateInfo.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkDescriptorSetLayoutCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated on the specifiedMemoryStack.Deprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static intnbindingCount(long struct) Unsafe version ofbindingCount().static voidnbindingCount(long struct, int value) Sets the specified value to thebindingCountfield of the specifiedstruct.static intnflags(long struct) Unsafe version offlags().static voidnflags(long struct, int value) Unsafe version offlags.static @Nullable VkDescriptorSetLayoutBinding.BuffernpBindings(long struct) Unsafe version ofpBindings().static voidnpBindings(long struct, @Nullable VkDescriptorSetLayoutBinding.Buffer value) Unsafe version ofpBindings.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.@Nullable VkDescriptorSetLayoutBinding.Buffera pointer to an array ofVkDescriptorSetLayoutBindingstructures.pBindings(@Nullable VkDescriptorSetLayoutBinding.Buffer value) Sets the address of the specifiedVkDescriptorSetLayoutBinding.Bufferto thepBindings()field.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.Prepends the specifiedVkDescriptorSetLayoutBindingFlagsCreateInfovalue to thepNextchain.Prepends the specifiedVkDescriptorSetLayoutBindingFlagsCreateInfoEXTvalue to thepNextchain.Prepends the specifiedVkMutableDescriptorTypeCreateInfoEXTvalue to thepNextchain.Prepends the specifiedVkMutableDescriptorTypeCreateInfoVALVEvalue to thepNextchain.set(int sType, long pNext, int flags, @Nullable VkDescriptorSetLayoutBinding.Buffer pBindings) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFOvalue to thesType()field.static voidvalidate(long struct) Validates pointer members that should not beNULL.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
FLAGS
public static final int FLAGSThe struct member offsets. -
BINDINGCOUNT
public static final int BINDINGCOUNTThe struct member offsets. -
PBINDINGS
public static final int PBINDINGSThe struct member offsets.
-
-
Constructor Details
-
VkDescriptorSetLayoutCreateInfo
Creates aVkDescriptorSetLayoutCreateInfoinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct<VkDescriptorSetLayoutCreateInfo>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
flags
public int flags()a bitmask ofVkDescriptorSetLayoutCreateFlagBitsspecifying options for descriptor set layout creation. -
bindingCount
public int bindingCount()the number of elements inpBindings. -
pBindings
a pointer to an array ofVkDescriptorSetLayoutBindingstructures. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFOvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
pNext
Prepends the specifiedVkDescriptorSetLayoutBindingFlagsCreateInfovalue to thepNextchain. -
pNext
Prepends the specifiedVkDescriptorSetLayoutBindingFlagsCreateInfoEXTvalue to thepNextchain. -
pNext
Prepends the specifiedVkMutableDescriptorTypeCreateInfoEXTvalue to thepNextchain. -
pNext
Prepends the specifiedVkMutableDescriptorTypeCreateInfoVALVEvalue to thepNextchain. -
flags
Sets the specified value to theflags()field. -
pBindings
public VkDescriptorSetLayoutCreateInfo pBindings(@Nullable VkDescriptorSetLayoutBinding.Buffer value) Sets the address of the specifiedVkDescriptorSetLayoutBinding.Bufferto thepBindings()field. -
set
public VkDescriptorSetLayoutCreateInfo set(int sType, long pNext, int flags, @Nullable VkDescriptorSetLayoutBinding.Buffer pBindings) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated withBufferUtils. -
create
Returns a newVkDescriptorSetLayoutCreateInfoinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkDescriptorSetLayoutCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkDescriptorSetLayoutCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkDescriptorSetLayoutCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkDescriptorSetLayoutCreateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkDescriptorSetLayoutCreateInfo.Buffer createSafe(long address, int capacity) -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
@Deprecated public static VkDescriptorSetLayoutCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
@Deprecated public static VkDescriptorSetLayoutCreateInfo callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
mallocStack
@Deprecated public static VkDescriptorSetLayoutCreateInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkDescriptorSetLayoutCreateInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkDescriptorSetLayoutCreateInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkDescriptorSetLayoutCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkDescriptorSetLayoutCreateInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkDescriptorSetLayoutCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
nflags
public static int nflags(long struct) Unsafe version offlags(). -
nbindingCount
public static int nbindingCount(long struct) Unsafe version ofbindingCount(). -
npBindings
Unsafe version ofpBindings(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nflags
public static void nflags(long struct, int value) Unsafe version offlags. -
nbindingCount
public static void nbindingCount(long struct, int value) Sets the specified value to thebindingCountfield of the specifiedstruct. -
npBindings
Unsafe version ofpBindings. -
validate
public static void validate(long struct) Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-