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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkImportSemaphoreFdInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying POSIX file descriptor to import to a semaphore.
Description

The handle types supported by handleType are:

Handle Types Supported by VkImportSemaphoreFdInfoKHR

Handle Type Transference Permanence Supported

EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_FD_BIT Reference Temporary,Permanent

EXTERNAL_SEMAPHORE_HANDLE_TYPE_SYNC_FD_BIT Copy Temporary

Valid Usage
- handleType must be a value included in the Handle Types Supported by VkImportSemaphoreFdInfoKHR table
- fd must obey any requirements listed for handleType in external semaphore handle types compatibility
- If handleType is EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_FD_BIT, the VkSemaphoreCreateInfo::flags field must match that of the semaphore from which fd was exported
- If handleType is EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_FD_BIT, the VkSemaphoreTypeCreateInfo::semaphoreType field must match that of the semaphore from which fd was exported
- If flags contains SEMAPHORE_IMPORT_TEMPORARY_BIT, the VkSemaphoreTypeCreateInfo::semaphoreType field of the semaphore from which fd was exported must not be SEMAPHORE_TYPE_TIMELINE
If handleType is EXTERNAL_SEMAPHORE_HANDLE_TYPE_SYNC_FD_BIT, the special value -1 for fd is treated like a valid sync file descriptor referring to an object that has already signaled. The import operation will succeed and the VkSemaphore will have a temporarily imported payload as if a valid file descriptor had been provided.

Note

This special behavior for importing an invalid sync file descriptor allows easier interoperability with other system APIs which use the convention that an invalid sync file descriptor represents work that has already completed and does not need to be waited for. It is consistent with the option for implementations to return a -1 file descriptor when exporting a EXTERNAL_SEMAPHORE_HANDLE_TYPE_SYNC_FD_BIT from a VkSemaphore which is signaled.

Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_IMPORT_SEMAPHORE_FD_INFO_KHR
- pNext must be NULL
- semaphore must be a valid VkSemaphore handle
- flags must be a valid combination of VkSemaphoreImportFlagBits values
- handleType must be a valid VkExternalSemaphoreHandleTypeFlagBits value
Host Synchronization
- Host access to semaphore must be externally synchronized
See Also

ImportSemaphoreFdKHR

Layout
```
 struct VkImportSemaphoreFdInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkSemaphore semaphore();
     VkSemaphoreImportFlags flags();
     VkExternalSemaphoreHandleTypeFlagBits handleType();
     int fd();
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

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

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`FD FLAGS HANDLETYPE PNEXT SEMAPHORE`	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	Description
`VkImportSemaphoreFdInfoKHR(java.nio.ByteBuffer container)`	Creates a `VkImportSemaphoreFdInfoKHR` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static VkImportSemaphoreFdInfoKHR`	`calloc()`	Returns a new `VkImportSemaphoreFdInfoKHR` instance allocated with `memCalloc`.
`static VkImportSemaphoreFdInfoKHR.Buffer`	`calloc(int capacity)`	Returns a new `VkImportSemaphoreFdInfoKHR.Buffer` instance allocated with `memCalloc`.
`static VkImportSemaphoreFdInfoKHR.Buffer`	`calloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkImportSemaphoreFdInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkImportSemaphoreFdInfoKHR`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkImportSemaphoreFdInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkImportSemaphoreFdInfoKHR`	`callocStack()`	Deprecated.
`static VkImportSemaphoreFdInfoKHR.Buffer`	`callocStack(int capacity)`	Deprecated.
`static VkImportSemaphoreFdInfoKHR.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static VkImportSemaphoreFdInfoKHR`	`callocStack(org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static VkImportSemaphoreFdInfoKHR`	`create()`	Returns a new `VkImportSemaphoreFdInfoKHR` instance allocated with `BufferUtils`.
`static VkImportSemaphoreFdInfoKHR.Buffer`	`create(int capacity)`	Returns a new `VkImportSemaphoreFdInfoKHR.Buffer` instance allocated with `BufferUtils`.
`static VkImportSemaphoreFdInfoKHR`	`create(long address)`	Returns a new `VkImportSemaphoreFdInfoKHR` instance for the specified memory address.
`static VkImportSemaphoreFdInfoKHR.Buffer`	`create(long address, int capacity)`	Create a `VkImportSemaphoreFdInfoKHR.Buffer` instance at the specified memory.
`static VkImportSemaphoreFdInfoKHR`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkImportSemaphoreFdInfoKHR.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`int`	`fd()`	the external handle to import.
`VkImportSemaphoreFdInfoKHR`	`fd(int value)`	Sets the specified value to the `fd()` field.
`int`	`flags()`	a bitmask of `VkSemaphoreImportFlagBits` specifying additional parameters for the semaphore payload import operation.
`VkImportSemaphoreFdInfoKHR`	`flags(int value)`	Sets the specified value to the `flags()` field.
`int`	`handleType()`	a `VkExternalSemaphoreHandleTypeFlagBits` value specifying the type of `fd`.
`VkImportSemaphoreFdInfoKHR`	`handleType(int value)`	Sets the specified value to the `handleType()` field.
`static VkImportSemaphoreFdInfoKHR`	`malloc()`	Returns a new `VkImportSemaphoreFdInfoKHR` instance allocated with `memAlloc`.
`static VkImportSemaphoreFdInfoKHR.Buffer`	`malloc(int capacity)`	Returns a new `VkImportSemaphoreFdInfoKHR.Buffer` instance allocated with `memAlloc`.
`static VkImportSemaphoreFdInfoKHR.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkImportSemaphoreFdInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkImportSemaphoreFdInfoKHR`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkImportSemaphoreFdInfoKHR` instance allocated on the specified `MemoryStack`.
`static VkImportSemaphoreFdInfoKHR`	`mallocStack()`	Deprecated.
`static VkImportSemaphoreFdInfoKHR.Buffer`	`mallocStack(int capacity)`	Deprecated.
`static VkImportSemaphoreFdInfoKHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static VkImportSemaphoreFdInfoKHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static int`	`nfd(long struct)`	Unsafe version of `fd()`.
`static void`	`nfd(long struct, int value)`	Unsafe version of `fd`.
`static int`	`nflags(long struct)`	Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)`	Unsafe version of `flags`.
`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 long`	`nsemaphore(long struct)`	Unsafe version of `semaphore()`.
`static void`	`nsemaphore(long struct, long value)`	Unsafe version of `semaphore`.
`static int`	`nsType(long struct)`	Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)`	Unsafe version of `sType`.
`long`	`pNext()`	`NULL` or a pointer to a structure extending this structure.
`VkImportSemaphoreFdInfoKHR`	`pNext(long value)`	Sets the specified value to the `pNext()` field.
`long`	`semaphore()`	the semaphore into which the payload will be imported.
`VkImportSemaphoreFdInfoKHR`	`semaphore(long value)`	Sets the specified value to the `semaphore()` field.
`VkImportSemaphoreFdInfoKHR`	`set(int sType, long pNext, long semaphore, int flags, int handleType, int fd)`	Initializes this struct with the specified values.
`VkImportSemaphoreFdInfoKHR`	`set(VkImportSemaphoreFdInfoKHR src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()`	the type of this structure.
`VkImportSemaphoreFdInfoKHR`	`sType(int value)`	Sets the specified value to the `sType()` field.
`VkImportSemaphoreFdInfoKHR`	`sType$Default()`	Sets the `STRUCTURE_TYPE_IMPORT_SEMAPHORE_FD_INFO_KHR` value to the `sType()` field.

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

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

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

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

- Field Detail
  - SIZEOF
    
    The struct size in bytes.
  - ALIGNOF
    
    The struct alignment in bytes.
  - STYPE, PNEXT, SEMAPHORE, FLAGS, HANDLETYPE, FD
    
    The struct member offsets.
- Constructor Detail
  - VkImportSemaphoreFdInfoKHR
```
public VkImportSemaphoreFdInfoKHR(java.nio.ByteBuffer container)
```
    Creates a VkImportSemaphoreFdInfoKHR 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()
```
    the type of this structure.
  - pNext
```
public long pNext()
```
    NULL or a pointer to a structure extending this structure.
  - semaphore
```
public long semaphore()
```
    the semaphore into which the payload will be imported.
  - flags
```
public int flags()
```
    a bitmask of VkSemaphoreImportFlagBits specifying additional parameters for the semaphore payload import operation.
  - handleType
```
public int handleType()
```
    a VkExternalSemaphoreHandleTypeFlagBits value specifying the type of fd.
  - fd
```
public int fd()
```
    the external handle to import.
  - sType
```
public VkImportSemaphoreFdInfoKHR sType(int value)
```
    Sets the specified value to the sType() field.
  - sType$Default
```
public VkImportSemaphoreFdInfoKHR sType$Default()
```
    Sets the STRUCTURE_TYPE_IMPORT_SEMAPHORE_FD_INFO_KHR value to the sType() field.
  - pNext
```
public VkImportSemaphoreFdInfoKHR pNext(long value)
```
    Sets the specified value to the pNext() field.
  - semaphore
```
public VkImportSemaphoreFdInfoKHR semaphore(long value)
```
    Sets the specified value to the semaphore() field.
  - flags
```
public VkImportSemaphoreFdInfoKHR flags(int value)
```
    Sets the specified value to the flags() field.
  - handleType
```
public VkImportSemaphoreFdInfoKHR handleType(int value)
```
    Sets the specified value to the handleType() field.
  - fd
```
public VkImportSemaphoreFdInfoKHR fd(int value)
```
    Sets the specified value to the fd() field.
  - set
```
public VkImportSemaphoreFdInfoKHR set(int sType,
                                      long pNext,
                                      long semaphore,
                                      int flags,
                                      int handleType,
                                      int fd)
```
    Initializes this struct with the specified values.
  - set
```
public VkImportSemaphoreFdInfoKHR set(VkImportSemaphoreFdInfoKHR src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkImportSemaphoreFdInfoKHR malloc()
```
    Returns a new VkImportSemaphoreFdInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkImportSemaphoreFdInfoKHR calloc()
```
    Returns a new VkImportSemaphoreFdInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkImportSemaphoreFdInfoKHR create()
```
    Returns a new VkImportSemaphoreFdInfoKHR instance allocated with BufferUtils.
  - create
```
public static VkImportSemaphoreFdInfoKHR create(long address)
```
    Returns a new VkImportSemaphoreFdInfoKHR instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkImportSemaphoreFdInfoKHR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkImportSemaphoreFdInfoKHR.Buffer malloc(int capacity)
```
    Returns a new VkImportSemaphoreFdInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkImportSemaphoreFdInfoKHR.Buffer calloc(int capacity)
```
    Returns a new VkImportSemaphoreFdInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkImportSemaphoreFdInfoKHR.Buffer create(int capacity)
```
    Returns a new VkImportSemaphoreFdInfoKHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkImportSemaphoreFdInfoKHR.Buffer create(long address,
                                                       int capacity)
```
    Create a VkImportSemaphoreFdInfoKHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkImportSemaphoreFdInfoKHR.Buffer createSafe(long address,
                                                           int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
@Deprecated
public static VkImportSemaphoreFdInfoKHR mallocStack()
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
  - callocStack
```
@Deprecated
public static VkImportSemaphoreFdInfoKHR callocStack()
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
  - mallocStack
```
@Deprecated
public static VkImportSemaphoreFdInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
  - callocStack
```
@Deprecated
public static VkImportSemaphoreFdInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
  - mallocStack
```
@Deprecated
public static VkImportSemaphoreFdInfoKHR.Buffer mallocStack(int capacity)
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
  - callocStack
```
@Deprecated
public static VkImportSemaphoreFdInfoKHR.Buffer callocStack(int capacity)
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
  - mallocStack
```
@Deprecated
public static VkImportSemaphoreFdInfoKHR.Buffer mallocStack(int capacity,
                                                            org.lwjgl.system.MemoryStack stack)
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
  - callocStack
```
@Deprecated
public static VkImportSemaphoreFdInfoKHR.Buffer callocStack(int capacity,
                                                            org.lwjgl.system.MemoryStack stack)
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
  - malloc
```
public static VkImportSemaphoreFdInfoKHR malloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImportSemaphoreFdInfoKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - calloc
```
public static VkImportSemaphoreFdInfoKHR calloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImportSemaphoreFdInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - malloc
```
public static VkImportSemaphoreFdInfoKHR.Buffer malloc(int capacity,
                                                       org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImportSemaphoreFdInfoKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - calloc
```
public static VkImportSemaphoreFdInfoKHR.Buffer calloc(int capacity,
                                                       org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImportSemaphoreFdInfoKHR.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().
  - nsemaphore
```
public static long nsemaphore(long struct)
```
    Unsafe version of semaphore().
  - nflags
```
public static int nflags(long struct)
```
    Unsafe version of flags().
  - 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.
  - nsemaphore
```
public static void nsemaphore(long struct,
                              long value)
```
    Unsafe version of semaphore.
  - nflags
```
public static void nflags(long struct,
                          int value)
```
    Unsafe version of flags.
  - 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.

Handle Type	Transference	Permanence Supported
`EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_FD_BIT`	Reference	Temporary,Permanent
`EXTERNAL_SEMAPHORE_HANDLE_TYPE_SYNC_FD_BIT`	Copy	Temporary

Class VkImportSemaphoreFdInfoKHR

Description

Handle Types Supported by VkImportSemaphoreFdInfoKHR

Valid Usage

Note

Valid Usage (Implicit)

Host Synchronization

See Also

Layout

Nested Class Summary

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

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

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

STYPE, PNEXT, SEMAPHORE, FLAGS, HANDLETYPE, FD

Constructor Detail

VkImportSemaphoreFdInfoKHR

Method Detail

sizeof

sType

pNext

semaphore

flags

handleType

fd

sType

sType$Default

pNext

semaphore

flags

handleType

fd

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

malloc

calloc

malloc

calloc

nsType

npNext

nsemaphore

nflags

nhandleType

nfd

nsType

npNext

nsemaphore

nflags

nhandleType

nfd

Handle Types Supported by `VkImportSemaphoreFdInfoKHR`