VkMemoryGetFdInfoKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkMemoryGetFdInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure describing a POSIX FD semaphore export operation.
Description

The properties of the file descriptor exported depend on the value of handleType. See VkExternalMemoryHandleTypeFlagBits for a description of the properties of the defined external memory handle types.

Note

The size of the exported file may be larger than the size requested by VkMemoryAllocateInfo::allocationSize. If handleType is EXTERNAL_MEMORY_HANDLE_TYPE_DMA_BUF_BIT_EXT, then the application can query the file's actual size with link:man:lseek(2)[lseek(2)].

Valid Usage
- handleType must have been included in VkExportMemoryAllocateInfo::handleTypes when memory was created.
- handleType must be defined as a POSIX file descriptor handle.
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_MEMORY_GET_FD_INFO_KHR
- pNext must be NULL
- memory must be a valid VkDeviceMemory handle
- handleType must be a valid VkExternalMemoryHandleTypeFlagBits value
See Also

GetMemoryFdKHR

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- memory – the memory object from which the handle will be exported.
- handleType – the type of handle requested.
Layout
```
 struct VkMemoryGetFdInfoKHR {
     VkStructureType sType;
     void const * pNext;
     VkDeviceMemory memory;
     VkExternalMemoryHandleTypeFlagBits handleType;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkMemoryGetFdInfoKHR.Buffer
An array of VkMemoryGetFdInfoKHR 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`	`VkMemoryGetFdInfoKHR.Buffer` An array of `VkMemoryGetFdInfoKHR` structs.

Field Summary

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

Class VkMemoryGetFdInfoKHR

Description

Note

Valid Usage

Valid Usage (Implicit)

See Also

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

MEMORY

HANDLETYPE

Constructor Detail

VkMemoryGetFdInfoKHR

Method Detail

sizeof

sType

pNext

memory

handleType

sType

pNext

memory

handleType

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nmemory

nhandleType

nsType

npNext

nmemory

nhandleType