Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkImportFenceFdInfoKHR

extends Struct<VkImportFenceFdInfoKHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

(None).
Description

The handle types supported by handleType are:

Handle Types Supported by VkImportFenceFdInfoKHR
Handle TypeTransferencePermanence Supported
EXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_FD_BITReferenceTemporary,Permanent
EXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BITCopyTemporary
Valid Usage

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)
Host Synchronization
See Also

ImportFenceFdKHR

Layout


struct VkImportFenceFdInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkFence fence;
    VkFenceImportFlags flags;
    VkExternalFenceHandleTypeFlagBits handleType;
    int fd;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
FD

The struct member offsets.

public static final int
FENCE

The struct member offsets.

public static final int
FLAGS

The struct member offsets.

public static final int
HANDLETYPE

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkImportFenceFdInfoKHR(long address, ByteBuffer container)

public
VkImportFenceFdInfoKHR(ByteBuffer container)

Creates a VkImportFenceFdInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkImportFenceFdInfoKHR
calloc()

Returns a new VkImportFenceFdInfoKHR instance allocated with memCalloc.

public static VkImportFenceFdInfoKHR.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkImportFenceFdInfoKHR.Buffer instance allocated with memCalloc.

public static VkImportFenceFdInfoKHR
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkImportFenceFdInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkImportFenceFdInfoKHR.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkImportFenceFdInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkImportFenceFdInfoKHR
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkImportFenceFdInfoKHR
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkImportFenceFdInfoKHR.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkImportFenceFdInfoKHR.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkImportFenceFdInfoKHR
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkImportFenceFdInfoKHR
create()

Returns a new VkImportFenceFdInfoKHR instance allocated with BufferUtils.

public static VkImportFenceFdInfoKHR
create(long address)

Returns a new VkImportFenceFdInfoKHR instance for the specified memory address.

public static VkImportFenceFdInfoKHR.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkImportFenceFdInfoKHR.Buffer instance allocated with BufferUtils.

public static VkImportFenceFdInfoKHR.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkImportFenceFdInfoKHR.Buffer instance at the specified memory.

public static VkImportFenceFdInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkImportFenceFdInfoKHR.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public int
fd()

the external handle to import.

public VkImportFenceFdInfoKHR
fd(int value)

Sets the specified value to the fd field.

public long
fence()

the fence into which the payload will be imported.

public VkImportFenceFdInfoKHR
fence(long value)

Sets the specified value to the fence field.

public int
flags()

a bitmask of VkFenceImportFlagBits specifying additional parameters for the fence payload import operation.

public VkImportFenceFdInfoKHR
flags(int value)

Sets the specified value to the flags field.

public int
handleType()

a VkExternalFenceHandleTypeFlagBits value specifying the type of fd.

public VkImportFenceFdInfoKHR
handleType(int value)

Sets the specified value to the handleType field.

public static VkImportFenceFdInfoKHR
malloc()

Returns a new VkImportFenceFdInfoKHR instance allocated with memAlloc.

public static VkImportFenceFdInfoKHR.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkImportFenceFdInfoKHR.Buffer instance allocated with memAlloc.

public static VkImportFenceFdInfoKHR
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkImportFenceFdInfoKHR instance allocated on the specified MemoryStack.

public static VkImportFenceFdInfoKHR.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkImportFenceFdInfoKHR.Buffer instance allocated on the specified MemoryStack.

public static VkImportFenceFdInfoKHR
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkImportFenceFdInfoKHR
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkImportFenceFdInfoKHR.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkImportFenceFdInfoKHR.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
nfd(long struct)

Unsafe version of fd.

public static void
nfd(long struct, int value)

Unsafe version of fd.

public static long
nfence(long struct)

Unsafe version of fence.

public static void
nfence(long struct, long value)

Unsafe version of fence.

public static int
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static int
nhandleType(long struct)

Unsafe version of handleType.

public static void
nhandleType(long struct, int value)

Unsafe version of handleType.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkImportFenceFdInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkImportFenceFdInfoKHR
set(int sType, long pNext, long fence, int flags, int handleType, int fd)

Initializes this struct with the specified values.

public VkImportFenceFdInfoKHR

Returns:

