Package org.lwjgl.vulkan

Class VkMemoryDedicatedAllocateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkMemoryDedicatedAllocateInfo>

org.lwjgl.vulkan.VkMemoryDedicatedAllocateInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkMemoryDedicatedAllocateInfoKHR

public class VkMemoryDedicatedAllocateInfo
extends Struct<VkMemoryDedicatedAllocateInfo>
implements NativeResource

Specify a dedicated memory allocation resource.

Valid Usage

• At least one of image and buffer must be NULL_HANDLE
• If image is not NULL_HANDLE and the memory is not an imported Android Hardware Buffer , VkMemoryAllocateInfo::allocationSize must equal the VkMemoryRequirements::size of the image
• If image is not NULL_HANDLE, image must have been created without IMAGE_CREATE_SPARSE_BINDING_BIT set in VkImageCreateInfo::flags
• If buffer is not NULL_HANDLE and the memory is not an imported Android Hardware Buffer , VkMemoryAllocateInfo::allocationSize must equal the VkMemoryRequirements::size of the buffer
• If buffer is not NULL_HANDLE, buffer must have been created without BUFFER_CREATE_SPARSE_BINDING_BIT set in VkBufferCreateInfo::flags
• If image is not NULL_HANDLE and VkMemoryAllocateInfo defines a memory import operation with handle type EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT, EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT, EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT, EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_KMT_BIT, EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT, or EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT, and the external handle was created by the Vulkan API, then the memory being imported must also be a dedicated image allocation and image must be identical to the image associated with the imported memory
• If buffer is not NULL_HANDLE and VkMemoryAllocateInfo defines a memory import operation with handle type EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT, EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT, EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT, EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_KMT_BIT, EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT, or EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT, and the external handle was created by the Vulkan API, then the memory being imported must also be a dedicated buffer allocation and buffer must be identical to the buffer associated with the imported memory
• If image is not NULL_HANDLE and VkMemoryAllocateInfo defines a memory import operation with handle type EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT, the memory being imported must also be a dedicated image allocation and image must be identical to the image associated with the imported memory
• If buffer is not NULL_HANDLE and VkMemoryAllocateInfo defines a memory import operation with handle type EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT, the memory being imported must also be a dedicated buffer allocation and buffer must be identical to the buffer associated with the imported memory
• If image is not NULL_HANDLE, image must not have been created with IMAGE_CREATE_DISJOINT_BIT set in VkImageCreateInfo::flags

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_MEMORY_DEDICATED_ALLOCATE_INFO
• If image is not NULL_HANDLE, image must be a valid VkImage handle
• If buffer is not NULL_HANDLE, buffer must be a valid VkBuffer handle
• Both of buffer, and image that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same VkDevice

Layout

 struct VkMemoryDedicatedAllocateInfo {
     VkStructureType sType();
     void const * pNext();
     VkImage image();
     VkBuffer buffer();
 }

Nested Class Summary

