Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSemaphoreGetFdInfoKHR

extends Struct<VkSemaphoreGetFdInfoKHR>
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 semaphore export operation.
Description

The properties of the file descriptor returned depend on the value of handleType. See VkExternalSemaphoreHandleTypeFlagBits for a description of the properties of the defined external semaphore handle types.

Valid Usage
Valid Usage (Implicit)
See Also

GetSemaphoreFdKHR

Layout


struct VkSemaphoreGetFdInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkSemaphore semaphore;
    VkExternalSemaphoreHandleTypeFlagBits 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
HANDLETYPE

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SEMAPHORE

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

public
VkSemaphoreGetFdInfoKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkSemaphoreGetFdInfoKHR
calloc()

Returns a new VkSemaphoreGetFdInfoKHR instance allocated with memCalloc.

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

Returns a new VkSemaphoreGetFdInfoKHR.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkSemaphoreGetFdInfoKHR
callocStack()

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

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

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

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

Returns a new VkSemaphoreGetFdInfoKHR instance allocated with BufferUtils.

public static VkSemaphoreGetFdInfoKHR
create(long address)

Returns a new VkSemaphoreGetFdInfoKHR instance for the specified memory address.

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

Returns a new VkSemaphoreGetFdInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkSemaphoreGetFdInfoKHR.Buffer instance at the specified memory.

public static VkSemaphoreGetFdInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
handleType()

a VkExternalSemaphoreHandleTypeFlagBits value specifying the type of handle requested.

public VkSemaphoreGetFdInfoKHR
handleType(int value)

Sets the specified value to the handleType field.

public static VkSemaphoreGetFdInfoKHR
malloc()

Returns a new VkSemaphoreGetFdInfoKHR instance allocated with memAlloc.

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

Returns a new VkSemaphoreGetFdInfoKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkSemaphoreGetFdInfoKHR instance allocated on the specified MemoryStack.

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

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

public static VkSemaphoreGetFdInfoKHR
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
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 long
nsemaphore(long struct)

Unsafe version of semaphore.

public static void
nsemaphore(long struct, long value)

Unsafe version of semaphore.

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

Sets the specified value to the pNext field.

public long
semaphore()

the semaphore from which state will be exported.

public VkSemaphoreGetFdInfoKHR
semaphore(long value)

Sets the specified value to the semaphore field.

public VkSemaphoreGetFdInfoKHR
set(int sType, long pNext, long semaphore, int handleType)

Initializes this struct with the specified values.

public VkSemaphoreGetFdInfoKHR

Returns:

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

Sets the specified value to the sType field.

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

HANDLETYPEback to summary
public static final int HANDLETYPE

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SEMAPHOREback to summary
public static final int SEMAPHORE

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

VkSemaphoreGetFdInfoKHRback to summary
protected VkSemaphoreGetFdInfoKHR(long address, ByteBuffer container)
VkSemaphoreGetFdInfoKHRback to summary
public VkSemaphoreGetFdInfoKHR(ByteBuffer container)

Creates a VkSemaphoreGetFdInfoKHR 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 VkSemaphoreGetFdInfoKHR calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkSemaphoreGetFdInfoKHR calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new VkSemaphoreGetFdInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkSemaphoreGetFdInfoKHR create(long address)

Returns a new VkSemaphoreGetFdInfoKHR instance for the specified memory address.

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

Returns a new VkSemaphoreGetFdInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkSemaphoreGetFdInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkSemaphoreGetFdInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
handleTypeback to summary
public int handleType()

a VkExternalSemaphoreHandleTypeFlagBits value specifying the type of handle requested.

Annotations
@NativeType:VkExternalSemaphoreHandleTypeFlagBits
handleTypeback to summary
public VkSemaphoreGetFdInfoKHR handleType(int value)

Sets the specified value to the handleType field.

mallocback to summary
public static VkSemaphoreGetFdInfoKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkSemaphoreGetFdInfoKHR malloc(MemoryStack stack)

Returns a new VkSemaphoreGetFdInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

nsemaphoreback to summary
public static long nsemaphore(long struct)

Unsafe version of semaphore.

nsemaphoreback to summary
public static void nsemaphore(long struct, long value)

Unsafe version of semaphore.

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

Sets the specified value to the pNext field.

semaphoreback to summary
public long semaphore()

the semaphore from which state will be exported.

Annotations
@NativeType:VkSemaphore
semaphoreback to summary
public VkSemaphoreGetFdInfoKHR semaphore(long value)

Sets the specified value to the semaphore field.

setback to summary
public VkSemaphoreGetFdInfoKHR set(int sType, long pNext, long semaphore, int handleType)

Initializes this struct with the specified values.

setback to summary
public VkSemaphoreGetFdInfoKHR set(VkSemaphoreGetFdInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkSemaphoreGetFdInfoKHR

the source struct

Returns:VkSemaphoreGetFdInfoKHR

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_SEMAPHORE_GET_FD_INFO_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkSemaphoreGetFdInfoKHR.Buffer

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

An array of VkSemaphoreGetFdInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkSemaphoreGetFdInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkSemaphoreGetFdInfoKHR.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
protected VkSemaphoreGetFdInfoKHR
public int

Returns:

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

public VkSemaphoreGetFdInfoKHR.Buffer
handleType(int value)

Sets the specified value to the VkSemaphoreGetFdInfoKHR#handleType field.

public long

Returns:

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

public VkSemaphoreGetFdInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkSemaphoreGetFdInfoKHR#pNext field.

protected VkSemaphoreGetFdInfoKHR.Buffer
public long

Returns:

the value of the VkSemaphoreGetFdInfoKHR#semaphore field.
semaphore
()

public VkSemaphoreGetFdInfoKHR.Buffer
semaphore(long value)

Sets the specified value to the VkSemaphoreGetFdInfoKHR#semaphore field.

public int

Returns:

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

public VkSemaphoreGetFdInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkSemaphoreGetFdInfoKHR#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkSemaphoreGetFdInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

getElementFactoryback to summary
protected VkSemaphoreGetFdInfoKHR getElementFactory()

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

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

the value of the VkSemaphoreGetFdInfoKHR#handleType field.

Annotations
@NativeType:VkExternalSemaphoreHandleTypeFlagBits
handleTypeback to summary
public VkSemaphoreGetFdInfoKHR.Buffer handleType(int value)

Sets the specified value to the VkSemaphoreGetFdInfoKHR#handleType field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkSemaphoreGetFdInfoKHR#pNext field.

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

Sets the specified value to the VkSemaphoreGetFdInfoKHR#pNext field.

selfback to summary
protected VkSemaphoreGetFdInfoKHR.Buffer self()

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

Annotations
@Override
semaphoreback to summary
public long semaphore()
Returns:long

the value of the VkSemaphoreGetFdInfoKHR#semaphore field.

Annotations
@NativeType:VkSemaphore
semaphoreback to summary
public VkSemaphoreGetFdInfoKHR.Buffer semaphore(long value)

Sets the specified value to the VkSemaphoreGetFdInfoKHR#semaphore field.

sTypeback to summary
public int sType()
Returns:int

the value of the VkSemaphoreGetFdInfoKHR#sType field.

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

Sets the specified value to the VkSemaphoreGetFdInfoKHR#sType field.

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

Sets the STRUCTURE_TYPE_SEMAPHORE_GET_FD_INFO_KHR value to the VkSemaphoreGetFdInfoKHR#sType field.