VkExportSemaphoreWin32HandleInfoKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkExportSemaphoreWin32HandleInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying additional attributes of Windows handles exported from a semaphore.
Description

If this structure is not present, or if pAttributes is set to NULL, default security descriptor values will be used, and child processes created by the application will not inherit the handle, as described in the MSDN documentation for "Synchronization Object Security and Access Rights"¹.

For handles of the following types:

EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_BIT

The implementation must ensure the access rights allow both signal and wait operations on the semaphore.

For handles of the following types:

EXTERNAL_SEMAPHORE_HANDLE_TYPE_D3D12_FENCE_BIT

The access rights must be:

GENERIC_ALL

1

https://docs.microsoft.com/en-us/windows/win32/sync/synchronization-object-security-and-access-rights

Valid Usage
- If VkExportSemaphoreCreateInfo::handleTypes does not include EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_BIT or EXTERNAL_SEMAPHORE_HANDLE_TYPE_D3D12_FENCE_BIT, VkExportSemaphoreWin32HandleInfoKHR must not be included in the pNext chain of VkSemaphoreCreateInfo.
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_EXPORT_SEMAPHORE_WIN32_HANDLE_INFO_KHR
- If pAttributes is not NULL, pAttributes must be a valid pointer to a valid SECURITY_ATTRIBUTES value
Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- pAttributes – a pointer to a Windows SECURITY_ATTRIBUTES structure specifying security attributes of the handle.
- dwAccess – a DWORD specifying access rights of the handle.
- name – a null-terminated UTF-16 string to associate with the underlying synchronization primitive referenced by NT handles exported from the created semaphore.
Layout
```
 struct VkExportSemaphoreWin32HandleInfoKHR {
     VkStructureType sType;
     void const * pNext;
     SECURITY_ATTRIBUTES const * pAttributes;
     DWORD dwAccess;
     LPCWSTR name;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkExportSemaphoreWin32HandleInfoKHR.Buffer` An array of `VkExportSemaphoreWin32HandleInfoKHR` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`DWACCESS` The struct member offsets.
