Package org.lwjgl.vulkan

Class VkMemoryDedicatedRequirements

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkMemoryDedicatedRequirements>

org.lwjgl.vulkan.VkMemoryDedicatedRequirements

All Implemented Interfaces:

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

Direct Known Subclasses:

VkMemoryDedicatedRequirementsKHR

public class VkMemoryDedicatedRequirements
extends org.lwjgl.system.Struct<VkMemoryDedicatedRequirements>
implements org.lwjgl.system.NativeResource

Structure describing dedicated allocation requirements of buffer and image resources.

Description

To determine the dedicated allocation requirements of a buffer or image resource, add a VkMemoryDedicatedRequirements structure to the pNext chain of the VkMemoryRequirements2 structure passed as the pMemoryRequirements parameter of GetBufferMemoryRequirements2 or GetImageMemoryRequirements2, respectively.

Constraints on the values returned for buffer resources are:

• requiresDedicatedAllocation may be TRUE if 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. Otherwise, requiresDedicatedAllocation will be FALSE.
• When the implementation sets requiresDedicatedAllocation to TRUE, it must also set prefersDedicatedAllocation to TRUE.
• If BUFFER_CREATE_SPARSE_BINDING_BIT was set in VkBufferCreateInfo::flags when buffer was created, then both prefersDedicatedAllocation and requiresDedicatedAllocation will be FALSE.

Constraints on the values returned for image resources are:

• requiresDedicatedAllocation may be TRUE if the pNext chain of VkImageCreateInfo for the call to CreateImage 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.
• requiresDedicatedAllocation may be TRUE if the image’s tiling is IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.
• requiresDedicatedAllocation will otherwise be FALSE
• If IMAGE_CREATE_SPARSE_BINDING_BIT was set in VkImageCreateInfo::flags when image was created, then both prefersDedicatedAllocation and requiresDedicatedAllocation will be FALSE.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_MEMORY_DEDICATED_REQUIREMENTS

Layout

 struct VkMemoryDedicatedRequirements {
     VkStructureType sType();
     void * pNext();
     VkBool32 prefersDedicatedAllocation();
     VkBool32 requiresDedicatedAllocation();
 }

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	PNEXT	The struct member offsets.
static final int	PREFERSDEDICATEDALLOCATION	The struct member offsets.
static final int	REQUIRESDEDICATEDALLOCATION	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final 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	Description
VkMemoryDedicatedRequirements(ByteBuffer container)	Creates a VkMemoryDedicatedRequirements instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	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.Buffer	calloc(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	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkMemoryDedicatedRequirements instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkMemoryDedicatedRequirements	callocStack()	Deprecated.
static VkMemoryDedicatedRequirements.Buffer	callocStack(int capacity)	Deprecated.
static VkMemoryDedicatedRequirements.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkMemoryDedicatedRequirements	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
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 @Nullable VkMemoryDedicatedRequirements	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable 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.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkMemoryDedicatedRequirements.Buffer instance allocated on the specified MemoryStack.
static VkMemoryDedicatedRequirements	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkMemoryDedicatedRequirements instance allocated on the specified MemoryStack.
static VkMemoryDedicatedRequirements	mallocStack()	Deprecated.
static VkMemoryDedicatedRequirements.Buffer	mallocStack(int capacity)	Deprecated.
static VkMemoryDedicatedRequirements.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkMemoryDedicatedRequirements	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
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()	NULL or a pointer to a structure extending this structure.
VkMemoryDedicatedRequirements	pNext(long value)	Sets the specified value to the pNext() field.
boolean	prefersDedicatedAllocation()	specifies that the implementation would prefer a dedicated allocation for this resource.
boolean	requiresDedicatedAllocation()	specifies that a dedicated allocation is required for this resource.
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()	a VkStructureType value identifying this structure.
VkMemoryDedicatedRequirements	sType(int value)	Sets the specified value to the sType() field.
VkMemoryDedicatedRequirements	sType$Default()	Sets the STRUCTURE_TYPE_MEMORY_DEDICATED_REQUIREMENTS value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

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 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.

PREFERSDEDICATEDALLOCATION

public static final int PREFERSDEDICATEDALLOCATION

The struct member offsets.

REQUIRESDEDICATEDALLOCATION

public static final int REQUIRESDEDICATEDALLOCATION

The struct member offsets.

Constructor Details

VkMemoryDedicatedRequirements

public VkMemoryDedicatedRequirements(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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkMemoryDedicatedRequirements>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

prefersDedicatedAllocation

public boolean 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

public boolean requiresDedicatedAllocation()

specifies that a dedicated allocation is required for this resource.

sType

public VkMemoryDedicatedRequirements sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkMemoryDedicatedRequirements sType$Default()

Sets the STRUCTURE_TYPE_MEMORY_DEDICATED_REQUIREMENTS 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

public static @Nullable 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

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkMemoryDedicatedRequirements mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkMemoryDedicatedRequirements callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkMemoryDedicatedRequirements mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkMemoryDedicatedRequirements callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkMemoryDedicatedRequirements.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkMemoryDedicatedRequirements.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VkMemoryDedicatedRequirements.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkMemoryDedicatedRequirements.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static VkMemoryDedicatedRequirements malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkMemoryDedicatedRequirements instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkMemoryDedicatedRequirements calloc(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

malloc

public static VkMemoryDedicatedRequirements.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkMemoryDedicatedRequirements.Buffer calloc(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:

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().

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.