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
,NativeResource
,Pointer
public class VkSemaphoreGetWin32HandleInfoKHR
extends Struct<VkSemaphoreGetWin32HandleInfoKHR>
implements 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
handleType
must have been included inVkExportSemaphoreCreateInfo
::handleTypes
when thesemaphore
’s current payload was created- If
handleType
is defined as an NT handle,GetSemaphoreWin32HandleKHR
must be called no more than once for each valid unique combination ofsemaphore
andhandleType
semaphore
must 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
::exportFromImportedHandleTypes
forhandleType
- If
handleType
refers to a handle type with copy payload transference semantics, as defined below in Importing Semaphore Payloads, there must be no queue waiting onsemaphore
- If
handleType
refers to a handle type with copy payload transference semantics,semaphore
must be signaled, or have an associated semaphore signal operation pending execution handleType
must be defined as an NT handle or a global share handle
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_SEMAPHORE_GET_WIN32_HANDLE_INFO_KHR
pNext
must beNULL
semaphore
must be a validVkSemaphore
handlehandleType
must be a validVkExternalSemaphoreHandleTypeFlagBits
value
See Also
Layout
struct VkSemaphoreGetWin32HandleInfoKHR {
VkStructureType sType()
;
void const * pNext()
;
VkSemaphore semaphore()
;
VkExternalSemaphoreHandleTypeFlagBits handleType()
;
}
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
An array ofVkSemaphoreGetWin32HandleInfoKHR
structs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionVkSemaphoreGetWin32HandleInfoKHR
(ByteBuffer container) Creates aVkSemaphoreGetWin32HandleInfoKHR
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()
Returns a newVkSemaphoreGetWin32HandleInfoKHR
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkSemaphoreGetWin32HandleInfoKHR.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkSemaphoreGetWin32HandleInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.calloc
(MemoryStack stack) Returns a newVkSemaphoreGetWin32HandleInfoKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.Deprecated.callocStack
(int capacity) Deprecated.callocStack
(int capacity, MemoryStack stack) Deprecated.callocStack
(MemoryStack stack) Deprecated.create()
Returns a newVkSemaphoreGetWin32HandleInfoKHR
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkSemaphoreGetWin32HandleInfoKHR.Buffer
instance allocated withBufferUtils
.create
(long address) Returns a newVkSemaphoreGetWin32HandleInfoKHR
instance for the specified memory address.create
(long address, int capacity) Create aVkSemaphoreGetWin32HandleInfoKHR.Buffer
instance at the specified memory.createSafe
(long address) createSafe
(long address, int capacity) int
aVkExternalSemaphoreHandleTypeFlagBits
value specifying the type of handle requested.handleType
(int value) Sets the specified value to thehandleType()
field.malloc()
Returns a newVkSemaphoreGetWin32HandleInfoKHR
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkSemaphoreGetWin32HandleInfoKHR.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkSemaphoreGetWin32HandleInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.malloc
(MemoryStack stack) Returns a newVkSemaphoreGetWin32HandleInfoKHR
instance allocated on the specifiedMemoryStack
.Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.mallocStack
(MemoryStack stack) Deprecated.static int
nhandleType
(long struct) Unsafe version ofhandleType()
.static void
nhandleType
(long struct, int value) Unsafe version ofhandleType
.static long
npNext
(long struct) Unsafe version ofpNext()
.static void
npNext
(long struct, long value) Unsafe version ofpNext
.static long
nsemaphore
(long struct) Unsafe version ofsemaphore()
.static void
nsemaphore
(long struct, long value) Unsafe version ofsemaphore
.static int
nsType
(long struct) Unsafe version ofsType()
.static void
nsType
(long struct, int value) Unsafe version ofsType
.long
pNext()
NULL
or a pointer to a structure extending this structure.pNext
(long value) Sets the specified value to thepNext()
field.long
the 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.int
sizeof()
Returnssizeof(struct)
.int
sType()
aVkStructureType
value identifying this structure.sType
(int value) Sets the specified value to thesType()
field.Sets theSTRUCTURE_TYPE_SEMAPHORE_GET_WIN32_HANDLE_INFO_KHR
value to thesType()
field.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods 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 aVkSemaphoreGetWin32HandleInfoKHR
instance at the current position of the specifiedByteBuffer
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 Details
-
sizeof
public int sizeof()Description copied from class:Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkSemaphoreGetWin32HandleInfoKHR>
-
sType
public int sType()aVkStructureType
value identifying this structure. -
pNext
public long pNext()NULL
or a pointer to a structure extending this structure. -
semaphore
public long semaphore()the semaphore from which state will be exported. -
handleType
public int handleType()aVkExternalSemaphoreHandleTypeFlagBits
value specifying the type of handle requested. -
sType
Sets the specified value to thesType()
field. -
sType$Default
Sets theSTRUCTURE_TYPE_SEMAPHORE_GET_WIN32_HANDLE_INFO_KHR
value 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 newVkSemaphoreGetWin32HandleInfoKHR
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkSemaphoreGetWin32HandleInfoKHR
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkSemaphoreGetWin32HandleInfoKHR
instance allocated withBufferUtils
. -
create
Returns a newVkSemaphoreGetWin32HandleInfoKHR
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkSemaphoreGetWin32HandleInfoKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkSemaphoreGetWin32HandleInfoKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkSemaphoreGetWin32HandleInfoKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkSemaphoreGetWin32HandleInfoKHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static 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.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
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, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkSemaphoreGetWin32HandleInfoKHR.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkSemaphoreGetWin32HandleInfoKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkSemaphoreGetWin32HandleInfoKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkSemaphoreGetWin32HandleInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkSemaphoreGetWin32HandleInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
and 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
.
-