`static int`	`NAME` The struct member offsets.
`static int`	`PATTRIBUTES` The struct member offsets.
`static int`	`PNEXT` 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 and Description
`VkExportSemaphoreWin32HandleInfoKHR(java.nio.ByteBuffer container)` Creates a `VkExportSemaphoreWin32HandleInfoKHR` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VkExportSemaphoreWin32HandleInfoKHR`	`calloc()` Returns a new `VkExportSemaphoreWin32HandleInfoKHR` instance allocated with `memCalloc`.
`static VkExportSemaphoreWin32HandleInfoKHR.Buffer`	`calloc(int capacity)` Returns a new `VkExportSemaphoreWin32HandleInfoKHR.Buffer` instance allocated with `memCalloc`.
`static VkExportSemaphoreWin32HandleInfoKHR`	`callocStack()` Returns a new `VkExportSemaphoreWin32HandleInfoKHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkExportSemaphoreWin32HandleInfoKHR.Buffer`	`callocStack(int capacity)` Returns a new `VkExportSemaphoreWin32HandleInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkExportSemaphoreWin32HandleInfoKHR.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkExportSemaphoreWin32HandleInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkExportSemaphoreWin32HandleInfoKHR`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkExportSemaphoreWin32HandleInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkExportSemaphoreWin32HandleInfoKHR`	`create()` Returns a new `VkExportSemaphoreWin32HandleInfoKHR` instance allocated with `BufferUtils`.
`static VkExportSemaphoreWin32HandleInfoKHR.Buffer`	`create(int capacity)` Returns a new `VkExportSemaphoreWin32HandleInfoKHR.Buffer` instance allocated with `BufferUtils`.
`static VkExportSemaphoreWin32HandleInfoKHR`	`create(long address)` Returns a new `VkExportSemaphoreWin32HandleInfoKHR` instance for the specified memory address.
`static VkExportSemaphoreWin32HandleInfoKHR.Buffer`	`create(long address, int capacity)` Create a `VkExportSemaphoreWin32HandleInfoKHR.Buffer` instance at the specified memory.
`static VkExportSemaphoreWin32HandleInfoKHR`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkExportSemaphoreWin32HandleInfoKHR.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`dwAccess()` Returns the value of the `dwAccess` field.
`VkExportSemaphoreWin32HandleInfoKHR`	`dwAccess(int value)` Sets the specified value to the `dwAccess` field.
`static VkExportSemaphoreWin32HandleInfoKHR`	`malloc()` Returns a new `VkExportSemaphoreWin32HandleInfoKHR` instance allocated with `memAlloc`.
`static VkExportSemaphoreWin32HandleInfoKHR.Buffer`	`malloc(int capacity)` Returns a new `VkExportSemaphoreWin32HandleInfoKHR.Buffer` instance allocated with `memAlloc`.
`static VkExportSemaphoreWin32HandleInfoKHR`	`mallocStack()` Returns a new `VkExportSemaphoreWin32HandleInfoKHR` instance allocated on the thread-local `MemoryStack`.
`static VkExportSemaphoreWin32HandleInfoKHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkExportSemaphoreWin32HandleInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkExportSemaphoreWin32HandleInfoKHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkExportSemaphoreWin32HandleInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkExportSemaphoreWin32HandleInfoKHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkExportSemaphoreWin32HandleInfoKHR` instance allocated on the specified `MemoryStack`.
`java.nio.ByteBuffer`	`name()` Returns a `ByteBuffer` view of the null-terminated string pointed to by the `name` field.
`VkExportSemaphoreWin32HandleInfoKHR`	`name(java.nio.ByteBuffer value)` Sets the address of the specified encoded string to the `name` field.
`java.lang.String`	`nameString()` Decodes the null-terminated string pointed to by the `name` field.
`static int`	`ndwAccess(long struct)` Unsafe version of `dwAccess()`.
`static void`	`ndwAccess(long struct, int value)` Unsafe version of `dwAccess`.
`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 org.lwjgl.system.windows.SECURITY_ATTRIBUTES`	`npAttributes(long struct)` Unsafe version of `pAttributes()`.
`static void`	`npAttributes(long struct, org.lwjgl.system.windows.SECURITY_ATTRIBUTES value)` Unsafe version of `pAttributes`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`org.lwjgl.system.windows.SECURITY_ATTRIBUTES`	`pAttributes()` Returns a `SECURITY_ATTRIBUTES` view of the struct pointed to by the `pAttributes` field.
`VkExportSemaphoreWin32HandleInfoKHR`	`pAttributes(org.lwjgl.system.windows.SECURITY_ATTRIBUTES value)` Sets the address of the specified `SECURITY_ATTRIBUTES` to the `pAttributes` field.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkExportSemaphoreWin32HandleInfoKHR`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkExportSemaphoreWin32HandleInfoKHR`	`set(int sType, long pNext, org.lwjgl.system.windows.SECURITY_ATTRIBUTES pAttributes, int dwAccess, java.nio.ByteBuffer name)` Initializes this struct with the specified values.
`VkExportSemaphoreWin32HandleInfoKHR`	`set(VkExportSemaphoreWin32HandleInfoKHR src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkExportSemaphoreWin32HandleInfoKHR`	`sType(int value)` Sets the specified value to the `sType` field.
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.

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

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

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

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - STYPE
```
public static final int STYPE
```
    The struct member offsets.
  - PNEXT
```
public static final int PNEXT
```
    The struct member offsets.
  - PATTRIBUTES
```
public static final int PATTRIBUTES
```
    The struct member offsets.
  - DWACCESS
```
public static final int DWACCESS
```
    The struct member offsets.
  - NAME
```
public static final int NAME
```
    The struct member offsets.
- Constructor Detail
  - VkExportSemaphoreWin32HandleInfoKHR
```
public VkExportSemaphoreWin32HandleInfoKHR(java.nio.ByteBuffer container)
```
    Creates a VkExportSemaphoreWin32HandleInfoKHR 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()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - pAttributes
```
@Nullable
public org.lwjgl.system.windows.SECURITY_ATTRIBUTES pAttributes()
```
    Returns a SECURITY_ATTRIBUTES view of the struct pointed to by the pAttributes field.
  - dwAccess
```
public int dwAccess()
```
    Returns the value of the dwAccess field.
  - name
```
public java.nio.ByteBuffer name()
```
    Returns a ByteBuffer view of the null-terminated string pointed to by the name field.
  - nameString
```
public java.lang.String nameString()
```
    Decodes the null-terminated string pointed to by the name field.
  - sType
```
public VkExportSemaphoreWin32HandleInfoKHR sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkExportSemaphoreWin32HandleInfoKHR pNext(long value)
```
    Sets the specified value to the pNext field.
  - pAttributes
```
public VkExportSemaphoreWin32HandleInfoKHR pAttributes(@Nullable
                                                       org.lwjgl.system.windows.SECURITY_ATTRIBUTES value)
```
    Sets the address of the specified SECURITY_ATTRIBUTES to the pAttributes field.
  - dwAccess
