Package org.lwjgl.vulkan

Class VkMemoryGetWin32HandleInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkMemoryGetWin32HandleInfoKHR>

org.lwjgl.vulkan.VkMemoryGetWin32HandleInfoKHR

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkMemoryGetWin32HandleInfoKHR
extends org.lwjgl.system.Struct<VkMemoryGetWin32HandleInfoKHR>
implements org.lwjgl.system.NativeResource

Structure describing a Win32 handle memory export operation.

Description

The properties of the handle returned depend on the value of handleType. See VkExternalMemoryHandleTypeFlagBits for a description of the properties of the defined external memory handle types.

Valid Usage

• handleType must have been included in VkExportMemoryAllocateInfo::handleTypes when memory was created
• If handleType is defined as an NT handle, GetMemoryWin32HandleKHR must be called no more than once for each valid unique combination of memory and handleType
• handleType must be defined as an NT handle or a global share handle

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_MEMORY_GET_WIN32_HANDLE_INFO_KHR
• pNext must be NULL
• memory must be a valid VkDeviceMemory handle
• handleType must be a valid VkExternalMemoryHandleTypeFlagBits value

See Also

GetMemoryWin32HandleKHR

Layout

 struct VkMemoryGetWin32HandleInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkDeviceMemory memory();
     VkExternalMemoryHandleTypeFlagBits handleType();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkMemoryGetWin32HandleInfoKHR.Buffer	An array of VkMemoryGetWin32HandleInfoKHR structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	HANDLETYPE	The struct member offsets.
