Package org.lwjgl.vulkan

Class VkMemoryPriorityAllocateInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkMemoryPriorityAllocateInfoEXT>

org.lwjgl.vulkan.VkMemoryPriorityAllocateInfoEXT

All Implemented Interfaces:

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

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

Specify a memory allocation priority.

Description

Memory allocations with higher priority may be more likely to stay in device-local memory when the system is under memory pressure.

If this structure is not included, it is as if the priority value were 0.5.

Valid Usage

• priority must be between 0 and 1, inclusive

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_MEMORY_PRIORITY_ALLOCATE_INFO_EXT

Layout

 struct VkMemoryPriorityAllocateInfoEXT {
     VkStructureType sType();
     void const * pNext();
     float priority();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkMemoryPriorityAllocateInfoEXT	calloc()	Returns a new VkMemoryPriorityAllocateInfoEXT instance allocated with memCalloc.
static VkMemoryPriorityAllocateInfoEXT.Buffer	calloc(int capacity)	Returns a new VkMemoryPriorityAllocateInfoEXT.Buffer instance allocated with memCalloc.
static VkMemoryPriorityAllocateInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkMemoryPriorityAllocateInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkMemoryPriorityAllocateInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkMemoryPriorityAllocateInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkMemoryPriorityAllocateInfoEXT	callocStack()	Deprecated.
static VkMemoryPriorityAllocateInfoEXT.Buffer	callocStack(int capacity)	Deprecated.
static VkMemoryPriorityAllocateInfoEXT.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkMemoryPriorityAllocateInfoEXT	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkMemoryPriorityAllocateInfoEXT	create()	Returns a new VkMemoryPriorityAllocateInfoEXT instance allocated with BufferUtils.
static VkMemoryPriorityAllocateInfoEXT.Buffer	create(int capacity)	Returns a new VkMemoryPriorityAllocateInfoEXT.Buffer instance allocated with BufferUtils.
static VkMemoryPriorityAllocateInfoEXT	create(long address)	Returns a new VkMemoryPriorityAllocateInfoEXT instance for the specified memory address.
static VkMemoryPriorityAllocateInfoEXT.Buffer	create(long address, int capacity)	Create a VkMemoryPriorityAllocateInfoEXT.Buffer instance at the specified memory.
static @Nullable VkMemoryPriorityAllocateInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkMemoryPriorityAllocateInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkMemoryPriorityAllocateInfoEXT	malloc()	Returns a new VkMemoryPriorityAllocateInfoEXT instance allocated with memAlloc.
static VkMemoryPriorityAllocateInfoEXT.Buffer	malloc(int capacity)	Returns a new VkMemoryPriorityAllocateInfoEXT.Buffer instance allocated with memAlloc.
static VkMemoryPriorityAllocateInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkMemoryPriorityAllocateInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkMemoryPriorityAllocateInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkMemoryPriorityAllocateInfoEXT instance allocated on the specified MemoryStack.
static VkMemoryPriorityAllocateInfoEXT	mallocStack()	Deprecated.
static VkMemoryPriorityAllocateInfoEXT.Buffer	mallocStack(int capacity)	Deprecated.
static VkMemoryPriorityAllocateInfoEXT.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkMemoryPriorityAllocateInfoEXT	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static float	npriority(long struct)	Unsafe version of priority().
static void	npriority(long struct, float value)	Unsafe version of priority.
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.
VkMemoryPriorityAllocateInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
float	priority()	a floating-point value between 0 and 1, indicating the priority of the allocation relative to other memory allocations.
VkMemoryPriorityAllocateInfoEXT	priority(float value)	Sets the specified value to the priority() field.
VkMemoryPriorityAllocateInfoEXT	set(int sType, long pNext, float priority)	Initializes this struct with the specified values.
VkMemoryPriorityAllocateInfoEXT	set(VkMemoryPriorityAllocateInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkMemoryPriorityAllocateInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkMemoryPriorityAllocateInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_MEMORY_PRIORITY_ALLOCATE_INFO_EXT 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.

PRIORITY

public static final int PRIORITY

The struct member offsets.

Constructor Details

VkMemoryPriorityAllocateInfoEXT

public VkMemoryPriorityAllocateInfoEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

priority

public float priority()

a floating-point value between 0 and 1, indicating the priority of the allocation relative to other memory allocations. Larger values are higher priority. The granularity of the priorities is implementation-dependent.

sType

public VkMemoryPriorityAllocateInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkMemoryPriorityAllocateInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_MEMORY_PRIORITY_ALLOCATE_INFO_EXT value to the sType() field.

pNext

public VkMemoryPriorityAllocateInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

priority

public VkMemoryPriorityAllocateInfoEXT priority(float value)

Sets the specified value to the priority() field.

set

public VkMemoryPriorityAllocateInfoEXT set(int sType,
 long pNext,
 float priority)

Initializes this struct with the specified values.

set

public VkMemoryPriorityAllocateInfoEXT set(VkMemoryPriorityAllocateInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkMemoryPriorityAllocateInfoEXT malloc()

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

calloc

public static VkMemoryPriorityAllocateInfoEXT calloc()

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

create

public static VkMemoryPriorityAllocateInfoEXT create()

Returns a new VkMemoryPriorityAllocateInfoEXT instance allocated with BufferUtils.

create

public static VkMemoryPriorityAllocateInfoEXT create(long address)

Returns a new VkMemoryPriorityAllocateInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkMemoryPriorityAllocateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkMemoryPriorityAllocateInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkMemoryPriorityAllocateInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkMemoryPriorityAllocateInfoEXT.Buffer create(int capacity)

Returns a new VkMemoryPriorityAllocateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkMemoryPriorityAllocateInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkMemoryPriorityAllocateInfoEXT mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkMemoryPriorityAllocateInfoEXT callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Returns a new VkMemoryPriorityAllocateInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

npriority

public static float npriority(long struct)

Unsafe version of priority().

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.

npriority

public static void npriority(long struct,
 float value)

Unsafe version of priority.