java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkImportSemaphoreWin32HandleInfoKHR

All Implemented Interfaces:: java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkImportSemaphoreWin32HandleInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource

Structure specifying Windows handle to import to a semaphore.

Description

The handle types supported by handleType are:

Handle Types Supported by `VkImportSemaphoreWin32HandleInfoKHR`

Handle Type	Transference	Permanence Supported
`EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_BIT`	Reference	Temporary,Permanent
`EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT`	Reference	Temporary,Permanent
`EXTERNAL_SEMAPHORE_HANDLE_TYPE_D3D12_FENCE_BIT`	Reference	Temporary,Permanent

Valid Usage

handleType must be a value included in the Handle Types Supported by VkImportSemaphoreWin32HandleInfoKHR table
If handleType is not EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_BIT or EXTERNAL_SEMAPHORE_HANDLE_TYPE_D3D12_FENCE_BIT, name must be NULL
If handle is NULL, name must name a valid synchronization primitive of the type specified by handleType
If name is NULL, handle must be a valid handle of the type specified by handleType
If handle is not NULL, name must be NULL
If handle is not NULL, it must obey any requirements listed for handleType in external semaphore handle types compatibility
If name is not NULL, it must obey any requirements listed for handleType in external semaphore handle types compatibility
If handleType is EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_BIT or EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT, the VkSemaphoreCreateInfo::flags field must match that of the semaphore from which handle or name was exported
If handleType is EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_BIT or EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT, the VkSemaphoreTypeCreateInfo::semaphoreType field must match that of the semaphore from which handle or name was exported
If flags contains SEMAPHORE_IMPORT_TEMPORARY_BIT, the VkSemaphoreTypeCreateInfo::semaphoreType field of the semaphore from which handle or name was exported must not be SEMAPHORE_TYPE_TIMELINE

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_IMPORT_SEMAPHORE_WIN32_HANDLE_INFO_KHR
pNext must be NULL
semaphore must be a valid VkSemaphore handle
flags must be a valid combination of VkSemaphoreImportFlagBits values

Host Synchronization

Host access to semaphore must be externally synchronized

