Package org.lwjgl.vulkan

Class VkDescriptorBufferBindingInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDescriptorBufferBindingInfoEXT>

org.lwjgl.vulkan.VkDescriptorBufferBindingInfoEXT

All Implemented Interfaces:

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

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

Structure specifying descriptor buffer binding information.

Description

If the pNext chain includes a VkBufferUsageFlags2CreateInfo structure, VkBufferUsageFlags2CreateInfo::usage from that structure is used instead of usage from this structure.

Valid Usage

• If the pNext chain does not include a VkBufferUsageFlags2CreateInfo structure, usage must be a valid combination of VkBufferUsageFlagBits values
• If the pNext chain does not include a VkBufferUsageFlags2CreateInfo structure, usage must not be 0
• If VkPhysicalDeviceDescriptorBufferPropertiesEXT::bufferlessPushDescriptors is FALSE, and usage contains BUFFER_USAGE_PUSH_DESCRIPTORS_DESCRIPTOR_BUFFER_BIT_EXT, then the pNext chain must include a VkDescriptorBufferBindingPushDescriptorBufferHandleEXT structure
• address must be aligned to VkPhysicalDeviceDescriptorBufferPropertiesEXT::descriptorBufferOffsetAlignment
• If usage includes BUFFER_USAGE_SAMPLER_DESCRIPTOR_BUFFER_BIT_EXT, address must be an address within a valid buffer that was created with BUFFER_USAGE_SAMPLER_DESCRIPTOR_BUFFER_BIT_EXT
• If usage includes BUFFER_USAGE_RESOURCE_DESCRIPTOR_BUFFER_BIT_EXT, address must be an address within a valid buffer that was created with BUFFER_USAGE_RESOURCE_DESCRIPTOR_BUFFER_BIT_EXT
• If usage includes BUFFER_USAGE_PUSH_DESCRIPTORS_DESCRIPTOR_BUFFER_BIT_EXT, address must be an address within a valid buffer that was created with BUFFER_USAGE_PUSH_DESCRIPTORS_DESCRIPTOR_BUFFER_BIT_EXT

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DESCRIPTOR_BUFFER_BINDING_INFO_EXT
• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkBufferUsageFlags2CreateInfo or VkDescriptorBufferBindingPushDescriptorBufferHandleEXT
• The sType value of each struct in the pNext chain must be unique

See Also

CmdBindDescriptorBuffersEXT

Layout

 struct VkDescriptorBufferBindingInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkDeviceAddress address;
     VkBufferUsageFlags usage();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkDescriptorBufferBindingInfoEXT.Buffer	An array of VkDescriptorBufferBindingInfoEXT 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	ADDRESS	The struct member offsets.
