java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkBufferCreateInfo

All Implemented Interfaces:

java.lang.AutoCloseable, NativeResource, Pointer
```
public class VkBufferCreateInfo
extends Struct
implements NativeResource
```
Structure specifying the parameters of a newly created buffer object.
Valid Usage
- size must be greater than 0
- If sharingMode is SHARING_MODE_CONCURRENT, pQueueFamilyIndices must be a valid pointer to an array of queueFamilyIndexCount uint32_t values
- If sharingMode is SHARING_MODE_CONCURRENT, queueFamilyIndexCount must be greater than 1
- If sharingMode is SHARING_MODE_CONCURRENT, each element of pQueueFamilyIndices must be unique and must be less than pQueueFamilyPropertyCount returned by either GetPhysicalDeviceQueueFamilyProperties or GetPhysicalDeviceQueueFamilyProperties2 for the physicalDevice that was used to create device
- If the sparse bindings feature is not enabled, flags must not contain BUFFER_CREATE_SPARSE_BINDING_BIT
- If the sparse buffer residency feature is not enabled, flags must not contain BUFFER_CREATE_SPARSE_RESIDENCY_BIT
- If the sparse aliased residency feature is not enabled, flags must not contain BUFFER_CREATE_SPARSE_ALIASED_BIT
- If flags contains BUFFER_CREATE_SPARSE_RESIDENCY_BIT or BUFFER_CREATE_SPARSE_ALIASED_BIT, it must also contain BUFFER_CREATE_SPARSE_BINDING_BIT
- If the pNext chain contains an instance of VkExternalMemoryBufferCreateInfo, its handleTypes member must only contain bits that are also in VkExternalBufferProperties::externalMemoryProperties.compatibleHandleTypes, as returned by GetPhysicalDeviceExternalBufferProperties with pExternalBufferInfo->handleType equal to any one of the handle types specified in VkExternalMemoryBufferCreateInfo::handleTypes
- If the protected memory feature is not enabled, flags must not contain BUFFER_CREATE_PROTECTED_BIT
- If any of the bits BUFFER_CREATE_SPARSE_BINDING_BIT, BUFFER_CREATE_SPARSE_RESIDENCY_BIT, or BUFFER_CREATE_SPARSE_ALIASED_BIT are set, BUFFER_CREATE_PROTECTED_BIT must not also be set
- If the pNext chain contains an instance of VkDedicatedAllocationBufferCreateInfoNV, and the dedicatedAllocation member of the chained structure is TRUE, then flags must not include BUFFER_CREATE_SPARSE_BINDING_BIT, BUFFER_CREATE_SPARSE_RESIDENCY_BIT, or BUFFER_CREATE_SPARSE_ALIASED_BIT
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_BUFFER_CREATE_INFO
- 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 VkDedicatedAllocationBufferCreateInfoNV or VkExternalMemoryBufferCreateInfo
- Each sType member in the pNext chain must be unique
- flags must be a valid combination of VkBufferCreateFlagBits values
- usage must be a valid combination of VkBufferUsageFlagBits values
- usage must not be 0
- sharingMode must be a valid VkSharingMode value
See Also