this struct
set
(VkImportFenceFdInfoKHR
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkImportFenceFdInfoKHR
sType(int value)

Sets the specified value to the sType field.

public VkImportFenceFdInfoKHR
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

FDback to summary
public static final int FD

The struct member offsets.

FENCEback to summary
public static final int FENCE

The struct member offsets.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

HANDLETYPEback to summary
public static final int HANDLETYPE

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkImportFenceFdInfoKHRback to summary
protected VkImportFenceFdInfoKHR(long address, ByteBuffer container)
VkImportFenceFdInfoKHRback to summary
public VkImportFenceFdInfoKHR(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

callocback to summary
public static VkImportFenceFdInfoKHR calloc()

Returns a new VkImportFenceFdInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkImportFenceFdInfoKHR.Buffer calloc(int capacity)

Returns a new VkImportFenceFdInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkImportFenceFdInfoKHR calloc(MemoryStack stack)

Returns a new VkImportFenceFdInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkImportFenceFdInfoKHR.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkImportFenceFdInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkImportFenceFdInfoKHR callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkImportFenceFdInfoKHR callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkImportFenceFdInfoKHR.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkImportFenceFdInfoKHR.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected VkImportFenceFdInfoKHR create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkImportFenceFdInfoKHR create()

Returns a new VkImportFenceFdInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkImportFenceFdInfoKHR create(long address)

Returns a new VkImportFenceFdInfoKHR instance for the specified memory address.

createback to summary
public static VkImportFenceFdInfoKHR.Buffer create(int capacity)

Returns a new VkImportFenceFdInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkImportFenceFdInfoKHR.Buffer create(long address, int capacity)

Create a VkImportFenceFdInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkImportFenceFdInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkImportFenceFdInfoKHR.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
fdback to summary
public int fd()

the external handle to import.

fdback to summary
public VkImportFenceFdInfoKHR fd(int value)

Sets the specified value to the fd field.

fenceback to summary
public long fence()

the fence into which the payload will be imported.

Annotations
@NativeType:VkFence
fenceback to summary
public VkImportFenceFdInfoKHR fence(long value)

Sets the specified value to the fence field.

flagsback to summary
public int flags()

a bitmask of VkFenceImportFlagBits specifying additional parameters for the fence payload import operation.

Annotations
@NativeType:VkFenceImportFlags
flagsback to summary
public VkImportFenceFdInfoKHR flags(int value)

Sets the specified value to the flags field.

handleTypeback to summary
public int handleType()

a VkExternalFenceHandleTypeFlagBits value specifying the type of fd.

Annotations
@NativeType:VkExternalFenceHandleTypeFlagBits
handleTypeback to summary
public VkImportFenceFdInfoKHR handleType(int value)

Sets the specified value to the handleType field.

mallocback to summary
public static VkImportFenceFdInfoKHR malloc()

Returns a new VkImportFenceFdInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkImportFenceFdInfoKHR.Buffer malloc(int capacity)

Returns a new VkImportFenceFdInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkImportFenceFdInfoKHR malloc(MemoryStack stack)

Returns a new VkImportFenceFdInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkImportFenceFdInfoKHR.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkImportFenceFdInfoKHR.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkImportFenceFdInfoKHR mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkImportFenceFdInfoKHR mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkImportFenceFdInfoKHR.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkImportFenceFdInfoKHR.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nfdback to summary
public static int nfd(long struct)

Unsafe version of fd.

nfdback to summary
public static void nfd(long struct, int value)

Unsafe version of fd.

nfenceback to summary
public static long nfence(long struct)

Unsafe version of fence.

nfenceback to summary
public static void nfence(long struct, long value)

Unsafe version of fence.

nflagsback to summary
public static int nflags(long struct)

Unsafe version of flags.

nflagsback to summary
public static void nflags(long struct, int value)

Unsafe version of flags.

nhandleTypeback to summary
public static int nhandleType(long struct)

Unsafe version of handleType.

nhandleTypeback to summary
public static void nhandleType(long struct, int value)

Unsafe version of handleType.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkImportFenceFdInfoKHR pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkImportFenceFdInfoKHR set(int sType, long pNext, long fence, int flags, int handleType, int fd)

Initializes this struct with the specified values.

setback to summary
public VkImportFenceFdInfoKHR set(VkImportFenceFdInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkImportFenceFdInfoKHR

the source struct

Returns:VkImportFenceFdInfoKHR

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkImportFenceFdInfoKHR sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkImportFenceFdInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_IMPORT_FENCE_FD_INFO_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkImportFenceFdInfoKHR.Buffer

extends StructBuffer<VkImportFenceFdInfoKHR, VkImportFenceFdInfoKHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkImportFenceFdInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkImportFenceFdInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkImportFenceFdInfoKHR.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the VkImportFenceFdInfoKHR#fd field.
fd
()

public VkImportFenceFdInfoKHR.Buffer
fd(int value)

Sets the specified value to the VkImportFenceFdInfoKHR#fd field.

public long

Returns:

the value of the VkImportFenceFdInfoKHR#fence field.
fence
()

public VkImportFenceFdInfoKHR.Buffer
fence(long value)

Sets the specified value to the VkImportFenceFdInfoKHR#fence field.

public int

Returns:

the value of the VkImportFenceFdInfoKHR#flags field.
flags
()

public VkImportFenceFdInfoKHR.Buffer
flags(int value)

Sets the specified value to the VkImportFenceFdInfoKHR#flags field.

protected VkImportFenceFdInfoKHR
public int

Returns:

the value of the VkImportFenceFdInfoKHR#handleType field.
handleType
()

public VkImportFenceFdInfoKHR.Buffer
handleType(int value)

Sets the specified value to the VkImportFenceFdInfoKHR#handleType field.

public long

Returns:

the value of the VkImportFenceFdInfoKHR#pNext field.
pNext
()

public VkImportFenceFdInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkImportFenceFdInfoKHR#pNext field.

protected VkImportFenceFdInfoKHR.Buffer
public int

Returns:

the value of the VkImportFenceFdInfoKHR#sType field.
sType
()

public VkImportFenceFdInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkImportFenceFdInfoKHR#sType field.

public VkImportFenceFdInfoKHR.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkImportFenceFdInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkImportFenceFdInfoKHR.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkImportFenceFdInfoKHR#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

fdback to summary
public int fd()
Returns:int

the value of the VkImportFenceFdInfoKHR#fd field.

fdback to summary
public VkImportFenceFdInfoKHR.Buffer fd(int value)

Sets the specified value to the VkImportFenceFdInfoKHR#fd field.

fenceback to summary
public long fence()
Returns:long

the value of the VkImportFenceFdInfoKHR#fence field.

Annotations
@NativeType:VkFence
fenceback to summary
public VkImportFenceFdInfoKHR.Buffer fence(long value)

Sets the specified value to the VkImportFenceFdInfoKHR#fence field.

flagsback to summary
public int flags()
Returns:int

the value of the VkImportFenceFdInfoKHR#flags field.

Annotations
@NativeType:VkFenceImportFlags
flagsback to summary
public VkImportFenceFdInfoKHR.Buffer flags(int value)

Sets the specified value to the VkImportFenceFdInfoKHR#flags field.

getElementFactoryback to summary
protected VkImportFenceFdInfoKHR getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
handleTypeback to summary
public int handleType()
Returns:int

the value of the VkImportFenceFdInfoKHR#handleType field.

Annotations
@NativeType:VkExternalFenceHandleTypeFlagBits
handleTypeback to summary
public VkImportFenceFdInfoKHR.Buffer handleType(int value)

Sets the specified value to the VkImportFenceFdInfoKHR#handleType field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkImportFenceFdInfoKHR#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkImportFenceFdInfoKHR.Buffer pNext(long value)

Sets the specified value to the VkImportFenceFdInfoKHR#pNext field.

selfback to summary
protected VkImportFenceFdInfoKHR.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkImportFenceFdInfoKHR#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkImportFenceFdInfoKHR.Buffer sType(int value)

Sets the specified value to the VkImportFenceFdInfoKHR#sType field.

sType$Defaultback to summary
public VkImportFenceFdInfoKHR.Buffer sType$Default()

Sets the STRUCTURE_TYPE_IMPORT_FENCE_FD_INFO_KHR value to the VkImportFenceFdInfoKHR#sType field.