static final int	ALIGNOF	The struct alignment in bytes.
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.
static final int	USAGE	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
VkDescriptorBufferBindingInfoEXT(ByteBuffer container)	Creates a VkDescriptorBufferBindingInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
long	address$()	a VkDeviceAddress specifying the device address defining the descriptor buffer to be bound.
VkDescriptorBufferBindingInfoEXT	address$(long value)	Sets the specified value to the address$() field.
static VkDescriptorBufferBindingInfoEXT	calloc()	Returns a new VkDescriptorBufferBindingInfoEXT instance allocated with memCalloc.
static VkDescriptorBufferBindingInfoEXT.Buffer	calloc(int capacity)	Returns a new VkDescriptorBufferBindingInfoEXT.Buffer instance allocated with memCalloc.
static VkDescriptorBufferBindingInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDescriptorBufferBindingInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDescriptorBufferBindingInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDescriptorBufferBindingInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDescriptorBufferBindingInfoEXT	create()	Returns a new VkDescriptorBufferBindingInfoEXT instance allocated with BufferUtils.
static VkDescriptorBufferBindingInfoEXT.Buffer	create(int capacity)	Returns a new VkDescriptorBufferBindingInfoEXT.Buffer instance allocated with BufferUtils.
static VkDescriptorBufferBindingInfoEXT	create(long address)	Returns a new VkDescriptorBufferBindingInfoEXT instance for the specified memory address.
static VkDescriptorBufferBindingInfoEXT.Buffer	create(long address, int capacity)	Create a VkDescriptorBufferBindingInfoEXT.Buffer instance at the specified memory.
static @Nullable VkDescriptorBufferBindingInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDescriptorBufferBindingInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkDescriptorBufferBindingInfoEXT	malloc()	Returns a new VkDescriptorBufferBindingInfoEXT instance allocated with memAlloc.
static VkDescriptorBufferBindingInfoEXT.Buffer	malloc(int capacity)	Returns a new VkDescriptorBufferBindingInfoEXT.Buffer instance allocated with memAlloc.
static VkDescriptorBufferBindingInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDescriptorBufferBindingInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkDescriptorBufferBindingInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDescriptorBufferBindingInfoEXT instance allocated on the specified MemoryStack.
static long	naddress$(long struct)	Unsafe version of address$().
static void	naddress$(long struct, long value)	Unsafe version of address$.
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.
static int	nusage(long struct)	Unsafe version of usage().
static void	nusage(long struct, int value)	Unsafe version of usage.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkDescriptorBufferBindingInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkDescriptorBufferBindingInfoEXT	pNext(VkBufferUsageFlags2CreateInfo value)	Prepends the specified VkBufferUsageFlags2CreateInfo value to the pNext chain.
VkDescriptorBufferBindingInfoEXT	pNext(VkBufferUsageFlags2CreateInfoKHR value)	Prepends the specified VkBufferUsageFlags2CreateInfoKHR value to the pNext chain.
VkDescriptorBufferBindingInfoEXT	pNext(VkDescriptorBufferBindingPushDescriptorBufferHandleEXT value)	Prepends the specified VkDescriptorBufferBindingPushDescriptorBufferHandleEXT value to the pNext chain.
VkDescriptorBufferBindingInfoEXT	set(int sType, long pNext, long address$, int usage)	Initializes this struct with the specified values.
VkDescriptorBufferBindingInfoEXT	set(VkDescriptorBufferBindingInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkDescriptorBufferBindingInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkDescriptorBufferBindingInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_DESCRIPTOR_BUFFER_BINDING_INFO_EXT value to the sType() field.
int	usage()	a bitmask of VkBufferUsageFlagBits specifying the VkBufferCreateInfo::usage for the buffer from which address was queried.
VkDescriptorBufferBindingInfoEXT	usage(int value)	Sets the specified value to the usage() 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.

ADDRESS

public static final int ADDRESS

The struct member offsets.

USAGE

public static final int USAGE

The struct member offsets.

Constructor Details

VkDescriptorBufferBindingInfoEXT

public VkDescriptorBufferBindingInfoEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

address$

public long address$()

a VkDeviceAddress specifying the device address defining the descriptor buffer to be bound.

usage

public int usage()

a bitmask of VkBufferUsageFlagBits specifying the VkBufferCreateInfo::usage for the buffer from which address was queried.

sType

public VkDescriptorBufferBindingInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkDescriptorBufferBindingInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_DESCRIPTOR_BUFFER_BINDING_INFO_EXT value to the sType() field.

pNext

public VkDescriptorBufferBindingInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

pNext

public VkDescriptorBufferBindingInfoEXT pNext(VkBufferUsageFlags2CreateInfo value)

Prepends the specified VkBufferUsageFlags2CreateInfo value to the pNext chain.

pNext

public VkDescriptorBufferBindingInfoEXT pNext(VkBufferUsageFlags2CreateInfoKHR value)

Prepends the specified VkBufferUsageFlags2CreateInfoKHR value to the pNext chain.

pNext

public VkDescriptorBufferBindingInfoEXT pNext(VkDescriptorBufferBindingPushDescriptorBufferHandleEXT value)

Prepends the specified VkDescriptorBufferBindingPushDescriptorBufferHandleEXT value to the pNext chain.

address$

public VkDescriptorBufferBindingInfoEXT address$(long value)

Sets the specified value to the address$() field.

usage

public VkDescriptorBufferBindingInfoEXT usage(int value)

Sets the specified value to the usage() field.

set

public VkDescriptorBufferBindingInfoEXT set(int sType,
 long pNext,
 long address$,
 int usage)

Initializes this struct with the specified values.

set

public VkDescriptorBufferBindingInfoEXT set(VkDescriptorBufferBindingInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDescriptorBufferBindingInfoEXT malloc()

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

calloc

public static VkDescriptorBufferBindingInfoEXT calloc()

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

create

public static VkDescriptorBufferBindingInfoEXT create()

Returns a new VkDescriptorBufferBindingInfoEXT instance allocated with BufferUtils.

create

public static VkDescriptorBufferBindingInfoEXT create(long address)

Returns a new VkDescriptorBufferBindingInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkDescriptorBufferBindingInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDescriptorBufferBindingInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDescriptorBufferBindingInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDescriptorBufferBindingInfoEXT.Buffer create(int capacity)

Returns a new VkDescriptorBufferBindingInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDescriptorBufferBindingInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkDescriptorBufferBindingInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

naddress$

public static long naddress$(long struct)

Unsafe version of address$().

nusage

public static int nusage(long struct)

Unsafe version of usage().

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.

naddress$

public static void naddress$(long struct,
 long value)

Unsafe version of address$.

nusage

public static void nusage(long struct,
 int value)

Unsafe version of usage.