Package org.lwjgl.vulkan
Class VkImportMemoryFdInfoKHR
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkImportMemoryFdInfoKHR>
org.lwjgl.vulkan.VkImportMemoryFdInfoKHR
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkImportMemoryFdInfoKHR
extends org.lwjgl.system.Struct<VkImportMemoryFdInfoKHR>
implements org.lwjgl.system.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
handleTypeis not 0, it must be supported for import, as reported byVkExternalImageFormatPropertiesorVkExternalBufferProperties - The memory from which
fdwas exported must have been created on the same underlying physical device asdevice - If
handleTypeis not 0, it must beEXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BITorEXTERNAL_MEMORY_HANDLE_TYPE_DMA_BUF_BIT_EXT - If
handleTypeis not 0,fdmust be a valid handle of the type specified byhandleType - The memory represented by
fdmust have been created from a physical device and driver that is compatible withdeviceandhandleType, as described in External memory handle types compatibility fdmust obey any requirements listed forhandleTypein external memory handle types compatibility
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_IMPORT_MEMORY_FD_INFO_KHR- If
handleTypeis not 0,handleTypemust be a validVkExternalMemoryHandleTypeFlagBitsvalue
Layout
struct VkImportMemoryFdInfoKHR {
VkStructureType sType();
void const * pNext();
VkExternalMemoryHandleTypeFlagBits handleType();
int fd();
}-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkImportMemoryFdInfoKHR(ByteBuffer container) Creates aVkImportMemoryFdInfoKHRinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkImportMemoryFdInfoKHRcalloc()Returns a newVkImportMemoryFdInfoKHRinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkImportMemoryFdInfoKHR.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImportMemoryFdInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImportMemoryFdInfoKHRcalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkImportMemoryFdInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImportMemoryFdInfoKHRDeprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkImportMemoryFdInfoKHRcallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static VkImportMemoryFdInfoKHRcreate()Returns a newVkImportMemoryFdInfoKHRinstance allocated withBufferUtils.create(int capacity) Returns a newVkImportMemoryFdInfoKHR.Bufferinstance allocated withBufferUtils.static VkImportMemoryFdInfoKHRcreate(long address) Returns a newVkImportMemoryFdInfoKHRinstance for the specified memory address.create(long address, int capacity) Create aVkImportMemoryFdInfoKHR.Bufferinstance at the specified memory.static @Nullable VkImportMemoryFdInfoKHRcreateSafe(long address) static @Nullable VkImportMemoryFdInfoKHR.BuffercreateSafe(long address, int capacity) intfd()the external handle to import.fd(int value) Sets the specified value to thefd()field.intaVkExternalMemoryHandleTypeFlagBitsvalue specifying the handle type offd.handleType(int value) Sets the specified value to thehandleType()field.static VkImportMemoryFdInfoKHRmalloc()Returns a newVkImportMemoryFdInfoKHRinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkImportMemoryFdInfoKHR.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImportMemoryFdInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.static VkImportMemoryFdInfoKHRmalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkImportMemoryFdInfoKHRinstance allocated on the specifiedMemoryStack.static VkImportMemoryFdInfoKHRDeprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkImportMemoryFdInfoKHRmallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static intnfd(long struct) Unsafe version offd().static voidnfd(long struct, int value) Unsafe version offd.static intnhandleType(long struct) Unsafe version ofhandleType().static voidnhandleType(long struct, int value) Unsafe version ofhandleType.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.longpNext()NULLor 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.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_IMPORT_MEMORY_FD_INFO_KHRvalue to thesType()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods 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 aVkImportMemoryFdInfoKHRinstance at the current position of the specifiedByteBuffercontainer. 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()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkImportMemoryFdInfoKHR>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
handleType
public int handleType()aVkExternalMemoryHandleTypeFlagBitsvalue 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_KHRvalue 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 newVkImportMemoryFdInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkImportMemoryFdInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkImportMemoryFdInfoKHRinstance allocated withBufferUtils. -
create
Returns a newVkImportMemoryFdInfoKHRinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkImportMemoryFdInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkImportMemoryFdInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkImportMemoryFdInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkImportMemoryFdInfoKHR.Bufferinstance 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, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkImportMemoryFdInfoKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkImportMemoryFdInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkImportMemoryFdInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkImportMemoryFdInfoKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImportMemoryFdInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkImportMemoryFdInfoKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImportMemoryFdInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand 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.
-