Package org.lwjgl.vulkan
Class VkImportMemoryFdInfoKHR
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
public class VkImportMemoryFdInfoKHR
extends Struct<VkImportMemoryFdInfoKHR>
implements NativeResource
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
- If
handleType
is not 0, it must be supported for import, as reported byVkExternalImageFormatProperties
orVkExternalBufferProperties
- The memory from which
fd
was exported must have been created on the same underlying physical device asdevice
- If
handleType
is not 0, it must beEXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT
orEXTERNAL_MEMORY_HANDLE_TYPE_DMA_BUF_BIT_EXT
- If
handleType
is not 0,fd
must be a valid handle of the type specified byhandleType
- The memory represented by
fd
must have been created from a physical device and driver that is compatible withdevice
andhandleType
, as described in External memory handle types compatibility fd
must obey any requirements listed forhandleType
in external memory handle types compatibility
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_IMPORT_MEMORY_FD_INFO_KHR
- If
handleType
is not 0,handleType
must be a validVkExternalMemoryHandleTypeFlagBits
value
Layout
struct VkImportMemoryFdInfoKHR {
VkStructureType sType()
;
void const * pNext()
;
VkExternalMemoryHandleTypeFlagBits handleType()
;
int fd()
;
}
-
Nested Class Summary
Nested classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionVkImportMemoryFdInfoKHR
(ByteBuffer container) Creates aVkImportMemoryFdInfoKHR
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkImportMemoryFdInfoKHR
calloc()
Returns a newVkImportMemoryFdInfoKHR
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkImportMemoryFdInfoKHR.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkImportMemoryFdInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImportMemoryFdInfoKHR
calloc
(MemoryStack stack) Returns a newVkImportMemoryFdInfoKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImportMemoryFdInfoKHR
Deprecated.callocStack
(int capacity) Deprecated.callocStack
(int capacity, MemoryStack stack) Deprecated.static VkImportMemoryFdInfoKHR
callocStack
(MemoryStack stack) Deprecated.static VkImportMemoryFdInfoKHR
create()
Returns a newVkImportMemoryFdInfoKHR
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkImportMemoryFdInfoKHR.Buffer
instance allocated withBufferUtils
.static VkImportMemoryFdInfoKHR
create
(long address) Returns a newVkImportMemoryFdInfoKHR
instance for the specified memory address.create
(long address, int capacity) Create aVkImportMemoryFdInfoKHR.Buffer
instance at the specified memory.static VkImportMemoryFdInfoKHR
createSafe
(long address) createSafe
(long address, int capacity) int
fd()
the external handle to import.fd
(int value) Sets the specified value to thefd()
field.int
aVkExternalMemoryHandleTypeFlagBits
value specifying the handle type offd
.handleType
(int value) Sets the specified value to thehandleType()
field.static VkImportMemoryFdInfoKHR
malloc()
Returns a newVkImportMemoryFdInfoKHR
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkImportMemoryFdInfoKHR.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkImportMemoryFdInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkImportMemoryFdInfoKHR
malloc
(MemoryStack stack) Returns a newVkImportMemoryFdInfoKHR
instance allocated on the specifiedMemoryStack
.static VkImportMemoryFdInfoKHR
Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.static VkImportMemoryFdInfoKHR
mallocStack
(MemoryStack stack) Deprecated.static int
nfd
(long struct) Unsafe version offd()
.static void
nfd
(long struct, int value) Unsafe version offd
.static int
nhandleType
(long struct) Unsafe version ofhandleType()
.static void
nhandleType
(long struct, int value) Unsafe version ofhandleType
.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()
NULL
or a pointer to a structure extending this structure.pNext
(long value) Sets the specified value to thepNext()
field.set
(int sType, long pNext, int handleType, int fd) Initializes this struct with the specified values.Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.int
sType()
aVkStructureType
value identifying this structure.sType
(int value) Sets the specified value to thesType()
field.Sets theSTRUCTURE_TYPE_IMPORT_MEMORY_FD_INFO_KHR
value to thesType()
field.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
HANDLETYPE
public static final int HANDLETYPEThe struct member offsets. -
FD
public static final int FDThe struct member offsets.
-
-
Constructor Details
-
VkImportMemoryFdInfoKHR
Creates aVkImportMemoryFdInfoKHR
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 Details
-
sizeof
public int sizeof()Description copied from class:Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkImportMemoryFdInfoKHR>
-
sType
public int sType()aVkStructureType
value identifying this structure. -
pNext
public long pNext()NULL
or a pointer to a structure extending this structure. -
handleType
public int handleType()aVkExternalMemoryHandleTypeFlagBits
value specifying the handle type offd
. -
fd
public int fd()the external handle to import. -
sType
Sets the specified value to thesType()
field. -
sType$Default
Sets theSTRUCTURE_TYPE_IMPORT_MEMORY_FD_INFO_KHR
value to thesType()
field. -
pNext
Sets the specified value to thepNext()
field. -
handleType
Sets the specified value to thehandleType()
field. -
fd
Sets the specified value to thefd()
field. -
set
Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
Returns a newVkImportMemoryFdInfoKHR
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkImportMemoryFdInfoKHR
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkImportMemoryFdInfoKHR
instance allocated withBufferUtils
. -
create
Returns a newVkImportMemoryFdInfoKHR
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkImportMemoryFdInfoKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkImportMemoryFdInfoKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkImportMemoryFdInfoKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkImportMemoryFdInfoKHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
@Deprecated public static VkImportMemoryFdInfoKHR.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkImportMemoryFdInfoKHR.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkImportMemoryFdInfoKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkImportMemoryFdInfoKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkImportMemoryFdInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkImportMemoryFdInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType()
. -
npNext
public static long npNext(long struct) Unsafe version ofpNext()
. -
nhandleType
public static int nhandleType(long struct) Unsafe version ofhandleType()
. -
nfd
public static int nfd(long struct) Unsafe version offd()
. -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType
. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext
. -
nhandleType
public static void nhandleType(long struct, int value) Unsafe version ofhandleType
. -
nfd
public static void nfd(long struct, int value) Unsafe version offd
.
-