Layout


 struct VkImportSemaphoreWin32HandleInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkSemaphore semaphore();
     VkSemaphoreImportFlags flags();
     VkExternalSemaphoreHandleTypeFlagBits handleType();
     HANDLE handle();
     LPCWSTR name();
 }

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VkImportSemaphoreWin32HandleInfoKHR.Buffer
An array of VkImportSemaphoreWin32HandleInfoKHR structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default
- Nested classes/interfaces inherited from class org.lwjgl.system.Struct
  org.lwjgl.system.Struct.StructValidation

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`FLAGS HANDLE HANDLETYPE NAME PNEXT SEMAPHORE`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`STYPE`	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor	Description
`VkImportSemaphoreWin32HandleInfoKHR(java.nio.ByteBuffer container)`	Creates a `VkImportSemaphoreWin32HandleInfoKHR` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static VkImportSemaphoreWin32HandleInfoKHR`	`calloc()`	Returns a new `VkImportSemaphoreWin32HandleInfoKHR` instance allocated with `memCalloc`.
`static VkImportSemaphoreWin32HandleInfoKHR.Buffer`	`calloc(int capacity)`	Returns a new `VkImportSemaphoreWin32HandleInfoKHR.Buffer` instance allocated with `memCalloc`.
`static VkImportSemaphoreWin32HandleInfoKHR.Buffer`	`calloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkImportSemaphoreWin32HandleInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkImportSemaphoreWin32HandleInfoKHR`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkImportSemaphoreWin32HandleInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkImportSemaphoreWin32HandleInfoKHR`	`callocStack()`	Deprecated.
`static VkImportSemaphoreWin32HandleInfoKHR.Buffer`	`callocStack(int capacity)`	Deprecated.
`static VkImportSemaphoreWin32HandleInfoKHR.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static VkImportSemaphoreWin32HandleInfoKHR`	`callocStack(org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static VkImportSemaphoreWin32HandleInfoKHR`	`create()`	Returns a new `VkImportSemaphoreWin32HandleInfoKHR` instance allocated with `BufferUtils`.
`static VkImportSemaphoreWin32HandleInfoKHR.Buffer`	`create(int capacity)`	Returns a new `VkImportSemaphoreWin32HandleInfoKHR.Buffer` instance allocated with `BufferUtils`.
`static VkImportSemaphoreWin32HandleInfoKHR`	`create(long address)`	Returns a new `VkImportSemaphoreWin32HandleInfoKHR` instance for the specified memory address.
`static VkImportSemaphoreWin32HandleInfoKHR.Buffer`	`create(long address, int capacity)`	Create a `VkImportSemaphoreWin32HandleInfoKHR.Buffer` instance at the specified memory.
`static VkImportSemaphoreWin32HandleInfoKHR`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkImportSemaphoreWin32HandleInfoKHR.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`int`	`flags()`	a bitmask of `VkSemaphoreImportFlagBits` specifying additional parameters for the semaphore payload import operation.
`VkImportSemaphoreWin32HandleInfoKHR`	`flags(int value)`	Sets the specified value to the `flags()` field.
`long`	`handle()`	`NULL` or the external handle to import.
`VkImportSemaphoreWin32HandleInfoKHR`	`handle(long value)`	Sets the specified value to the `handle()` field.
`int`	`handleType()`	a `VkExternalSemaphoreHandleTypeFlagBits` value specifying the type of `handle`.
`VkImportSemaphoreWin32HandleInfoKHR`	`handleType(int value)`	Sets the specified value to the `handleType()` field.
`static VkImportSemaphoreWin32HandleInfoKHR`	`malloc()`	Returns a new `VkImportSemaphoreWin32HandleInfoKHR` instance allocated with `memAlloc`.
`static VkImportSemaphoreWin32HandleInfoKHR.Buffer`	`malloc(int capacity)`	Returns a new `VkImportSemaphoreWin32HandleInfoKHR.Buffer` instance allocated with `memAlloc`.
`static VkImportSemaphoreWin32HandleInfoKHR.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkImportSemaphoreWin32HandleInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkImportSemaphoreWin32HandleInfoKHR`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkImportSemaphoreWin32HandleInfoKHR` instance allocated on the specified `MemoryStack`.
`static VkImportSemaphoreWin32HandleInfoKHR`	`mallocStack()`	Deprecated.
`static VkImportSemaphoreWin32HandleInfoKHR.Buffer`	`mallocStack(int capacity)`	Deprecated.
`static VkImportSemaphoreWin32HandleInfoKHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static VkImportSemaphoreWin32HandleInfoKHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)`	Deprecated.
`java.nio.ByteBuffer`	`name()`	`NULL` or a null-terminated UTF-16 string naming the underlying synchronization primitive to import.
`VkImportSemaphoreWin32HandleInfoKHR`	`name(java.nio.ByteBuffer value)`	Sets the address of the specified encoded string to the `name()` field.
`java.lang.String`	`nameString()`	`NULL` or a null-terminated UTF-16 string naming the underlying synchronization primitive to import.
`static int`	`nflags(long struct)`	Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)`	Unsafe version of `flags`.
`static long`	`nhandle(long struct)`	Unsafe version of `handle()`.
`static void`	`nhandle(long struct, long value)`	Unsafe version of `handle`.
`static int`	`nhandleType(long struct)`	Unsafe version of `handleType()`.
`static void`	`nhandleType(long struct, int value)`	Unsafe version of `handleType`.
`static java.nio.ByteBuffer`	`nname(long struct)`	Unsafe version of `name()`.
`static void`	`nname(long struct, java.nio.ByteBuffer value)`	Unsafe version of `name`.
`static java.lang.String`	`nnameString(long struct)`	Unsafe version of `nameString()`.
`static long`	`npNext(long struct)`	Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)`	Unsafe version of `pNext`.
`static long`	`nsemaphore(long struct)`	Unsafe version of `semaphore()`.
`static void`	`nsemaphore(long struct, long value)`	Unsafe version of `semaphore`.
`static int`	`nsType(long struct)`	Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)`	Unsafe version of `sType`.
`long`	`pNext()`	`NULL` or a pointer to a structure extending this structure.
`VkImportSemaphoreWin32HandleInfoKHR`	`pNext(long value)`	Sets the specified value to the `pNext()` field.
`long`	`semaphore()`	the semaphore into which the payload will be imported.
`VkImportSemaphoreWin32HandleInfoKHR`	`semaphore(long value)`	Sets the specified value to the `semaphore()` field.
`VkImportSemaphoreWin32HandleInfoKHR`	`set(int sType, long pNext, long semaphore, int flags, int handleType, long handle, java.nio.ByteBuffer name)`	Initializes this struct with the specified values.
`VkImportSemaphoreWin32HandleInfoKHR`	`set(VkImportSemaphoreWin32HandleInfoKHR src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()`	the type of this structure.
`VkImportSemaphoreWin32HandleInfoKHR`	`sType(int value)`	Sets the specified value to the `sType()` field.
`VkImportSemaphoreWin32HandleInfoKHR`	`sType$Default()`	Sets the `STRUCTURE_TYPE_IMPORT_SEMAPHORE_WIN32_HANDLE_INFO_KHR` value to the `sType()` field.
`static void`	`validate(long struct)`	Validates pointer members that should not be `NULL`.

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate

Field Detail
- SIZEOF
  
  The struct size in bytes.
- ALIGNOF
  
  The struct alignment in bytes.
- STYPE, PNEXT, SEMAPHORE, FLAGS, HANDLETYPE, HANDLE, NAME
  
  The struct member offsets.

Constructor Detail
- VkImportSemaphoreWin32HandleInfoKHR
```
public VkImportSemaphoreWin32HandleInfoKHR(java.nio.ByteBuffer container)
```
  Creates a VkImportSemaphoreWin32HandleInfoKHR instance at the current position of the specified ByteBuffer 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 class org.lwjgl.system.Struct

sType
```
public int sType()
```
the type of this structure.

pNext
```
public long pNext()
```
NULL or a pointer to a structure extending this structure.

semaphore
```
public long semaphore()
```
the semaphore into which the payload will be imported.

flags
```
public int flags()
```
a bitmask of VkSemaphoreImportFlagBits specifying additional parameters for the semaphore payload import operation.

handleType
```
public int handleType()
```
a VkExternalSemaphoreHandleTypeFlagBits value specifying the type of handle.

handle
```
public long handle()
```
NULL or the external handle to import.

name, nameString
```
public java.nio.ByteBuffer name()

public java.lang.String nameString()
```
NULL or a null-terminated UTF-16 string naming the underlying synchronization primitive to import.

sType

public VkImportSemaphoreWin32HandleInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default
```
public VkImportSemaphoreWin32HandleInfoKHR sType$Default()
```
Sets the STRUCTURE_TYPE_IMPORT_SEMAPHORE_WIN32_HANDLE_INFO_KHR value to the sType() field.

pNext

public VkImportSemaphoreWin32HandleInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

semaphore

public VkImportSemaphoreWin32HandleInfoKHR semaphore(long value)

Sets the specified value to the semaphore() field.

flags

public VkImportSemaphoreWin32HandleInfoKHR flags(int value)

Sets the specified value to the flags() field.

handleType

public VkImportSemaphoreWin32HandleInfoKHR handleType(int value)

Sets the specified value to the handleType() field.

handle

public VkImportSemaphoreWin32HandleInfoKHR handle(long value)

Sets the specified value to the handle() field.

name

public VkImportSemaphoreWin32HandleInfoKHR name(java.nio.ByteBuffer value)

Sets the address of the specified encoded string to the name() field.

set

public VkImportSemaphoreWin32HandleInfoKHR set(int sType,
                                               long pNext,
                                               long semaphore,
                                               int flags,
                                               int handleType,
                                               long handle,
                                               java.nio.ByteBuffer name)

Initializes this struct with the specified values.

set
```
public VkImportSemaphoreWin32HandleInfoKHR set(VkImportSemaphoreWin32HandleInfoKHR src)
```
Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc
```
public static VkImportSemaphoreWin32HandleInfoKHR malloc()
```
Returns a new VkImportSemaphoreWin32HandleInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.

calloc
```
public static VkImportSemaphoreWin32HandleInfoKHR calloc()
```
Returns a new VkImportSemaphoreWin32HandleInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.

create
```
public static VkImportSemaphoreWin32HandleInfoKHR create()
```
Returns a new VkImportSemaphoreWin32HandleInfoKHR instance allocated with BufferUtils.

create
```
public static VkImportSemaphoreWin32HandleInfoKHR create(long address)
```
Returns a new VkImportSemaphoreWin32HandleInfoKHR instance for the specified memory address.

createSafe

