VkImportSemaphoreFdInfoKHR (LWJGL 3.2.4 SNAPSHOT

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 VkSemaphoreTypeCreateInfoKHR::semaphoreType field must match that of the semaphore from which fd was exported.
- If flags contains SEMAPHORE_IMPORT_TEMPORARY_BIT, the VkSemaphoreTypeCreateInfoKHR::semaphoreType field of the semaphore from which fd was exported must not be SEMAPHORE_TYPE_TIMELINE_KHR.
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

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- semaphore – the semaphore into which the payload will be imported.
- flags – a bitmask of VkSemaphoreImportFlagBits specifying additional parameters for the semaphore payload import operation.
- handleType – specifies the type of fd.
- fd – the external handle to import.
Layout
```
 struct VkImportSemaphoreFdInfoKHR {
     VkStructureType sType;
     void const * pNext;
     VkSemaphore semaphore;
     VkSemaphoreImportFlags flags;
     VkExternalSemaphoreHandleTypeFlagBits handleType;
     int 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

Nested Class Summary

Nested Classes
Modifier and Type Class and 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
Modifier and Type	Class and Description
`static class`	`VkImportSemaphoreFdInfoKHR.Buffer` An array of `VkImportSemaphoreFdInfoKHR` 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`	`FLAGS` The struct member offsets.
`static int`	`HANDLETYPE` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`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 and 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
Modifier and Type	Method and 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`	`callocStack()` Returns a new `VkImportSemaphoreFdInfoKHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkImportSemaphoreFdInfoKHR.Buffer`	`callocStack(int capacity)` Returns a new `VkImportSemaphoreFdInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkImportSemaphoreFdInfoKHR.Buffer`	`callocStack(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`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkImportSemaphoreFdInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`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()` Returns the value of the `fd` field.
`VkImportSemaphoreFdInfoKHR`	`fd(int value)` Sets the specified value to the `fd` field.
`int`	`flags()` Returns the value of the `flags` field.
`VkImportSemaphoreFdInfoKHR`	`flags(int value)` Sets the specified value to the `flags` field.
`int`	`handleType()` Returns the value of the `handleType` field.
`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`	`mallocStack()` Returns a new `VkImportSemaphoreFdInfoKHR` instance allocated on the thread-local `MemoryStack`.
`static VkImportSemaphoreFdInfoKHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkImportSemaphoreFdInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkImportSemaphoreFdInfoKHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkImportSemaphoreFdInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkImportSemaphoreFdInfoKHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkImportSemaphoreFdInfoKHR` 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`	`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()` Returns the value of the `pNext` field.
`VkImportSemaphoreFdInfoKHR`	`pNext(long value)` Sets the specified value to the `pNext` field.
`long`	`semaphore()` Returns the value of the `semaphore` field.
`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()` Returns the value of the `sType` field.
`VkImportSemaphoreFdInfoKHR`	`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.
  - SEMAPHORE
```
public static final int SEMAPHORE
```
    The struct member offsets.
  - FLAGS
```
public static final int FLAGS
```
    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
  - 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()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - semaphore
```
public long semaphore()
```
    Returns the value of the semaphore field.
  - flags
```
public int flags()
```
    Returns the value of the flags 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 VkImportSemaphoreFdInfoKHR sType(int value)
```
    Sets the specified 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
```
public static VkImportSemaphoreFdInfoKHR mallocStack()
```
    Returns a new VkImportSemaphoreFdInfoKHR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkImportSemaphoreFdInfoKHR callocStack()
```
    Returns a new VkImportSemaphoreFdInfoKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkImportSemaphoreFdInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImportSemaphoreFdInfoKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkImportSemaphoreFdInfoKHR callocStack(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
  - mallocStack
```
public static VkImportSemaphoreFdInfoKHR.Buffer mallocStack(int capacity)
```
    Returns a new VkImportSemaphoreFdInfoKHR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkImportSemaphoreFdInfoKHR.Buffer callocStack(int capacity)
```
    Returns a new VkImportSemaphoreFdInfoKHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkImportSemaphoreFdInfoKHR.Buffer mallocStack(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
  - callocStack
```
public static VkImportSemaphoreFdInfoKHR.Buffer callocStack(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.

Class VkImportSemaphoreFdInfoKHR

Description

Handle Types Supported by VkImportSemaphoreFdInfoKHR

Valid Usage

Valid Usage (Implicit)

Host Synchronization

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

SEMAPHORE

FLAGS

HANDLETYPE

FD

Constructor Detail

VkImportSemaphoreFdInfoKHR

Method Detail

sizeof

sType

pNext

semaphore

flags

handleType

fd

sType

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

nsType

npNext

nsemaphore

nflags

nhandleType

nfd

nsType

npNext

nsemaphore

nflags

nhandleType

nfd

Handle Types Supported by `VkImportSemaphoreFdInfoKHR`