VkImportMemoryFdInfoKHR (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkImportMemoryFdInfoKHR

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkImportMemoryFdInfoKHR
extends org.lwjgl.system.Struct
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.

Applications can import the same underlying memory 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 by VkExternalImageFormatProperties or VkExternalBufferProperties.
- The memory from which fd was exported must have been created on the same underlying physical device as device.
- If handleType is not 0, it must be defined as a POSIX file descriptor handle.
- If handleType is not 0, fd must be a valid handle of the type specified by handleType.
- The memory represented by fd must have been created from a physical device and driver that is compatible with device and handleType, as described in External memory handle types compatibility.
- fd must obey any requirements listed for handleType in external memory handle types compatibility.
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_IMPORT_MEMORY_FD_INFO_KHR
- If handleType is not 0, handleType must be a valid VkExternalMemoryHandleTypeFlagBits value
Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- handleType – specifies the handle type of fd.
- fd – the external handle to import.
Layout
```
 struct VkImportMemoryFdInfoKHR {
     VkStructureType sType;
     void const * pNext;
     VkExternalMemoryHandleTypeFlagBits handleType;
     int fd;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkImportMemoryFdInfoKHR.Buffer
An array of VkImportMemoryFdInfoKHR structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkImportMemoryFdInfoKHR.Buffer` An array of `VkImportMemoryFdInfoKHR` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`FD` The struct member offsets.
`static int`	`HANDLETYPE` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STYPE` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkImportMemoryFdInfoKHR(java.nio.ByteBuffer container)` Creates a `VkImportMemoryFdInfoKHR` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VkImportMemoryFdInfoKHR`	`calloc()` Returns a new `VkImportMemoryFdInfoKHR` instance allocated with `memCalloc`.
`static VkImportMemoryFdInfoKHR.Buffer`	`calloc(int capacity)` Returns a new `VkImportMemoryFdInfoKHR.Buffer` instance allocated with `memCalloc`.
`static VkImportMemoryFdInfoKHR`	`callocStack()` Returns a new `VkImportMemoryFdInfoKHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkImportMemoryFdInfoKHR.Buffer`	`callocStack(int capacity)` Returns a new `VkImportMemoryFdInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkImportMemoryFdInfoKHR.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkImportMemoryFdInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkImportMemoryFdInfoKHR`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkImportMemoryFdInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkImportMemoryFdInfoKHR`	`create()` Returns a new `VkImportMemoryFdInfoKHR` instance allocated with `BufferUtils`.
`static VkImportMemoryFdInfoKHR.Buffer`	`create(int capacity)` Returns a new `VkImportMemoryFdInfoKHR.Buffer` instance allocated with `BufferUtils`.
`static VkImportMemoryFdInfoKHR`	`create(long address)` Returns a new `VkImportMemoryFdInfoKHR` instance for the specified memory address.
`static VkImportMemoryFdInfoKHR.Buffer`	`create(long address, int capacity)` Create a `VkImportMemoryFdInfoKHR.Buffer` instance at the specified memory.
`static VkImportMemoryFdInfoKHR`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkImportMemoryFdInfoKHR.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`fd()` Returns the value of the `fd` field.
`VkImportMemoryFdInfoKHR`	`fd(int value)` Sets the specified value to the `fd` field.
`int`	`handleType()` Returns the value of the `handleType` field.
`VkImportMemoryFdInfoKHR`	`handleType(int value)` Sets the specified value to the `handleType` field.
`static VkImportMemoryFdInfoKHR`	`malloc()` Returns a new `VkImportMemoryFdInfoKHR` instance allocated with `memAlloc`.
`static VkImportMemoryFdInfoKHR.Buffer`	`malloc(int capacity)` Returns a new `VkImportMemoryFdInfoKHR.Buffer` instance allocated with `memAlloc`.
`static VkImportMemoryFdInfoKHR`	`mallocStack()` Returns a new `VkImportMemoryFdInfoKHR` instance allocated on the thread-local `MemoryStack`.
`static VkImportMemoryFdInfoKHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkImportMemoryFdInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkImportMemoryFdInfoKHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkImportMemoryFdInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkImportMemoryFdInfoKHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkImportMemoryFdInfoKHR` instance allocated on the specified `MemoryStack`.
`static int`	`nfd(long struct)` Unsafe version of `fd()`.
`static void`	`nfd(long struct, int value)` Unsafe version of `fd`.
`static int`	`nhandleType(long struct)` Unsafe version of `handleType()`.
`static void`	`nhandleType(long struct, int value)` Unsafe version of `handleType`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkImportMemoryFdInfoKHR`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkImportMemoryFdInfoKHR`	`set(int sType, long pNext, int handleType, int fd)` Initializes this struct with the specified values.
`VkImportMemoryFdInfoKHR`	`set(VkImportMemoryFdInfoKHR src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkImportMemoryFdInfoKHR`	`sType(int value)` Sets the specified value to the `sType` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - STYPE
```
public static final int STYPE
```
    The struct member offsets.
  - PNEXT
```
public static final int PNEXT
```
    The struct member offsets.
  - HANDLETYPE
```
public static final int HANDLETYPE
```
    The struct member offsets.
  - FD
```
public static final int FD
```
    The struct member offsets.
- Constructor Detail
  - VkImportMemoryFdInfoKHR
```
public VkImportMemoryFdInfoKHR(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - handleType
```
public int handleType()
```
    Returns the value of the handleType field.
  - fd
```
public int fd()
```
    Returns the value of the fd field.
  - sType
```
public VkImportMemoryFdInfoKHR sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkImportMemoryFdInfoKHR pNext(long value)
```
    Sets the specified value to the pNext field.
  - handleType
```
public VkImportMemoryFdInfoKHR handleType(int value)
```
    Sets the specified value to the handleType field.
  - fd
```
public VkImportMemoryFdInfoKHR fd(int value)
```
    Sets the specified value to the fd field.
  - set
```
public VkImportMemoryFdInfoKHR set(int sType,
                                   long pNext,
                                   int handleType,
                                   int fd)
```
    Initializes this struct with the specified values.
  - set
```
public VkImportMemoryFdInfoKHR set(VkImportMemoryFdInfoKHR src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkImportMemoryFdInfoKHR malloc()
```
    Returns a new VkImportMemoryFdInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkImportMemoryFdInfoKHR calloc()
```
    Returns a new VkImportMemoryFdInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkImportMemoryFdInfoKHR create()
```
    Returns a new VkImportMemoryFdInfoKHR instance allocated with BufferUtils.
  - create
```
public static VkImportMemoryFdInfoKHR create(long address)
```
    Returns a new VkImportMemoryFdInfoKHR instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkImportMemoryFdInfoKHR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkImportMemoryFdInfoKHR.Buffer malloc(int capacity)
```
    Returns a new VkImportMemoryFdInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkImportMemoryFdInfoKHR.Buffer calloc(int capacity)
```
    Returns a new VkImportMemoryFdInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkImportMemoryFdInfoKHR.Buffer create(int capacity)
```
    Returns a new VkImportMemoryFdInfoKHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkImportMemoryFdInfoKHR.Buffer create(long address,
                                                    int capacity)
```
    Create a VkImportMemoryFdInfoKHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkImportMemoryFdInfoKHR.Buffer createSafe(long address,
                                                                  int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkImportMemoryFdInfoKHR mallocStack()
```
    Returns a new VkImportMemoryFdInfoKHR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkImportMemoryFdInfoKHR callocStack()
```
    Returns a new VkImportMemoryFdInfoKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkImportMemoryFdInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImportMemoryFdInfoKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkImportMemoryFdInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImportMemoryFdInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkImportMemoryFdInfoKHR.Buffer mallocStack(int capacity)
```
    Returns a new VkImportMemoryFdInfoKHR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkImportMemoryFdInfoKHR.Buffer callocStack(int capacity)
```
    Returns a new VkImportMemoryFdInfoKHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkImportMemoryFdInfoKHR.Buffer mallocStack(int capacity,
                                                         org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImportMemoryFdInfoKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkImportMemoryFdInfoKHR.Buffer callocStack(int capacity,
                                                         org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImportMemoryFdInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - nhandleType
```
public static int nhandleType(long struct)
```
    Unsafe version of handleType().
  - nfd
```
public static int nfd(long struct)
```
    Unsafe version of fd().
  - nsType
```
public static void nsType(long struct,
                          int value)
```
    Unsafe version of sType.
  - npNext
```
public static void npNext(long struct,
                          long value)
```
    Unsafe version of pNext.
  - nhandleType
```
public static void nhandleType(long struct,
                               int value)
```
    Unsafe version of handleType.
  - nfd
```
public static void nfd(long struct,
                       int value)
```
    Unsafe version of fd.

Class VkImportMemoryFdInfoKHR

Description

Valid Usage

Valid Usage (Implicit)

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

HANDLETYPE

FD

Constructor Detail

VkImportMemoryFdInfoKHR

Method Detail

sizeof

sType

pNext

handleType

fd

sType

pNext

handleType

fd

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nhandleType

nfd

nsType

npNext

nhandleType

nfd