Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkImportMemoryHostPointerInfoEXT

extends Struct<VkImportMemoryHostPointerInfoEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

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 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
Valid Usage (Implicit)

Layout


struct VkImportMemoryHostPointerInfoEXT {
    VkStructureType sType;
    void const * pNext;
    VkExternalMemoryHandleTypeFlagBits handleType;
    void * pHostPointer;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
HANDLETYPE

The struct member offsets.

public static final int
PHOSTPOINTER

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkImportMemoryHostPointerInfoEXT(ByteBuffer container)

Creates a VkImportMemoryHostPointerInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkImportMemoryHostPointerInfoEXT
calloc()

Returns a new VkImportMemoryHostPointerInfoEXT instance allocated with memCalloc.

public static VkImportMemoryHostPointerInfoEXT.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkImportMemoryHostPointerInfoEXT.Buffer instance allocated with memCalloc.

public static VkImportMemoryHostPointerInfoEXT
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkImportMemoryHostPointerInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkImportMemoryHostPointerInfoEXT.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkImportMemoryHostPointerInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkImportMemoryHostPointerInfoEXT
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkImportMemoryHostPointerInfoEXT
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkImportMemoryHostPointerInfoEXT.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkImportMemoryHostPointerInfoEXT.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkImportMemoryHostPointerInfoEXT
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkImportMemoryHostPointerInfoEXT
create()

Returns a new VkImportMemoryHostPointerInfoEXT instance allocated with BufferUtils.

public static VkImportMemoryHostPointerInfoEXT
create(long address)

Returns a new VkImportMemoryHostPointerInfoEXT instance for the specified memory address.

public static VkImportMemoryHostPointerInfoEXT.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkImportMemoryHostPointerInfoEXT.Buffer instance allocated with BufferUtils.

public static VkImportMemoryHostPointerInfoEXT.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkImportMemoryHostPointerInfoEXT.Buffer instance at the specified memory.

public static VkImportMemoryHostPointerInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkImportMemoryHostPointerInfoEXT.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public int
handleType()

a VkExternalMemoryHandleTypeFlagBits value specifying the handle type.

public VkImportMemoryHostPointerInfoEXT
handleType(int value)

Sets the specified value to the handleType field.

public static VkImportMemoryHostPointerInfoEXT
malloc()

Returns a new VkImportMemoryHostPointerInfoEXT instance allocated with memAlloc.

public static VkImportMemoryHostPointerInfoEXT.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkImportMemoryHostPointerInfoEXT.Buffer instance allocated with memAlloc.

public static VkImportMemoryHostPointerInfoEXT
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkImportMemoryHostPointerInfoEXT instance allocated on the specified MemoryStack.

public static VkImportMemoryHostPointerInfoEXT.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkImportMemoryHostPointerInfoEXT.Buffer instance allocated on the specified MemoryStack.

public static VkImportMemoryHostPointerInfoEXT
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkImportMemoryHostPointerInfoEXT
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkImportMemoryHostPointerInfoEXT.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkImportMemoryHostPointerInfoEXT.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
nhandleType(long struct)

Unsafe version of handleType.

public static void
nhandleType(long struct, int value)

Unsafe version of handleType.

public static long
npHostPointer(long struct)

Unsafe version of pHostPointer.

public static void
npHostPointer(long struct, long value)

Unsafe version of pHostPointer.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pHostPointer()

the host pointer to import from.

public VkImportMemoryHostPointerInfoEXT
pHostPointer(long value)

Sets the specified value to the pHostPointer field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkImportMemoryHostPointerInfoEXT
pNext(long value)

Sets the specified value to the pNext field.

public VkImportMemoryHostPointerInfoEXT
set(int sType, long pNext, int handleType, long pHostPointer)

Initializes this struct with the specified values.

public VkImportMemoryHostPointerInfoEXT

Returns:

this struct
set
(VkImportMemoryHostPointerInfoEXT
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkImportMemoryHostPointerInfoEXT
sType(int value)

Sets the specified value to the sType field.

public VkImportMemoryHostPointerInfoEXT
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

HANDLETYPEback to summary
public static final int HANDLETYPE

The struct member offsets.

PHOSTPOINTERback to summary
public static final int PHOSTPOINTER

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkImportMemoryHostPointerInfoEXTback to summary
protected VkImportMemoryHostPointerInfoEXT(long address, ByteBuffer container)
VkImportMemoryHostPointerInfoEXTback to summary
public VkImportMemoryHostPointerInfoEXT(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

callocback to summary
public static VkImportMemoryHostPointerInfoEXT calloc()

Returns a new VkImportMemoryHostPointerInfoEXT instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkImportMemoryHostPointerInfoEXT.Buffer calloc(int capacity)

Returns a new VkImportMemoryHostPointerInfoEXT.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkImportMemoryHostPointerInfoEXT calloc(MemoryStack stack)

Returns a new VkImportMemoryHostPointerInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkImportMemoryHostPointerInfoEXT.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkImportMemoryHostPointerInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkImportMemoryHostPointerInfoEXT callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkImportMemoryHostPointerInfoEXT callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkImportMemoryHostPointerInfoEXT.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkImportMemoryHostPointerInfoEXT.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected VkImportMemoryHostPointerInfoEXT create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkImportMemoryHostPointerInfoEXT create()

Returns a new VkImportMemoryHostPointerInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkImportMemoryHostPointerInfoEXT create(long address)

Returns a new VkImportMemoryHostPointerInfoEXT instance for the specified memory address.

createback to summary
public static VkImportMemoryHostPointerInfoEXT.Buffer create(int capacity)

Returns a new VkImportMemoryHostPointerInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkImportMemoryHostPointerInfoEXT.Buffer create(long address, int capacity)

Create a VkImportMemoryHostPointerInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkImportMemoryHostPointerInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkImportMemoryHostPointerInfoEXT.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
handleTypeback to summary
public int handleType()

a VkExternalMemoryHandleTypeFlagBits value specifying the handle type.

Annotations
@NativeType:VkExternalMemoryHandleTypeFlagBits
handleTypeback to summary
public VkImportMemoryHostPointerInfoEXT handleType(int value)

Sets the specified value to the handleType field.

mallocback to summary
public static VkImportMemoryHostPointerInfoEXT malloc()

Returns a new VkImportMemoryHostPointerInfoEXT instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkImportMemoryHostPointerInfoEXT.Buffer malloc(int capacity)

Returns a new VkImportMemoryHostPointerInfoEXT.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkImportMemoryHostPointerInfoEXT malloc(MemoryStack stack)

Returns a new VkImportMemoryHostPointerInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkImportMemoryHostPointerInfoEXT.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkImportMemoryHostPointerInfoEXT.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkImportMemoryHostPointerInfoEXT mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkImportMemoryHostPointerInfoEXT mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkImportMemoryHostPointerInfoEXT.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkImportMemoryHostPointerInfoEXT.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nhandleTypeback to summary
public static int nhandleType(long struct)

Unsafe version of handleType.

nhandleTypeback to summary
public static void nhandleType(long struct, int value)

Unsafe version of handleType.

npHostPointerback to summary
public static long npHostPointer(long struct)

Unsafe version of pHostPointer.

npHostPointerback to summary
public static void npHostPointer(long struct, long value)

Unsafe version of pHostPointer.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pHostPointerback to summary
public long pHostPointer()

the host pointer to import from.

Annotations
@NativeType:void *
pHostPointerback to summary
public VkImportMemoryHostPointerInfoEXT pHostPointer(long value)

Sets the specified value to the pHostPointer field.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkImportMemoryHostPointerInfoEXT pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkImportMemoryHostPointerInfoEXT set(int sType, long pNext, int handleType, long pHostPointer)

Initializes this struct with the specified values.

setback to summary
public VkImportMemoryHostPointerInfoEXT set(VkImportMemoryHostPointerInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkImportMemoryHostPointerInfoEXT

the source struct

Returns:VkImportMemoryHostPointerInfoEXT

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkImportMemoryHostPointerInfoEXT sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkImportMemoryHostPointerInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_IMPORT_MEMORY_HOST_POINTER_INFO_EXT value to the sType field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkImportMemoryHostPointerInfoEXT.Buffer

extends StructBuffer<VkImportMemoryHostPointerInfoEXT, VkImportMemoryHostPointerInfoEXT.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkImportMemoryHostPointerInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkImportMemoryHostPointerInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkImportMemoryHostPointerInfoEXT.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VkImportMemoryHostPointerInfoEXT
public int

Returns:

the value of the VkImportMemoryHostPointerInfoEXT#handleType field.
handleType
()

public VkImportMemoryHostPointerInfoEXT.Buffer
handleType(int value)

Sets the specified value to the VkImportMemoryHostPointerInfoEXT#handleType field.

public long
public VkImportMemoryHostPointerInfoEXT.Buffer
pHostPointer(long value)

Sets the specified value to the VkImportMemoryHostPointerInfoEXT#pHostPointer field.

public long

Returns:

the value of the VkImportMemoryHostPointerInfoEXT#pNext field.
pNext
()

public VkImportMemoryHostPointerInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkImportMemoryHostPointerInfoEXT#pNext field.

protected VkImportMemoryHostPointerInfoEXT.Buffer
public int

Returns:

the value of the VkImportMemoryHostPointerInfoEXT#sType field.
sType
()

public VkImportMemoryHostPointerInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkImportMemoryHostPointerInfoEXT#sType field.

public VkImportMemoryHostPointerInfoEXT.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkImportMemoryHostPointerInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkImportMemoryHostPointerInfoEXT.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkImportMemoryHostPointerInfoEXT#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VkImportMemoryHostPointerInfoEXT getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
handleTypeback to summary
public int handleType()
Returns:int

the value of the VkImportMemoryHostPointerInfoEXT#handleType field.

Annotations
@NativeType:VkExternalMemoryHandleTypeFlagBits
handleTypeback to summary
public VkImportMemoryHostPointerInfoEXT.Buffer handleType(int value)

Sets the specified value to the VkImportMemoryHostPointerInfoEXT#handleType field.

pHostPointerback to summary
public long pHostPointer()
Returns:long

the value of the VkImportMemoryHostPointerInfoEXT#pHostPointer field.

Annotations
@NativeType:void *
pHostPointerback to summary
public VkImportMemoryHostPointerInfoEXT.Buffer pHostPointer(long value)

Sets the specified value to the VkImportMemoryHostPointerInfoEXT#pHostPointer field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkImportMemoryHostPointerInfoEXT#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkImportMemoryHostPointerInfoEXT.Buffer pNext(long value)

Sets the specified value to the VkImportMemoryHostPointerInfoEXT#pNext field.

selfback to summary
protected VkImportMemoryHostPointerInfoEXT.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkImportMemoryHostPointerInfoEXT#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkImportMemoryHostPointerInfoEXT.Buffer sType(int value)

Sets the specified value to the VkImportMemoryHostPointerInfoEXT#sType field.

sType$Defaultback to summary
public VkImportMemoryHostPointerInfoEXT.Buffer sType$Default()

Sets the STRUCTURE_TYPE_IMPORT_MEMORY_HOST_POINTER_INFO_EXT value to the VkImportMemoryHostPointerInfoEXT#sType field.