static final int	MEMORY	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final 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	Description
VkMemoryGetWin32HandleInfoKHR(ByteBuffer container)	Creates a VkMemoryGetWin32HandleInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkMemoryGetWin32HandleInfoKHR	calloc()	Returns a new VkMemoryGetWin32HandleInfoKHR instance allocated with memCalloc.
static VkMemoryGetWin32HandleInfoKHR.Buffer	calloc(int capacity)	Returns a new VkMemoryGetWin32HandleInfoKHR.Buffer instance allocated with memCalloc.
static VkMemoryGetWin32HandleInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkMemoryGetWin32HandleInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkMemoryGetWin32HandleInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkMemoryGetWin32HandleInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkMemoryGetWin32HandleInfoKHR	callocStack()	Deprecated.
static VkMemoryGetWin32HandleInfoKHR.Buffer	callocStack(int capacity)	Deprecated.
static VkMemoryGetWin32HandleInfoKHR.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkMemoryGetWin32HandleInfoKHR	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkMemoryGetWin32HandleInfoKHR	create()	Returns a new VkMemoryGetWin32HandleInfoKHR instance allocated with BufferUtils.
static VkMemoryGetWin32HandleInfoKHR.Buffer	create(int capacity)	Returns a new VkMemoryGetWin32HandleInfoKHR.Buffer instance allocated with BufferUtils.
static VkMemoryGetWin32HandleInfoKHR	create(long address)	Returns a new VkMemoryGetWin32HandleInfoKHR instance for the specified memory address.
static VkMemoryGetWin32HandleInfoKHR.Buffer	create(long address, int capacity)	Create a VkMemoryGetWin32HandleInfoKHR.Buffer instance at the specified memory.
static @Nullable VkMemoryGetWin32HandleInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkMemoryGetWin32HandleInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	handleType()	a VkExternalMemoryHandleTypeFlagBits value specifying the type of handle requested.
VkMemoryGetWin32HandleInfoKHR	handleType(int value)	Sets the specified value to the handleType() field.
static VkMemoryGetWin32HandleInfoKHR	malloc()	Returns a new VkMemoryGetWin32HandleInfoKHR instance allocated with memAlloc.
static VkMemoryGetWin32HandleInfoKHR.Buffer	malloc(int capacity)	Returns a new VkMemoryGetWin32HandleInfoKHR.Buffer instance allocated with memAlloc.
static VkMemoryGetWin32HandleInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkMemoryGetWin32HandleInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkMemoryGetWin32HandleInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkMemoryGetWin32HandleInfoKHR instance allocated on the specified MemoryStack.
static VkMemoryGetWin32HandleInfoKHR	mallocStack()	Deprecated.
static VkMemoryGetWin32HandleInfoKHR.Buffer	mallocStack(int capacity)	Deprecated.
static VkMemoryGetWin32HandleInfoKHR.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkMemoryGetWin32HandleInfoKHR	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
long	memory()	the memory object from which the handle will be exported.
VkMemoryGetWin32HandleInfoKHR	memory(long value)	Sets the specified value to the memory() field.
static int	nhandleType(long struct)	Unsafe version of handleType().
static void	nhandleType(long struct, int value)	Unsafe version of handleType.
static long	nmemory(long struct)	Unsafe version of memory().
static void	nmemory(long struct, long value)	Unsafe version of memory.
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	pNext()	NULL or a pointer to a structure extending this structure.
VkMemoryGetWin32HandleInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkMemoryGetWin32HandleInfoKHR	set(int sType, long pNext, long memory, int handleType)	Initializes this struct with the specified values.
VkMemoryGetWin32HandleInfoKHR	set(VkMemoryGetWin32HandleInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkMemoryGetWin32HandleInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkMemoryGetWin32HandleInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_MEMORY_GET_WIN32_HANDLE_INFO_KHR value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

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 Details

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.

MEMORY

public static final int MEMORY

The struct member offsets.

HANDLETYPE

public static final int HANDLETYPE

The struct member offsets.

Constructor Details

VkMemoryGetWin32HandleInfoKHR

public VkMemoryGetWin32HandleInfoKHR(ByteBuffer container)

Creates a VkMemoryGetWin32HandleInfoKHR 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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkMemoryGetWin32HandleInfoKHR>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

memory

public long memory()

the memory object from which the handle will be exported.

handleType

public int handleType()

a VkExternalMemoryHandleTypeFlagBits value specifying the type of handle requested.

sType

public VkMemoryGetWin32HandleInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkMemoryGetWin32HandleInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_MEMORY_GET_WIN32_HANDLE_INFO_KHR value to the sType() field.

pNext

public VkMemoryGetWin32HandleInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

memory

public VkMemoryGetWin32HandleInfoKHR memory(long value)

Sets the specified value to the memory() field.

handleType

public VkMemoryGetWin32HandleInfoKHR handleType(int value)

Sets the specified value to the handleType() field.

set

public VkMemoryGetWin32HandleInfoKHR set(int sType,
 long pNext,
 long memory,
 int handleType)

Initializes this struct with the specified values.

set

public VkMemoryGetWin32HandleInfoKHR set(VkMemoryGetWin32HandleInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkMemoryGetWin32HandleInfoKHR malloc()

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

calloc

public static VkMemoryGetWin32HandleInfoKHR calloc()

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

create

public static VkMemoryGetWin32HandleInfoKHR create()

Returns a new VkMemoryGetWin32HandleInfoKHR instance allocated with BufferUtils.

create

public static VkMemoryGetWin32HandleInfoKHR create(long address)

Returns a new VkMemoryGetWin32HandleInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkMemoryGetWin32HandleInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkMemoryGetWin32HandleInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkMemoryGetWin32HandleInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkMemoryGetWin32HandleInfoKHR.Buffer create(int capacity)

Returns a new VkMemoryGetWin32HandleInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkMemoryGetWin32HandleInfoKHR.Buffer create(long address,
 int capacity)

Create a VkMemoryGetWin32HandleInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkMemoryGetWin32HandleInfoKHR.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkMemoryGetWin32HandleInfoKHR mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkMemoryGetWin32HandleInfoKHR callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkMemoryGetWin32HandleInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkMemoryGetWin32HandleInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static VkMemoryGetWin32HandleInfoKHR.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static VkMemoryGetWin32HandleInfoKHR.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static VkMemoryGetWin32HandleInfoKHR.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkMemoryGetWin32HandleInfoKHR.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

malloc

public static VkMemoryGetWin32HandleInfoKHR malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkMemoryGetWin32HandleInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkMemoryGetWin32HandleInfoKHR calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkMemoryGetWin32HandleInfoKHR.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkMemoryGetWin32HandleInfoKHR.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nmemory

public static long nmemory(long struct)

Unsafe version of memory().

nhandleType

public static int nhandleType(long struct)

Unsafe version of handleType().

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.

nmemory

public static void nmemory(long struct,
 long value)

Unsafe version of memory.

nhandleType

public static void nhandleType(long struct,
 int value)

Unsafe version of handleType.