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_EXT - 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 any binding has the
DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXTbit set,flagsmust includeDESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT - If any binding has the
DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXTbit set, then all bindings must not havedescriptorTypeofDESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMICorDESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFOpNextmust beNULLor a pointer to a valid instance ofVkDescriptorSetLayoutBindingFlagsCreateInfoEXTflagsmust be a valid combination ofVkDescriptorSetLayoutCreateFlagBitsvalues- If
bindingCountis not 0,pBindingsmust be a valid pointer to an array ofbindingCountvalidVkDescriptorSetLayoutBindingstructures
See Also
VkDescriptorSetLayoutBinding,CreateDescriptorSetLayout,GetDescriptorSetLayoutSupport,GetDescriptorSetLayoutSupportKHRMember documentation
sType– the type of this structure.pNext–NULLor a pointer to an extension-specific structure.flags– a bitmask ofVkDescriptorSetLayoutCreateFlagBitsspecifying options for descriptor set layout creation.bindingCount– the number of elements inpBindings.pBindings– a pointer to an array ofVkDescriptorSetLayoutBindingstructures.
Layout
struct VkDescriptorSetLayoutCreateInfo { VkStructureType sType; void const * pNext; VkDescriptorSetLayoutCreateFlags flags; uint32_t bindingCount;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 Modifier and Type Method Description intbindingCount()Returns the value of thebindingCountfield.static VkDescriptorSetLayoutCreateInfocalloc()Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated withmemCalloc.static VkDescriptorSetLayoutCreateInfo.Buffercalloc(int capacity)Returns a newVkDescriptorSetLayoutCreateInfo.Bufferinstance allocated withmemCalloc.static VkDescriptorSetLayoutCreateInfocallocStack()Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkDescriptorSetLayoutCreateInfo.BuffercallocStack(int capacity)Returns a newVkDescriptorSetLayoutCreateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkDescriptorSetLayoutCreateInfo.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkDescriptorSetLayoutCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDescriptorSetLayoutCreateInfocallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.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()Returns the value of theflagsfield.VkDescriptorSetLayoutCreateInfoflags(int value)Sets the specified value to theflagsfield.static VkDescriptorSetLayoutCreateInfomalloc()Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated withmemAlloc.static VkDescriptorSetLayoutCreateInfo.Buffermalloc(int capacity)Returns a newVkDescriptorSetLayoutCreateInfo.Bufferinstance allocated withmemAlloc.static VkDescriptorSetLayoutCreateInfomallocStack()Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated on the thread-localMemoryStack.static VkDescriptorSetLayoutCreateInfo.BuffermallocStack(int capacity)Returns a newVkDescriptorSetLayoutCreateInfo.Bufferinstance allocated on the thread-localMemoryStack.static VkDescriptorSetLayoutCreateInfo.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkDescriptorSetLayoutCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkDescriptorSetLayoutCreateInfomallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated on the specifiedMemoryStack.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()Returns aVkDescriptorSetLayoutBinding.Bufferview of the struct array pointed to by thepBindingsfield.VkDescriptorSetLayoutCreateInfopBindings(VkDescriptorSetLayoutBinding.Buffer value)Sets the address of the specifiedVkDescriptorSetLayoutBinding.Bufferto thepBindingsfield.longpNext()Returns the value of thepNextfield.VkDescriptorSetLayoutCreateInfopNext(long value)Sets the specified value to thepNextfield.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()Returns the value of thesTypefield.VkDescriptorSetLayoutCreateInfosType(int value)Sets the specified value to thesTypefield.static voidvalidate(long struct)Validates pointer members that should not beNULL.static voidvalidate(long array, int count)Callsvalidate(long)for each struct contained in the specified struct array.
-
-
-
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()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
flags
public int flags()
Returns the value of theflagsfield.
-
bindingCount
public int bindingCount()
Returns the value of thebindingCountfield.
-
pBindings
@Nullable public VkDescriptorSetLayoutBinding.Buffer pBindings()
Returns aVkDescriptorSetLayoutBinding.Bufferview of the struct array pointed to by thepBindingsfield.
-
sType
public VkDescriptorSetLayoutCreateInfo sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkDescriptorSetLayoutCreateInfo pNext(long value)
Sets the specified value to thepNextfield.
-
flags
public VkDescriptorSetLayoutCreateInfo flags(int value)
Sets the specified value to theflagsfield.
-
pBindings
public VkDescriptorSetLayoutCreateInfo pBindings(@Nullable VkDescriptorSetLayoutBinding.Buffer value)
Sets the address of the specifiedVkDescriptorSetLayoutBinding.Bufferto thepBindingsfield.
-
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
public static VkDescriptorSetLayoutCreateInfo mallocStack()
Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkDescriptorSetLayoutCreateInfo callocStack()
Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkDescriptorSetLayoutCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDescriptorSetLayoutCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkDescriptorSetLayoutCreateInfo callocStack(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
-
mallocStack
public static VkDescriptorSetLayoutCreateInfo.Buffer mallocStack(int capacity)
Returns a newVkDescriptorSetLayoutCreateInfo.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkDescriptorSetLayoutCreateInfo.Buffer callocStack(int capacity)
Returns a newVkDescriptorSetLayoutCreateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkDescriptorSetLayoutCreateInfo.Buffer mallocStack(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
-
callocStack
public static VkDescriptorSetLayoutCreateInfo.Buffer callocStack(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
-
validate
public static void validate(long array, int count)Callsvalidate(long)for each struct contained in the specified struct array.- Parameters:
array- the struct array to validatecount- the number of structs inarray
-
-