VkMemoryAllocateFlagsInfo (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

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

Direct Known Subclasses:

VkMemoryAllocateFlagsInfoKHR
```
public class VkMemoryAllocateFlagsInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure controlling how many instances of memory will be allocated.
Description

If MEMORY_ALLOCATE_DEVICE_MASK_BIT is not set, the number of instances allocated depends on whether MEMORY_HEAP_MULTI_INSTANCE_BIT is set in the memory heap. If MEMORY_HEAP_MULTI_INSTANCE_BIT is set, then memory is allocated for every physical device in the logical device (as if deviceMask has bits set for all device indices). If MEMORY_HEAP_MULTI_INSTANCE_BIT is not set, then a single instance of memory is allocated (as if deviceMask is set to one).

On some implementations, allocations from a multi-instance heap may consume memory on all physical devices even if the deviceMask excludes some devices. If VkPhysicalDeviceGroupProperties::subsetAllocation is TRUE, then memory is only consumed for the devices in the device mask.

Note

In practice, most allocations on a multi-instance heap will be allocated across all physical devices. Unicast allocation support is an optional optimization for a minority of allocations.

Valid Usage
- If MEMORY_ALLOCATE_DEVICE_MASK_BIT is set, deviceMask must be a valid device mask.
- If MEMORY_ALLOCATE_DEVICE_MASK_BIT is set, deviceMask must not be zero
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_MEMORY_ALLOCATE_FLAGS_INFO
- flags must be a valid combination of VkMemoryAllocateFlagBits values
Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- flags – a bitmask of VkMemoryAllocateFlagBits controlling the allocation.
- deviceMask – a mask of physical devices in the logical device, indicating that memory must be allocated on each device in the mask, if MEMORY_ALLOCATE_DEVICE_MASK_BIT is set in flags.
Layout
```
 struct VkMemoryAllocateFlagsInfo {
     VkStructureType sType;
     void const * pNext;
     VkMemoryAllocateFlags flags;
     uint32_t deviceMask;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkMemoryAllocateFlagsInfo.Buffer
An array of VkMemoryAllocateFlagsInfo structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkMemoryAllocateFlagsInfo.Buffer` An array of `VkMemoryAllocateFlagsInfo` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`DEVICEMASK` The struct member offsets.
`static int`	`FLAGS` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STYPE` 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 and Description
`VkMemoryAllocateFlagsInfo(java.nio.ByteBuffer container)` Creates a `VkMemoryAllocateFlagsInfo` 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 VkMemoryAllocateFlagsInfo`	`calloc()` Returns a new `VkMemoryAllocateFlagsInfo` instance allocated with `memCalloc`.
`static VkMemoryAllocateFlagsInfo.Buffer`	`calloc(int capacity)` Returns a new `VkMemoryAllocateFlagsInfo.Buffer` instance allocated with `memCalloc`.
`static VkMemoryAllocateFlagsInfo`	`callocStack()` Returns a new `VkMemoryAllocateFlagsInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkMemoryAllocateFlagsInfo.Buffer`	`callocStack(int capacity)` Returns a new `VkMemoryAllocateFlagsInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkMemoryAllocateFlagsInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkMemoryAllocateFlagsInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkMemoryAllocateFlagsInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkMemoryAllocateFlagsInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkMemoryAllocateFlagsInfo`	`create()` Returns a new `VkMemoryAllocateFlagsInfo` instance allocated with `BufferUtils`.
`static VkMemoryAllocateFlagsInfo.Buffer`	`create(int capacity)` Returns a new `VkMemoryAllocateFlagsInfo.Buffer` instance allocated with `BufferUtils`.
`static VkMemoryAllocateFlagsInfo`	`create(long address)` Returns a new `VkMemoryAllocateFlagsInfo` instance for the specified memory address.
`static VkMemoryAllocateFlagsInfo.Buffer`	`create(long address, int capacity)` Create a `VkMemoryAllocateFlagsInfo.Buffer` instance at the specified memory.
`static VkMemoryAllocateFlagsInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkMemoryAllocateFlagsInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`deviceMask()` Returns the value of the `deviceMask` field.
`VkMemoryAllocateFlagsInfo`	`deviceMask(int value)` Sets the specified value to the `deviceMask` field.
`int`	`flags()` Returns the value of the `flags` field.
`VkMemoryAllocateFlagsInfo`	`flags(int value)` Sets the specified value to the `flags` field.
`static VkMemoryAllocateFlagsInfo`	`malloc()` Returns a new `VkMemoryAllocateFlagsInfo` instance allocated with `memAlloc`.
`static VkMemoryAllocateFlagsInfo.Buffer`	`malloc(int capacity)` Returns a new `VkMemoryAllocateFlagsInfo.Buffer` instance allocated with `memAlloc`.
`static VkMemoryAllocateFlagsInfo`	`mallocStack()` Returns a new `VkMemoryAllocateFlagsInfo` instance allocated on the thread-local `MemoryStack`.
`static VkMemoryAllocateFlagsInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VkMemoryAllocateFlagsInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkMemoryAllocateFlagsInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkMemoryAllocateFlagsInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkMemoryAllocateFlagsInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkMemoryAllocateFlagsInfo` instance allocated on the specified `MemoryStack`.
`static int`	`ndeviceMask(long struct)` Unsafe version of `deviceMask()`.
`static void`	`ndeviceMask(long struct, int value)` Unsafe version of `deviceMask`.
`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 int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkMemoryAllocateFlagsInfo`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkMemoryAllocateFlagsInfo`	`set(int sType, long pNext, int flags, int deviceMask)` Initializes this struct with the specified values.
`VkMemoryAllocateFlagsInfo`	`set(VkMemoryAllocateFlagsInfo src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkMemoryAllocateFlagsInfo`	`sType(int value)` Sets the specified value to the `sType` field.

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

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 Detail
  - 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.
  - DEVICEMASK
```
public static final int DEVICEMASK
```
    The struct member offsets.
- Constructor Detail
  - VkMemoryAllocateFlagsInfo
```
public VkMemoryAllocateFlagsInfo(java.nio.ByteBuffer container)
```
    Creates a VkMemoryAllocateFlagsInfo 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()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.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.
  - deviceMask
```
public int deviceMask()
```
    Returns the value of the deviceMask field.
  - sType
```
public VkMemoryAllocateFlagsInfo sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkMemoryAllocateFlagsInfo pNext(long value)
```
    Sets the specified value to the pNext field.
  - flags
```
public VkMemoryAllocateFlagsInfo flags(int value)
```
    Sets the specified value to the flags field.
  - deviceMask
```
public VkMemoryAllocateFlagsInfo deviceMask(int value)
```
    Sets the specified value to the deviceMask field.
  - set
```
public VkMemoryAllocateFlagsInfo set(int sType,
                                     long pNext,
                                     int flags,
                                     int deviceMask)
```
    Initializes this struct with the specified values.
  - set
```
public VkMemoryAllocateFlagsInfo set(VkMemoryAllocateFlagsInfo src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkMemoryAllocateFlagsInfo malloc()
```
    Returns a new VkMemoryAllocateFlagsInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkMemoryAllocateFlagsInfo calloc()
```
    Returns a new VkMemoryAllocateFlagsInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkMemoryAllocateFlagsInfo create()
```
    Returns a new VkMemoryAllocateFlagsInfo instance allocated with BufferUtils.
  - create
```
public static VkMemoryAllocateFlagsInfo create(long address)
```
    Returns a new VkMemoryAllocateFlagsInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkMemoryAllocateFlagsInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkMemoryAllocateFlagsInfo.Buffer malloc(int capacity)
```
    Returns a new VkMemoryAllocateFlagsInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkMemoryAllocateFlagsInfo.Buffer calloc(int capacity)
```
    Returns a new VkMemoryAllocateFlagsInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkMemoryAllocateFlagsInfo.Buffer create(int capacity)
```
    Returns a new VkMemoryAllocateFlagsInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkMemoryAllocateFlagsInfo.Buffer create(long address,
                                                      int capacity)
```
    Create a VkMemoryAllocateFlagsInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkMemoryAllocateFlagsInfo.Buffer createSafe(long address,
                                                                    int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkMemoryAllocateFlagsInfo mallocStack()
```
    Returns a new VkMemoryAllocateFlagsInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkMemoryAllocateFlagsInfo callocStack()
```
    Returns a new VkMemoryAllocateFlagsInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkMemoryAllocateFlagsInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkMemoryAllocateFlagsInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkMemoryAllocateFlagsInfo callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkMemoryAllocateFlagsInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkMemoryAllocateFlagsInfo.Buffer mallocStack(int capacity)
```
    Returns a new VkMemoryAllocateFlagsInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkMemoryAllocateFlagsInfo.Buffer callocStack(int capacity)
```
    Returns a new VkMemoryAllocateFlagsInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkMemoryAllocateFlagsInfo.Buffer mallocStack(int capacity,
                                                           org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkMemoryAllocateFlagsInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkMemoryAllocateFlagsInfo.Buffer callocStack(int capacity,
                                                           org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkMemoryAllocateFlagsInfo.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().
  - ndeviceMask
```
public static int ndeviceMask(long struct)
```
    Unsafe version of deviceMask().
  - 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.
  - ndeviceMask
```
public static void ndeviceMask(long struct,
                               int value)
```
    Unsafe version of deviceMask.

Class VkMemoryAllocateFlagsInfo

Description

Note

Valid Usage

Valid Usage (Implicit)

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

ALIGNOF

STYPE

PNEXT

FLAGS

DEVICEMASK

Constructor Detail

VkMemoryAllocateFlagsInfo

Method Detail

sizeof

sType

pNext

flags

deviceMask

sType

pNext

flags

deviceMask

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nflags

ndeviceMask

nsType

npNext

nflags

ndeviceMask