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.NativeResource
Structure describing a Win32 handle semaphore export operation.Description
The properties of the handle returned depend on the value of
handleType
. SeeVkExternalSemaphoreHandleTypeFlagBits
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
Member documentation
sType
– the type of this structure.pNext
–NULL
or 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 class
VkSemaphoreGetWin32HandleInfoKHR.Buffer
An array ofVkSemaphoreGetWin32HandleInfoKHR
structs.
-
Constructor Summary
Constructors Constructor Description VkSemaphoreGetWin32HandleInfoKHR(java.nio.ByteBuffer container)
Creates aVkSemaphoreGetWin32HandleInfoKHR
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkSemaphoreGetWin32HandleInfoKHR
calloc()
Returns a newVkSemaphoreGetWin32HandleInfoKHR
instance allocated withmemCalloc
.static VkSemaphoreGetWin32HandleInfoKHR.Buffer
calloc(int capacity)
Returns a newVkSemaphoreGetWin32HandleInfoKHR.Buffer
instance allocated withmemCalloc
.static VkSemaphoreGetWin32HandleInfoKHR
callocStack()
Returns a newVkSemaphoreGetWin32HandleInfoKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkSemaphoreGetWin32HandleInfoKHR.Buffer
callocStack(int capacity)
Returns a newVkSemaphoreGetWin32HandleInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkSemaphoreGetWin32HandleInfoKHR.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSemaphoreGetWin32HandleInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSemaphoreGetWin32HandleInfoKHR
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSemaphoreGetWin32HandleInfoKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSemaphoreGetWin32HandleInfoKHR
create()
Returns a newVkSemaphoreGetWin32HandleInfoKHR
instance allocated withBufferUtils
.static VkSemaphoreGetWin32HandleInfoKHR.Buffer
create(int capacity)
Returns a newVkSemaphoreGetWin32HandleInfoKHR.Buffer
instance allocated withBufferUtils
.static VkSemaphoreGetWin32HandleInfoKHR
create(long address)
Returns a newVkSemaphoreGetWin32HandleInfoKHR
instance for the specified memory address.static VkSemaphoreGetWin32HandleInfoKHR.Buffer
create(long address, int capacity)
Create aVkSemaphoreGetWin32HandleInfoKHR.Buffer
instance at the specified memory.static VkSemaphoreGetWin32HandleInfoKHR
createSafe(long address)
static VkSemaphoreGetWin32HandleInfoKHR.Buffer
createSafe(long address, int capacity)
int
handleType()
Returns the value of thehandleType
field.VkSemaphoreGetWin32HandleInfoKHR
handleType(int value)
Sets the specified value to thehandleType
field.static VkSemaphoreGetWin32HandleInfoKHR
malloc()
Returns a newVkSemaphoreGetWin32HandleInfoKHR
instance allocated withmemAlloc
.static VkSemaphoreGetWin32HandleInfoKHR.Buffer
malloc(int capacity)
Returns a newVkSemaphoreGetWin32HandleInfoKHR.Buffer
instance allocated withmemAlloc
.static VkSemaphoreGetWin32HandleInfoKHR
mallocStack()
Returns a newVkSemaphoreGetWin32HandleInfoKHR
instance allocated on the thread-localMemoryStack
.static VkSemaphoreGetWin32HandleInfoKHR.Buffer
mallocStack(int capacity)
Returns a newVkSemaphoreGetWin32HandleInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
.static VkSemaphoreGetWin32HandleInfoKHR.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSemaphoreGetWin32HandleInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkSemaphoreGetWin32HandleInfoKHR
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSemaphoreGetWin32HandleInfoKHR
instance allocated on the specifiedMemoryStack
.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()
Returns the value of thepNext
field.VkSemaphoreGetWin32HandleInfoKHR
pNext(long value)
Sets the specified value to thepNext
field.long
semaphore()
Returns the value of thesemaphore
field.VkSemaphoreGetWin32HandleInfoKHR
semaphore(long value)
Sets the specified value to thesemaphore
field.VkSemaphoreGetWin32HandleInfoKHR
set(int sType, long pNext, long semaphore, int handleType)
Initializes this struct with the specified values.VkSemaphoreGetWin32HandleInfoKHR
set(VkSemaphoreGetWin32HandleInfoKHR src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkSemaphoreGetWin32HandleInfoKHR
sType(int value)
Sets the specified value to thesType
field.
-
-
-
Constructor Detail
-
VkSemaphoreGetWin32HandleInfoKHR
public VkSemaphoreGetWin32HandleInfoKHR(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
semaphore
public long semaphore()
Returns the value of thesemaphore
field.
-
handleType
public int handleType()
Returns the value of thehandleType
field.
-
sType
public VkSemaphoreGetWin32HandleInfoKHR sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkSemaphoreGetWin32HandleInfoKHR pNext(long value)
Sets the specified value to thepNext
field.
-
semaphore
public VkSemaphoreGetWin32HandleInfoKHR semaphore(long value)
Sets the specified value to thesemaphore
field.
-
handleType
public VkSemaphoreGetWin32HandleInfoKHR handleType(int value)
Sets the specified value to thehandleType
field.
-
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 newVkSemaphoreGetWin32HandleInfoKHR
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkSemaphoreGetWin32HandleInfoKHR calloc()
Returns a newVkSemaphoreGetWin32HandleInfoKHR
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkSemaphoreGetWin32HandleInfoKHR create()
Returns a newVkSemaphoreGetWin32HandleInfoKHR
instance allocated withBufferUtils
.
-
create
public static VkSemaphoreGetWin32HandleInfoKHR create(long address)
Returns a newVkSemaphoreGetWin32HandleInfoKHR
instance for the specified memory address.
-
createSafe
@Nullable public static VkSemaphoreGetWin32HandleInfoKHR createSafe(long address)
-
malloc
public static VkSemaphoreGetWin32HandleInfoKHR.Buffer malloc(int capacity)
Returns a newVkSemaphoreGetWin32HandleInfoKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkSemaphoreGetWin32HandleInfoKHR.Buffer calloc(int capacity)
Returns a newVkSemaphoreGetWin32HandleInfoKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkSemaphoreGetWin32HandleInfoKHR.Buffer create(int capacity)
Returns a newVkSemaphoreGetWin32HandleInfoKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkSemaphoreGetWin32HandleInfoKHR.Buffer create(long address, int capacity)
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
public static VkSemaphoreGetWin32HandleInfoKHR mallocStack()
Returns a newVkSemaphoreGetWin32HandleInfoKHR
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkSemaphoreGetWin32HandleInfoKHR callocStack()
Returns a newVkSemaphoreGetWin32HandleInfoKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkSemaphoreGetWin32HandleInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSemaphoreGetWin32HandleInfoKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkSemaphoreGetWin32HandleInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSemaphoreGetWin32HandleInfoKHR
instance allocated on the specifiedMemoryStack
and 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.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkSemaphoreGetWin32HandleInfoKHR.Buffer callocStack(int capacity)
Returns a newVkSemaphoreGetWin32HandleInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
and 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.Buffer
instance 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.Buffer
instance allocated on the specifiedMemoryStack
and 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
.
-
-