Nested Classes

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

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

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
long	buffer()	NULL_HANDLE or a handle of a buffer which this memory will be bound to.
VkMemoryDedicatedAllocateInfo	buffer(long value)	Sets the specified value to the buffer() field.
static VkMemoryDedicatedAllocateInfo	calloc()	Returns a new VkMemoryDedicatedAllocateInfo instance allocated with memCalloc.
static VkMemoryDedicatedAllocateInfo.Buffer	calloc(int capacity)	Returns a new VkMemoryDedicatedAllocateInfo.Buffer instance allocated with memCalloc.
static VkMemoryDedicatedAllocateInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkMemoryDedicatedAllocateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkMemoryDedicatedAllocateInfo	calloc(MemoryStack stack)	Returns a new VkMemoryDedicatedAllocateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkMemoryDedicatedAllocateInfo	callocStack()	Deprecated.
static VkMemoryDedicatedAllocateInfo.Buffer	callocStack(int capacity)	Deprecated.
static VkMemoryDedicatedAllocateInfo.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkMemoryDedicatedAllocateInfo	callocStack(MemoryStack stack)	Deprecated.
static VkMemoryDedicatedAllocateInfo	create()	Returns a new VkMemoryDedicatedAllocateInfo instance allocated with BufferUtils.
static VkMemoryDedicatedAllocateInfo.Buffer	create(int capacity)	Returns a new VkMemoryDedicatedAllocateInfo.Buffer instance allocated with BufferUtils.
static VkMemoryDedicatedAllocateInfo	create(long address)	Returns a new VkMemoryDedicatedAllocateInfo instance for the specified memory address.
static VkMemoryDedicatedAllocateInfo.Buffer	create(long address, int capacity)	Create a VkMemoryDedicatedAllocateInfo.Buffer instance at the specified memory.
static VkMemoryDedicatedAllocateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static VkMemoryDedicatedAllocateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	image()	NULL_HANDLE or a handle of an image which this memory will be bound to.
VkMemoryDedicatedAllocateInfo	image(long value)	Sets the specified value to the image() field.
static VkMemoryDedicatedAllocateInfo	malloc()	Returns a new VkMemoryDedicatedAllocateInfo instance allocated with memAlloc.
static VkMemoryDedicatedAllocateInfo.Buffer	malloc(int capacity)	Returns a new VkMemoryDedicatedAllocateInfo.Buffer instance allocated with memAlloc.
static VkMemoryDedicatedAllocateInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkMemoryDedicatedAllocateInfo.Buffer instance allocated on the specified MemoryStack.
static VkMemoryDedicatedAllocateInfo	malloc(MemoryStack stack)	Returns a new VkMemoryDedicatedAllocateInfo instance allocated on the specified MemoryStack.
static VkMemoryDedicatedAllocateInfo	mallocStack()	Deprecated.
static VkMemoryDedicatedAllocateInfo.Buffer	mallocStack(int capacity)	Deprecated.
static VkMemoryDedicatedAllocateInfo.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkMemoryDedicatedAllocateInfo	mallocStack(MemoryStack stack)	Deprecated.
static long	nbuffer(long struct)	Unsafe version of buffer().
static void	nbuffer(long struct, long value)	Unsafe version of buffer.
static long	nimage(long struct)	Unsafe version of image().
static void	nimage(long struct, long value)	Unsafe version of image.
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()	NULL or a pointer to a structure extending this structure.
VkMemoryDedicatedAllocateInfo	pNext(long value)	Sets the specified value to the pNext() field.
VkMemoryDedicatedAllocateInfo	set(int sType, long pNext, long image, long buffer)	Initializes this struct with the specified values.
VkMemoryDedicatedAllocateInfo	set(VkMemoryDedicatedAllocateInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()	a VkStructureType value identifying this structure.
VkMemoryDedicatedAllocateInfo	sType(int value)	Sets the specified value to the sType() field.
VkMemoryDedicatedAllocateInfo	sType$Default()	Sets the STRUCTURE_TYPE_MEMORY_DEDICATED_ALLOCATE_INFO value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, 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.

IMAGE

public static final int IMAGE

The struct member offsets.

BUFFER

public static final int BUFFER

The struct member offsets.

Constructor Details

VkMemoryDedicatedAllocateInfo

public VkMemoryDedicatedAllocateInfo(ByteBuffer container)

Creates a VkMemoryDedicatedAllocateInfo 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()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkMemoryDedicatedAllocateInfo>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

image

public long image()

NULL_HANDLE or a handle of an image which this memory will be bound to.

buffer

public long buffer()

NULL_HANDLE or a handle of a buffer which this memory will be bound to.

sType

public VkMemoryDedicatedAllocateInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkMemoryDedicatedAllocateInfo sType$Default()

Sets the STRUCTURE_TYPE_MEMORY_DEDICATED_ALLOCATE_INFO value to the sType() field.

pNext

public VkMemoryDedicatedAllocateInfo pNext(long value)

Sets the specified value to the pNext() field.

image

public VkMemoryDedicatedAllocateInfo image(long value)

Sets the specified value to the image() field.

buffer

public VkMemoryDedicatedAllocateInfo buffer(long value)

Sets the specified value to the buffer() field.

set

public VkMemoryDedicatedAllocateInfo set(int sType,
 long pNext,
 long image,
 long buffer)

Initializes this struct with the specified values.

set

public VkMemoryDedicatedAllocateInfo set(VkMemoryDedicatedAllocateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkMemoryDedicatedAllocateInfo malloc()

Returns a new VkMemoryDedicatedAllocateInfo instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkMemoryDedicatedAllocateInfo calloc()

Returns a new VkMemoryDedicatedAllocateInfo instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkMemoryDedicatedAllocateInfo create()

Returns a new VkMemoryDedicatedAllocateInfo instance allocated with BufferUtils.

create

public static VkMemoryDedicatedAllocateInfo create(long address)

Returns a new VkMemoryDedicatedAllocateInfo instance for the specified memory address.

createSafe

@Nullable
public static VkMemoryDedicatedAllocateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkMemoryDedicatedAllocateInfo.Buffer malloc(int capacity)

Returns a new VkMemoryDedicatedAllocateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkMemoryDedicatedAllocateInfo.Buffer calloc(int capacity)

Returns a new VkMemoryDedicatedAllocateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkMemoryDedicatedAllocateInfo.Buffer create(int capacity)

Returns a new VkMemoryDedicatedAllocateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkMemoryDedicatedAllocateInfo.Buffer create(long address,
 int capacity)

Create a VkMemoryDedicatedAllocateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkMemoryDedicatedAllocateInfo mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkMemoryDedicatedAllocateInfo callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkMemoryDedicatedAllocateInfo mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkMemoryDedicatedAllocateInfo callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkMemoryDedicatedAllocateInfo.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkMemoryDedicatedAllocateInfo.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static VkMemoryDedicatedAllocateInfo malloc(MemoryStack stack)

Returns a new VkMemoryDedicatedAllocateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkMemoryDedicatedAllocateInfo calloc(MemoryStack stack)

Returns a new VkMemoryDedicatedAllocateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static VkMemoryDedicatedAllocateInfo.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkMemoryDedicatedAllocateInfo.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new VkMemoryDedicatedAllocateInfo.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().

nimage

public static long nimage(long struct)

Unsafe version of image().

nbuffer

public static long nbuffer(long struct)

Unsafe version of buffer().

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.

nimage

public static void nimage(long struct,
 long value)

Unsafe version of image.

nbuffer

public static void nbuffer(long struct,
 long value)

Unsafe version of buffer.