Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkImportMemoryFdInfoKHR

extends Struct<VkImportMemoryFdInfoKHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Import memory created on the same physical device from a file descriptor.
Description

Importing memory from a file descriptor transfers ownership of the file descriptor from the application to the Vulkan implementation. The application must not perform any operations on the file descriptor after a successful import. The imported memory object holds a reference to its payload.

Applications can import the same payload into multiple instances of Vulkan, into the same instance from which it was exported, and multiple times into a given Vulkan instance. In all cases, each import operation must create a distinct VkDeviceMemory object.

Valid Usage
Valid Usage (Implicit)

Layout


struct VkImportMemoryFdInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkExternalMemoryHandleTypeFlagBits handleType;
    int fd;
}

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
FD

The struct member offsets.

public static final int
HANDLETYPE

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

public
VkImportMemoryFdInfoKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkImportMemoryFdInfoKHR
calloc()

Returns a new VkImportMemoryFdInfoKHR instance allocated with memCalloc.

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

Returns a new VkImportMemoryFdInfoKHR.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkImportMemoryFdInfoKHR
callocStack()

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

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

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

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

Returns a new VkImportMemoryFdInfoKHR instance allocated with BufferUtils.

public static VkImportMemoryFdInfoKHR
create(long address)

Returns a new VkImportMemoryFdInfoKHR instance for the specified memory address.

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

Returns a new VkImportMemoryFdInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkImportMemoryFdInfoKHR.Buffer instance at the specified memory.

public static VkImportMemoryFdInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
fd()

the external handle to import.

public VkImportMemoryFdInfoKHR
fd(int value)

Sets the specified value to the fd field.

public int
handleType()

a VkExternalMemoryHandleTypeFlagBits value specifying the handle type of fd.

public VkImportMemoryFdInfoKHR
handleType(int value)

Sets the specified value to the handleType field.

public static VkImportMemoryFdInfoKHR
malloc()

Returns a new VkImportMemoryFdInfoKHR instance allocated with memAlloc.

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

Returns a new VkImportMemoryFdInfoKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkImportMemoryFdInfoKHR instance allocated on the specified MemoryStack.

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

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

public static VkImportMemoryFdInfoKHR
mallocStack()

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

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

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

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

Unsafe version of fd.

public static void
nfd(long struct, int value)

Unsafe version of fd.

public static int
nhandleType(long struct)

Unsafe version of handleType.

public static void
nhandleType(long struct, int value)

Unsafe version of handleType.

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

Sets the specified value to the pNext field.

public VkImportMemoryFdInfoKHR
set(int sType, long pNext, int handleType, int fd)

Initializes this struct with the specified values.

public VkImportMemoryFdInfoKHR

Returns:

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

Sets the specified value to the sType field.

public VkImportMemoryFdInfoKHR
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.

FDback to summary
public static final int FD

The struct member offsets.

HANDLETYPEback to summary
public static final int HANDLETYPE

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

VkImportMemoryFdInfoKHRback to summary
protected VkImportMemoryFdInfoKHR(long address, ByteBuffer container)
VkImportMemoryFdInfoKHRback to summary
public VkImportMemoryFdInfoKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkImportMemoryFdInfoKHR calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new VkImportMemoryFdInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkImportMemoryFdInfoKHR create(long address)

Returns a new VkImportMemoryFdInfoKHR instance for the specified memory address.

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

Returns a new VkImportMemoryFdInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkImportMemoryFdInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkImportMemoryFdInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
fdback to summary
public int fd()

the external handle to import.

fdback to summary
public VkImportMemoryFdInfoKHR fd(int value)

Sets the specified value to the fd field.

handleTypeback to summary
public int handleType()

a VkExternalMemoryHandleTypeFlagBits value specifying the handle type of fd.

Annotations
@NativeType:VkExternalMemoryHandleTypeFlagBits
handleTypeback to summary
public VkImportMemoryFdInfoKHR handleType(int value)

Sets the specified value to the handleType field.

mallocback to summary
public static VkImportMemoryFdInfoKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkImportMemoryFdInfoKHR malloc(MemoryStack stack)

Returns a new VkImportMemoryFdInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nfdback to summary
public static int nfd(long struct)

Unsafe version of fd.

nfdback to summary
public static void nfd(long struct, int value)

Unsafe version of fd.

nhandleTypeback to summary
public static int nhandleType(long struct)

Unsafe version of handleType.

nhandleTypeback to summary
public static void nhandleType(long struct, int value)

Unsafe version of handleType.

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

Sets the specified value to the pNext field.

setback to summary
public VkImportMemoryFdInfoKHR set(int sType, long pNext, int handleType, int fd)

Initializes this struct with the specified values.

setback to summary
public VkImportMemoryFdInfoKHR set(VkImportMemoryFdInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkImportMemoryFdInfoKHR

the source struct

Returns:VkImportMemoryFdInfoKHR

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_IMPORT_MEMORY_FD_INFO_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkImportMemoryFdInfoKHR.Buffer

extends StructBuffer<VkImportMemoryFdInfoKHR, VkImportMemoryFdInfoKHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkImportMemoryFdInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkImportMemoryFdInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkImportMemoryFdInfoKHR.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 int

Returns:

the value of the VkImportMemoryFdInfoKHR#fd field.
fd
()

public VkImportMemoryFdInfoKHR.Buffer
fd(int value)

Sets the specified value to the VkImportMemoryFdInfoKHR#fd field.

protected VkImportMemoryFdInfoKHR
public int

Returns:

the value of the VkImportMemoryFdInfoKHR#handleType field.
handleType
()

public VkImportMemoryFdInfoKHR.Buffer
handleType(int value)

Sets the specified value to the VkImportMemoryFdInfoKHR#handleType field.

public long

Returns:

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

public VkImportMemoryFdInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkImportMemoryFdInfoKHR#pNext field.

protected VkImportMemoryFdInfoKHR.Buffer
public int

Returns:

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

public VkImportMemoryFdInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkImportMemoryFdInfoKHR#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkImportMemoryFdInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

fdback to summary
public int fd()
Returns:int

the value of the VkImportMemoryFdInfoKHR#fd field.

fdback to summary
public VkImportMemoryFdInfoKHR.Buffer fd(int value)

Sets the specified value to the VkImportMemoryFdInfoKHR#fd field.

getElementFactoryback to summary
protected VkImportMemoryFdInfoKHR getElementFactory()

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

Annotations
@Override
handleTypeback to summary
public int handleType()
Returns:int

the value of the VkImportMemoryFdInfoKHR#handleType field.

Annotations
@NativeType:VkExternalMemoryHandleTypeFlagBits
handleTypeback to summary
public VkImportMemoryFdInfoKHR.Buffer handleType(int value)

Sets the specified value to the VkImportMemoryFdInfoKHR#handleType field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkImportMemoryFdInfoKHR#pNext field.

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

Sets the specified value to the VkImportMemoryFdInfoKHR#pNext field.

selfback to summary
protected VkImportMemoryFdInfoKHR.Buffer self()

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

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

the value of the VkImportMemoryFdInfoKHR#sType field.

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

Sets the specified value to the VkImportMemoryFdInfoKHR#sType field.

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

Sets the STRUCTURE_TYPE_IMPORT_MEMORY_FD_INFO_KHR value to the VkImportMemoryFdInfoKHR#sType field.