@Nullable
public static VkImportSemaphoreWin32HandleInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc
```
public static VkImportSemaphoreWin32HandleInfoKHR.Buffer malloc(int capacity)
```
Returns a new VkImportSemaphoreWin32HandleInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc
```
public static VkImportSemaphoreWin32HandleInfoKHR.Buffer calloc(int capacity)
```
Returns a new VkImportSemaphoreWin32HandleInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create
```
public static VkImportSemaphoreWin32HandleInfoKHR.Buffer create(int capacity)
```
Returns a new VkImportSemaphoreWin32HandleInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkImportSemaphoreWin32HandleInfoKHR.Buffer create(long address,
                                                                int capacity)

Create a VkImportSemaphoreWin32HandleInfoKHR.Buffer instance at the specified memory.

Parameters:: address - the memory address; capacity - the buffer capacity

createSafe

@Nullable
public static VkImportSemaphoreWin32HandleInfoKHR.Buffer createSafe(long address,
                                                                    int capacity)

Like create, but returns null if address is NULL.

mallocStack
```
@Deprecated
public static VkImportSemaphoreWin32HandleInfoKHR mallocStack()
```
Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack
```
@Deprecated
public static VkImportSemaphoreWin32HandleInfoKHR callocStack()
```
Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkImportSemaphoreWin32HandleInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkImportSemaphoreWin32HandleInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkImportSemaphoreWin32HandleInfoKHR.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkImportSemaphoreWin32HandleInfoKHR.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VkImportSemaphoreWin32HandleInfoKHR.Buffer mallocStack(int capacity,
                                                                     org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkImportSemaphoreWin32HandleInfoKHR.Buffer callocStack(int capacity,
                                                                     org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc
```
public static VkImportSemaphoreWin32HandleInfoKHR malloc(org.lwjgl.system.MemoryStack stack)
```
Returns a new VkImportSemaphoreWin32HandleInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc
```
public static VkImportSemaphoreWin32HandleInfoKHR calloc(org.lwjgl.system.MemoryStack stack)
```
Returns a new VkImportSemaphoreWin32HandleInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static VkImportSemaphoreWin32HandleInfoKHR.Buffer malloc(int capacity,
                                                                org.lwjgl.system.MemoryStack stack)

Returns a new VkImportSemaphoreWin32HandleInfoKHR.Buffer instance allocated on the specified MemoryStack.

Parameters:: stack - the stack from which to allocate; capacity - the buffer capacity

calloc
```
public static VkImportSemaphoreWin32HandleInfoKHR.Buffer calloc(int capacity,
                                                                org.lwjgl.system.MemoryStack stack)
```
Returns a new VkImportSemaphoreWin32HandleInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

capacity - the buffer capacity

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nsemaphore

public static long nsemaphore(long struct)

Unsafe version of semaphore().

nflags

public static int nflags(long struct)

Unsafe version of flags().

nhandleType

public static int nhandleType(long struct)

Unsafe version of handleType().

nhandle

public static long nhandle(long struct)

Unsafe version of handle().

nname

public static java.nio.ByteBuffer nname(long struct)

Unsafe version of name().

nnameString

public static java.lang.String nnameString(long struct)

Unsafe version of nameString().

nsType

public static void nsType(long struct,
                          int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
                          long value)

Unsafe version of pNext.

nsemaphore

public static void nsemaphore(long struct,
                              long value)

Unsafe version of semaphore.

nflags

public static void nflags(long struct,
                          int value)

Unsafe version of flags.

nhandleType

public static void nhandleType(long struct,
                               int value)

Unsafe version of handleType.

nhandle

public static void nhandle(long struct,
                           long value)

Unsafe version of handle.

nname

public static void nname(long struct,
                         java.nio.ByteBuffer value)

Unsafe version of name.

validate
```
public static void validate(long struct)
```
Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate

Class VkImportSemaphoreWin32HandleInfoKHR

Description

Handle Types Supported by VkImportSemaphoreWin32HandleInfoKHR

Valid Usage

Valid Usage (Implicit)

Host Synchronization

See Also

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

STYPE, PNEXT, SEMAPHORE, FLAGS, HANDLETYPE, HANDLE, NAME

Constructor Detail

VkImportSemaphoreWin32HandleInfoKHR

Method Detail

sizeof

sType

pNext

semaphore

flags

handleType

handle

name, nameString

sType

sType$Default

pNext

semaphore

flags

handleType

handle

name

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

malloc

calloc

malloc

calloc

nsType

npNext

nsemaphore

nflags

nhandleType

nhandle

nname

nnameString

nsType

npNext

nsemaphore

nflags

nhandleType

nhandle

Handle Types Supported by `VkImportSemaphoreWin32HandleInfoKHR`