Package org.lwjgl.vulkan

Class VkDedicatedAllocationMemoryAllocateInfoNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct

org.lwjgl.vulkan.VkDedicatedAllocationMemoryAllocateInfoNV

All Implemented Interfaces:

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

public class VkDedicatedAllocationMemoryAllocateInfoNV
extends org.lwjgl.system.Struct
implements org.lwjgl.system.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, the image must have been created with VkDedicatedAllocationImageCreateInfoNV::dedicatedAllocation equal to TRUE
• If buffer is not NULL_HANDLE, the buffer must have been created with VkDedicatedAllocationBufferCreateInfoNV::dedicatedAllocation equal to TRUE
• If image is not NULL_HANDLE, VkMemoryAllocateInfo::allocationSize must equal the VkMemoryRequirements::size of the image
• If buffer is not NULL_HANDLE, VkMemoryAllocateInfo::allocationSize must equal the VkMemoryRequirements::size of the buffer
• If image is not NULL_HANDLE and VkMemoryAllocateInfo defines a memory import operation, 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, the memory being imported must also be a dedicated buffer allocation and buffer must be identical to the buffer associated with the imported memory

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DEDICATED_ALLOCATION_MEMORY_ALLOCATE_INFO_NV
• 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 VkDedicatedAllocationMemoryAllocateInfoNV {
     VkStructureType sType();
     void const * pNext();
     VkImage image();
     VkBuffer buffer();
 }

Nested Class Summary

Nested Classes

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

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

org.lwjgl.system.Pointer.Default

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

org.lwjgl.system.Struct.StructValidation

Field Summary

Fields

Modifier and Type	Field	Description
static int	ALIGNOF	The struct alignment in bytes.
static int	BUFFER IMAGE 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	Description
VkDedicatedAllocationMemoryAllocateInfoNV(java.nio.ByteBuffer container)	Creates a VkDedicatedAllocationMemoryAllocateInfoNV 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.
VkDedicatedAllocationMemoryAllocateInfoNV	buffer(long value)	Sets the specified value to the buffer() field.
static VkDedicatedAllocationMemoryAllocateInfoNV	calloc()	Returns a new VkDedicatedAllocationMemoryAllocateInfoNV instance allocated with memCalloc.
static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer	calloc(int capacity)	Returns a new VkDedicatedAllocationMemoryAllocateInfoNV.Buffer instance allocated with memCalloc.
static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDedicatedAllocationMemoryAllocateInfoNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDedicatedAllocationMemoryAllocateInfoNV	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDedicatedAllocationMemoryAllocateInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDedicatedAllocationMemoryAllocateInfoNV	callocStack()	Deprecated.
static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer	callocStack(int capacity)	Deprecated.
static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDedicatedAllocationMemoryAllocateInfoNV	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDedicatedAllocationMemoryAllocateInfoNV	create()	Returns a new VkDedicatedAllocationMemoryAllocateInfoNV instance allocated with BufferUtils.
static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer	create(int capacity)	Returns a new VkDedicatedAllocationMemoryAllocateInfoNV.Buffer instance allocated with BufferUtils.
static VkDedicatedAllocationMemoryAllocateInfoNV	create(long address)	Returns a new VkDedicatedAllocationMemoryAllocateInfoNV instance for the specified memory address.
static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer	create(long address, int capacity)	Create a VkDedicatedAllocationMemoryAllocateInfoNV.Buffer instance at the specified memory.
static VkDedicatedAllocationMemoryAllocateInfoNV	createSafe(long address)	Like create, but returns null if address is NULL.
static VkDedicatedAllocationMemoryAllocateInfoNV.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.
VkDedicatedAllocationMemoryAllocateInfoNV	image(long value)	Sets the specified value to the image() field.
static VkDedicatedAllocationMemoryAllocateInfoNV	malloc()	Returns a new VkDedicatedAllocationMemoryAllocateInfoNV instance allocated with memAlloc.
static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer	malloc(int capacity)	Returns a new VkDedicatedAllocationMemoryAllocateInfoNV.Buffer instance allocated with memAlloc.
static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDedicatedAllocationMemoryAllocateInfoNV.Buffer instance allocated on the specified MemoryStack.
static VkDedicatedAllocationMemoryAllocateInfoNV	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDedicatedAllocationMemoryAllocateInfoNV instance allocated on the specified MemoryStack.
static VkDedicatedAllocationMemoryAllocateInfoNV	mallocStack()	Deprecated.
static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer	mallocStack(int capacity)	Deprecated.
static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDedicatedAllocationMemoryAllocateInfoNV	mallocStack(org.lwjgl.system.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.
VkDedicatedAllocationMemoryAllocateInfoNV	pNext(long value)	Sets the specified value to the pNext() field.
VkDedicatedAllocationMemoryAllocateInfoNV	set(int sType, long pNext, long image, long buffer)	Initializes this struct with the specified values.
VkDedicatedAllocationMemoryAllocateInfoNV	set(VkDedicatedAllocationMemoryAllocateInfoNV src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	the type of this structure.
VkDedicatedAllocationMemoryAllocateInfoNV	sType(int value)	Sets the specified value to the sType() field.
VkDedicatedAllocationMemoryAllocateInfoNV	sType$Default()	Sets the STRUCTURE_TYPE_DEDICATED_ALLOCATION_MEMORY_ALLOCATE_INFO_NV value to the sType() field.

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

Field Detail

SIZEOF

The struct size in bytes.

ALIGNOF

The struct alignment in bytes.

STYPE, PNEXT, IMAGE, BUFFER

The struct member offsets.

Constructor Detail

VkDedicatedAllocationMemoryAllocateInfoNV

public VkDedicatedAllocationMemoryAllocateInfoNV(java.nio.ByteBuffer container)

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

the type of 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 VkDedicatedAllocationMemoryAllocateInfoNV sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkDedicatedAllocationMemoryAllocateInfoNV sType$Default()

Sets the STRUCTURE_TYPE_DEDICATED_ALLOCATION_MEMORY_ALLOCATE_INFO_NV value to the sType() field.

pNext

public VkDedicatedAllocationMemoryAllocateInfoNV pNext(long value)

Sets the specified value to the pNext() field.

image

public VkDedicatedAllocationMemoryAllocateInfoNV image(long value)

Sets the specified value to the image() field.

buffer

public VkDedicatedAllocationMemoryAllocateInfoNV buffer(long value)

Sets the specified value to the buffer() field.

set

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

Initializes this struct with the specified values.

set

public VkDedicatedAllocationMemoryAllocateInfoNV set(VkDedicatedAllocationMemoryAllocateInfoNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDedicatedAllocationMemoryAllocateInfoNV malloc()

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

calloc

public static VkDedicatedAllocationMemoryAllocateInfoNV calloc()

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

create

public static VkDedicatedAllocationMemoryAllocateInfoNV create()

Returns a new VkDedicatedAllocationMemoryAllocateInfoNV instance allocated with BufferUtils.

create

public static VkDedicatedAllocationMemoryAllocateInfoNV create(long address)

Returns a new VkDedicatedAllocationMemoryAllocateInfoNV instance for the specified memory address.

createSafe

@Nullable
public static VkDedicatedAllocationMemoryAllocateInfoNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer create(int capacity)

Returns a new VkDedicatedAllocationMemoryAllocateInfoNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDedicatedAllocationMemoryAllocateInfoNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkDedicatedAllocationMemoryAllocateInfoNV mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkDedicatedAllocationMemoryAllocateInfoNV callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkDedicatedAllocationMemoryAllocateInfoNV.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 VkDedicatedAllocationMemoryAllocateInfoNV.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 VkDedicatedAllocationMemoryAllocateInfoNV malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkDedicatedAllocationMemoryAllocateInfoNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkDedicatedAllocationMemoryAllocateInfoNV calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

stack - the stack from which to allocate

capacity - the buffer capacity

calloc

public static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer calloc(int capacity,
                                                                      org.lwjgl.system.MemoryStack stack)

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

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.