Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkExportMemoryAllocateInfo

extends Struct<VkExportMemoryAllocateInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkExportMemoryAllocateInfoKHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Specify exportable handle types for a device memory object.
Valid Usage
Valid Usage (Implicit)

Layout


struct VkExportMemoryAllocateInfo {
    VkStructureType sType;
    void const * pNext;
    VkExternalMemoryHandleTypeFlags handleTypes;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkExportMemoryAllocateInfo.Buffer

An array of VkExportMemoryAllocateInfo structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
HANDLETYPES

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
VkExportMemoryAllocateInfo(long address, ByteBuffer container)

public
VkExportMemoryAllocateInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkExportMemoryAllocateInfo
calloc()

Returns a new VkExportMemoryAllocateInfo instance allocated with memCalloc.

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

Returns a new VkExportMemoryAllocateInfo.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkExportMemoryAllocateInfo
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
protected VkExportMemoryAllocateInfo
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 VkExportMemoryAllocateInfo
create()

Returns a new VkExportMemoryAllocateInfo instance allocated with BufferUtils.

public static VkExportMemoryAllocateInfo
create(long address)

Returns a new VkExportMemoryAllocateInfo instance for the specified memory address.

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

Returns a new VkExportMemoryAllocateInfo.Buffer instance allocated with BufferUtils.

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

Create a VkExportMemoryAllocateInfo.Buffer instance at the specified memory.

public static VkExportMemoryAllocateInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
handleTypes()

zero or a bitmask of VkExternalMemoryHandleTypeFlagBits specifying one or more memory handle types the application can export from the resulting allocation.

public VkExportMemoryAllocateInfo
handleTypes(int value)

Sets the specified value to the handleTypes field.

public static VkExportMemoryAllocateInfo
malloc()

Returns a new VkExportMemoryAllocateInfo instance allocated with memAlloc.

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

Returns a new VkExportMemoryAllocateInfo.Buffer instance allocated with memAlloc.

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

Returns a new VkExportMemoryAllocateInfo instance allocated on the specified MemoryStack.

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

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

public static VkExportMemoryAllocateInfo
mallocStack()

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

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

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

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

Unsafe version of handleTypes.

public static void
nhandleTypes(long struct, int value)

Unsafe version of handleTypes.

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 VkExportMemoryAllocateInfo
pNext(long value)

Sets the specified value to the pNext field.

public VkExportMemoryAllocateInfo
set(int sType, long pNext, int handleTypes)

Initializes this struct with the specified values.

public VkExportMemoryAllocateInfo

Returns:

this struct
set(VkExportMemoryAllocateInfo
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 VkExportMemoryAllocateInfo
sType(int value)

Sets the specified value to the sType field.

public VkExportMemoryAllocateInfo
sType$Default()

Sets the STRUCTURE_TYPE_EXPORT_MEMORY_ALLOCATE_INFO value to the sType field.

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.

HANDLETYPESback to summary
public static final int HANDLETYPES

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

VkExportMemoryAllocateInfoback to summary
protected VkExportMemoryAllocateInfo(long address, ByteBuffer container)
VkExportMemoryAllocateInfoback to summary
public VkExportMemoryAllocateInfo(ByteBuffer container)

Creates a VkExportMemoryAllocateInfo 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

callocback to summary
public static VkExportMemoryAllocateInfo calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkExportMemoryAllocateInfo calloc(MemoryStack stack)

Returns a new VkExportMemoryAllocateInfo 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 VkExportMemoryAllocateInfo.Buffer calloc(int capacity, MemoryStack stack)

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkExportMemoryAllocateInfo.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 VkExportMemoryAllocateInfo 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 VkExportMemoryAllocateInfo create()

Returns a new VkExportMemoryAllocateInfo instance allocated with BufferUtils.

createback to summary
public static VkExportMemoryAllocateInfo create(long address)

Returns a new VkExportMemoryAllocateInfo instance for the specified memory address.

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

Returns a new VkExportMemoryAllocateInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkExportMemoryAllocateInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkExportMemoryAllocateInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
handleTypesback to summary
public int handleTypes()

zero or a bitmask of VkExternalMemoryHandleTypeFlagBits specifying one or more memory handle types the application can export from the resulting allocation. The application can request multiple handle types for the same allocation.

Annotations
@NativeType:VkExternalMemoryHandleTypeFlags
handleTypesback to summary
public VkExportMemoryAllocateInfo handleTypes(int value)

Sets the specified value to the handleTypes field.

mallocback to summary
public static VkExportMemoryAllocateInfo malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkExportMemoryAllocateInfo malloc(MemoryStack stack)

Returns a new VkExportMemoryAllocateInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nhandleTypesback to summary
public static int nhandleTypes(long struct)

Unsafe version of handleTypes.

nhandleTypesback to summary
public static void nhandleTypes(long struct, int value)

Unsafe version of handleTypes.

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 VkExportMemoryAllocateInfo pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkExportMemoryAllocateInfo set(int sType, long pNext, int handleTypes)

Initializes this struct with the specified values.

setback to summary
public VkExportMemoryAllocateInfo set(VkExportMemoryAllocateInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkExportMemoryAllocateInfo

the source struct

Returns:VkExportMemoryAllocateInfo

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 VkExportMemoryAllocateInfo sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_EXPORT_MEMORY_ALLOCATE_INFO value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkExportMemoryAllocateInfo.Buffer

extends StructBuffer<VkExportMemoryAllocateInfo, VkExportMemoryAllocateInfo.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkExportMemoryAllocateInfoKHR.Buffer
An array of VkExportMemoryAllocateInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VkExportMemoryAllocateInfo
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkExportMemoryAllocateInfo.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
protected VkExportMemoryAllocateInfo
getElementFactory()

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

public int

Returns:

the value of the VkExportMemoryAllocateInfo#handleTypes field.
handleTypes()

public VkExportMemoryAllocateInfo.Buffer
handleTypes(int value)

Sets the specified value to the VkExportMemoryAllocateInfo#handleTypes field.

public long

Returns:

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

public VkExportMemoryAllocateInfo.Buffer
pNext(long value)

Sets the specified value to the VkExportMemoryAllocateInfo#pNext field.

protected VkExportMemoryAllocateInfo.Buffer
self()

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

public int

Returns:

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

public VkExportMemoryAllocateInfo.Buffer
sType(int value)

Sets the specified value to the VkExportMemoryAllocateInfo#sType field.

public VkExportMemoryAllocateInfo.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_EXPORT_MEMORY_ALLOCATE_INFO value to the VkExportMemoryAllocateInfo#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkExportMemoryAllocateInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkExportMemoryAllocateInfo.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 VkExportMemoryAllocateInfo#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

getElementFactoryback to summary
protected VkExportMemoryAllocateInfo getElementFactory()

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

Annotations
@Override
handleTypesback to summary
public int handleTypes()
Returns:int

the value of the VkExportMemoryAllocateInfo#handleTypes field.

Annotations
@NativeType:VkExternalMemoryHandleTypeFlags
handleTypesback to summary
public VkExportMemoryAllocateInfo.Buffer handleTypes(int value)

Sets the specified value to the VkExportMemoryAllocateInfo#handleTypes field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkExportMemoryAllocateInfo#pNext field.

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

Sets the specified value to the VkExportMemoryAllocateInfo#pNext field.

selfback to summary
protected VkExportMemoryAllocateInfo.Buffer self()

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

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

the value of the VkExportMemoryAllocateInfo#sType field.

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

Sets the specified value to the VkExportMemoryAllocateInfo#sType field.

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

Sets the STRUCTURE_TYPE_EXPORT_MEMORY_ALLOCATE_INFO value to the VkExportMemoryAllocateInfo#sType field.