VkImportMemoryHostPointerInfoEXT (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkImportMemoryHostPointerInfoEXT
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
import memory from a host pointer.
Description

Importing memory from a host pointer shares ownership of the memory between the host and the Vulkan implementation. The application can continue to access the memory through the host pointer but it is the application's responsibility to synchronize device and non-device access to the underlying memory as defined in Host Access to Device Memory Objects.

Applications can import the same underlying memory into multiple instances of Vulkan and multiple times into a given Vulkan instance. However, implementations may fail to import the same underlying memory multiple times into a given physical device due to platform constraints.

Importing memory from a particular host pointer may not be possible due to additional platform-specific restrictions beyond the scope of this specification in which case the implementation must fail the memory import operation with the error code ERROR_INVALID_EXTERNAL_HANDLE_KHR.

The application must ensure that the imported memory range remains valid and accessible for the lifetime of the imported memory object.

Valid Usage
- If handleType is not 0, it must be supported for import, as reported in VkExternalMemoryProperties
- If handleType is not 0, it must be EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT or EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT
- pHostPointer must be a pointer aligned to an integer multiple of VkPhysicalDeviceExternalMemoryHostPropertiesEXT::minImportedHostPointerAlignment
- If handleType is EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT, pHostPointer must be a pointer to allocationSize number of bytes of host memory, where allocationSize is the member of the VkMemoryAllocateInfo structure this structure is chained to
- If handleType is EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT, pHostPointer must be a pointer to allocationSize number of bytes of host mapped foreign memory, where allocationSize is the member of the VkMemoryAllocateInfo structure this structure is chained to
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_IMPORT_MEMORY_HOST_POINTER_INFO_EXT
- 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 handle type.
- pHostPointer – the host pointer to import from.
Layout
```
 struct VkImportMemoryHostPointerInfoEXT {
     VkStructureType sType;
     void const * pNext;
     VkExternalMemoryHandleTypeFlagBits handleType;
     void * pHostPointer;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

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

Class VkImportMemoryHostPointerInfoEXT

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

PHOSTPOINTER

Constructor Detail

VkImportMemoryHostPointerInfoEXT

Method Detail

sizeof

sType

pNext

handleType

pHostPointer

sType

pNext

handleType

pHostPointer

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nhandleType

npHostPointer

nsType

npNext

nhandleType

npHostPointer