Package org.lwjgl.vulkan

Class VkMemoryHostPointerPropertiesEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkMemoryHostPointerPropertiesEXT>

org.lwjgl.vulkan.VkMemoryHostPointerPropertiesEXT

All Implemented Interfaces:

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

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

Properties of external memory host pointer.

Description

The value returned by memoryTypeBits must only include bits that identify memory types which are host visible.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_MEMORY_HOST_POINTER_PROPERTIES_EXT
• pNext must be NULL

See Also

GetMemoryHostPointerPropertiesEXT

Layout

 struct VkMemoryHostPointerPropertiesEXT {
     VkStructureType sType();
     void * pNext();
     uint32_t memoryTypeBits();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkMemoryHostPointerPropertiesEXT	calloc()	Returns a new VkMemoryHostPointerPropertiesEXT instance allocated with memCalloc.
static VkMemoryHostPointerPropertiesEXT.Buffer	calloc(int capacity)	Returns a new VkMemoryHostPointerPropertiesEXT.Buffer instance allocated with memCalloc.
static VkMemoryHostPointerPropertiesEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkMemoryHostPointerPropertiesEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkMemoryHostPointerPropertiesEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkMemoryHostPointerPropertiesEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkMemoryHostPointerPropertiesEXT	callocStack()	Deprecated.
static VkMemoryHostPointerPropertiesEXT.Buffer	callocStack(int capacity)	Deprecated.
static VkMemoryHostPointerPropertiesEXT.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkMemoryHostPointerPropertiesEXT	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkMemoryHostPointerPropertiesEXT	create()	Returns a new VkMemoryHostPointerPropertiesEXT instance allocated with BufferUtils.
static VkMemoryHostPointerPropertiesEXT.Buffer	create(int capacity)	Returns a new VkMemoryHostPointerPropertiesEXT.Buffer instance allocated with BufferUtils.
static VkMemoryHostPointerPropertiesEXT	create(long address)	Returns a new VkMemoryHostPointerPropertiesEXT instance for the specified memory address.
static VkMemoryHostPointerPropertiesEXT.Buffer	create(long address, int capacity)	Create a VkMemoryHostPointerPropertiesEXT.Buffer instance at the specified memory.
static VkMemoryHostPointerPropertiesEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static VkMemoryHostPointerPropertiesEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkMemoryHostPointerPropertiesEXT	malloc()	Returns a new VkMemoryHostPointerPropertiesEXT instance allocated with memAlloc.
static VkMemoryHostPointerPropertiesEXT.Buffer	malloc(int capacity)	Returns a new VkMemoryHostPointerPropertiesEXT.Buffer instance allocated with memAlloc.
static VkMemoryHostPointerPropertiesEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkMemoryHostPointerPropertiesEXT.Buffer instance allocated on the specified MemoryStack.
static VkMemoryHostPointerPropertiesEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkMemoryHostPointerPropertiesEXT instance allocated on the specified MemoryStack.
static VkMemoryHostPointerPropertiesEXT	mallocStack()	Deprecated.
static VkMemoryHostPointerPropertiesEXT.Buffer	mallocStack(int capacity)	Deprecated.
static VkMemoryHostPointerPropertiesEXT.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkMemoryHostPointerPropertiesEXT	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
int	memoryTypeBits()	a bitmask containing one bit set for every memory type which the specified host pointer can be imported as.
static int	nmemoryTypeBits(long struct)	Unsafe version of memoryTypeBits().
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.
VkMemoryHostPointerPropertiesEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkMemoryHostPointerPropertiesEXT	set(int sType, long pNext)	Initializes this struct with the specified values.
VkMemoryHostPointerPropertiesEXT	set(VkMemoryHostPointerPropertiesEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkMemoryHostPointerPropertiesEXT	sType(int value)	Sets the specified value to the sType() field.
VkMemoryHostPointerPropertiesEXT	sType$Default()	Sets the STRUCTURE_TYPE_MEMORY_HOST_POINTER_PROPERTIES_EXT value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, 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.

MEMORYTYPEBITS

public static final int MEMORYTYPEBITS

The struct member offsets.

Constructor Details

VkMemoryHostPointerPropertiesEXT

public VkMemoryHostPointerPropertiesEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

memoryTypeBits

public int memoryTypeBits()

a bitmask containing one bit set for every memory type which the specified host pointer can be imported as.

sType

public VkMemoryHostPointerPropertiesEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkMemoryHostPointerPropertiesEXT sType$Default()

Sets the STRUCTURE_TYPE_MEMORY_HOST_POINTER_PROPERTIES_EXT value to the sType() field.

pNext

public VkMemoryHostPointerPropertiesEXT pNext(long value)

Sets the specified value to the pNext() field.

set

public VkMemoryHostPointerPropertiesEXT set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkMemoryHostPointerPropertiesEXT set(VkMemoryHostPointerPropertiesEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkMemoryHostPointerPropertiesEXT malloc()

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

calloc

public static VkMemoryHostPointerPropertiesEXT calloc()

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

create

public static VkMemoryHostPointerPropertiesEXT create()

Returns a new VkMemoryHostPointerPropertiesEXT instance allocated with BufferUtils.

create

public static VkMemoryHostPointerPropertiesEXT create(long address)

Returns a new VkMemoryHostPointerPropertiesEXT instance for the specified memory address.

createSafe

@Nullable
public static VkMemoryHostPointerPropertiesEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkMemoryHostPointerPropertiesEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkMemoryHostPointerPropertiesEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkMemoryHostPointerPropertiesEXT.Buffer create(int capacity)

Returns a new VkMemoryHostPointerPropertiesEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkMemoryHostPointerPropertiesEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkMemoryHostPointerPropertiesEXT mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkMemoryHostPointerPropertiesEXT callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Returns a new VkMemoryHostPointerPropertiesEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nmemoryTypeBits

public static int nmemoryTypeBits(long struct)

Unsafe version of memoryTypeBits().

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.