Package org.lwjgl.vulkan
Class VkSemaphoreGetFdInfoKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkSemaphoreGetFdInfoKHR
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkSemaphoreGetFdInfoKHR extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure describing a POSIX FD semaphore export operation.Description
The properties of the file descriptor returned depend on the value of
handleType. SeeVkExternalSemaphoreHandleTypeFlagBitsfor a description of the properties of the defined external semaphore handle types.Valid Usage
handleTypemust have been included inVkExportSemaphoreCreateInfo::handleTypeswhensemaphore’s current payload was created.semaphoremust not currently have its payload replaced by an imported payload as described below in Importing Semaphore Payloads unless that imported payload’s handle type was included inVkExternalSemaphoreProperties::exportFromImportedHandleTypesforhandleType.- If
handleTyperefers to a handle type with copy payload transference semantics, as defined below in Importing Semaphore Payloads, there must be no queue waiting onsemaphore. - If
handleTyperefers to a handle type with copy payload transference semantics,semaphoremust be signaled, or have an associated semaphore signal operation pending execution. handleTypemust be defined as a POSIX file descriptor handle.
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_SEMAPHORE_GET_FD_INFO_KHRpNextmust beNULLsemaphoremust be a validVkSemaphorehandlehandleTypemust be a validVkExternalSemaphoreHandleTypeFlagBitsvalue
See Also
Member documentation
sType– the type of this structure.pNext–NULLor a pointer to an extension-specific structure.semaphore– the semaphore from which state will be exported.handleType– the type of handle requested.
Layout
struct VkSemaphoreGetFdInfoKHR { VkStructureType sType; void const * pNext; VkSemaphore semaphore; VkExternalSemaphoreHandleTypeFlagBits handleType; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkSemaphoreGetFdInfoKHR.BufferAn array ofVkSemaphoreGetFdInfoKHRstructs.
-
Constructor Summary
Constructors Constructor Description VkSemaphoreGetFdInfoKHR(java.nio.ByteBuffer container)Creates aVkSemaphoreGetFdInfoKHRinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkSemaphoreGetFdInfoKHRcalloc()Returns a newVkSemaphoreGetFdInfoKHRinstance allocated withmemCalloc.static VkSemaphoreGetFdInfoKHR.Buffercalloc(int capacity)Returns a newVkSemaphoreGetFdInfoKHR.Bufferinstance allocated withmemCalloc.static VkSemaphoreGetFdInfoKHRcallocStack()Returns a newVkSemaphoreGetFdInfoKHRinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkSemaphoreGetFdInfoKHR.BuffercallocStack(int capacity)Returns a newVkSemaphoreGetFdInfoKHR.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkSemaphoreGetFdInfoKHR.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkSemaphoreGetFdInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkSemaphoreGetFdInfoKHRcallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkSemaphoreGetFdInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkSemaphoreGetFdInfoKHRcreate()Returns a newVkSemaphoreGetFdInfoKHRinstance allocated withBufferUtils.static VkSemaphoreGetFdInfoKHR.Buffercreate(int capacity)Returns a newVkSemaphoreGetFdInfoKHR.Bufferinstance allocated withBufferUtils.static VkSemaphoreGetFdInfoKHRcreate(long address)Returns a newVkSemaphoreGetFdInfoKHRinstance for the specified memory address.static VkSemaphoreGetFdInfoKHR.Buffercreate(long address, int capacity)Create aVkSemaphoreGetFdInfoKHR.Bufferinstance at the specified memory.static VkSemaphoreGetFdInfoKHRcreateSafe(long address)static VkSemaphoreGetFdInfoKHR.BuffercreateSafe(long address, int capacity)inthandleType()Returns the value of thehandleTypefield.VkSemaphoreGetFdInfoKHRhandleType(int value)Sets the specified value to thehandleTypefield.static VkSemaphoreGetFdInfoKHRmalloc()Returns a newVkSemaphoreGetFdInfoKHRinstance allocated withmemAlloc.static VkSemaphoreGetFdInfoKHR.Buffermalloc(int capacity)Returns a newVkSemaphoreGetFdInfoKHR.Bufferinstance allocated withmemAlloc.static VkSemaphoreGetFdInfoKHRmallocStack()Returns a newVkSemaphoreGetFdInfoKHRinstance allocated on the thread-localMemoryStack.static VkSemaphoreGetFdInfoKHR.BuffermallocStack(int capacity)Returns a newVkSemaphoreGetFdInfoKHR.Bufferinstance allocated on the thread-localMemoryStack.static VkSemaphoreGetFdInfoKHR.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkSemaphoreGetFdInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.static VkSemaphoreGetFdInfoKHRmallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkSemaphoreGetFdInfoKHRinstance allocated on the specifiedMemoryStack.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 longnsemaphore(long struct)Unsafe version ofsemaphore().static voidnsemaphore(long struct, long value)Unsafe version ofsemaphore.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.longpNext()Returns the value of thepNextfield.VkSemaphoreGetFdInfoKHRpNext(long value)Sets the specified value to thepNextfield.longsemaphore()Returns the value of thesemaphorefield.VkSemaphoreGetFdInfoKHRsemaphore(long value)Sets the specified value to thesemaphorefield.VkSemaphoreGetFdInfoKHRset(int sType, long pNext, long semaphore, int handleType)Initializes this struct with the specified values.VkSemaphoreGetFdInfoKHRset(VkSemaphoreGetFdInfoKHR src)Copies the specified struct data to this struct.intsizeof()intsType()Returns the value of thesTypefield.VkSemaphoreGetFdInfoKHRsType(int value)Sets the specified value to thesTypefield.
-
-
-
Constructor Detail
-
VkSemaphoreGetFdInfoKHR
public VkSemaphoreGetFdInfoKHR(java.nio.ByteBuffer container)
Creates aVkSemaphoreGetFdInfoKHRinstance 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.
-
semaphore
public long semaphore()
Returns the value of thesemaphorefield.
-
handleType
public int handleType()
Returns the value of thehandleTypefield.
-
sType
public VkSemaphoreGetFdInfoKHR sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkSemaphoreGetFdInfoKHR pNext(long value)
Sets the specified value to thepNextfield.
-
semaphore
public VkSemaphoreGetFdInfoKHR semaphore(long value)
Sets the specified value to thesemaphorefield.
-
handleType
public VkSemaphoreGetFdInfoKHR handleType(int value)
Sets the specified value to thehandleTypefield.
-
set
public VkSemaphoreGetFdInfoKHR set(int sType, long pNext, long semaphore, int handleType)
Initializes this struct with the specified values.
-
set
public VkSemaphoreGetFdInfoKHR set(VkSemaphoreGetFdInfoKHR src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkSemaphoreGetFdInfoKHR malloc()
Returns a newVkSemaphoreGetFdInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkSemaphoreGetFdInfoKHR calloc()
Returns a newVkSemaphoreGetFdInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkSemaphoreGetFdInfoKHR create()
Returns a newVkSemaphoreGetFdInfoKHRinstance allocated withBufferUtils.
-
create
public static VkSemaphoreGetFdInfoKHR create(long address)
Returns a newVkSemaphoreGetFdInfoKHRinstance for the specified memory address.
-
createSafe
@Nullable public static VkSemaphoreGetFdInfoKHR createSafe(long address)
-
malloc
public static VkSemaphoreGetFdInfoKHR.Buffer malloc(int capacity)
Returns a newVkSemaphoreGetFdInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkSemaphoreGetFdInfoKHR.Buffer calloc(int capacity)
Returns a newVkSemaphoreGetFdInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkSemaphoreGetFdInfoKHR.Buffer create(int capacity)
Returns a newVkSemaphoreGetFdInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkSemaphoreGetFdInfoKHR.Buffer create(long address, int capacity)
Create aVkSemaphoreGetFdInfoKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkSemaphoreGetFdInfoKHR.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkSemaphoreGetFdInfoKHR mallocStack()
Returns a newVkSemaphoreGetFdInfoKHRinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkSemaphoreGetFdInfoKHR callocStack()
Returns a newVkSemaphoreGetFdInfoKHRinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkSemaphoreGetFdInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSemaphoreGetFdInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkSemaphoreGetFdInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSemaphoreGetFdInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkSemaphoreGetFdInfoKHR.Buffer mallocStack(int capacity)
Returns a newVkSemaphoreGetFdInfoKHR.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkSemaphoreGetFdInfoKHR.Buffer callocStack(int capacity)
Returns a newVkSemaphoreGetFdInfoKHR.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkSemaphoreGetFdInfoKHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSemaphoreGetFdInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkSemaphoreGetFdInfoKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSemaphoreGetFdInfoKHR.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().
-
nsemaphore
public static long nsemaphore(long struct)
Unsafe version ofsemaphore().
-
nhandleType
public static int nhandleType(long struct)
Unsafe version ofhandleType().
-
nsType
public static void nsType(long struct, int value)Unsafe version ofsType.
-
npNext
public static void npNext(long struct, long value)Unsafe version ofpNext.
-
nsemaphore
public static void nsemaphore(long struct, long value)Unsafe version ofsemaphore.
-
nhandleType
public static void nhandleType(long struct, int value)Unsafe version ofhandleType.
-
-