Class VkImportMemoryWin32HandleInfoKHR
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
Description
Importing memory object payloads 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 handle ownership using the CloseHandle system call when the handle is no longer needed. For handle types defined as NT handles, the imported memory object holds a reference to its payload.
Note
Non-NT handle import operations do not add a reference to their associated payload. If the original object owning the payload is destroyed, all resources and handles sharing that payload will become invalid.
Applications can import the same payload 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
handleTypeis not 0, it must be supported for import, as reported byVkExternalImageFormatPropertiesorVkExternalBufferProperties - The memory from which
handlewas exported, or the memory named bynamemust have been created on the same underlying physical device asdevice - If
handleTypeis not 0, it must be defined as an NT handle or a global share handle - If
handleTypeis notEXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT,EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT,EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT, orEXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT,namemust beNULL - If
handleTypeis not 0 andhandleisNULL,namemust name a valid memory resource of the type specified byhandleType - If
handleTypeis not 0 andnameisNULL,handlemust be a valid handle of the type specified byhandleType - If
handleis notNULL,namemust beNULL - If
handleis notNULL, it must obey any requirements listed forhandleTypein external memory handle types compatibility - If
nameis notNULL, it must obey any requirements listed forhandleTypein external memory handle types compatibility
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_IMPORT_MEMORY_WIN32_HANDLE_INFO_KHR- If
handleTypeis not 0,handleTypemust be a validVkExternalMemoryHandleTypeFlagBitsvalue
Layout
struct VkImportMemoryWin32HandleInfoKHR {
VkStructureType sType();
void const * pNext();
VkExternalMemoryHandleTypeFlagBits handleType();
HANDLE handle();
LPCWSTR name();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkImportMemoryWin32HandleInfoKHRstructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkImportMemoryWin32HandleInfoKHR(ByteBuffer container) Creates aVkImportMemoryWin32HandleInfoKHRinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkImportMemoryWin32HandleInfoKHRinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkImportMemoryWin32HandleInfoKHR.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImportMemoryWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkImportMemoryWin32HandleInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.Deprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.create()Returns a newVkImportMemoryWin32HandleInfoKHRinstance allocated withBufferUtils.create(int capacity) Returns a newVkImportMemoryWin32HandleInfoKHR.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkImportMemoryWin32HandleInfoKHRinstance for the specified memory address.create(long address, int capacity) Create aVkImportMemoryWin32HandleInfoKHR.Bufferinstance at the specified memory.static @Nullable VkImportMemoryWin32HandleInfoKHRcreateSafe(long address) static @Nullable VkImportMemoryWin32HandleInfoKHR.BuffercreateSafe(long address, int capacity) longhandle()NULLor the external handle to import.handle(long value) Sets the specified value to thehandle()field.intaVkExternalMemoryHandleTypeFlagBitsvalue specifying the type ofhandleorname.handleType(int value) Sets the specified value to thehandleType()field.malloc()Returns a newVkImportMemoryWin32HandleInfoKHRinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkImportMemoryWin32HandleInfoKHR.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImportMemoryWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkImportMemoryWin32HandleInfoKHRinstance allocated on the specifiedMemoryStack.Deprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.name()NULLor a null-terminated UTF-16 string naming the payload to import.name(ByteBuffer value) Sets the address of the specified encoded string to thename()field.NULLor a null-terminated UTF-16 string naming the payload to import.static longnhandle(long struct) Unsafe version ofhandle().static voidnhandle(long struct, long value) Unsafe version ofhandle.static intnhandleType(long struct) Unsafe version ofhandleType().static voidnhandleType(long struct, int value) Unsafe version ofhandleType.static ByteBuffernname(long struct) Unsafe version ofname().static voidnname(long struct, ByteBuffer value) Unsafe version ofname.static StringnnameString(long struct) Unsafe version ofnameString().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.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.set(int sType, long pNext, int handleType, long handle, ByteBuffer name) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_IMPORT_MEMORY_WIN32_HANDLE_INFO_KHRvalue to thesType()field.static voidvalidate(long struct) Validates pointer members that should not beNULL.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
HANDLETYPE
public static final int HANDLETYPEThe struct member offsets. -
HANDLE
public static final int HANDLEThe struct member offsets. -
NAME
public static final int NAMEThe struct member offsets.
-
-
Constructor Details
-
VkImportMemoryWin32HandleInfoKHR
Creates aVkImportMemoryWin32HandleInfoKHRinstance 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 Details
-
sizeof
public int sizeof()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkImportMemoryWin32HandleInfoKHR>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
handleType
public int handleType()aVkExternalMemoryHandleTypeFlagBitsvalue specifying the type ofhandleorname. -
handle
public long handle()NULLor the external handle to import. -
name
NULLor a null-terminated UTF-16 string naming the payload to import. -
nameString
NULLor a null-terminated UTF-16 string naming the payload to import. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_IMPORT_MEMORY_WIN32_HANDLE_INFO_KHRvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
handleType
Sets the specified value to thehandleType()field. -
handle
Sets the specified value to thehandle()field. -
name
Sets the address of the specified encoded string to thename()field. -
set
public VkImportMemoryWin32HandleInfoKHR set(int sType, long pNext, int handleType, long handle, ByteBuffer name) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkImportMemoryWin32HandleInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkImportMemoryWin32HandleInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkImportMemoryWin32HandleInfoKHRinstance allocated withBufferUtils. -
create
Returns a newVkImportMemoryWin32HandleInfoKHRinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkImportMemoryWin32HandleInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkImportMemoryWin32HandleInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkImportMemoryWin32HandleInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkImportMemoryWin32HandleInfoKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkImportMemoryWin32HandleInfoKHR.Buffer createSafe(long address, int capacity) -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
@Deprecated public static VkImportMemoryWin32HandleInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
@Deprecated public static VkImportMemoryWin32HandleInfoKHR callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
mallocStack
@Deprecated public static VkImportMemoryWin32HandleInfoKHR.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 VkImportMemoryWin32HandleInfoKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkImportMemoryWin32HandleInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkImportMemoryWin32HandleInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkImportMemoryWin32HandleInfoKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImportMemoryWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkImportMemoryWin32HandleInfoKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImportMemoryWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
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(). -
nhandle
public static long nhandle(long struct) Unsafe version ofhandle(). -
nname
Unsafe version ofname(). -
nnameString
Unsafe version ofnameString(). -
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. -
nhandle
public static void nhandle(long struct, long value) Unsafe version ofhandle. -
nname
Unsafe version ofname. -
validate
public static void validate(long struct) Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-