```
public VkExportSemaphoreWin32HandleInfoKHR dwAccess(int value)
```
    Sets the specified value to the dwAccess field.
  - name
```
public VkExportSemaphoreWin32HandleInfoKHR name(java.nio.ByteBuffer value)
```
    Sets the address of the specified encoded string to the name field.
  - set
```
public VkExportSemaphoreWin32HandleInfoKHR set(int sType,
                                               long pNext,
                                               @Nullable
                                               org.lwjgl.system.windows.SECURITY_ATTRIBUTES pAttributes,
                                               int dwAccess,
                                               java.nio.ByteBuffer name)
```
    Initializes this struct with the specified values.
  - set
```
public VkExportSemaphoreWin32HandleInfoKHR set(VkExportSemaphoreWin32HandleInfoKHR src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkExportSemaphoreWin32HandleInfoKHR malloc()
```
    Returns a new VkExportSemaphoreWin32HandleInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkExportSemaphoreWin32HandleInfoKHR calloc()
```
    Returns a new VkExportSemaphoreWin32HandleInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkExportSemaphoreWin32HandleInfoKHR create()
```
    Returns a new VkExportSemaphoreWin32HandleInfoKHR instance allocated with BufferUtils.
  - create
```
public static VkExportSemaphoreWin32HandleInfoKHR create(long address)
```
    Returns a new VkExportSemaphoreWin32HandleInfoKHR instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkExportSemaphoreWin32HandleInfoKHR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkExportSemaphoreWin32HandleInfoKHR.Buffer malloc(int capacity)
```
    Returns a new VkExportSemaphoreWin32HandleInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkExportSemaphoreWin32HandleInfoKHR.Buffer calloc(int capacity)
```
    Returns a new VkExportSemaphoreWin32HandleInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkExportSemaphoreWin32HandleInfoKHR.Buffer create(int capacity)
```
    Returns a new VkExportSemaphoreWin32HandleInfoKHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkExportSemaphoreWin32HandleInfoKHR.Buffer create(long address,
                                                                int capacity)
```
    Create a VkExportSemaphoreWin32HandleInfoKHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkExportSemaphoreWin32HandleInfoKHR.Buffer createSafe(long address,
                                                                              int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkExportSemaphoreWin32HandleInfoKHR mallocStack()
```
    Returns a new VkExportSemaphoreWin32HandleInfoKHR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkExportSemaphoreWin32HandleInfoKHR callocStack()
```
    Returns a new VkExportSemaphoreWin32HandleInfoKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkExportSemaphoreWin32HandleInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkExportSemaphoreWin32HandleInfoKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkExportSemaphoreWin32HandleInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkExportSemaphoreWin32HandleInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkExportSemaphoreWin32HandleInfoKHR.Buffer mallocStack(int capacity)
```
    Returns a new VkExportSemaphoreWin32HandleInfoKHR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkExportSemaphoreWin32HandleInfoKHR.Buffer callocStack(int capacity)
```
    Returns a new VkExportSemaphoreWin32HandleInfoKHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkExportSemaphoreWin32HandleInfoKHR.Buffer mallocStack(int capacity,
                                                                     org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkExportSemaphoreWin32HandleInfoKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkExportSemaphoreWin32HandleInfoKHR.Buffer callocStack(int capacity,
                                                                     org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkExportSemaphoreWin32HandleInfoKHR.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().
  - npAttributes
```
@Nullable
public static org.lwjgl.system.windows.SECURITY_ATTRIBUTES npAttributes(long struct)
```
    Unsafe version of pAttributes().
  - ndwAccess
```
public static int ndwAccess(long struct)
```
    Unsafe version of dwAccess().
  - 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.
  - npAttributes
```
public static void npAttributes(long struct,
                                @Nullable
                                org.lwjgl.system.windows.SECURITY_ATTRIBUTES value)
```
    Unsafe version of pAttributes.
  - ndwAccess
```
public static void ndwAccess(long struct,
                             int value)
```
    Unsafe version of dwAccess.
  - 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
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class VkExportSemaphoreWin32HandleInfoKHR

Description

Valid Usage

Valid Usage (Implicit)

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

PATTRIBUTES

DWACCESS

NAME

Constructor Detail

VkExportSemaphoreWin32HandleInfoKHR

Method Detail

sizeof

sType

pNext

pAttributes

dwAccess

name

nameString

sType

pNext

pAttributes

dwAccess

name

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

npAttributes

ndwAccess

nname

nnameString

nsType

npNext

npAttributes

ndwAccess

nname

validate

validate