VkFenceGetWin32HandleInfoKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkFenceGetWin32HandleInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure describing a Win32 handle fence export operation.
Description

The properties of the handle returned depend on the value of handleType. See VkExternalFenceHandleTypeFlagBits for a description of the properties of the defined external fence handle types.

Valid Usage
- handleType must have been included in VkExportFenceCreateInfo::handleTypes when the fence’s current payload was created.
- If handleType is defined as an NT handle, GetFenceWin32HandleKHR must be called no more than once for each valid unique combination of fence and handleType.
- fence must not currently have its payload replaced by an imported payload as described below in Importing Fence Payloads unless that imported payload’s handle type was included in VkExternalFenceProperties::exportFromImportedHandleTypes for handleType.
- If handleType refers to a handle type with copy payload transference semantics, fence must be signaled, or have an associated fence signal operation pending execution.
- handleType must be defined as an NT handle or a global share handle.
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_FENCE_GET_WIN32_HANDLE_INFO_KHR
- pNext must be NULL
- fence must be a valid VkFence handle
- handleType must be a valid VkExternalFenceHandleTypeFlagBits value
See Also

GetFenceWin32HandleKHR

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- fence – the fence from which state will be exported.
- handleType – the type of handle requested.
Layout
```
 struct VkFenceGetWin32HandleInfoKHR {
     VkStructureType sType;
     void const * pNext;
     VkFence fence;
     VkExternalFenceHandleTypeFlagBits handleType;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkFenceGetWin32HandleInfoKHR.Buffer
An array of VkFenceGetWin32HandleInfoKHR 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`	`VkFenceGetWin32HandleInfoKHR.Buffer` An array of `VkFenceGetWin32HandleInfoKHR` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`FENCE` The struct member offsets.
`static int`	`HANDLETYPE` 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
`VkFenceGetWin32HandleInfoKHR(java.nio.ByteBuffer container)` Creates a `VkFenceGetWin32HandleInfoKHR` 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 VkFenceGetWin32HandleInfoKHR`	`calloc()` Returns a new `VkFenceGetWin32HandleInfoKHR` instance allocated with `memCalloc`.
`static VkFenceGetWin32HandleInfoKHR.Buffer`	`calloc(int capacity)` Returns a new `VkFenceGetWin32HandleInfoKHR.Buffer` instance allocated with `memCalloc`.
`static VkFenceGetWin32HandleInfoKHR`	`callocStack()` Returns a new `VkFenceGetWin32HandleInfoKHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkFenceGetWin32HandleInfoKHR.Buffer`	`callocStack(int capacity)` Returns a new `VkFenceGetWin32HandleInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkFenceGetWin32HandleInfoKHR.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkFenceGetWin32HandleInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkFenceGetWin32HandleInfoKHR`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkFenceGetWin32HandleInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkFenceGetWin32HandleInfoKHR`	`create()` Returns a new `VkFenceGetWin32HandleInfoKHR` instance allocated with `BufferUtils`.
`static VkFenceGetWin32HandleInfoKHR.Buffer`	`create(int capacity)` Returns a new `VkFenceGetWin32HandleInfoKHR.Buffer` instance allocated with `BufferUtils`.
`static VkFenceGetWin32HandleInfoKHR`	`create(long address)` Returns a new `VkFenceGetWin32HandleInfoKHR` instance for the specified memory address.
`static VkFenceGetWin32HandleInfoKHR.Buffer`	`create(long address, int capacity)` Create a `VkFenceGetWin32HandleInfoKHR.Buffer` instance at the specified memory.
`static VkFenceGetWin32HandleInfoKHR`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkFenceGetWin32HandleInfoKHR.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`long`	`fence()` Returns the value of the `fence` field.
`VkFenceGetWin32HandleInfoKHR`	`fence(long value)` Sets the specified value to the `fence` field.
`int`	`handleType()` Returns the value of the `handleType` field.
`VkFenceGetWin32HandleInfoKHR`	`handleType(int value)` Sets the specified value to the `handleType` field.
`static VkFenceGetWin32HandleInfoKHR`	`malloc()` Returns a new `VkFenceGetWin32HandleInfoKHR` instance allocated with `memAlloc`.
`static VkFenceGetWin32HandleInfoKHR.Buffer`	`malloc(int capacity)` Returns a new `VkFenceGetWin32HandleInfoKHR.Buffer` instance allocated with `memAlloc`.
`static VkFenceGetWin32HandleInfoKHR`	`mallocStack()` Returns a new `VkFenceGetWin32HandleInfoKHR` instance allocated on the thread-local `MemoryStack`.
`static VkFenceGetWin32HandleInfoKHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkFenceGetWin32HandleInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkFenceGetWin32HandleInfoKHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkFenceGetWin32HandleInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkFenceGetWin32HandleInfoKHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkFenceGetWin32HandleInfoKHR` instance allocated on the specified `MemoryStack`.
`static long`	`nfence(long struct)` Unsafe version of `fence()`.
`static void`	`nfence(long struct, long value)` Unsafe version of `fence`.
`static int`	`nhandleType(long struct)` Unsafe version of `handleType()`.
`static void`	`nhandleType(long struct, int value)` Unsafe version of `handleType`.
`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`.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkFenceGetWin32HandleInfoKHR`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkFenceGetWin32HandleInfoKHR`	`set(int sType, long pNext, long fence, int handleType)` Initializes this struct with the specified values.
`VkFenceGetWin32HandleInfoKHR`	`set(VkFenceGetWin32HandleInfoKHR src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkFenceGetWin32HandleInfoKHR`	`sType(int value)` Sets the specified value to the `sType` field.

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.
  - FENCE
```
public static final int FENCE
```
    The struct member offsets.
  - HANDLETYPE
```
public static final int HANDLETYPE
```
    The struct member offsets.
- Constructor Detail
  - VkFenceGetWin32HandleInfoKHR
```
public VkFenceGetWin32HandleInfoKHR(java.nio.ByteBuffer container)
```
    Creates a VkFenceGetWin32HandleInfoKHR 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.
  - fence
```
public long fence()
```
    Returns the value of the fence field.
  - handleType
```
public int handleType()
```
    Returns the value of the handleType field.
  - sType
```
public VkFenceGetWin32HandleInfoKHR sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkFenceGetWin32HandleInfoKHR pNext(long value)
```
    Sets the specified value to the pNext field.
  - fence
```
public VkFenceGetWin32HandleInfoKHR fence(long value)
```
    Sets the specified value to the fence field.
  - handleType
```
public VkFenceGetWin32HandleInfoKHR handleType(int value)
```
    Sets the specified value to the handleType field.
  - set
```
public VkFenceGetWin32HandleInfoKHR set(int sType,
                                        long pNext,
                                        long fence,
                                        int handleType)
```
    Initializes this struct with the specified values.
  - set
```
public VkFenceGetWin32HandleInfoKHR set(VkFenceGetWin32HandleInfoKHR src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkFenceGetWin32HandleInfoKHR malloc()
```
    Returns a new VkFenceGetWin32HandleInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkFenceGetWin32HandleInfoKHR calloc()
```
    Returns a new VkFenceGetWin32HandleInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkFenceGetWin32HandleInfoKHR create()
```
    Returns a new VkFenceGetWin32HandleInfoKHR instance allocated with BufferUtils.
  - create
```
public static VkFenceGetWin32HandleInfoKHR create(long address)
```
    Returns a new VkFenceGetWin32HandleInfoKHR instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkFenceGetWin32HandleInfoKHR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkFenceGetWin32HandleInfoKHR.Buffer malloc(int capacity)
```
    Returns a new VkFenceGetWin32HandleInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkFenceGetWin32HandleInfoKHR.Buffer calloc(int capacity)
```
    Returns a new VkFenceGetWin32HandleInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkFenceGetWin32HandleInfoKHR.Buffer create(int capacity)
```
    Returns a new VkFenceGetWin32HandleInfoKHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkFenceGetWin32HandleInfoKHR.Buffer create(long address,
                                                         int capacity)
```
    Create a VkFenceGetWin32HandleInfoKHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkFenceGetWin32HandleInfoKHR.Buffer createSafe(long address,
                                                                       int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkFenceGetWin32HandleInfoKHR mallocStack()
```
    Returns a new VkFenceGetWin32HandleInfoKHR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkFenceGetWin32HandleInfoKHR callocStack()
```
    Returns a new VkFenceGetWin32HandleInfoKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkFenceGetWin32HandleInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkFenceGetWin32HandleInfoKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkFenceGetWin32HandleInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkFenceGetWin32HandleInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkFenceGetWin32HandleInfoKHR.Buffer mallocStack(int capacity)
```
    Returns a new VkFenceGetWin32HandleInfoKHR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkFenceGetWin32HandleInfoKHR.Buffer callocStack(int capacity)
```
    Returns a new VkFenceGetWin32HandleInfoKHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkFenceGetWin32HandleInfoKHR.Buffer mallocStack(int capacity,
                                                              org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkFenceGetWin32HandleInfoKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkFenceGetWin32HandleInfoKHR.Buffer callocStack(int capacity,
                                                              org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkFenceGetWin32HandleInfoKHR.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().
  - nfence
```
public static long nfence(long struct)
```
    Unsafe version of fence().
  - nhandleType
```
public static int nhandleType(long struct)
```
    Unsafe version of handleType().
  - 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.
  - nfence
```
public static void nfence(long struct,
                          long value)
```
    Unsafe version of fence.
  - nhandleType
```
public static void nhandleType(long struct,
                               int value)
```
    Unsafe version of handleType.

Class VkFenceGetWin32HandleInfoKHR

Description

Valid Usage

Valid Usage (Implicit)

See Also

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

FENCE

HANDLETYPE

Constructor Detail

VkFenceGetWin32HandleInfoKHR

Method Detail

sizeof

sType

pNext

fence

handleType

sType

pNext

fence

handleType

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nfence

nhandleType

nsType

npNext

nfence

nhandleType