Package org.lwjgl.vulkan

Class VkBufferUsageFlags2CreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkBufferUsageFlags2CreateInfo>

org.lwjgl.vulkan.VkBufferUsageFlags2CreateInfo

All Implemented Interfaces:

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

Direct Known Subclasses:

VkBufferUsageFlags2CreateInfoKHR

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

Extended buffer usage flags.

Description

If this structure is included in the pNext chain of a buffer creation structure, usage is used instead of the corresponding usage value passed in that creation structure, allowing additional usage flags to be specified. If this structure is included in the pNext chain of a buffer query structure, the usage flags of the buffer are returned in usage of this structure, and the usage flags representable in usage of the buffer query structure are also returned in that field.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_BUFFER_USAGE_FLAGS_2_CREATE_INFO
• usage must be a valid combination of VkBufferUsageFlagBits2 values
• usage must not be 0

Layout

 struct VkBufferUsageFlags2CreateInfo {
     VkStructureType sType();
     void const * pNext();
     VkBufferUsageFlags2 usage();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkBufferUsageFlags2CreateInfo.Buffer	An array of VkBufferUsageFlags2CreateInfo 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	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
VkBufferUsageFlags2CreateInfo(ByteBuffer container)	Creates a VkBufferUsageFlags2CreateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkBufferUsageFlags2CreateInfo	calloc()	Returns a new VkBufferUsageFlags2CreateInfo instance allocated with memCalloc.
static VkBufferUsageFlags2CreateInfo.Buffer	calloc(int capacity)	Returns a new VkBufferUsageFlags2CreateInfo.Buffer instance allocated with memCalloc.
static VkBufferUsageFlags2CreateInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkBufferUsageFlags2CreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkBufferUsageFlags2CreateInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkBufferUsageFlags2CreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkBufferUsageFlags2CreateInfo	create()	Returns a new VkBufferUsageFlags2CreateInfo instance allocated with BufferUtils.
static VkBufferUsageFlags2CreateInfo.Buffer	create(int capacity)	Returns a new VkBufferUsageFlags2CreateInfo.Buffer instance allocated with BufferUtils.
static VkBufferUsageFlags2CreateInfo	create(long address)	Returns a new VkBufferUsageFlags2CreateInfo instance for the specified memory address.
static VkBufferUsageFlags2CreateInfo.Buffer	create(long address, int capacity)	Create a VkBufferUsageFlags2CreateInfo.Buffer instance at the specified memory.
static @Nullable VkBufferUsageFlags2CreateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkBufferUsageFlags2CreateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkBufferUsageFlags2CreateInfo	malloc()	Returns a new VkBufferUsageFlags2CreateInfo instance allocated with memAlloc.
static VkBufferUsageFlags2CreateInfo.Buffer	malloc(int capacity)	Returns a new VkBufferUsageFlags2CreateInfo.Buffer instance allocated with memAlloc.
static VkBufferUsageFlags2CreateInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkBufferUsageFlags2CreateInfo.Buffer instance allocated on the specified MemoryStack.
static VkBufferUsageFlags2CreateInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkBufferUsageFlags2CreateInfo instance allocated on the specified MemoryStack.
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 long	nusage(long struct)	Unsafe version of usage().
static void	nusage(long struct, long value)	Unsafe version of usage.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkBufferUsageFlags2CreateInfo	pNext(long value)	Sets the specified value to the pNext() field.
VkBufferUsageFlags2CreateInfo	set(int sType, long pNext, long usage)	Initializes this struct with the specified values.
VkBufferUsageFlags2CreateInfo	set(VkBufferUsageFlags2CreateInfo src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkBufferUsageFlags2CreateInfo	sType(int value)	Sets the specified value to the sType() field.
VkBufferUsageFlags2CreateInfo	sType$Default()	Sets the STRUCTURE_TYPE_BUFFER_USAGE_FLAGS_2_CREATE_INFO value to the sType() field.
long	usage()	a bitmask of VkBufferUsageFlagBits2 specifying allowed usages of the buffer.
VkBufferUsageFlags2CreateInfo	usage(long 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.

USAGE

public static final int USAGE

The struct member offsets.

Constructor Details

VkBufferUsageFlags2CreateInfo

public VkBufferUsageFlags2CreateInfo(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

usage

public long usage()

a bitmask of VkBufferUsageFlagBits2 specifying allowed usages of the buffer.

sType

public VkBufferUsageFlags2CreateInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkBufferUsageFlags2CreateInfo sType$Default()

Sets the STRUCTURE_TYPE_BUFFER_USAGE_FLAGS_2_CREATE_INFO value to the sType() field.

pNext

public VkBufferUsageFlags2CreateInfo pNext(long value)

Sets the specified value to the pNext() field.

usage

public VkBufferUsageFlags2CreateInfo usage(long value)

Sets the specified value to the usage() field.

set

public VkBufferUsageFlags2CreateInfo set(int sType,
 long pNext,
 long usage)

Initializes this struct with the specified values.

set

public VkBufferUsageFlags2CreateInfo set(VkBufferUsageFlags2CreateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkBufferUsageFlags2CreateInfo malloc()

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

calloc

public static VkBufferUsageFlags2CreateInfo calloc()

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

create

public static VkBufferUsageFlags2CreateInfo create()

Returns a new VkBufferUsageFlags2CreateInfo instance allocated with BufferUtils.

create

public static VkBufferUsageFlags2CreateInfo create(long address)

Returns a new VkBufferUsageFlags2CreateInfo instance for the specified memory address.

createSafe

public static @Nullable VkBufferUsageFlags2CreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkBufferUsageFlags2CreateInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkBufferUsageFlags2CreateInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkBufferUsageFlags2CreateInfo.Buffer create(int capacity)

Returns a new VkBufferUsageFlags2CreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkBufferUsageFlags2CreateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkBufferUsageFlags2CreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nusage

public static long 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.

nusage

public static void nusage(long struct,
 long value)

Unsafe version of usage.