Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkMemoryDedicatedAllocateInfo

extends Struct<VkMemoryDedicatedAllocateInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkMemoryDedicatedAllocateInfoKHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Specify a dedicated memory allocation resource.
Valid Usage
Valid Usage (Implicit)

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
BUFFER

The struct member offsets.

public static final int
IMAGE

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkMemoryDedicatedAllocateInfo(long address, ByteBuffer container)

public
VkMemoryDedicatedAllocateInfo(ByteBuffer container)

Creates a VkMemoryDedicatedAllocateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public long
buffer()

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

public VkMemoryDedicatedAllocateInfo
buffer(long value)

Sets the specified value to the buffer field.

public static VkMemoryDedicatedAllocateInfo
calloc()

Returns a new VkMemoryDedicatedAllocateInfo instance allocated with memCalloc.

public static VkMemoryDedicatedAllocateInfo.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkMemoryDedicatedAllocateInfo.Buffer instance allocated with memCalloc.

public static VkMemoryDedicatedAllocateInfo
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkMemoryDedicatedAllocateInfo.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static VkMemoryDedicatedAllocateInfo
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkMemoryDedicatedAllocateInfo
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkMemoryDedicatedAllocateInfo.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkMemoryDedicatedAllocateInfo.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkMemoryDedicatedAllocateInfo
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkMemoryDedicatedAllocateInfo
create()

Returns a new VkMemoryDedicatedAllocateInfo instance allocated with BufferUtils.

public static VkMemoryDedicatedAllocateInfo
create(long address)

Returns a new VkMemoryDedicatedAllocateInfo instance for the specified memory address.

public static VkMemoryDedicatedAllocateInfo.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkMemoryDedicatedAllocateInfo.Buffer instance allocated with BufferUtils.

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

Create a VkMemoryDedicatedAllocateInfo.Buffer instance at the specified memory.

public static VkMemoryDedicatedAllocateInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
image()

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

public VkMemoryDedicatedAllocateInfo
image(long value)

Sets the specified value to the image field.

public static VkMemoryDedicatedAllocateInfo
malloc()

Returns a new VkMemoryDedicatedAllocateInfo instance allocated with memAlloc.

public static VkMemoryDedicatedAllocateInfo.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkMemoryDedicatedAllocateInfo.Buffer instance allocated with memAlloc.

public static VkMemoryDedicatedAllocateInfo
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkMemoryDedicatedAllocateInfo instance allocated on the specified MemoryStack.

public static VkMemoryDedicatedAllocateInfo.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static VkMemoryDedicatedAllocateInfo
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkMemoryDedicatedAllocateInfo
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkMemoryDedicatedAllocateInfo.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkMemoryDedicatedAllocateInfo.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static long
nbuffer(long struct)

Unsafe version of buffer.

public static void
nbuffer(long struct, long value)

Unsafe version of buffer.

public static long
nimage(long struct)

Unsafe version of image.

public static void
nimage(long struct, long value)

Unsafe version of image.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkMemoryDedicatedAllocateInfo
pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkMemoryDedicatedAllocateInfo

Returns:

