VkMemoryDedicatedRequirements (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

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

Direct Known Subclasses:

VkMemoryDedicatedRequirementsKHR
```
public class VkMemoryDedicatedRequirements
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure describing dedicated allocation requirements of buffer and image resources.
Description

When the implementation sets requiresDedicatedAllocation to TRUE, it must also set prefersDedicatedAllocation to TRUE.

If the VkMemoryDedicatedRequirements structure is included in the pNext chain of the VkMemoryRequirements2 structure passed as the pMemoryRequirements parameter of a vkGetBufferMemoryRequirements2 call, requiresDedicatedAllocation may be TRUE under one of the following conditions:
- The pNext chain of VkBufferCreateInfo for the call to vkCreateBuffer used to create the buffer being queried included a VkExternalMemoryBufferCreateInfo structure, and any of the handle types specified in VkExternalMemoryBufferCreateInfo::handleTypes requires dedicated allocation, as reported by GetPhysicalDeviceExternalBufferProperties in VkExternalBufferProperties::externalMemoryProperties.externalMemoryFeatures, the requiresDedicatedAllocation field will be set to TRUE.
In all other cases, requiresDedicatedAllocation must be set to FALSE by the implementation whenever a VkMemoryDedicatedRequirements structure is included in the pNext chain of the VkMemoryRequirements2 structure passed to a call to vkGetBufferMemoryRequirements2.

If the VkMemoryDedicatedRequirements structure is included in the pNext chain of the VkMemoryRequirements2 structure passed as the pMemoryRequirements parameter of a vkGetBufferMemoryRequirements2 call and BUFFER_CREATE_SPARSE_BINDING_BIT was set in VkBufferCreateInfo::flags when buffer was created then the implementation must set both prefersDedicatedAllocation and requiresDedicatedAllocation to FALSE.

If the VkMemoryDedicatedRequirements structure is included in the pNext chain of the VkMemoryRequirements2 structure passed as the pMemoryRequirements parameter of a vkGetImageMemoryRequirements2 call, requiresDedicatedAllocation may be TRUE under one of the following conditions:
- The pNext chain of VkImageCreateInfo for the call to vkCreateImage used to create the image being queried included a VkExternalMemoryImageCreateInfo structure, and any of the handle types specified in VkExternalMemoryImageCreateInfo::handleTypes requires dedicated allocation, as reported by GetPhysicalDeviceImageFormatProperties2 in VkExternalImageFormatProperties::externalMemoryProperties.externalMemoryFeatures, the requiresDedicatedAllocation field will be set to TRUE.
In all other cases, requiresDedicatedAllocation must be set to FALSE by the implementation whenever a VkMemoryDedicatedRequirements structure is included in the pNext chain of the VkMemoryRequirements2 structure passed to a call to vkGetImageMemoryRequirements2.

If the VkMemoryDedicatedRequirements structure is included in the pNext chain of the VkMemoryRequirements2 structure passed as the pMemoryRequirements parameter of a vkGetImageMemoryRequirements2 call and IMAGE_CREATE_SPARSE_BINDING_BIT was set in VkImageCreateInfo::flags when image was created then the implementation must set both prefersDedicatedAllocation and requiresDedicatedAllocation to FALSE.

Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_MEMORY_DEDICATED_REQUIREMENTS
Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- prefersDedicatedAllocation – specifies that the implementation would prefer a dedicated allocation for this resource. The application is still free to suballocate the resource but it may get better performance if a dedicated allocation is used.
- requiresDedicatedAllocation – specifies that a dedicated allocation is required for this resource.
Layout
```
 struct VkMemoryDedicatedRequirements {
     VkStructureType sType;
     void * pNext;
     VkBool32 prefersDedicatedAllocation;
     VkBool32 requiresDedicatedAllocation;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkMemoryDedicatedRequirements.Buffer
An array of VkMemoryDedicatedRequirements 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`	`VkMemoryDedicatedRequirements.Buffer` An array of `VkMemoryDedicatedRequirements` structs.

Field Summary

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

Class VkMemoryDedicatedRequirements

Description

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

PREFERSDEDICATEDALLOCATION

REQUIRESDEDICATEDALLOCATION

Constructor Detail

VkMemoryDedicatedRequirements

Method Detail

sizeof

sType

pNext

prefersDedicatedAllocation

requiresDedicatedAllocation

sType

pNext

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nprefersDedicatedAllocation

nrequiresDedicatedAllocation

nsType

npNext