Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkFenceGetFdInfoKHR

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

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
Valid Usage (Implicit)
See Also

GetFenceFdKHR

Layout


struct VkFenceGetFdInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkFence fence;
    VkExternalFenceHandleTypeFlagBits handleType;
}

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
FENCE

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
VkFenceGetFdInfoKHR(long address, ByteBuffer container)

public
VkFenceGetFdInfoKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkFenceGetFdInfoKHR
calloc()

Returns a new VkFenceGetFdInfoKHR instance allocated with memCalloc.

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

Returns a new VkFenceGetFdInfoKHR.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkFenceGetFdInfoKHR
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
protected VkFenceGetFdInfoKHR
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 VkFenceGetFdInfoKHR
create()

Returns a new VkFenceGetFdInfoKHR instance allocated with BufferUtils.

public static VkFenceGetFdInfoKHR
create(long address)

Returns a new VkFenceGetFdInfoKHR instance for the specified memory address.

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

Returns a new VkFenceGetFdInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkFenceGetFdInfoKHR.Buffer instance at the specified memory.

public static VkFenceGetFdInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
fence()

the fence from which state will be exported.

public VkFenceGetFdInfoKHR
fence(long value)

Sets the specified value to the fence field.

public int
handleType()

a VkExternalFenceHandleTypeFlagBits value specifying the type of handle requested.

public VkFenceGetFdInfoKHR
handleType(int value)

Sets the specified value to the handleType field.

public static VkFenceGetFdInfoKHR
malloc()

Returns a new VkFenceGetFdInfoKHR instance allocated with memAlloc.

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

Returns a new VkFenceGetFdInfoKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkFenceGetFdInfoKHR instance allocated on the specified MemoryStack.

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

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

public static VkFenceGetFdInfoKHR
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
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
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 VkFenceGetFdInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkFenceGetFdInfoKHR
set(int sType, long pNext, long fence, int handleType)

Initializes this struct with the specified values.

public VkFenceGetFdInfoKHR

Returns:

this struct
set
(VkFenceGetFdInfoKHR
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 VkFenceGetFdInfoKHR
sType(int value)

Sets the specified value to the sType field.

public VkFenceGetFdInfoKHR
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.

FENCEback to summary
public static final int FENCE

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

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

callocback to summary
public static VkFenceGetFdInfoKHR calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkFenceGetFdInfoKHR calloc(MemoryStack stack)

Returns a new VkFenceGetFdInfoKHR 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 VkFenceGetFdInfoKHR.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkFenceGetFdInfoKHR.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 VkFenceGetFdInfoKHR callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkFenceGetFdInfoKHR.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 VkFenceGetFdInfoKHR 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 VkFenceGetFdInfoKHR create()

Returns a new VkFenceGetFdInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkFenceGetFdInfoKHR create(long address)

Returns a new VkFenceGetFdInfoKHR instance for the specified memory address.

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

Returns a new VkFenceGetFdInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkFenceGetFdInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkFenceGetFdInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
fenceback to summary
public long fence()

the fence from which state will be exported.

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

Sets the specified value to the fence field.

handleTypeback to summary
public int handleType()

a VkExternalFenceHandleTypeFlagBits value specifying the type of handle requested.

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

Sets the specified value to the handleType field.

mallocback to summary
public static VkFenceGetFdInfoKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkFenceGetFdInfoKHR malloc(MemoryStack stack)

Returns a new VkFenceGetFdInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new VkFenceGetFdInfoKHR.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 VkFenceGetFdInfoKHR mallocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
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.

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 VkFenceGetFdInfoKHR pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkFenceGetFdInfoKHR set(int sType, long pNext, long fence, int handleType)

Initializes this struct with the specified values.

setback to summary
public VkFenceGetFdInfoKHR set(VkFenceGetFdInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkFenceGetFdInfoKHR

the source struct

Returns:VkFenceGetFdInfoKHR

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 VkFenceGetFdInfoKHR sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_FENCE_GET_FD_INFO_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkFenceGetFdInfoKHR.Buffer

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

An array of VkFenceGetFdInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkFenceGetFdInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkFenceGetFdInfoKHR.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 long

Returns:

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

public VkFenceGetFdInfoKHR.Buffer
fence(long value)

Sets the specified value to the VkFenceGetFdInfoKHR#fence field.

protected VkFenceGetFdInfoKHR
public int

Returns:

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

public VkFenceGetFdInfoKHR.Buffer
handleType(int value)

Sets the specified value to the VkFenceGetFdInfoKHR#handleType field.

public long

Returns:

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

public VkFenceGetFdInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkFenceGetFdInfoKHR#pNext field.

protected VkFenceGetFdInfoKHR.Buffer
public int

Returns:

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

public VkFenceGetFdInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkFenceGetFdInfoKHR#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkFenceGetFdInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkFenceGetFdInfoKHR.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 VkFenceGetFdInfoKHR#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

fenceback to summary
public long fence()
Returns:long

the value of the VkFenceGetFdInfoKHR#fence field.

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

Sets the specified value to the VkFenceGetFdInfoKHR#fence field.

getElementFactoryback to summary
protected VkFenceGetFdInfoKHR getElementFactory()

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

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

the value of the VkFenceGetFdInfoKHR#handleType field.

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

Sets the specified value to the VkFenceGetFdInfoKHR#handleType field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkFenceGetFdInfoKHR#pNext field.

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

Sets the specified value to the VkFenceGetFdInfoKHR#pNext field.

selfback to summary
protected VkFenceGetFdInfoKHR.Buffer self()

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

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

the value of the VkFenceGetFdInfoKHR#sType field.

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

Sets the specified value to the VkFenceGetFdInfoKHR#sType field.

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

Sets the STRUCTURE_TYPE_FENCE_GET_FD_INFO_KHR value to the VkFenceGetFdInfoKHR#sType field.