Class VkBufferCreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkBufferCreateInfo>

org.lwjgl.vulkan.VkBufferCreateInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkBufferCreateInfo
extends Struct<VkBufferCreateInfo>
implements NativeResource

struct VkBufferCreateInfo {
    VkStructureType sType;
    void const * pNext;
    VkBufferCreateFlags flags;
    VkDeviceSize size;
    VkBufferUsageFlags usage;
    VkSharingMode sharingMode;
    uint32_t queueFamilyIndexCount;
    uint32_t const * pQueueFamilyIndices;
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkBufferCreateInfo.Buffer	An array of VkBufferCreateInfo structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	FLAGS	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	PQUEUEFAMILYINDICES	The struct member offsets.
static final int	QUEUEFAMILYINDEXCOUNT	The struct member offsets.
static final int	SHARINGMODE	The struct member offsets.
static final int	SIZE	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 Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkBufferCreateInfo(ByteBuffer container)	Creates a VkBufferCreateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkBufferCreateInfo	calloc()	Returns a new VkBufferCreateInfo instance allocated with memCalloc.
static VkBufferCreateInfo.Buffer	calloc(int capacity)	Returns a new VkBufferCreateInfo.Buffer instance allocated with memCalloc.
static VkBufferCreateInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkBufferCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkBufferCreateInfo	calloc(MemoryStack stack)	Returns a new VkBufferCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkBufferCreateInfo	create()	Returns a new VkBufferCreateInfo instance allocated with BufferUtils.
static VkBufferCreateInfo.Buffer	create(int capacity)	Returns a new VkBufferCreateInfo.Buffer instance allocated with BufferUtils.
static VkBufferCreateInfo	create(long address)	Returns a new VkBufferCreateInfo instance for the specified memory address.
static VkBufferCreateInfo.Buffer	create(long address, int capacity)	Create a VkBufferCreateInfo.Buffer instance at the specified memory.
static @Nullable VkBufferCreateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkBufferCreateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()
VkBufferCreateInfo	flags(int value)	Sets the specified value to the flags field.
static VkBufferCreateInfo	malloc()	Returns a new VkBufferCreateInfo instance allocated with memAlloc.
static VkBufferCreateInfo.Buffer	malloc(int capacity)	Returns a new VkBufferCreateInfo.Buffer instance allocated with memAlloc.
static VkBufferCreateInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkBufferCreateInfo.Buffer instance allocated on the specified MemoryStack.
static VkBufferCreateInfo	malloc(MemoryStack stack)	Returns a new VkBufferCreateInfo instance allocated on the specified MemoryStack.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static @Nullable IntBuffer	npQueueFamilyIndices(long struct)	Unsafe version of pQueueFamilyIndices.
static void	npQueueFamilyIndices(long struct, @Nullable IntBuffer value)	Unsafe version of pQueueFamilyIndices.
static int	nqueueFamilyIndexCount(long struct)	Unsafe version of queueFamilyIndexCount().
static void	nqueueFamilyIndexCount(long struct, int value)	Sets the specified value to the queueFamilyIndexCount field of the specified struct.
static int	nsharingMode(long struct)	Unsafe version of sharingMode().
static void	nsharingMode(long struct, int value)	Unsafe version of sharingMode.
static long	nsize(long struct)	Unsafe version of size().
static void	nsize(long struct, long value)	Unsafe version of size.
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()
VkBufferCreateInfo	pNext(long value)	Sets the specified value to the pNext field.
VkBufferCreateInfo	pNext(VkBufferDeviceAddressCreateInfoEXT value)	Prepends the specified VkBufferDeviceAddressCreateInfoEXT value to the pNext chain.
VkBufferCreateInfo	pNext(VkBufferOpaqueCaptureAddressCreateInfo value)	Prepends the specified VkBufferOpaqueCaptureAddressCreateInfo value to the pNext chain.
VkBufferCreateInfo	pNext(VkBufferOpaqueCaptureAddressCreateInfoKHR value)	Prepends the specified VkBufferOpaqueCaptureAddressCreateInfoKHR value to the pNext chain.
VkBufferCreateInfo	pNext(VkBufferUsageFlags2CreateInfo value)	Prepends the specified VkBufferUsageFlags2CreateInfo value to the pNext chain.
VkBufferCreateInfo	pNext(VkBufferUsageFlags2CreateInfoKHR value)	Prepends the specified VkBufferUsageFlags2CreateInfoKHR value to the pNext chain.
VkBufferCreateInfo	pNext(VkDedicatedAllocationBufferCreateInfoNV value)	Prepends the specified VkDedicatedAllocationBufferCreateInfoNV value to the pNext chain.
VkBufferCreateInfo	pNext(VkExternalMemoryBufferCreateInfo value)	Prepends the specified VkExternalMemoryBufferCreateInfo value to the pNext chain.
VkBufferCreateInfo	pNext(VkExternalMemoryBufferCreateInfoKHR value)	Prepends the specified VkExternalMemoryBufferCreateInfoKHR value to the pNext chain.
VkBufferCreateInfo	pNext(VkOpaqueCaptureDescriptorDataCreateInfoEXT value)	Prepends the specified VkOpaqueCaptureDescriptorDataCreateInfoEXT value to the pNext chain.
VkBufferCreateInfo	pNext(VkVideoProfileListInfoKHR value)	Prepends the specified VkVideoProfileListInfoKHR value to the pNext chain.
@Nullable IntBuffer	pQueueFamilyIndices()
VkBufferCreateInfo	pQueueFamilyIndices(@Nullable IntBuffer value)	Sets the address of the specified IntBuffer to the pQueueFamilyIndices field.
int	queueFamilyIndexCount()
VkBufferCreateInfo	queueFamilyIndexCount(int value)	Sets the specified value to the queueFamilyIndexCount field.
VkBufferCreateInfo	set(int sType, long pNext, int flags, long size, int usage, int sharingMode, int queueFamilyIndexCount, @Nullable IntBuffer pQueueFamilyIndices)	Initializes this struct with the specified values.
VkBufferCreateInfo	set(VkBufferCreateInfo src)	Copies the specified struct data to this struct.
int	sharingMode()
VkBufferCreateInfo	sharingMode(int value)	Sets the specified value to the sharingMode field.
long	size()
VkBufferCreateInfo	size(long value)	Sets the specified value to the size field.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkBufferCreateInfo	sType(int value)	Sets the specified value to the sType field.
VkBufferCreateInfo	sType$Default()	Sets the STRUCTURE_TYPE_BUFFER_CREATE_INFO value to the sType field.
int	usage()
VkBufferCreateInfo	usage(int value)	Sets the specified value to the usage field.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface 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.

FLAGS

public static final int FLAGS

The struct member offsets.

SIZE

public static final int SIZE

The struct member offsets.

USAGE

public static final int USAGE

The struct member offsets.

SHARINGMODE

public static final int SHARINGMODE

The struct member offsets.

QUEUEFAMILYINDEXCOUNT

public static final int QUEUEFAMILYINDEXCOUNT

The struct member offsets.

PQUEUEFAMILYINDICES

public static final int PQUEUEFAMILYINDICES

The struct member offsets.

Constructor Details

VkBufferCreateInfo

public VkBufferCreateInfo(ByteBuffer container)

Creates a VkBufferCreateInfo 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()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkBufferCreateInfo>

sType

@NativeType("VkStructureType")
public int sType()

Returns:

the value of the sType field.

pNext

@NativeType("void const *")
public long pNext()

Returns:

the value of the pNext field.

flags

@NativeType("VkBufferCreateFlags")
public int flags()

Returns:

the value of the flags field.

size

@NativeType("VkDeviceSize")
public long size()

Returns:

the value of the size field.

usage

@NativeType("VkBufferUsageFlags")
public int usage()

Returns:

the value of the usage field.

sharingMode

@NativeType("VkSharingMode")
public int sharingMode()

Returns:

the value of the sharingMode field.

queueFamilyIndexCount

@NativeType("uint32_t")
public int queueFamilyIndexCount()

Returns:

the value of the queueFamilyIndexCount field.

pQueueFamilyIndices

@NativeType("uint32_t const *")
public @Nullable IntBuffer pQueueFamilyIndices()

Returns:

a IntBuffer view of the data pointed to by the pQueueFamilyIndices field.

sType

public VkBufferCreateInfo sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

sType$Default

public VkBufferCreateInfo sType$Default()

Sets the STRUCTURE_TYPE_BUFFER_CREATE_INFO value to the sType field.

pNext

public VkBufferCreateInfo pNext(@NativeType("void const *")
 long value)

Sets the specified value to the pNext field.

pNext

public VkBufferCreateInfo pNext(VkBufferDeviceAddressCreateInfoEXT value)

Prepends the specified VkBufferDeviceAddressCreateInfoEXT value to the pNext chain.

pNext

public VkBufferCreateInfo pNext(VkBufferOpaqueCaptureAddressCreateInfo value)

Prepends the specified VkBufferOpaqueCaptureAddressCreateInfo value to the pNext chain.

pNext

public VkBufferCreateInfo pNext(VkBufferOpaqueCaptureAddressCreateInfoKHR value)

Prepends the specified VkBufferOpaqueCaptureAddressCreateInfoKHR value to the pNext chain.

pNext

public VkBufferCreateInfo pNext(VkBufferUsageFlags2CreateInfo value)

Prepends the specified VkBufferUsageFlags2CreateInfo value to the pNext chain.

pNext

public VkBufferCreateInfo pNext(VkBufferUsageFlags2CreateInfoKHR value)

Prepends the specified VkBufferUsageFlags2CreateInfoKHR value to the pNext chain.

pNext

public VkBufferCreateInfo pNext(VkDedicatedAllocationBufferCreateInfoNV value)

Prepends the specified VkDedicatedAllocationBufferCreateInfoNV value to the pNext chain.

pNext

public VkBufferCreateInfo pNext(VkExternalMemoryBufferCreateInfo value)

Prepends the specified VkExternalMemoryBufferCreateInfo value to the pNext chain.

pNext

public VkBufferCreateInfo pNext(VkExternalMemoryBufferCreateInfoKHR value)

Prepends the specified VkExternalMemoryBufferCreateInfoKHR value to the pNext chain.

pNext

public VkBufferCreateInfo pNext(VkOpaqueCaptureDescriptorDataCreateInfoEXT value)

Prepends the specified VkOpaqueCaptureDescriptorDataCreateInfoEXT value to the pNext chain.

pNext

public VkBufferCreateInfo pNext(VkVideoProfileListInfoKHR value)

Prepends the specified VkVideoProfileListInfoKHR value to the pNext chain.

flags

public VkBufferCreateInfo flags(@NativeType("VkBufferCreateFlags")
 int value)

Sets the specified value to the flags field.

size

public VkBufferCreateInfo size(@NativeType("VkDeviceSize")
 long value)

Sets the specified value to the size field.

usage

public VkBufferCreateInfo usage(@NativeType("VkBufferUsageFlags")
 int value)

Sets the specified value to the usage field.

sharingMode

public VkBufferCreateInfo sharingMode(@NativeType("VkSharingMode")
 int value)

Sets the specified value to the sharingMode field.

queueFamilyIndexCount

public VkBufferCreateInfo queueFamilyIndexCount(@NativeType("uint32_t")
 int value)

Sets the specified value to the queueFamilyIndexCount field.

pQueueFamilyIndices

public VkBufferCreateInfo pQueueFamilyIndices(@NativeType("uint32_t const *")
 @Nullable IntBuffer value)

Sets the address of the specified IntBuffer to the pQueueFamilyIndices field.

set

public VkBufferCreateInfo set(int sType,
 long pNext,
 int flags,
 long size,
 int usage,
 int sharingMode,
 int queueFamilyIndexCount,
 @Nullable IntBuffer pQueueFamilyIndices)

Initializes this struct with the specified values.

set

public VkBufferCreateInfo set(VkBufferCreateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkBufferCreateInfo malloc()

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

calloc

public static VkBufferCreateInfo calloc()

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

create

public static VkBufferCreateInfo create()

Returns a new VkBufferCreateInfo instance allocated with BufferUtils.

create

public static VkBufferCreateInfo create(long address)

Returns a new VkBufferCreateInfo instance for the specified memory address.

createSafe

public static @Nullable VkBufferCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkBufferCreateInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkBufferCreateInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkBufferCreateInfo.Buffer create(int capacity)

Returns a new VkBufferCreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkBufferCreateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkBufferCreateInfo malloc(MemoryStack stack)

Returns a new VkBufferCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkBufferCreateInfo calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkBufferCreateInfo.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkBufferCreateInfo.Buffer calloc(int capacity,
 MemoryStack stack)

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

nflags

public static int nflags(long struct)

Unsafe version of flags().

nsize

public static long nsize(long struct)

Unsafe version of size().

nusage

public static int nusage(long struct)

Unsafe version of usage().

nsharingMode

public static int nsharingMode(long struct)

Unsafe version of sharingMode().

nqueueFamilyIndexCount

public static int nqueueFamilyIndexCount(long struct)

Unsafe version of queueFamilyIndexCount().

npQueueFamilyIndices

public static @Nullable IntBuffer npQueueFamilyIndices(long struct)

Unsafe version of pQueueFamilyIndices.

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.

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.

nsize

public static void nsize(long struct,
 long value)

Unsafe version of size.

nusage

public static void nusage(long struct,
 int value)

Unsafe version of usage.

nsharingMode

public static void nsharingMode(long struct,
 int value)

Unsafe version of sharingMode.

nqueueFamilyIndexCount

public static void nqueueFamilyIndexCount(long struct,
 int value)

Sets the specified value to the queueFamilyIndexCount field of the specified struct.

npQueueFamilyIndices

public static void npQueueFamilyIndices(long struct,
 @Nullable IntBuffer value)

Unsafe version of pQueueFamilyIndices.