Package org.lwjgl.vulkan
Class VkSemaphoreGetWin32HandleInfoKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkSemaphoreGetWin32HandleInfoKHR
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkSemaphoreGetWin32HandleInfoKHR extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure describing a Win32 handle semaphore export operation.Description
The properties of the handle 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::handleTypeswhen thesemaphore’s current payload was created.- If
handleTypeis defined as an NT handle,GetSemaphoreWin32HandleKHRmust be called no more than once for each valid unique combination ofsemaphoreandhandleType. 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 an NT handle or a global share handle.
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_SEMAPHORE_GET_WIN32_HANDLE_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 VkSemaphoreGetWin32HandleInfoKHR { VkStructureType sType; void const * pNext; VkSemaphore semaphore; VkExternalSemaphoreHandleTypeFlagBits handleType; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkSemaphoreGetWin32HandleInfoKHR.BufferAn array ofVkSemaphoreGetWin32HandleInfoKHRstructs.
-
Constructor Summary
Constructors Constructor Description VkSemaphoreGetWin32HandleInfoKHR(java.nio.ByteBuffer container)Creates aVkSemaphoreGetWin32HandleInfoKHRinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkSemaphoreGetWin32HandleInfoKHRcalloc()Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance allocated withmemCalloc.static VkSemaphoreGetWin32HandleInfoKHR.Buffercalloc(int capacity)Returns a newVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance allocated withmemCalloc.static VkSemaphoreGetWin32HandleInfoKHRcallocStack()Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkSemaphoreGetWin32HandleInfoKHR.BuffercallocStack(int capacity)Returns a newVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkSemaphoreGetWin32HandleInfoKHR.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkSemaphoreGetWin32HandleInfoKHRcallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkSemaphoreGetWin32HandleInfoKHRcreate()Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance allocated withBufferUtils.static VkSemaphoreGetWin32HandleInfoKHR.Buffercreate(int capacity)Returns a newVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance allocated withBufferUtils.static VkSemaphoreGetWin32HandleInfoKHRcreate(long address)Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance for the specified memory address.static VkSemaphoreGetWin32HandleInfoKHR.Buffercreate(long address, int capacity)Create aVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance at the specified memory.static VkSemaphoreGetWin32HandleInfoKHRcreateSafe(long address)static VkSemaphoreGetWin32HandleInfoKHR.BuffercreateSafe(long address, int capacity)inthandleType()Returns the value of thehandleTypefield.VkSemaphoreGetWin32HandleInfoKHRhandleType(int value)Sets the specified value to thehandleTypefield.static VkSemaphoreGetWin32HandleInfoKHRmalloc()Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance allocated withmemAlloc.static VkSemaphoreGetWin32HandleInfoKHR.Buffermalloc(int capacity)Returns a newVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance allocated withmemAlloc.static VkSemaphoreGetWin32HandleInfoKHRmallocStack()Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance allocated on the thread-localMemoryStack.static VkSemaphoreGetWin32HandleInfoKHR.BuffermallocStack(int capacity)Returns a newVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance allocated on the thread-localMemoryStack.static VkSemaphoreGetWin32HandleInfoKHR.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.static VkSemaphoreGetWin32HandleInfoKHRmallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance 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.VkSemaphoreGetWin32HandleInfoKHRpNext(long value)Sets the specified value to thepNextfield.longsemaphore()Returns the value of thesemaphorefield.VkSemaphoreGetWin32HandleInfoKHRsemaphore(long value)Sets the specified value to thesemaphorefield.VkSemaphoreGetWin32HandleInfoKHRset(int sType, long pNext, long semaphore, int handleType)Initializes this struct with the specified values.VkSemaphoreGetWin32HandleInfoKHRset(VkSemaphoreGetWin32HandleInfoKHR src)Copies the specified struct data to this struct.intsizeof()intsType()Returns the value of thesTypefield.VkSemaphoreGetWin32HandleInfoKHRsType(int value)Sets the specified value to thesTypefield.
-
-
-
Constructor Detail
-
VkSemaphoreGetWin32HandleInfoKHR
public VkSemaphoreGetWin32HandleInfoKHR(java.nio.ByteBuffer container)
Creates aVkSemaphoreGetWin32HandleInfoKHRinstance 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 VkSemaphoreGetWin32HandleInfoKHR sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkSemaphoreGetWin32HandleInfoKHR pNext(long value)
Sets the specified value to thepNextfield.
-
semaphore
public VkSemaphoreGetWin32HandleInfoKHR semaphore(long value)
Sets the specified value to thesemaphorefield.
-
handleType
public VkSemaphoreGetWin32HandleInfoKHR handleType(int value)
Sets the specified value to thehandleTypefield.
-
set
public VkSemaphoreGetWin32HandleInfoKHR set(int sType, long pNext, long semaphore, int handleType)
Initializes this struct with the specified values.
-
set
public VkSemaphoreGetWin32HandleInfoKHR set(VkSemaphoreGetWin32HandleInfoKHR src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkSemaphoreGetWin32HandleInfoKHR malloc()
Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkSemaphoreGetWin32HandleInfoKHR calloc()
Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkSemaphoreGetWin32HandleInfoKHR create()
Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance allocated withBufferUtils.
-
create
public static VkSemaphoreGetWin32HandleInfoKHR create(long address)
Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance for the specified memory address.
-
createSafe
@Nullable public static VkSemaphoreGetWin32HandleInfoKHR createSafe(long address)
-
malloc
public static VkSemaphoreGetWin32HandleInfoKHR.Buffer malloc(int capacity)
Returns a newVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkSemaphoreGetWin32HandleInfoKHR.Buffer calloc(int capacity)
Returns a newVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkSemaphoreGetWin32HandleInfoKHR.Buffer create(int capacity)
Returns a newVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkSemaphoreGetWin32HandleInfoKHR.Buffer create(long address, int capacity)
Create aVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkSemaphoreGetWin32HandleInfoKHR.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkSemaphoreGetWin32HandleInfoKHR mallocStack()
Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkSemaphoreGetWin32HandleInfoKHR callocStack()
Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkSemaphoreGetWin32HandleInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkSemaphoreGetWin32HandleInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkSemaphoreGetWin32HandleInfoKHR.Buffer mallocStack(int capacity)
Returns a newVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkSemaphoreGetWin32HandleInfoKHR.Buffer callocStack(int capacity)
Returns a newVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkSemaphoreGetWin32HandleInfoKHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkSemaphoreGetWin32HandleInfoKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSemaphoreGetWin32HandleInfoKHR.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.
-
-