Package org.lwjgl.vulkan
Class VkImportMemoryWin32HandleInfoKHR
- 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.NativeResourceimport 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
CloseHandlesystem 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
VkDeviceMemoryobject.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
Member documentation
sType– the type of this structure.pNext–NULLor a pointer to an extension-specific structure.handleType– specifies the type ofhandleorname.handle– the external handle to import, orNULL.name– a NULL-terminated UTF-16 string naming the underlying memory resource to import, orNULL.
Layout
struct VkImportMemoryWin32HandleInfoKHR { VkStructureType sType; void const * pNext; VkExternalMemoryHandleTypeFlagBits handleType; HANDLE handle; LPCWSTR name; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkImportMemoryWin32HandleInfoKHR.BufferAn array ofVkImportMemoryWin32HandleInfoKHRstructs.
-
Constructor Summary
Constructors Constructor Description VkImportMemoryWin32HandleInfoKHR(java.nio.ByteBuffer container)Creates aVkImportMemoryWin32HandleInfoKHRinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkImportMemoryWin32HandleInfoKHRcalloc()Returns a newVkImportMemoryWin32HandleInfoKHRinstance allocated withmemCalloc.static VkImportMemoryWin32HandleInfoKHR.Buffercalloc(int capacity)Returns a newVkImportMemoryWin32HandleInfoKHR.Bufferinstance allocated withmemCalloc.static VkImportMemoryWin32HandleInfoKHRcallocStack()Returns a newVkImportMemoryWin32HandleInfoKHRinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkImportMemoryWin32HandleInfoKHR.BuffercallocStack(int capacity)Returns a newVkImportMemoryWin32HandleInfoKHR.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkImportMemoryWin32HandleInfoKHR.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkImportMemoryWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImportMemoryWin32HandleInfoKHRcallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkImportMemoryWin32HandleInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImportMemoryWin32HandleInfoKHRcreate()Returns a newVkImportMemoryWin32HandleInfoKHRinstance allocated withBufferUtils.static VkImportMemoryWin32HandleInfoKHR.Buffercreate(int capacity)Returns a newVkImportMemoryWin32HandleInfoKHR.Bufferinstance allocated withBufferUtils.static VkImportMemoryWin32HandleInfoKHRcreate(long address)Returns a newVkImportMemoryWin32HandleInfoKHRinstance for the specified memory address.static VkImportMemoryWin32HandleInfoKHR.Buffercreate(long address, int capacity)Create aVkImportMemoryWin32HandleInfoKHR.Bufferinstance at the specified memory.static VkImportMemoryWin32HandleInfoKHRcreateSafe(long address)static VkImportMemoryWin32HandleInfoKHR.BuffercreateSafe(long address, int capacity)longhandle()Returns the value of thehandlefield.VkImportMemoryWin32HandleInfoKHRhandle(long value)Sets the specified value to thehandlefield.inthandleType()Returns the value of thehandleTypefield.VkImportMemoryWin32HandleInfoKHRhandleType(int value)Sets the specified value to thehandleTypefield.static VkImportMemoryWin32HandleInfoKHRmalloc()Returns a newVkImportMemoryWin32HandleInfoKHRinstance allocated withmemAlloc.static VkImportMemoryWin32HandleInfoKHR.Buffermalloc(int capacity)Returns a newVkImportMemoryWin32HandleInfoKHR.Bufferinstance allocated withmemAlloc.static VkImportMemoryWin32HandleInfoKHRmallocStack()Returns a newVkImportMemoryWin32HandleInfoKHRinstance allocated on the thread-localMemoryStack.static VkImportMemoryWin32HandleInfoKHR.BuffermallocStack(int capacity)Returns a newVkImportMemoryWin32HandleInfoKHR.Bufferinstance allocated on the thread-localMemoryStack.static VkImportMemoryWin32HandleInfoKHR.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkImportMemoryWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.static VkImportMemoryWin32HandleInfoKHRmallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkImportMemoryWin32HandleInfoKHRinstance allocated on the specifiedMemoryStack.java.nio.ByteBuffername()Returns aByteBufferview of the null-terminated string pointed to by thenamefield.VkImportMemoryWin32HandleInfoKHRname(java.nio.ByteBuffer value)Sets the address of the specified encoded string to thenamefield.java.lang.StringnameString()Decodes the null-terminated string pointed to by thenamefield.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 java.nio.ByteBuffernname(long struct)Unsafe version ofname().static voidnname(long struct, java.nio.ByteBuffer value)Unsafe version ofname.static java.lang.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()Returns the value of thepNextfield.VkImportMemoryWin32HandleInfoKHRpNext(long value)Sets the specified value to thepNextfield.VkImportMemoryWin32HandleInfoKHRset(int sType, long pNext, int handleType, long handle, java.nio.ByteBuffer name)Initializes this struct with the specified values.VkImportMemoryWin32HandleInfoKHRset(VkImportMemoryWin32HandleInfoKHR src)Copies the specified struct data to this struct.intsizeof()intsType()Returns the value of thesTypefield.VkImportMemoryWin32HandleInfoKHRsType(int value)Sets the specified value to thesTypefield.static voidvalidate(long struct)Validates pointer members that should not beNULL.static voidvalidate(long array, int count)Callsvalidate(long)for each struct contained in the specified struct array.
-
-
-
Constructor Detail
-
VkImportMemoryWin32HandleInfoKHR
public VkImportMemoryWin32HandleInfoKHR(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
handleType
public int handleType()
Returns the value of thehandleTypefield.
-
handle
public long handle()
Returns the value of thehandlefield.
-
name
public java.nio.ByteBuffer name()
Returns aByteBufferview of the null-terminated string pointed to by thenamefield.
-
nameString
public java.lang.String nameString()
Decodes the null-terminated string pointed to by thenamefield.
-
sType
public VkImportMemoryWin32HandleInfoKHR sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkImportMemoryWin32HandleInfoKHR pNext(long value)
Sets the specified value to thepNextfield.
-
handleType
public VkImportMemoryWin32HandleInfoKHR handleType(int value)
Sets the specified value to thehandleTypefield.
-
handle
public VkImportMemoryWin32HandleInfoKHR handle(long value)
Sets the specified value to thehandlefield.
-
name
public VkImportMemoryWin32HandleInfoKHR name(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to thenamefield.
-
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 newVkImportMemoryWin32HandleInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkImportMemoryWin32HandleInfoKHR calloc()
Returns a newVkImportMemoryWin32HandleInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkImportMemoryWin32HandleInfoKHR create()
Returns a newVkImportMemoryWin32HandleInfoKHRinstance allocated withBufferUtils.
-
create
public static VkImportMemoryWin32HandleInfoKHR create(long address)
Returns a newVkImportMemoryWin32HandleInfoKHRinstance for the specified memory address.
-
createSafe
@Nullable public static VkImportMemoryWin32HandleInfoKHR createSafe(long address)
-
malloc
public static VkImportMemoryWin32HandleInfoKHR.Buffer malloc(int capacity)
Returns a newVkImportMemoryWin32HandleInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkImportMemoryWin32HandleInfoKHR.Buffer calloc(int capacity)
Returns a newVkImportMemoryWin32HandleInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkImportMemoryWin32HandleInfoKHR.Buffer create(int capacity)
Returns a newVkImportMemoryWin32HandleInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkImportMemoryWin32HandleInfoKHR.Buffer create(long address, int capacity)
Create aVkImportMemoryWin32HandleInfoKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkImportMemoryWin32HandleInfoKHR.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkImportMemoryWin32HandleInfoKHR mallocStack()
Returns a newVkImportMemoryWin32HandleInfoKHRinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkImportMemoryWin32HandleInfoKHR callocStack()
Returns a newVkImportMemoryWin32HandleInfoKHRinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkImportMemoryWin32HandleInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImportMemoryWin32HandleInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkImportMemoryWin32HandleInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImportMemoryWin32HandleInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkImportMemoryWin32HandleInfoKHR.Buffer mallocStack(int capacity)
Returns a newVkImportMemoryWin32HandleInfoKHR.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkImportMemoryWin32HandleInfoKHR.Buffer callocStack(int capacity)
Returns a newVkImportMemoryWin32HandleInfoKHR.Bufferinstance allocated on the thread-localMemoryStackand 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 newVkImportMemoryWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkImportMemoryWin32HandleInfoKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImportMemoryWin32HandleInfoKHR.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().
-
nhandle
public static long nhandle(long struct)
Unsafe version ofhandle().
-
nname
public static java.nio.ByteBuffer nname(long struct)
Unsafe version ofname().
-
nnameString
public static java.lang.String nnameString(long struct)
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
public static void nname(long struct, java.nio.ByteBuffer value)Unsafe version ofname.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
validate
public static void validate(long array, int count)Callsvalidate(long)for each struct contained in the specified struct array.- Parameters:
array- the struct array to validatecount- the number of structs inarray
-
-