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

Khronos Reference Page
Vulkan Specification

Contains information about how a buffer should be created.

Valid Usage

sType must be STRUCTURE_TYPE_BUFFER_CREATE_INFO
pNext must be NULL
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
size must be greater than 0
If sharingMode is SHARING_MODE_CONCURRENT, pQueueFamilyIndices must be a pointer to an array of queueFamilyIndexCount uint32_t values
If sharingMode is SHARING_MODE_CONCURRENT, queueFamilyIndexCount must be greater than 1
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

Member documentation

sType – the type of this structure. Must be: STRUCTURE_TYPE_BUFFER_CREATE_INFO
pNext – reserved for use by extensions
flags – a VkBufferCreateFlagBits bitfield describing additional parameters of the buffer. One or more of:
BUFFER_CREATE_SPARSE_ALIASED_BIT BUFFER_CREATE_SPARSE_BINDING_BIT
BUFFER_CREATE_SPARSE_RESIDENCY_BIT
size – the size in bytes of the buffer to be created

usage – a VkBufferUsageFlagBits bitfield describing the allowed usages of the buffer. One or more of:

`BUFFER_USAGE_INDEX_BUFFER_BIT`	`BUFFER_USAGE_INDIRECT_BUFFER_BIT`
`BUFFER_USAGE_STORAGE_BUFFER_BIT`	`BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT`
`BUFFER_USAGE_TRANSFER_DST_BIT`	`BUFFER_USAGE_TRANSFER_SRC_BIT`
`BUFFER_USAGE_UNIFORM_BUFFER_BIT`	`BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT`
`BUFFER_USAGE_VERTEX_BUFFER_BIT`

sharingMode – the sharing mode of the buffer when it will be accessed by multiple queue families. One of:
SHARING_MODE_CONCURRENT SHARING_MODE_EXCLUSIVE
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;
    const void * pNext;
    VkBufferCreateFlags flags;
    VkDeviceSize size;
    VkBufferUsageFlags usage;
    VkSharingMode sharingMode;
    uint32_t queueFamilyIndexCount;
    const uint32_t * pQueueFamilyIndices;
}

Nested Class Summary

Nested Classes
Modifier and Type Class and 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 and Description

static int SIZEOF
The struct size in bytes.
- Fields inherited from interface org.lwjgl.system.Pointer
  POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and 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 and 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 or `null` if the address is `NULL`.
`static VkBufferCreateInfo.Buffer`	`create(long address, int capacity)` Create a `VkBufferCreateInfo.Buffer` instance at the specified memory.
`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`.
`VkBufferCreateInfo`	`nset(long struct)` Unsafe version of `set`.
`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 the `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 `VkBufferCreateInfo.validate(long)` for each struct contained in the specified struct array.

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

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
- 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 the 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
```
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(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,
                              java.nio.IntBuffer pQueueFamilyIndices)
```
    Initializes this struct with the specified values.
  - nset
```
public VkBufferCreateInfo nset(long struct)
```
    Unsafe version of set.
  - 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 or null if the 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
  - 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
  - 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 VkBufferCreateInfo.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

`BUFFER_CREATE_SPARSE_ALIASED_BIT`	`BUFFER_CREATE_SPARSE_BINDING_BIT`
`BUFFER_CREATE_SPARSE_RESIDENCY_BIT`

Class VkBufferCreateInfo

Valid Usage

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 class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

Constructor Detail

VkBufferCreateInfo

Method Detail

sizeof

sType

pNext

flags

size

usage

sharingMode

queueFamilyIndexCount

pQueueFamilyIndices

sType

pNext

flags

size

usage

sharingMode

pQueueFamilyIndices

set

nset

set

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

validate

validate