VkFenceGetFdInfoKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

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

The properties of the file descriptor returned depend on the value of handleType. See VkExternalFenceHandleTypeFlagBits for a description of the properties of the defined external fence handle types.

Valid Usage
- handleType must have been included in VkExportFenceCreateInfo::handleTypes when fence’s current payload was created.
- If handleType refers to a handle type with copy payload transference semantics, fence must be signaled, or have an associated fence signal operation pending execution.
- fence must not currently have its payload replaced by an imported payload as described below in Importing Fence Payloads unless that imported payload’s handle type was included in VkExternalFenceProperties::exportFromImportedHandleTypes for handleType.
- handleType must be defined as a POSIX file descriptor handle.
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_FENCE_GET_FD_INFO_KHR
- pNext must be NULL
- fence must be a valid VkFence handle
- handleType must be a valid VkExternalFenceHandleTypeFlagBits value
See Also

GetFenceFdKHR

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

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

Class VkFenceGetFdInfoKHR

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

FENCE

HANDLETYPE

Constructor Detail

VkFenceGetFdInfoKHR

Method Detail

sizeof

sType

pNext

fence

handleType

sType

pNext

fence

handleType

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nfence

nhandleType

nsType

npNext

nfence

nhandleType