Package org.lwjgl.vulkan
Class VkDescriptorSetLayoutCreateInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkDescriptorSetLayoutCreateInfo
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkDescriptorSetLayoutCreateInfo extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying parameters of a newly created descriptor set layout.Valid Usage
- The
VkDescriptorSetLayoutBinding::bindingmembers of the elements of thepBindingsarray must each have different values - If
flagscontainsDESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR, then all elements ofpBindingsmust not have adescriptorTypeofDESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMICorDESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC - If
flagscontainsDESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR, then all elements ofpBindingsmust not have adescriptorTypeofDESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK - If
flagscontainsDESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR, then the total number of elements of all bindings must be less than or equal toVkPhysicalDevicePushDescriptorPropertiesKHR::maxPushDescriptors - If
flagscontainsDESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR,flagsmust not containDESCRIPTOR_SET_LAYOUT_CREATE_HOST_ONLY_POOL_BIT_VALVE - If
flagscontainsDESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR,pBindingsmust not have adescriptorTypeofDESCRIPTOR_TYPE_MUTABLE_VALVE - 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_VALVE - If any binding has a
descriptorTypeofDESCRIPTOR_TYPE_MUTABLE_VALVE, then aVkMutableDescriptorTypeCreateInfoVALVEmust be present in thepNextchain - If a binding has a
descriptorTypevalue ofDESCRIPTOR_TYPE_MUTABLE_VALVE, thenpImmutableSamplersmust beNULL - If
VkPhysicalDeviceMutableDescriptorTypeFeaturesVALVE::mutableDescriptorTypeis not enabled,pBindingsmust not contain adescriptorTypeofDESCRIPTOR_TYPE_MUTABLE_VALVE - If
flagscontainsDESCRIPTOR_SET_LAYOUT_CREATE_HOST_ONLY_POOL_BIT_VALVE,VkPhysicalDeviceMutableDescriptorTypeFeaturesVALVE::mutableDescriptorTypemust be enabled
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 ofVkDescriptorSetLayoutBindingFlagsCreateInfoorVkMutableDescriptorTypeCreateInfoVALVE - 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,GetDescriptorSetLayoutSupportKHRLayout
struct VkDescriptorSetLayoutCreateInfo { VkStructureTypesType(); void const *pNext(); VkDescriptorSetLayoutCreateFlagsflags(); uint32_tbindingCount();VkDescriptorSetLayoutBindingconst *pBindings(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkDescriptorSetLayoutCreateInfo.BufferAn array ofVkDescriptorSetLayoutCreateInfostructs.
-
Constructor Summary
Constructors Constructor Description VkDescriptorSetLayoutCreateInfo(java.nio.ByteBuffer container)Creates aVkDescriptorSetLayoutCreateInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description intbindingCount()the number of elements inpBindings.static VkDescriptorSetLayoutCreateInfocalloc()Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated withmemCalloc.static VkDescriptorSetLayoutCreateInfo.Buffercalloc(int capacity)Returns a newVkDescriptorSetLayoutCreateInfo.Bufferinstance allocated withmemCalloc.static VkDescriptorSetLayoutCreateInfo.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkDescriptorSetLayoutCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDescriptorSetLayoutCreateInfocalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDescriptorSetLayoutCreateInfocallocStack()Deprecated.static VkDescriptorSetLayoutCreateInfo.BuffercallocStack(int capacity)Deprecated.static VkDescriptorSetLayoutCreateInfo.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkDescriptorSetLayoutCreateInfocallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static VkDescriptorSetLayoutCreateInfocreate()Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated withBufferUtils.static VkDescriptorSetLayoutCreateInfo.Buffercreate(int capacity)Returns a newVkDescriptorSetLayoutCreateInfo.Bufferinstance allocated withBufferUtils.static VkDescriptorSetLayoutCreateInfocreate(long address)Returns a newVkDescriptorSetLayoutCreateInfoinstance for the specified memory address.static VkDescriptorSetLayoutCreateInfo.Buffercreate(long address, int capacity)Create aVkDescriptorSetLayoutCreateInfo.Bufferinstance at the specified memory.static VkDescriptorSetLayoutCreateInfocreateSafe(long address)static VkDescriptorSetLayoutCreateInfo.BuffercreateSafe(long address, int capacity)intflags()a bitmask ofVkDescriptorSetLayoutCreateFlagBitsspecifying options for descriptor set layout creation.VkDescriptorSetLayoutCreateInfoflags(int value)Sets the specified value to theflags()field.static VkDescriptorSetLayoutCreateInfomalloc()Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated withmemAlloc.static VkDescriptorSetLayoutCreateInfo.Buffermalloc(int capacity)Returns a newVkDescriptorSetLayoutCreateInfo.Bufferinstance allocated withmemAlloc.static VkDescriptorSetLayoutCreateInfo.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkDescriptorSetLayoutCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkDescriptorSetLayoutCreateInfomalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated on the specifiedMemoryStack.static VkDescriptorSetLayoutCreateInfomallocStack()Deprecated.static VkDescriptorSetLayoutCreateInfo.BuffermallocStack(int capacity)Deprecated.static VkDescriptorSetLayoutCreateInfo.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkDescriptorSetLayoutCreateInfomallocStack(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 VkDescriptorSetLayoutBinding.BuffernpBindings(long struct)Unsafe version ofpBindings().static voidnpBindings(long struct, 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.VkDescriptorSetLayoutBinding.BufferpBindings()a pointer to an array ofVkDescriptorSetLayoutBindingstructures.VkDescriptorSetLayoutCreateInfopBindings(VkDescriptorSetLayoutBinding.Buffer value)Sets the address of the specifiedVkDescriptorSetLayoutBinding.Bufferto thepBindings()field.longpNext()NULLor a pointer to a structure extending this structure.VkDescriptorSetLayoutCreateInfopNext(long value)Sets the specified value to thepNext()field.VkDescriptorSetLayoutCreateInfopNext(VkDescriptorSetLayoutBindingFlagsCreateInfo value)Prepends the specifiedVkDescriptorSetLayoutBindingFlagsCreateInfovalue to thepNextchain.VkDescriptorSetLayoutCreateInfopNext(VkDescriptorSetLayoutBindingFlagsCreateInfoEXT value)Prepends the specifiedVkDescriptorSetLayoutBindingFlagsCreateInfoEXTvalue to thepNextchain.VkDescriptorSetLayoutCreateInfopNext(VkMutableDescriptorTypeCreateInfoVALVE value)Prepends the specifiedVkMutableDescriptorTypeCreateInfoVALVEvalue to thepNextchain.VkDescriptorSetLayoutCreateInfoset(int sType, long pNext, int flags, VkDescriptorSetLayoutBinding.Buffer pBindings)Initializes this struct with the specified values.VkDescriptorSetLayoutCreateInfoset(VkDescriptorSetLayoutCreateInfo src)Copies the specified struct data to this struct.intsizeof()intsType()the type of this structure.VkDescriptorSetLayoutCreateInfosType(int value)Sets the specified value to thesType()field.VkDescriptorSetLayoutCreateInfosType$Default()Sets theSTRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFOvalue to thesType()field.static voidvalidate(long struct)Validates pointer members that should not beNULL.
-
-
-
Constructor Detail
-
VkDescriptorSetLayoutCreateInfo
public VkDescriptorSetLayoutCreateInfo(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
the type of 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
@Nullable public VkDescriptorSetLayoutBinding.Buffer pBindings()
a pointer to an array ofVkDescriptorSetLayoutBindingstructures.
-
sType
public VkDescriptorSetLayoutCreateInfo sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkDescriptorSetLayoutCreateInfo sType$Default()
Sets theSTRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFOvalue to thesType()field.
-
pNext
public VkDescriptorSetLayoutCreateInfo pNext(long value)
Sets the specified value to thepNext()field.
-
pNext
public VkDescriptorSetLayoutCreateInfo pNext(VkDescriptorSetLayoutBindingFlagsCreateInfo value)
Prepends the specifiedVkDescriptorSetLayoutBindingFlagsCreateInfovalue to thepNextchain.
-
pNext
public VkDescriptorSetLayoutCreateInfo pNext(VkDescriptorSetLayoutBindingFlagsCreateInfoEXT value)
Prepends the specifiedVkDescriptorSetLayoutBindingFlagsCreateInfoEXTvalue to thepNextchain.
-
pNext
public VkDescriptorSetLayoutCreateInfo pNext(VkMutableDescriptorTypeCreateInfoVALVE value)
Prepends the specifiedVkMutableDescriptorTypeCreateInfoVALVEvalue to thepNextchain.
-
flags
public VkDescriptorSetLayoutCreateInfo flags(int value)
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
public VkDescriptorSetLayoutCreateInfo set(VkDescriptorSetLayoutCreateInfo src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkDescriptorSetLayoutCreateInfo malloc()
Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkDescriptorSetLayoutCreateInfo calloc()
Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkDescriptorSetLayoutCreateInfo create()
Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated withBufferUtils.
-
create
public static VkDescriptorSetLayoutCreateInfo create(long address)
Returns a newVkDescriptorSetLayoutCreateInfoinstance for the specified memory address.
-
createSafe
@Nullable public static VkDescriptorSetLayoutCreateInfo createSafe(long address)
-
malloc
public static VkDescriptorSetLayoutCreateInfo.Buffer malloc(int capacity)
Returns a newVkDescriptorSetLayoutCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkDescriptorSetLayoutCreateInfo.Buffer calloc(int capacity)
Returns a newVkDescriptorSetLayoutCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkDescriptorSetLayoutCreateInfo.Buffer create(int capacity)
Returns a newVkDescriptorSetLayoutCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkDescriptorSetLayoutCreateInfo.Buffer create(long address, int capacity)
Create aVkDescriptorSetLayoutCreateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkDescriptorSetLayoutCreateInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static VkDescriptorSetLayoutCreateInfo mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkDescriptorSetLayoutCreateInfo 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 public static VkDescriptorSetLayoutCreateInfo.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkDescriptorSetLayoutCreateInfo.Buffer callocStack(int capacity)
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
public static VkDescriptorSetLayoutCreateInfo malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkDescriptorSetLayoutCreateInfo calloc(org.lwjgl.system.MemoryStack stack)
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:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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
@Nullable public static VkDescriptorSetLayoutBinding.Buffer npBindings(long struct)
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
public static void npBindings(long struct, @Nullable VkDescriptorSetLayoutBinding.Buffer value)Unsafe version ofpBindings.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
-