Package org.lwjgl.vulkan

Class VkImportMemoryWin32HandleInfoNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkImportMemoryWin32HandleInfoNV>

org.lwjgl.vulkan.VkImportMemoryWin32HandleInfoNV

All Implemented Interfaces:

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

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

Import Win32 memory created on the same physical device.

Description

If handleType is 0, this structure is ignored by consumers of the VkMemoryAllocateInfo structure it is chained from.

Valid Usage

• handleType must not have more than one bit set
• handle must be a valid handle to memory, obtained as specified by handleType

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMPORT_MEMORY_WIN32_HANDLE_INFO_NV
• handleType must be a valid combination of VkExternalMemoryHandleTypeFlagBitsNV values

Layout

 struct VkImportMemoryWin32HandleInfoNV {
     VkStructureType sType();
     void const * pNext();
     VkExternalMemoryHandleTypeFlagsNV handleType();
     HANDLE handle();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkImportMemoryWin32HandleInfoNV.Buffer	An array of VkImportMemoryWin32HandleInfoNV 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	HANDLE	The struct member offsets.
static final int	HANDLETYPE	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
VkImportMemoryWin32HandleInfoNV(ByteBuffer container)	Creates a VkImportMemoryWin32HandleInfoNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkImportMemoryWin32HandleInfoNV	calloc()	Returns a new VkImportMemoryWin32HandleInfoNV instance allocated with memCalloc.
static VkImportMemoryWin32HandleInfoNV.Buffer	calloc(int capacity)	Returns a new VkImportMemoryWin32HandleInfoNV.Buffer instance allocated with memCalloc.
static VkImportMemoryWin32HandleInfoNV.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImportMemoryWin32HandleInfoNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImportMemoryWin32HandleInfoNV	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImportMemoryWin32HandleInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImportMemoryWin32HandleInfoNV	callocStack()	Deprecated.
static VkImportMemoryWin32HandleInfoNV.Buffer	callocStack(int capacity)	Deprecated.
static VkImportMemoryWin32HandleInfoNV.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkImportMemoryWin32HandleInfoNV	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkImportMemoryWin32HandleInfoNV	create()	Returns a new VkImportMemoryWin32HandleInfoNV instance allocated with BufferUtils.
static VkImportMemoryWin32HandleInfoNV.Buffer	create(int capacity)	Returns a new VkImportMemoryWin32HandleInfoNV.Buffer instance allocated with BufferUtils.
static VkImportMemoryWin32HandleInfoNV	create(long address)	Returns a new VkImportMemoryWin32HandleInfoNV instance for the specified memory address.
static VkImportMemoryWin32HandleInfoNV.Buffer	create(long address, int capacity)	Create a VkImportMemoryWin32HandleInfoNV.Buffer instance at the specified memory.
static @Nullable VkImportMemoryWin32HandleInfoNV	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkImportMemoryWin32HandleInfoNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	handle()	a Windows HANDLE referring to the memory.
VkImportMemoryWin32HandleInfoNV	handle(long value)	Sets the specified value to the handle() field.
int	handleType()	0 or a VkExternalMemoryHandleTypeFlagBitsNV value specifying the type of memory handle in handle.
VkImportMemoryWin32HandleInfoNV	handleType(int value)	Sets the specified value to the handleType() field.
static VkImportMemoryWin32HandleInfoNV	malloc()	Returns a new VkImportMemoryWin32HandleInfoNV instance allocated with memAlloc.
static VkImportMemoryWin32HandleInfoNV.Buffer	malloc(int capacity)	Returns a new VkImportMemoryWin32HandleInfoNV.Buffer instance allocated with memAlloc.
static VkImportMemoryWin32HandleInfoNV.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImportMemoryWin32HandleInfoNV.Buffer instance allocated on the specified MemoryStack.
static VkImportMemoryWin32HandleInfoNV	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImportMemoryWin32HandleInfoNV instance allocated on the specified MemoryStack.
static VkImportMemoryWin32HandleInfoNV	mallocStack()	Deprecated.
static VkImportMemoryWin32HandleInfoNV.Buffer	mallocStack(int capacity)	Deprecated.
static VkImportMemoryWin32HandleInfoNV.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkImportMemoryWin32HandleInfoNV	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static long	nhandle(long struct)	Unsafe version of handle().
static void	nhandle(long struct, long value)	Unsafe version of handle.
static int	nhandleType(long struct)	Unsafe version of handleType().
static void	nhandleType(long struct, int value)	Unsafe version of handleType.
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.
VkImportMemoryWin32HandleInfoNV	pNext(long value)	Sets the specified value to the pNext() field.
VkImportMemoryWin32HandleInfoNV	set(int sType, long pNext, int handleType, long handle)	Initializes this struct with the specified values.
VkImportMemoryWin32HandleInfoNV	set(VkImportMemoryWin32HandleInfoNV src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkImportMemoryWin32HandleInfoNV	sType(int value)	Sets the specified value to the sType() field.
VkImportMemoryWin32HandleInfoNV	sType$Default()	Sets the STRUCTURE_TYPE_IMPORT_MEMORY_WIN32_HANDLE_INFO_NV value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

HANDLETYPE

public static final int HANDLETYPE

The struct member offsets.

HANDLE

public static final int HANDLE

The struct member offsets.

Constructor Details

VkImportMemoryWin32HandleInfoNV

public VkImportMemoryWin32HandleInfoNV(ByteBuffer container)

Creates a VkImportMemoryWin32HandleInfoNV 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<VkImportMemoryWin32HandleInfoNV>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

handleType

public int handleType()

0 or a VkExternalMemoryHandleTypeFlagBitsNV value specifying the type of memory handle in handle.

handle

public long handle()

a Windows HANDLE referring to the memory.

sType

public VkImportMemoryWin32HandleInfoNV sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkImportMemoryWin32HandleInfoNV sType$Default()

Sets the STRUCTURE_TYPE_IMPORT_MEMORY_WIN32_HANDLE_INFO_NV value to the sType() field.

pNext

public VkImportMemoryWin32HandleInfoNV pNext(long value)

Sets the specified value to the pNext() field.

handleType

public VkImportMemoryWin32HandleInfoNV handleType(int value)

Sets the specified value to the handleType() field.

handle

public VkImportMemoryWin32HandleInfoNV handle(long value)

Sets the specified value to the handle() field.

set

public VkImportMemoryWin32HandleInfoNV set(int sType,
 long pNext,
 int handleType,
 long handle)

Initializes this struct with the specified values.

set

public VkImportMemoryWin32HandleInfoNV set(VkImportMemoryWin32HandleInfoNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkImportMemoryWin32HandleInfoNV malloc()

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

calloc

public static VkImportMemoryWin32HandleInfoNV calloc()

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

create

public static VkImportMemoryWin32HandleInfoNV create()

Returns a new VkImportMemoryWin32HandleInfoNV instance allocated with BufferUtils.

create

public static VkImportMemoryWin32HandleInfoNV create(long address)

Returns a new VkImportMemoryWin32HandleInfoNV instance for the specified memory address.

createSafe

public static @Nullable VkImportMemoryWin32HandleInfoNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkImportMemoryWin32HandleInfoNV.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkImportMemoryWin32HandleInfoNV.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkImportMemoryWin32HandleInfoNV.Buffer create(int capacity)

Returns a new VkImportMemoryWin32HandleInfoNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkImportMemoryWin32HandleInfoNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkImportMemoryWin32HandleInfoNV mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkImportMemoryWin32HandleInfoNV callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkImportMemoryWin32HandleInfoNV.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 VkImportMemoryWin32HandleInfoNV.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 VkImportMemoryWin32HandleInfoNV malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkImportMemoryWin32HandleInfoNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkImportMemoryWin32HandleInfoNV.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().

nhandleType

public static int nhandleType(long struct)

Unsafe version of handleType().

nhandle

public static long nhandle(long struct)

Unsafe version of handle().

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.

nhandleType

public static void nhandleType(long struct,
 int value)

Unsafe version of handleType.

nhandle

public static void nhandle(long struct,
 long value)

Unsafe version of handle.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate