VkSemaphoreGetFdInfoKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkSemaphoreGetFdInfoKHR
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 returned depend on the value of handleType. See VkExternalSemaphoreHandleTypeFlagBits for a description of the properties of the defined external semaphore handle types.

Valid Usage
- handleType must have been included in VkExportSemaphoreCreateInfo::handleTypes when semaphore’s current payload was created.
- semaphore must not currently have its payload replaced by an imported payload as described below in Importing Semaphore Payloads unless that imported payload’s handle type was included in VkExternalSemaphoreProperties::exportFromImportedHandleTypes for handleType.
- If handleType refers to a handle type with copy payload transference semantics, as defined below in Importing Semaphore Payloads, there must be no queue waiting on semaphore.
- If handleType refers to a handle type with copy payload transference semantics, semaphore must be signaled, or have an associated semaphore signal operation pending execution.
- handleType must be defined as a POSIX file descriptor handle.
- If handleType refers to a handle type with copy payload transference semantics, semaphore must have been created with a VkSemaphoreTypeKHR of SEMAPHORE_TYPE_BINARY_KHR.
- If handleType refers to a handle type with copy payload transference semantics, semaphore must have an associated semaphore signal operation that has been submitted for execution and any semaphore signal operations on which it depends (if any) must have also been submitted for execution.
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_SEMAPHORE_GET_FD_INFO_KHR
- pNext must be NULL
- semaphore must be a valid VkSemaphore handle
- handleType must be a valid VkExternalSemaphoreHandleTypeFlagBits value
See Also

GetSemaphoreFdKHR

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- semaphore – the semaphore from which state will be exported.
- handleType – the type of handle requested.
Layout
```
 struct VkSemaphoreGetFdInfoKHR {
     VkStructureType sType;
     void const * pNext;
     VkSemaphore semaphore;
     VkExternalSemaphoreHandleTypeFlagBits handleType;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Class VkSemaphoreGetFdInfoKHR

Description

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

SEMAPHORE

HANDLETYPE

Constructor Detail

VkSemaphoreGetFdInfoKHR

Method Detail

sizeof

sType

pNext

semaphore

handleType

sType

pNext

semaphore

handleType

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nsemaphore

nhandleType

nsType

npNext

nsemaphore

nhandleType