VkImportFenceFdInfoKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkImportFenceFdInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
(None).
Description

The handle types supported by handleType are:

Handle Types Supported by VkImportFenceFdInfoKHR

Handle Type Transference Permanence Supported

EXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_FD_BIT Reference Temporary,Permanent

EXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BIT Copy Temporary

Valid Usage
- handleType must be a value included in the Handle Types Supported by VkImportFenceFdInfoKHR table.
- fd must obey any requirements listed for handleType in external fence handle types compatibility.
If handleType is EXTERNAL_FENCE_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 VkFence 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_FENCE_HANDLE_TYPE_SYNC_FD_BIT from a VkFence which is signaled.

Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_IMPORT_FENCE_FD_INFO_KHR
- pNext must be NULL
- fence must be a valid VkFence handle
- flags must be a valid combination of VkFenceImportFlagBits values
- handleType must be a valid VkExternalFenceHandleTypeFlagBits value
Host Synchronization
- Host access to fence must be externally synchronized
See Also

ImportFenceFdKHR

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- fence – the fence into which the payload will be imported.
- flags – a bitmask of VkFenceImportFlagBits specifying additional parameters for the fence payload import operation.
- handleType – specifies the type of fd.
- fd – the external handle to import.
Layout
```
 struct VkImportFenceFdInfoKHR {
     VkStructureType sType;
     void const * pNext;
     VkFence fence;
     VkFenceImportFlags flags;
     VkExternalFenceHandleTypeFlagBits handleType;
     int fd;
 }
```

Handle Type	Transference	Permanence Supported
`EXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_FD_BIT`	Reference	Temporary,Permanent
`EXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BIT`	Copy	Temporary

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Description

Handle Types Supported by VkImportFenceFdInfoKHR

Valid Usage

Note

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

FENCE

FLAGS

HANDLETYPE

FD

Constructor Detail

VkImportFenceFdInfoKHR

Method Detail

sizeof

sType

pNext

fence

flags

handleType

fd

sType

pNext

fence

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

nfence

nflags

nhandleType

nfd

nsType

npNext

nfence

nflags

nhandleType

nfd

Handle Types Supported by `VkImportFenceFdInfoKHR`