CreateBuffer

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- flags – a bitmask of VkBufferCreateFlagBits specifying additional parameters of the buffer.
- size – the size in bytes of the buffer to be created.
- usage – a bitmask of VkBufferUsageFlagBits specifying allowed usages of the buffer.
- sharingMode – a VkSharingMode value specifying the sharing mode of the buffer when it will be accessed by multiple queue families.
- queueFamilyIndexCount – the number of entries in the pQueueFamilyIndices array.
- pQueueFamilyIndices – a list of queue families that will access this buffer (ignored if sharingMode is not SHARING_MODE_CONCURRENT).
Layout
```
 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 interface org.lwjgl.system.Pointer
  Pointer.Default

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`FLAGS PNEXT PQUEUEFAMILYINDICES QUEUEFAMILYINDEXCOUNT SHARINGMODE SIZE`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`STYPE USAGE`	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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`	`callocStack()`	Returns a new `VkBufferCreateInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkBufferCreateInfo.Buffer`	`callocStack(int capacity)`	Returns a new `VkBufferCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkBufferCreateInfo.Buffer`	`callocStack(int capacity, MemoryStack stack)`	Returns a new `VkBufferCreateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkBufferCreateInfo`	`callocStack(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 VkBufferCreateInfo`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkBufferCreateInfo.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`int`	`flags()`	Returns the value of the `flags` field.
`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`	`mallocStack()`	Returns a new `VkBufferCreateInfo` instance allocated on the thread-local `MemoryStack`.
`static VkBufferCreateInfo.Buffer`	`mallocStack(int capacity)`	Returns a new `VkBufferCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkBufferCreateInfo.Buffer`	`mallocStack(int capacity, MemoryStack stack)`	Returns a new `VkBufferCreateInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkBufferCreateInfo`	`mallocStack(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 java.nio.IntBuffer`	`npQueueFamilyIndices(long struct)`	Unsafe version of `pQueueFamilyIndices`.
`static void`	`npQueueFamilyIndices(long struct, java.nio.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()`	Returns the value of the `pNext` field.
`VkBufferCreateInfo`	`pNext(long value)`	Sets the specified value to the `pNext` field.
`java.nio.IntBuffer`	`pQueueFamilyIndices()`	Returns a `IntBuffer` view of the data pointed to by the `pQueueFamilyIndices` field.
`VkBufferCreateInfo`	`pQueueFamilyIndices(java.nio.IntBuffer value)`	Sets the address of the specified `IntBuffer` to the `pQueueFamilyIndices` field.
`int`	`queueFamilyIndexCount()`	Returns the value of the `queueFamilyIndexCount` field.
`VkBufferCreateInfo`	`set(int sType, long pNext, int flags, long size, int usage, int sharingMode, java.nio.IntBuffer pQueueFamilyIndices)`	Initializes this struct with the specified values.
`VkBufferCreateInfo`	`set(VkBufferCreateInfo src)`	Copies the specified struct data to this struct.
`int`	`sharingMode()`	Returns the value of the `sharingMode` field.
`VkBufferCreateInfo`	`sharingMode(int value)`	Sets the specified value to the `sharingMode` field.
`long`	`size()`	Returns the value of the `size` field.
`VkBufferCreateInfo`	`size(long value)`	Sets the specified value to the `size` field.
`int`	`sizeof()`	Returns `sizeof(struct)`.
`int`	`sType()`	Returns the value of the `sType` field.
`VkBufferCreateInfo`	`sType(int value)`	Sets the specified value to the `sType` field.
`int`	`usage()`	Returns the value of the `usage` field.
`VkBufferCreateInfo`	`usage(int value)`	Sets the specified value to the `usage` field.
`static void`	`validate(long struct)`	Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)`	Calls `validate(long)` for each struct contained in the specified struct array.

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

- Field Detail
  - SIZEOF
    
    The struct size in bytes.
  - ALIGNOF
    
    The struct alignment in bytes.
  - STYPE, PNEXT, FLAGS, SIZE, USAGE, SHARINGMODE, QUEUEFAMILYINDEXCOUNT, PQUEUEFAMILYINDICES
    
    The struct member offsets.
- Constructor Detail
  - VkBufferCreateInfo
```
public VkBufferCreateInfo(java.nio.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 Detail
  - sizeof
```
public int sizeof()
```
    Description copied from class: Struct
    
    Returns sizeof(struct).
    
    Specified by:
    
    sizeof in class Struct
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - flags
```
public int flags()
```
    Returns the value of the flags field.
  - size
```
public long size()
```
    Returns the value of the size field.
  - usage
```
public int usage()
```
    Returns the value of the usage field.
  - sharingMode
```
public int sharingMode()
```
    Returns the value of the sharingMode field.
  - queueFamilyIndexCount
```
public int queueFamilyIndexCount()
```
    Returns the value of the queueFamilyIndexCount field.
  - pQueueFamilyIndices
```
@Nullable
public java.nio.IntBuffer pQueueFamilyIndices()
```
    Returns a IntBuffer view of the data pointed to by the pQueueFamilyIndices field.
  - sType
```
public VkBufferCreateInfo sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkBufferCreateInfo pNext(long value)
```
    Sets the specified value to the pNext field.
  - flags
```
public VkBufferCreateInfo flags(int value)
```
    Sets the specified value to the flags field.
  - size
```
public VkBufferCreateInfo size(long value)
```
    Sets the specified value to the size field.
  - usage
```
public VkBufferCreateInfo usage(int value)
```
    Sets the specified value to the usage field.
  - sharingMode
```
public VkBufferCreateInfo sharingMode(int value)
```
    Sets the specified value to the sharingMode field.
  - pQueueFamilyIndices
```
public VkBufferCreateInfo pQueueFamilyIndices(@Nullable
                                              java.nio.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,
                              @Nullable
                              java.nio.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
```
@Nullable
public static 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
```
@Nullable
public static VkBufferCreateInfo.Buffer createSafe(long address,
                                                   int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkBufferCreateInfo mallocStack()
```
    Returns a new VkBufferCreateInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkBufferCreateInfo callocStack()
```
    Returns a new VkBufferCreateInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkBufferCreateInfo mallocStack(MemoryStack stack)
```
    Returns a new VkBufferCreateInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkBufferCreateInfo callocStack(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
  - mallocStack
```
public static VkBufferCreateInfo.Buffer mallocStack(int capacity)
```
    Returns a new VkBufferCreateInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkBufferCreateInfo.Buffer callocStack(int capacity)
```
    Returns a new VkBufferCreateInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkBufferCreateInfo.Buffer mallocStack(int capacity,
                                                    MemoryStack stack)
```
    Returns a new VkBufferCreateInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkBufferCreateInfo.Buffer callocStack(int capacity,
                                                    MemoryStack stack)
```
    Returns a new VkBufferCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - 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
```
@Nullable
public static java.nio.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
                                        java.nio.IntBuffer value)
```
    Unsafe version of pQueueFamilyIndices.
  - validate
```
public static void validate(long struct)
```
    Validates pointer members that should not be NULL.
    
    Parameters:
    
    struct - the struct to validate
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class VkBufferCreateInfo

Valid Usage

Valid Usage (Implicit)

See Also

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

STYPE, PNEXT, FLAGS, SIZE, USAGE, SHARINGMODE, QUEUEFAMILYINDEXCOUNT, PQUEUEFAMILYINDICES

Constructor Detail

VkBufferCreateInfo

Method Detail

sizeof

sType

pNext

flags

size

usage

sharingMode

queueFamilyIndexCount

pQueueFamilyIndices

sType

pNext

flags

size

usage

sharingMode

pQueueFamilyIndices

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nflags

nsize

nusage

nsharingMode

nqueueFamilyIndexCount

npQueueFamilyIndices

nsType

npNext

nflags

nsize

nusage

nsharingMode

nqueueFamilyIndexCount

npQueueFamilyIndices

validate

validate