this struct
set
(VkMemoryDedicatedAllocateInfo
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkMemoryDedicatedAllocateInfo
sType(int value)

Sets the specified value to the sType field.

public VkMemoryDedicatedAllocateInfo
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

BUFFERback to summary
public static final int BUFFER

The struct member offsets.

IMAGEback to summary
public static final int IMAGE

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkMemoryDedicatedAllocateInfoback to summary
protected VkMemoryDedicatedAllocateInfo(long address, ByteBuffer container)
VkMemoryDedicatedAllocateInfoback to summary
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 Detail

bufferback to summary
public long buffer()

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

Annotations
@NativeType:VkBuffer
bufferback to summary
public VkMemoryDedicatedAllocateInfo buffer(long value)

Sets the specified value to the buffer field.

callocback to summary
public static VkMemoryDedicatedAllocateInfo calloc()

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

callocback to summary
public static VkMemoryDedicatedAllocateInfo.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
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:MemoryStack

the stack from which to allocate

callocback to summary
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:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkMemoryDedicatedAllocateInfo callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkMemoryDedicatedAllocateInfo callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkMemoryDedicatedAllocateInfo.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkMemoryDedicatedAllocateInfo.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected VkMemoryDedicatedAllocateInfo create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkMemoryDedicatedAllocateInfo create()

Returns a new VkMemoryDedicatedAllocateInfo instance allocated with BufferUtils.

createback to summary
public static VkMemoryDedicatedAllocateInfo create(long address)

Returns a new VkMemoryDedicatedAllocateInfo instance for the specified memory address.

createback to summary
public static VkMemoryDedicatedAllocateInfo.Buffer create(int capacity)

Returns a new VkMemoryDedicatedAllocateInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkMemoryDedicatedAllocateInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkMemoryDedicatedAllocateInfo createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkMemoryDedicatedAllocateInfo.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
imageback to summary
public long image()

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

Annotations
@NativeType:VkImage
imageback to summary
public VkMemoryDedicatedAllocateInfo image(long value)

Sets the specified value to the image field.

mallocback to summary
public static VkMemoryDedicatedAllocateInfo malloc()

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

mallocback to summary
public static VkMemoryDedicatedAllocateInfo.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkMemoryDedicatedAllocateInfo malloc(MemoryStack stack)

Returns a new VkMemoryDedicatedAllocateInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkMemoryDedicatedAllocateInfo mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkMemoryDedicatedAllocateInfo mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkMemoryDedicatedAllocateInfo.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkMemoryDedicatedAllocateInfo.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
nbufferback to summary
public static long nbuffer(long struct)

Unsafe version of buffer.

nbufferback to summary
public static void nbuffer(long struct, long value)

Unsafe version of buffer.

nimageback to summary
public static long nimage(long struct)

Unsafe version of image.

nimageback to summary
public static void nimage(long struct, long value)

Unsafe version of image.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkMemoryDedicatedAllocateInfo pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkMemoryDedicatedAllocateInfo set(VkMemoryDedicatedAllocateInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkMemoryDedicatedAllocateInfo

the source struct

Returns:VkMemoryDedicatedAllocateInfo

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkMemoryDedicatedAllocateInfo sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkMemoryDedicatedAllocateInfo sType$Default()

Sets the STRUCTURE_TYPE_MEMORY_DEDICATED_ALLOCATE_INFO value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkMemoryDedicatedAllocateInfo.Buffer

extends StructBuffer<VkMemoryDedicatedAllocateInfo, VkMemoryDedicatedAllocateInfo.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkMemoryDedicatedAllocateInfoKHR.Buffer

An array of VkMemoryDedicatedAllocateInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VkMemoryDedicatedAllocateInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkMemoryDedicatedAllocateInfo.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

the value of the VkMemoryDedicatedAllocateInfo#buffer field.
buffer
()

public VkMemoryDedicatedAllocateInfo.Buffer
buffer(long value)

Sets the specified value to the VkMemoryDedicatedAllocateInfo#buffer field.

protected VkMemoryDedicatedAllocateInfo
public long

Returns:

the value of the VkMemoryDedicatedAllocateInfo#image field.
image
()

public VkMemoryDedicatedAllocateInfo.Buffer
image(long value)

Sets the specified value to the VkMemoryDedicatedAllocateInfo#image field.

public long

Returns:

the value of the VkMemoryDedicatedAllocateInfo#pNext field.
pNext
()

public VkMemoryDedicatedAllocateInfo.Buffer
pNext(long value)

Sets the specified value to the VkMemoryDedicatedAllocateInfo#pNext field.

protected VkMemoryDedicatedAllocateInfo.Buffer
public int

Returns:

the value of the VkMemoryDedicatedAllocateInfo#sType field.
sType
()

public VkMemoryDedicatedAllocateInfo.Buffer
sType(int value)

Sets the specified value to the VkMemoryDedicatedAllocateInfo#sType field.

public VkMemoryDedicatedAllocateInfo.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkMemoryDedicatedAllocateInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkMemoryDedicatedAllocateInfo.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkMemoryDedicatedAllocateInfo#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

bufferback to summary
public long buffer()
Returns:long

the value of the VkMemoryDedicatedAllocateInfo#buffer field.

Annotations
@NativeType:VkBuffer
bufferback to summary
public VkMemoryDedicatedAllocateInfo.Buffer buffer(long value)

Sets the specified value to the VkMemoryDedicatedAllocateInfo#buffer field.

getElementFactoryback to summary
protected VkMemoryDedicatedAllocateInfo getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
imageback to summary
public long image()
Returns:long

the value of the VkMemoryDedicatedAllocateInfo#image field.

Annotations
@NativeType:VkImage
imageback to summary
public VkMemoryDedicatedAllocateInfo.Buffer image(long value)

Sets the specified value to the VkMemoryDedicatedAllocateInfo#image field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkMemoryDedicatedAllocateInfo#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkMemoryDedicatedAllocateInfo.Buffer pNext(long value)

Sets the specified value to the VkMemoryDedicatedAllocateInfo#pNext field.

selfback to summary
protected VkMemoryDedicatedAllocateInfo.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkMemoryDedicatedAllocateInfo#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkMemoryDedicatedAllocateInfo.Buffer sType(int value)

Sets the specified value to the VkMemoryDedicatedAllocateInfo#sType field.

sType$Defaultback to summary
public VkMemoryDedicatedAllocateInfo.Buffer sType$Default()

Sets the STRUCTURE_TYPE_MEMORY_DEDICATED_ALLOCATE_INFO value to the VkMemoryDedicatedAllocateInfo#sType field.