Class VkImportFenceFdInfoKHR
- 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
handleTypeare:Handle Types Supported by
VkImportFenceFdInfoKHRHandle Type Transference Permanence Supported EXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_FD_BITReference Temporary,Permanent EXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BITCopy Temporary Valid Usage
handleTypemust be a value included in the Handle Types Supported by VkImportFenceFdInfoKHR table.fdmust obey any requirements listed forhandleTypein external fence handle types compatibility.
If
handleTypeisEXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BIT, the special value-1forfdis treated like a valid sync file descriptor referring to an object that has already signaled. The import operation will succeed and theVkFencewill 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
-1file descriptor when exporting aEXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BITfrom aVkFencewhich is signaled.Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_IMPORT_FENCE_FD_INFO_KHRpNextmust beNULLfencemust be a validVkFencehandleflagsmust be a valid combination ofVkFenceImportFlagBitsvalueshandleTypemust be a validVkExternalFenceHandleTypeFlagBitsvalue
Host Synchronization
- Host access to
fencemust be externally synchronized
See Also
Member documentation
sType– the type of this structure.pNext–NULLor a pointer to an extension-specific structure.fence– the fence into which the payload will be imported.flags– a bitmask ofVkFenceImportFlagBitsspecifying additional parameters for the fence payload import operation.handleType– specifies the type offd.fd– the external handle to import.
Layout
struct VkImportFenceFdInfoKHR { VkStructureType sType; void const * pNext; VkFence fence; VkFenceImportFlags flags; VkExternalFenceHandleTypeFlagBits handleType; int fd; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkImportFenceFdInfoKHR.BufferAn array ofVkImportFenceFdInfoKHRstructs.
-
Constructor Summary
Constructors Constructor Description VkImportFenceFdInfoKHR(java.nio.ByteBuffer container)Creates aVkImportFenceFdInfoKHRinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkImportFenceFdInfoKHRcalloc()Returns a newVkImportFenceFdInfoKHRinstance allocated withmemCalloc.static VkImportFenceFdInfoKHR.Buffercalloc(int capacity)Returns a newVkImportFenceFdInfoKHR.Bufferinstance allocated withmemCalloc.static VkImportFenceFdInfoKHRcallocStack()Returns a newVkImportFenceFdInfoKHRinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkImportFenceFdInfoKHR.BuffercallocStack(int capacity)Returns a newVkImportFenceFdInfoKHR.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkImportFenceFdInfoKHR.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkImportFenceFdInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImportFenceFdInfoKHRcallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkImportFenceFdInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImportFenceFdInfoKHRcreate()Returns a newVkImportFenceFdInfoKHRinstance allocated withBufferUtils.static VkImportFenceFdInfoKHR.Buffercreate(int capacity)Returns a newVkImportFenceFdInfoKHR.Bufferinstance allocated withBufferUtils.static VkImportFenceFdInfoKHRcreate(long address)Returns a newVkImportFenceFdInfoKHRinstance for the specified memory address.static VkImportFenceFdInfoKHR.Buffercreate(long address, int capacity)Create aVkImportFenceFdInfoKHR.Bufferinstance at the specified memory.static VkImportFenceFdInfoKHRcreateSafe(long address)static VkImportFenceFdInfoKHR.BuffercreateSafe(long address, int capacity)intfd()Returns the value of thefdfield.VkImportFenceFdInfoKHRfd(int value)Sets the specified value to thefdfield.longfence()Returns the value of thefencefield.VkImportFenceFdInfoKHRfence(long value)Sets the specified value to thefencefield.intflags()Returns the value of theflagsfield.VkImportFenceFdInfoKHRflags(int value)Sets the specified value to theflagsfield.inthandleType()Returns the value of thehandleTypefield.VkImportFenceFdInfoKHRhandleType(int value)Sets the specified value to thehandleTypefield.static VkImportFenceFdInfoKHRmalloc()Returns a newVkImportFenceFdInfoKHRinstance allocated withmemAlloc.static VkImportFenceFdInfoKHR.Buffermalloc(int capacity)Returns a newVkImportFenceFdInfoKHR.Bufferinstance allocated withmemAlloc.static VkImportFenceFdInfoKHRmallocStack()Returns a newVkImportFenceFdInfoKHRinstance allocated on the thread-localMemoryStack.static VkImportFenceFdInfoKHR.BuffermallocStack(int capacity)Returns a newVkImportFenceFdInfoKHR.Bufferinstance allocated on the thread-localMemoryStack.static VkImportFenceFdInfoKHR.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkImportFenceFdInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.static VkImportFenceFdInfoKHRmallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkImportFenceFdInfoKHRinstance allocated on the specifiedMemoryStack.static intnfd(long struct)Unsafe version offd().static voidnfd(long struct, int value)Unsafe version offd.static longnfence(long struct)Unsafe version offence().static voidnfence(long struct, long value)Unsafe version offence.static intnflags(long struct)Unsafe version offlags().static voidnflags(long struct, int value)Unsafe version offlags.static intnhandleType(long struct)Unsafe version ofhandleType().static voidnhandleType(long struct, int value)Unsafe version ofhandleType.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.longpNext()Returns the value of thepNextfield.VkImportFenceFdInfoKHRpNext(long value)Sets the specified value to thepNextfield.VkImportFenceFdInfoKHRset(int sType, long pNext, long fence, int flags, int handleType, int fd)Initializes this struct with the specified values.VkImportFenceFdInfoKHRset(VkImportFenceFdInfoKHR src)Copies the specified struct data to this struct.intsizeof()intsType()Returns the value of thesTypefield.VkImportFenceFdInfoKHRsType(int value)Sets the specified value to thesTypefield.
-
-
-
Constructor Detail
-
VkImportFenceFdInfoKHR
public VkImportFenceFdInfoKHR(java.nio.ByteBuffer container)
Creates aVkImportFenceFdInfoKHRinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
fence
public long fence()
Returns the value of thefencefield.
-
flags
public int flags()
Returns the value of theflagsfield.
-
handleType
public int handleType()
Returns the value of thehandleTypefield.
-
fd
public int fd()
Returns the value of thefdfield.
-
sType
public VkImportFenceFdInfoKHR sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkImportFenceFdInfoKHR pNext(long value)
Sets the specified value to thepNextfield.
-
fence
public VkImportFenceFdInfoKHR fence(long value)
Sets the specified value to thefencefield.
-
flags
public VkImportFenceFdInfoKHR flags(int value)
Sets the specified value to theflagsfield.
-
handleType
public VkImportFenceFdInfoKHR handleType(int value)
Sets the specified value to thehandleTypefield.
-
fd
public VkImportFenceFdInfoKHR fd(int value)
Sets the specified value to thefdfield.
-
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 newVkImportFenceFdInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkImportFenceFdInfoKHR calloc()
Returns a newVkImportFenceFdInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkImportFenceFdInfoKHR create()
Returns a newVkImportFenceFdInfoKHRinstance allocated withBufferUtils.
-
create
public static VkImportFenceFdInfoKHR create(long address)
Returns a newVkImportFenceFdInfoKHRinstance for the specified memory address.
-
createSafe
@Nullable public static VkImportFenceFdInfoKHR createSafe(long address)
-
malloc
public static VkImportFenceFdInfoKHR.Buffer malloc(int capacity)
Returns a newVkImportFenceFdInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkImportFenceFdInfoKHR.Buffer calloc(int capacity)
Returns a newVkImportFenceFdInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkImportFenceFdInfoKHR.Buffer create(int capacity)
Returns a newVkImportFenceFdInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkImportFenceFdInfoKHR.Buffer create(long address, int capacity)
Create aVkImportFenceFdInfoKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkImportFenceFdInfoKHR.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkImportFenceFdInfoKHR mallocStack()
Returns a newVkImportFenceFdInfoKHRinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkImportFenceFdInfoKHR callocStack()
Returns a newVkImportFenceFdInfoKHRinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkImportFenceFdInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImportFenceFdInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkImportFenceFdInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImportFenceFdInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkImportFenceFdInfoKHR.Buffer mallocStack(int capacity)
Returns a newVkImportFenceFdInfoKHR.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkImportFenceFdInfoKHR.Buffer callocStack(int capacity)
Returns a newVkImportFenceFdInfoKHR.Bufferinstance allocated on the thread-localMemoryStackand 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 newVkImportFenceFdInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkImportFenceFdInfoKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImportFenceFdInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType().
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext().
-
nfence
public static long nfence(long struct)
Unsafe version offence().
-
nflags
public static int nflags(long struct)
Unsafe version offlags().
-
nhandleType
public static int nhandleType(long struct)
Unsafe version ofhandleType().
-
nfd
public static int nfd(long struct)
Unsafe version offd().
-
nsType
public static void nsType(long struct, int value)Unsafe version ofsType.
-
npNext
public static void npNext(long struct, long value)Unsafe version ofpNext.
-
nfence
public static void nfence(long struct, long value)Unsafe version offence.
-
nflags
public static void nflags(long struct, int value)Unsafe version offlags.
-
nhandleType
public static void nhandleType(long struct, int value)Unsafe version ofhandleType.
-
nfd
public static void nfd(long struct, int value)Unsafe version offd.
-
-