Package org.lwjgl.vulkan
Class VkSemaphoreGetWin32HandleInfoKHR
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkSemaphoreGetWin32HandleInfoKHR>
org.lwjgl.vulkan.VkSemaphoreGetWin32HandleInfoKHR
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkSemaphoreGetWin32HandleInfoKHR
extends org.lwjgl.system.Struct<VkSemaphoreGetWin32HandleInfoKHR>
implements org.lwjgl.system.NativeResource
Structure describing a Win32 handle semaphore export operation.
Description
The properties of the handle returned depend on the value of handleType. See VkExternalSemaphoreHandleTypeFlagBits for 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
Layout
struct VkSemaphoreGetWin32HandleInfoKHR {
VkStructureType sType();
void const * pNext();
VkSemaphore semaphore();
VkExternalSemaphoreHandleTypeFlagBits handleType();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkSemaphoreGetWin32HandleInfoKHRstructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkSemaphoreGetWin32HandleInfoKHR(ByteBuffer container) Creates aVkSemaphoreGetWin32HandleInfoKHRinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.Deprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.create()Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance allocated withBufferUtils.create(int capacity) Returns a newVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance for the specified memory address.create(long address, int capacity) Create aVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance at the specified memory.static @Nullable VkSemaphoreGetWin32HandleInfoKHRcreateSafe(long address) static @Nullable VkSemaphoreGetWin32HandleInfoKHR.BuffercreateSafe(long address, int capacity) intaVkExternalSemaphoreHandleTypeFlagBitsvalue specifying the type of handle requested.handleType(int value) Sets the specified value to thehandleType()field.malloc()Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance allocated on the specifiedMemoryStack.Deprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.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()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.longthe semaphore from which state will be exported.semaphore(long value) Sets the specified value to thesemaphore()field.set(int sType, long pNext, long semaphore, int handleType) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_SEMAPHORE_GET_WIN32_HANDLE_INFO_KHRvalue to thesType()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
SEMAPHORE
public static final int SEMAPHOREThe struct member offsets. -
HANDLETYPE
public static final int HANDLETYPEThe struct member offsets.
-
-
Constructor Details
-
VkSemaphoreGetWin32HandleInfoKHR
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 Details
-
sizeof
public int sizeof()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkSemaphoreGetWin32HandleInfoKHR>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
semaphore
public long semaphore()the semaphore from which state will be exported. -
handleType
public int handleType()aVkExternalSemaphoreHandleTypeFlagBitsvalue specifying the type of handle requested. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_SEMAPHORE_GET_WIN32_HANDLE_INFO_KHRvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
semaphore
Sets the specified value to thesemaphore()field. -
handleType
Sets the specified value to thehandleType()field. -
set
Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance allocated withBufferUtils. -
create
Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkSemaphoreGetWin32HandleInfoKHR.Buffer createSafe(long address, int capacity) -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
@Deprecated public static VkSemaphoreGetWin32HandleInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
@Deprecated public static VkSemaphoreGetWin32HandleInfoKHR callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
mallocStack
@Deprecated public static VkSemaphoreGetWin32HandleInfoKHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkSemaphoreGetWin32HandleInfoKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkSemaphoreGetWin32HandleInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkSemaphoreGetWin32HandleInfoKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkSemaphoreGetWin32HandleInfoKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkSemaphoreGetWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
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.
-