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
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 forhandleType
in external fence handle types compatibility.
If
handleType
isEXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BIT
, the special value-1
forfd
is treated like a valid sync file descriptor referring to an object that has already signaled. The import operation will succeed and theVkFence
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 aEXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BIT
from aVkFence
which is signaled.Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_IMPORT_FENCE_FD_INFO_KHR
pNext
must beNULL
fence
must be a validVkFence
handleflags
must be a valid combination ofVkFenceImportFlagBits
valueshandleType
must be a validVkExternalFenceHandleTypeFlagBits
value
Host Synchronization
- Host access to
fence
must be externally synchronized
See Also
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 ofVkFenceImportFlagBits
specifying 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 class
VkImportFenceFdInfoKHR.Buffer
An array ofVkImportFenceFdInfoKHR
structs.
-
Constructor Summary
Constructors Constructor Description VkImportFenceFdInfoKHR(java.nio.ByteBuffer container)
Creates aVkImportFenceFdInfoKHR
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkImportFenceFdInfoKHR
calloc()
Returns a newVkImportFenceFdInfoKHR
instance allocated withmemCalloc
.static VkImportFenceFdInfoKHR.Buffer
calloc(int capacity)
Returns a newVkImportFenceFdInfoKHR.Buffer
instance allocated withmemCalloc
.static VkImportFenceFdInfoKHR
callocStack()
Returns a newVkImportFenceFdInfoKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImportFenceFdInfoKHR.Buffer
callocStack(int capacity)
Returns a newVkImportFenceFdInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImportFenceFdInfoKHR.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImportFenceFdInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImportFenceFdInfoKHR
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImportFenceFdInfoKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImportFenceFdInfoKHR
create()
Returns a newVkImportFenceFdInfoKHR
instance allocated withBufferUtils
.static VkImportFenceFdInfoKHR.Buffer
create(int capacity)
Returns a newVkImportFenceFdInfoKHR.Buffer
instance allocated withBufferUtils
.static VkImportFenceFdInfoKHR
create(long address)
Returns a newVkImportFenceFdInfoKHR
instance for the specified memory address.static VkImportFenceFdInfoKHR.Buffer
create(long address, int capacity)
Create aVkImportFenceFdInfoKHR.Buffer
instance at the specified memory.static VkImportFenceFdInfoKHR
createSafe(long address)
static VkImportFenceFdInfoKHR.Buffer
createSafe(long address, int capacity)
int
fd()
Returns the value of thefd
field.VkImportFenceFdInfoKHR
fd(int value)
Sets the specified value to thefd
field.long
fence()
Returns the value of thefence
field.VkImportFenceFdInfoKHR
fence(long value)
Sets the specified value to thefence
field.int
flags()
Returns the value of theflags
field.VkImportFenceFdInfoKHR
flags(int value)
Sets the specified value to theflags
field.int
handleType()
Returns the value of thehandleType
field.VkImportFenceFdInfoKHR
handleType(int value)
Sets the specified value to thehandleType
field.static VkImportFenceFdInfoKHR
malloc()
Returns a newVkImportFenceFdInfoKHR
instance allocated withmemAlloc
.static VkImportFenceFdInfoKHR.Buffer
malloc(int capacity)
Returns a newVkImportFenceFdInfoKHR.Buffer
instance allocated withmemAlloc
.static VkImportFenceFdInfoKHR
mallocStack()
Returns a newVkImportFenceFdInfoKHR
instance allocated on the thread-localMemoryStack
.static VkImportFenceFdInfoKHR.Buffer
mallocStack(int capacity)
Returns a newVkImportFenceFdInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
.static VkImportFenceFdInfoKHR.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImportFenceFdInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkImportFenceFdInfoKHR
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImportFenceFdInfoKHR
instance allocated on the specifiedMemoryStack
.static int
nfd(long struct)
Unsafe version offd()
.static void
nfd(long struct, int value)
Unsafe version offd
.static long
nfence(long struct)
Unsafe version offence()
.static void
nfence(long struct, long value)
Unsafe version offence
.static int
nflags(long struct)
Unsafe version offlags()
.static void
nflags(long struct, int value)
Unsafe version offlags
.static int
nhandleType(long struct)
Unsafe version ofhandleType()
.static void
nhandleType(long struct, int value)
Unsafe version ofhandleType
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.long
pNext()
Returns the value of thepNext
field.VkImportFenceFdInfoKHR
pNext(long value)
Sets the specified value to thepNext
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 thesType
field.VkImportFenceFdInfoKHR
sType(int value)
Sets the specified value to thesType
field.
-
-
-
Constructor Detail
-
VkImportFenceFdInfoKHR
public VkImportFenceFdInfoKHR(java.nio.ByteBuffer container)
Creates aVkImportFenceFdInfoKHR
instance at the current position of the specifiedByteBuffer
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 classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
fence
public long fence()
Returns the value of thefence
field.
-
flags
public int flags()
Returns the value of theflags
field.
-
handleType
public int handleType()
Returns the value of thehandleType
field.
-
fd
public int fd()
Returns the value of thefd
field.
-
sType
public VkImportFenceFdInfoKHR sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkImportFenceFdInfoKHR pNext(long value)
Sets the specified value to thepNext
field.
-
fence
public VkImportFenceFdInfoKHR fence(long value)
Sets the specified value to thefence
field.
-
flags
public VkImportFenceFdInfoKHR flags(int value)
Sets the specified value to theflags
field.
-
handleType
public VkImportFenceFdInfoKHR handleType(int value)
Sets the specified value to thehandleType
field.
-
fd
public VkImportFenceFdInfoKHR fd(int value)
Sets the specified value to thefd
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 newVkImportFenceFdInfoKHR
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkImportFenceFdInfoKHR calloc()
Returns a newVkImportFenceFdInfoKHR
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkImportFenceFdInfoKHR create()
Returns a newVkImportFenceFdInfoKHR
instance allocated withBufferUtils
.
-
create
public static VkImportFenceFdInfoKHR create(long address)
Returns a newVkImportFenceFdInfoKHR
instance for the specified memory address.
-
createSafe
@Nullable public static VkImportFenceFdInfoKHR createSafe(long address)
-
malloc
public static VkImportFenceFdInfoKHR.Buffer malloc(int capacity)
Returns a newVkImportFenceFdInfoKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkImportFenceFdInfoKHR.Buffer calloc(int capacity)
Returns a newVkImportFenceFdInfoKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImportFenceFdInfoKHR.Buffer create(int capacity)
Returns a newVkImportFenceFdInfoKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImportFenceFdInfoKHR.Buffer create(long address, int capacity)
Create aVkImportFenceFdInfoKHR.Buffer
instance 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 newVkImportFenceFdInfoKHR
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkImportFenceFdInfoKHR callocStack()
Returns a newVkImportFenceFdInfoKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkImportFenceFdInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImportFenceFdInfoKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkImportFenceFdInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImportFenceFdInfoKHR
instance allocated on the specifiedMemoryStack
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 newVkImportFenceFdInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkImportFenceFdInfoKHR.Buffer callocStack(int capacity)
Returns a newVkImportFenceFdInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
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 newVkImportFenceFdInfoKHR.Buffer
instance 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.Buffer
instance allocated on the specifiedMemoryStack
and 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
.
-
-