VkImportMemoryWin32HandleInfoKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkImportMemoryWin32HandleInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
import Win32 memory created on the same physical device.
Description

Importing memory objects from Windows handles does not transfer ownership of the handle to the Vulkan implementation. For handle types defined as NT handles, the application must release ownership using the CloseHandle system call when the handle is no longer needed.

Applications can import the same underlying memory into multiple instances of Vulkan, into the same instance from which it was exported, and multiple times into a given Vulkan instance. In all cases, each import operation must create a distinct VkDeviceMemory object.

Valid Usage
- If handleType is not 0, it must be supported for import, as reported by VkExternalImageFormatProperties or VkExternalBufferProperties.
- The memory from which handle was exported, or the memory named by name must have been created on the same underlying physical device as device.
- If handleType is not 0, it must be defined as an NT handle or a global share handle.
- If handleType is not EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT, EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT, EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT, or EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT, name must be NULL.
- If handleType is not 0 and handle is NULL, name must name a valid memory resource of the type specified by handleType.
- If handleType is not 0 and 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 memory handle types compatibility.
- If name is not NULL, it must obey any requirements listed for handleType in external memory handle types compatibility.
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_IMPORT_MEMORY_WIN32_HANDLE_INFO_KHR
- If handleType is not 0, handleType must be a valid VkExternalMemoryHandleTypeFlagBits value
Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- handleType – specifies the type of handle or name.
- handle – the external handle to import, or NULL.
- name – a null-terminated UTF-16 string naming the underlying memory resource to import, or NULL.
Layout
```
 struct VkImportMemoryWin32HandleInfoKHR {
     VkStructureType sType;
     void const * pNext;
     VkExternalMemoryHandleTypeFlagBits handleType;
     HANDLE handle;
     LPCWSTR name;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

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

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

HANDLETYPE

HANDLE

NAME

Constructor Detail

VkImportMemoryWin32HandleInfoKHR

Method Detail

sizeof

sType

pNext

handleType

handle

name

nameString

sType

pNext

handleType

handle

name

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nhandleType

nhandle

nname

nnameString

nsType

npNext

nhandleType

nhandle

nname

validate

validate