Class VkImportMemoryHostPointerInfoEXT
- 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.NativeResourceImport 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 payload as defined in Host Access to Device Memory Objects.
Applications can import the same payload into multiple instances of Vulkan and multiple times into a given Vulkan instance. However, implementations may fail to import the same payload 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.Whether device memory objects imported from a host pointer hold a reference to their payload is undefined. As such, the application must ensure that the imported memory range remains valid and accessible for the lifetime of the imported memory object.
Valid Usage
- If
handleTypeis not 0, it must be supported for import, as reported inVkExternalMemoryProperties - If
handleTypeis not 0, it must beEXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXTorEXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT pHostPointermust be a pointer aligned to an integer multiple ofVkPhysicalDeviceExternalMemoryHostPropertiesEXT::minImportedHostPointerAlignment- If
handleTypeisEXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT,pHostPointermust be a pointer toallocationSizenumber of bytes of host memory, whereallocationSizeis the member of theVkMemoryAllocateInfostructure this structure is chained to - If
handleTypeisEXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT,pHostPointermust be a pointer toallocationSizenumber of bytes of host mapped foreign memory, whereallocationSizeis the member of theVkMemoryAllocateInfostructure this structure is chained to
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_IMPORT_MEMORY_HOST_POINTER_INFO_EXThandleTypemust be a validVkExternalMemoryHandleTypeFlagBitsvalue
Layout
struct VkImportMemoryHostPointerInfoEXT { VkStructureTypesType(); void const *pNext(); VkExternalMemoryHandleTypeFlagBitshandleType(); void *pHostPointer(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkImportMemoryHostPointerInfoEXT.BufferAn array ofVkImportMemoryHostPointerInfoEXTstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intHANDLETYPE
PHOSTPOINTER
PNEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkImportMemoryHostPointerInfoEXT(java.nio.ByteBuffer container)Creates aVkImportMemoryHostPointerInfoEXTinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static VkImportMemoryHostPointerInfoEXTcalloc()Returns a newVkImportMemoryHostPointerInfoEXTinstance allocated withmemCalloc.static VkImportMemoryHostPointerInfoEXT.Buffercalloc(int capacity)Returns a newVkImportMemoryHostPointerInfoEXT.Bufferinstance allocated withmemCalloc.static VkImportMemoryHostPointerInfoEXT.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkImportMemoryHostPointerInfoEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImportMemoryHostPointerInfoEXTcalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkImportMemoryHostPointerInfoEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImportMemoryHostPointerInfoEXTcallocStack()Deprecated.static VkImportMemoryHostPointerInfoEXT.BuffercallocStack(int capacity)Deprecated.static VkImportMemoryHostPointerInfoEXT.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkImportMemoryHostPointerInfoEXTcallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static VkImportMemoryHostPointerInfoEXTcreate()Returns a newVkImportMemoryHostPointerInfoEXTinstance allocated withBufferUtils.static VkImportMemoryHostPointerInfoEXT.Buffercreate(int capacity)Returns a newVkImportMemoryHostPointerInfoEXT.Bufferinstance allocated withBufferUtils.static VkImportMemoryHostPointerInfoEXTcreate(long address)Returns a newVkImportMemoryHostPointerInfoEXTinstance for the specified memory address.static VkImportMemoryHostPointerInfoEXT.Buffercreate(long address, int capacity)Create aVkImportMemoryHostPointerInfoEXT.Bufferinstance at the specified memory.static VkImportMemoryHostPointerInfoEXTcreateSafe(long address)static VkImportMemoryHostPointerInfoEXT.BuffercreateSafe(long address, int capacity)inthandleType()aVkExternalMemoryHandleTypeFlagBitsvalue specifying the handle type.VkImportMemoryHostPointerInfoEXThandleType(int value)Sets the specified value to thehandleType()field.static VkImportMemoryHostPointerInfoEXTmalloc()Returns a newVkImportMemoryHostPointerInfoEXTinstance allocated withmemAlloc.static VkImportMemoryHostPointerInfoEXT.Buffermalloc(int capacity)Returns a newVkImportMemoryHostPointerInfoEXT.Bufferinstance allocated withmemAlloc.static VkImportMemoryHostPointerInfoEXT.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkImportMemoryHostPointerInfoEXT.Bufferinstance allocated on the specifiedMemoryStack.static VkImportMemoryHostPointerInfoEXTmalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkImportMemoryHostPointerInfoEXTinstance allocated on the specifiedMemoryStack.static VkImportMemoryHostPointerInfoEXTmallocStack()Deprecated.static VkImportMemoryHostPointerInfoEXT.BuffermallocStack(int capacity)Deprecated.static VkImportMemoryHostPointerInfoEXT.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkImportMemoryHostPointerInfoEXTmallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static intnhandleType(long struct)Unsafe version ofhandleType().static voidnhandleType(long struct, int value)Unsafe version ofhandleType.static longnpHostPointer(long struct)Unsafe version ofpHostPointer().static voidnpHostPointer(long struct, long value)Unsafe version ofpHostPointer.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.longpHostPointer()the host pointer to import from.VkImportMemoryHostPointerInfoEXTpHostPointer(long value)Sets the specified value to thepHostPointer()field.longpNext()NULLor a pointer to a structure extending this structure.VkImportMemoryHostPointerInfoEXTpNext(long value)Sets the specified value to thepNext()field.VkImportMemoryHostPointerInfoEXTset(int sType, long pNext, int handleType, long pHostPointer)Initializes this struct with the specified values.VkImportMemoryHostPointerInfoEXTset(VkImportMemoryHostPointerInfoEXT src)Copies the specified struct data to this struct.intsizeof()intsType()the type of this structure.VkImportMemoryHostPointerInfoEXTsType(int value)Sets the specified value to thesType()field.VkImportMemoryHostPointerInfoEXTsType$Default()Sets theSTRUCTURE_TYPE_IMPORT_MEMORY_HOST_POINTER_INFO_EXTvalue to thesType()field.
-
-
-
Constructor Detail
-
VkImportMemoryHostPointerInfoEXT
public VkImportMemoryHostPointerInfoEXT(java.nio.ByteBuffer container)
Creates aVkImportMemoryHostPointerInfoEXTinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
the type of this structure.
-
pNext
public long pNext()
NULLor a pointer to a structure extending this structure.
-
handleType
public int handleType()
aVkExternalMemoryHandleTypeFlagBitsvalue specifying the handle type.
-
pHostPointer
public long pHostPointer()
the host pointer to import from.
-
sType
public VkImportMemoryHostPointerInfoEXT sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkImportMemoryHostPointerInfoEXT sType$Default()
Sets theSTRUCTURE_TYPE_IMPORT_MEMORY_HOST_POINTER_INFO_EXTvalue to thesType()field.
-
pNext
public VkImportMemoryHostPointerInfoEXT pNext(long value)
Sets the specified value to thepNext()field.
-
handleType
public VkImportMemoryHostPointerInfoEXT handleType(int value)
Sets the specified value to thehandleType()field.
-
pHostPointer
public VkImportMemoryHostPointerInfoEXT pHostPointer(long value)
Sets the specified value to thepHostPointer()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 newVkImportMemoryHostPointerInfoEXTinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkImportMemoryHostPointerInfoEXT calloc()
Returns a newVkImportMemoryHostPointerInfoEXTinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkImportMemoryHostPointerInfoEXT create()
Returns a newVkImportMemoryHostPointerInfoEXTinstance allocated withBufferUtils.
-
create
public static VkImportMemoryHostPointerInfoEXT create(long address)
Returns a newVkImportMemoryHostPointerInfoEXTinstance for the specified memory address.
-
createSafe
@Nullable public static VkImportMemoryHostPointerInfoEXT createSafe(long address)
-
malloc
public static VkImportMemoryHostPointerInfoEXT.Buffer malloc(int capacity)
Returns a newVkImportMemoryHostPointerInfoEXT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkImportMemoryHostPointerInfoEXT.Buffer calloc(int capacity)
Returns a newVkImportMemoryHostPointerInfoEXT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkImportMemoryHostPointerInfoEXT.Buffer create(int capacity)
Returns a newVkImportMemoryHostPointerInfoEXT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkImportMemoryHostPointerInfoEXT.Buffer create(long address, int capacity)
Create aVkImportMemoryHostPointerInfoEXT.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkImportMemoryHostPointerInfoEXT.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static VkImportMemoryHostPointerInfoEXT mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkImportMemoryHostPointerInfoEXT callocStack()
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkImportMemoryHostPointerInfoEXT mallocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkImportMemoryHostPointerInfoEXT callocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkImportMemoryHostPointerInfoEXT.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkImportMemoryHostPointerInfoEXT.Buffer callocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
mallocStack
@Deprecated public static VkImportMemoryHostPointerInfoEXT.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkImportMemoryHostPointerInfoEXT.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
malloc
public static VkImportMemoryHostPointerInfoEXT malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkImportMemoryHostPointerInfoEXTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkImportMemoryHostPointerInfoEXT calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkImportMemoryHostPointerInfoEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkImportMemoryHostPointerInfoEXT.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImportMemoryHostPointerInfoEXT.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkImportMemoryHostPointerInfoEXT.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImportMemoryHostPointerInfoEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType().
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext().
-
nhandleType
public static int nhandleType(long struct)
Unsafe version ofhandleType().
-
npHostPointer
public static long npHostPointer(long struct)
Unsafe version ofpHostPointer().
-
nsType
public static void nsType(long struct, int value)Unsafe version ofsType.
-
npNext
public static void npNext(long struct, long value)Unsafe version ofpNext.
-
nhandleType
public static void nhandleType(long struct, int value)Unsafe version ofhandleType.
-
npHostPointer
public static void npHostPointer(long struct, long value)Unsafe version ofpHostPointer.
-
-