Package org.lwjgl.vulkan

Class VkMemoryGetRemoteAddressInfoNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkMemoryGetRemoteAddressInfoNV>

org.lwjgl.vulkan.VkMemoryGetRemoteAddressInfoNV

All Implemented Interfaces:

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

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

Structure describing a remote accessible address export operation.

Valid Usage

• handleType must have been included in VkExportMemoryAllocateInfo::handleTypes when memory was created

Valid Usage (Implicit)

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

See Also

GetMemoryRemoteAddressNV

Layout

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkMemoryGetRemoteAddressInfoNV.Buffer	An array of VkMemoryGetRemoteAddressInfoNV 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
VkMemoryGetRemoteAddressInfoNV(ByteBuffer container)	Creates a VkMemoryGetRemoteAddressInfoNV instance at the current position of the specified ByteBuffer container.

Method Summary

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

VkMemoryGetRemoteAddressInfoNV

public VkMemoryGetRemoteAddressInfoNV(ByteBuffer container)

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

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 remote accessible address will be exported.

handleType

public int handleType()

the type of handle requested.

sType

public VkMemoryGetRemoteAddressInfoNV sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkMemoryGetRemoteAddressInfoNV sType$Default()

Sets the STRUCTURE_TYPE_MEMORY_GET_REMOTE_ADDRESS_INFO_NV value to the sType() field.

pNext

public VkMemoryGetRemoteAddressInfoNV pNext(long value)

Sets the specified value to the pNext() field.

memory

public VkMemoryGetRemoteAddressInfoNV memory(long value)

Sets the specified value to the memory() field.

handleType

public VkMemoryGetRemoteAddressInfoNV handleType(int value)

Sets the specified value to the handleType() field.

set

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

Initializes this struct with the specified values.

set

public VkMemoryGetRemoteAddressInfoNV set(VkMemoryGetRemoteAddressInfoNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkMemoryGetRemoteAddressInfoNV malloc()

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

calloc

public static VkMemoryGetRemoteAddressInfoNV calloc()

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

create

public static VkMemoryGetRemoteAddressInfoNV create()

Returns a new VkMemoryGetRemoteAddressInfoNV instance allocated with BufferUtils.

create

public static VkMemoryGetRemoteAddressInfoNV create(long address)

Returns a new VkMemoryGetRemoteAddressInfoNV instance for the specified memory address.

createSafe

public static @Nullable VkMemoryGetRemoteAddressInfoNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkMemoryGetRemoteAddressInfoNV.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkMemoryGetRemoteAddressInfoNV.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkMemoryGetRemoteAddressInfoNV.Buffer create(int capacity)

Returns a new VkMemoryGetRemoteAddressInfoNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkMemoryGetRemoteAddressInfoNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkMemoryGetRemoteAddressInfoNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkMemoryGetRemoteAddressInfoNV.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.