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
,NativeResource
,Pointer
public class VkDedicatedAllocationMemoryAllocateInfoNV extends Struct implements NativeResource
Specify a dedicated memory allocation resource.Valid Usage
- At least one of
image
andbuffer
must beNULL_HANDLE
- If
image
is notNULL_HANDLE
, the image must have been created withVkDedicatedAllocationImageCreateInfoNV
::dedicatedAllocation
equal toTRUE
- If
buffer
is notNULL_HANDLE
, the buffer must have been created withVkDedicatedAllocationBufferCreateInfoNV
::dedicatedAllocation
equal toTRUE
- If
image
is notNULL_HANDLE
,VkMemoryAllocateInfo
::allocationSize
must equal theVkMemoryRequirements
::size
of the image - If
buffer
is notNULL_HANDLE
,VkMemoryAllocateInfo
::allocationSize
must equal theVkMemoryRequirements
::size
of the buffer - If
image
is notNULL_HANDLE
andVkMemoryAllocateInfo
defines a memory import operation, the memory being imported must also be a dedicated image allocation andimage
must be identical to the image associated with the imported memory. - If
buffer
is notNULL_HANDLE
andVkMemoryAllocateInfo
defines a memory import operation, the memory being imported must also be a dedicated buffer allocation andbuffer
must be identical to the buffer associated with the imported memory.
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_DEDICATED_ALLOCATION_MEMORY_ALLOCATE_INFO_NV
- If
image
is notNULL_HANDLE
,image
must be a validVkImage
handle - If
buffer
is notNULL_HANDLE
,buffer
must be a validVkBuffer
handle - Both of
buffer
, andimage
that are valid handles must have been created, allocated, or retrieved from the sameVkDevice
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.image
–NULL_HANDLE
or a handle of an image which this memory will be bound to.buffer
–NULL_HANDLE
or a handle of a buffer which this memory will be bound to.
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 ofVkDedicatedAllocationMemoryAllocateInfoNV
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
BUFFER
IMAGE
PNEXTThe 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, POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor Description VkDedicatedAllocationMemoryAllocateInfoNV(java.nio.ByteBuffer container)
Creates aVkDedicatedAllocationMemoryAllocateInfoNV
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description long
buffer()
Returns the value of thebuffer
field.VkDedicatedAllocationMemoryAllocateInfoNV
buffer(long value)
Sets the specified value to thebuffer
field.static VkDedicatedAllocationMemoryAllocateInfoNV
calloc()
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV
instance allocated withmemCalloc
.static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer
calloc(int capacity)
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV.Buffer
instance allocated withmemCalloc
.static VkDedicatedAllocationMemoryAllocateInfoNV
callocStack()
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer
callocStack(int capacity)
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDedicatedAllocationMemoryAllocateInfoNV
callocStack(MemoryStack stack)
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDedicatedAllocationMemoryAllocateInfoNV
create()
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV
instance allocated withBufferUtils
.static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer
create(int capacity)
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV.Buffer
instance allocated withBufferUtils
.static VkDedicatedAllocationMemoryAllocateInfoNV
create(long address)
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV
instance for the specified memory address.static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer
create(long address, int capacity)
Create aVkDedicatedAllocationMemoryAllocateInfoNV.Buffer
instance at the specified memory.static VkDedicatedAllocationMemoryAllocateInfoNV
createSafe(long address)
static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer
createSafe(long address, int capacity)
long
image()
Returns the value of theimage
field.VkDedicatedAllocationMemoryAllocateInfoNV
image(long value)
Sets the specified value to theimage
field.static VkDedicatedAllocationMemoryAllocateInfoNV
malloc()
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV
instance allocated withmemAlloc
.static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer
malloc(int capacity)
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV.Buffer
instance allocated withmemAlloc
.static VkDedicatedAllocationMemoryAllocateInfoNV
mallocStack()
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV
instance allocated on the thread-localMemoryStack
.static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer
mallocStack(int capacity)
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV.Buffer
instance allocated on the thread-localMemoryStack
.static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV.Buffer
instance allocated on the specifiedMemoryStack
.static VkDedicatedAllocationMemoryAllocateInfoNV
mallocStack(MemoryStack stack)
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV
instance allocated on the specifiedMemoryStack
.static long
nbuffer(long struct)
Unsafe version ofbuffer()
.static void
nbuffer(long struct, long value)
Unsafe version ofbuffer
.static long
nimage(long struct)
Unsafe version ofimage()
.static void
nimage(long struct, long value)
Unsafe version ofimage
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.long
pNext()
Returns the value of thepNext
field.VkDedicatedAllocationMemoryAllocateInfoNV
pNext(long value)
Sets the specified value to thepNext
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()
Returnssizeof(struct)
.int
sType()
Returns the value of thesType
field.VkDedicatedAllocationMemoryAllocateInfoNV
sType(int value)
Sets the specified value to thesType
field.-
Methods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
-
-
-
Constructor Detail
-
VkDedicatedAllocationMemoryAllocateInfoNV
public VkDedicatedAllocationMemoryAllocateInfoNV(java.nio.ByteBuffer container)
Creates aVkDedicatedAllocationMemoryAllocateInfoNV
instance at the current position of the specifiedByteBuffer
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()
Description copied from class:Struct
Returnssizeof(struct)
.
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
image
public long image()
Returns the value of theimage
field.
-
buffer
public long buffer()
Returns the value of thebuffer
field.
-
sType
public VkDedicatedAllocationMemoryAllocateInfoNV sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkDedicatedAllocationMemoryAllocateInfoNV pNext(long value)
Sets the specified value to thepNext
field.
-
image
public VkDedicatedAllocationMemoryAllocateInfoNV image(long value)
Sets the specified value to theimage
field.
-
buffer
public VkDedicatedAllocationMemoryAllocateInfoNV buffer(long value)
Sets the specified value to thebuffer
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 newVkDedicatedAllocationMemoryAllocateInfoNV
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkDedicatedAllocationMemoryAllocateInfoNV calloc()
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkDedicatedAllocationMemoryAllocateInfoNV create()
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV
instance allocated withBufferUtils
.
-
create
public static VkDedicatedAllocationMemoryAllocateInfoNV create(long address)
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV
instance for the specified memory address.
-
createSafe
@Nullable public static VkDedicatedAllocationMemoryAllocateInfoNV createSafe(long address)
-
malloc
public static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer malloc(int capacity)
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer calloc(int capacity)
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer create(int capacity)
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer create(long address, int capacity)
Create aVkDedicatedAllocationMemoryAllocateInfoNV.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkDedicatedAllocationMemoryAllocateInfoNV mallocStack()
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkDedicatedAllocationMemoryAllocateInfoNV callocStack()
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkDedicatedAllocationMemoryAllocateInfoNV mallocStack(MemoryStack stack)
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkDedicatedAllocationMemoryAllocateInfoNV callocStack(MemoryStack stack)
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer mallocStack(int capacity)
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer callocStack(int capacity)
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkDedicatedAllocationMemoryAllocateInfoNV.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkDedicatedAllocationMemoryAllocateInfoNV.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType()
.
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext()
.
-
nimage
public static long nimage(long struct)
Unsafe version ofimage()
.
-
nbuffer
public static long nbuffer(long struct)
Unsafe version ofbuffer()
.
-
nsType
public static void nsType(long struct, int value)
Unsafe version ofsType
.
-
npNext
public static void npNext(long struct, long value)
Unsafe version ofpNext
.
-
nimage
public static void nimage(long struct, long value)
Unsafe version ofimage
.
-
nbuffer
public static void nbuffer(long struct, long value)
Unsafe version ofbuffer
.
-
-