Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkMemoryPriorityAllocateInfoEXT

extends Struct<VkMemoryPriorityAllocateInfoEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
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
Valid Usage (Implicit)

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkMemoryPriorityAllocateInfoEXT.Buffer

An array of VkMemoryPriorityAllocateInfoEXT structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PNEXT

The struct member offsets.

public static final int
PRIORITY

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkMemoryPriorityAllocateInfoEXT(long address, ByteBuffer container)

public
VkMemoryPriorityAllocateInfoEXT(ByteBuffer container)

Creates a VkMemoryPriorityAllocateInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkMemoryPriorityAllocateInfoEXT
calloc()

Returns a new VkMemoryPriorityAllocateInfoEXT instance allocated with memCalloc.

public static VkMemoryPriorityAllocateInfoEXT.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new VkMemoryPriorityAllocateInfoEXT.Buffer instance allocated with memCalloc.

public static VkMemoryPriorityAllocateInfoEXT
calloc(MemoryStack
the stack from which to allocate
stack)

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

public static VkMemoryPriorityAllocateInfoEXT.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static VkMemoryPriorityAllocateInfoEXT
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkMemoryPriorityAllocateInfoEXT
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkMemoryPriorityAllocateInfoEXT.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkMemoryPriorityAllocateInfoEXT.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkMemoryPriorityAllocateInfoEXT
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkMemoryPriorityAllocateInfoEXT
create()

Returns a new VkMemoryPriorityAllocateInfoEXT instance allocated with BufferUtils.

public static VkMemoryPriorityAllocateInfoEXT
create(long address)

Returns a new VkMemoryPriorityAllocateInfoEXT instance for the specified memory address.

public static VkMemoryPriorityAllocateInfoEXT.Buffer
create(int
the buffer capacity
capacity)

Returns a new VkMemoryPriorityAllocateInfoEXT.Buffer instance allocated with BufferUtils.

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

Create a VkMemoryPriorityAllocateInfoEXT.Buffer instance at the specified memory.

public static VkMemoryPriorityAllocateInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkMemoryPriorityAllocateInfoEXT
malloc()

Returns a new VkMemoryPriorityAllocateInfoEXT instance allocated with memAlloc.

public static VkMemoryPriorityAllocateInfoEXT.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new VkMemoryPriorityAllocateInfoEXT.Buffer instance allocated with memAlloc.

public static VkMemoryPriorityAllocateInfoEXT
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkMemoryPriorityAllocateInfoEXT instance allocated on the specified MemoryStack.

public static VkMemoryPriorityAllocateInfoEXT.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static VkMemoryPriorityAllocateInfoEXT
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkMemoryPriorityAllocateInfoEXT
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkMemoryPriorityAllocateInfoEXT.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkMemoryPriorityAllocateInfoEXT.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static float
npriority(long struct)

Unsafe version of priority.

public static void
npriority(long struct, float value)

Unsafe version of priority.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkMemoryPriorityAllocateInfoEXT
pNext(long value)

Sets the specified value to the pNext field.

public float
priority()

a floating-point value between 0 and 1, indicating the priority of the allocation relative to other memory allocations.

public VkMemoryPriorityAllocateInfoEXT
priority(float value)

Sets the specified value to the priority field.

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

Initializes this struct with the specified values.

public VkMemoryPriorityAllocateInfoEXT

Returns:

this struct
set(VkMemoryPriorityAllocateInfoEXT
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkMemoryPriorityAllocateInfoEXT
sType(int value)

Sets the specified value to the sType field.

public VkMemoryPriorityAllocateInfoEXT
sType$Default()

Sets the STRUCTURE_TYPE_MEMORY_PRIORITY_ALLOCATE_INFO_EXT value to the sType field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

PRIORITYback to summary
public static final int PRIORITY

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkMemoryPriorityAllocateInfoEXTback to summary
protected VkMemoryPriorityAllocateInfoEXT(long address, ByteBuffer container)
VkMemoryPriorityAllocateInfoEXTback to summary
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 Detail

callocback to summary
public static VkMemoryPriorityAllocateInfoEXT calloc()

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

callocback to summary
public static VkMemoryPriorityAllocateInfoEXT.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkMemoryPriorityAllocateInfoEXT calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkMemoryPriorityAllocateInfoEXT.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkMemoryPriorityAllocateInfoEXT callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkMemoryPriorityAllocateInfoEXT callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkMemoryPriorityAllocateInfoEXT.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkMemoryPriorityAllocateInfoEXT.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected VkMemoryPriorityAllocateInfoEXT create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkMemoryPriorityAllocateInfoEXT create()

Returns a new VkMemoryPriorityAllocateInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkMemoryPriorityAllocateInfoEXT create(long address)

Returns a new VkMemoryPriorityAllocateInfoEXT instance for the specified memory address.

createback to summary
public static VkMemoryPriorityAllocateInfoEXT.Buffer create(int capacity)

Returns a new VkMemoryPriorityAllocateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkMemoryPriorityAllocateInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkMemoryPriorityAllocateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkMemoryPriorityAllocateInfoEXT.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkMemoryPriorityAllocateInfoEXT malloc()

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

mallocback to summary
public static VkMemoryPriorityAllocateInfoEXT.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkMemoryPriorityAllocateInfoEXT malloc(MemoryStack stack)

Returns a new VkMemoryPriorityAllocateInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkMemoryPriorityAllocateInfoEXT.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkMemoryPriorityAllocateInfoEXT mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkMemoryPriorityAllocateInfoEXT mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkMemoryPriorityAllocateInfoEXT.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkMemoryPriorityAllocateInfoEXT.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

npriorityback to summary
public static float npriority(long struct)

Unsafe version of priority.

npriorityback to summary
public static void npriority(long struct, float value)

Unsafe version of priority.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkMemoryPriorityAllocateInfoEXT pNext(long value)

Sets the specified value to the pNext field.

priorityback to summary
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.

priorityback to summary
public VkMemoryPriorityAllocateInfoEXT priority(float value)

Sets the specified value to the priority field.

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

Initializes this struct with the specified values.

setback to summary
public VkMemoryPriorityAllocateInfoEXT set(VkMemoryPriorityAllocateInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkMemoryPriorityAllocateInfoEXT

the source struct

Returns:VkMemoryPriorityAllocateInfoEXT

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkMemoryPriorityAllocateInfoEXT sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkMemoryPriorityAllocateInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_MEMORY_PRIORITY_ALLOCATE_INFO_EXT value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkMemoryPriorityAllocateInfoEXT.Buffer

extends StructBuffer<VkMemoryPriorityAllocateInfoEXT, VkMemoryPriorityAllocateInfoEXT.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of VkMemoryPriorityAllocateInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkMemoryPriorityAllocateInfoEXT
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkMemoryPriorityAllocateInfoEXT.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VkMemoryPriorityAllocateInfoEXT
getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

public long

Returns:

the value of the VkMemoryPriorityAllocateInfoEXT#pNext field.
pNext()

public VkMemoryPriorityAllocateInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkMemoryPriorityAllocateInfoEXT#pNext field.

public float

Returns:

the value of the VkMemoryPriorityAllocateInfoEXT#priority field.
priority()

public VkMemoryPriorityAllocateInfoEXT.Buffer
priority(float value)

Sets the specified value to the VkMemoryPriorityAllocateInfoEXT#priority field.

protected VkMemoryPriorityAllocateInfoEXT.Buffer
self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

public int

Returns:

the value of the VkMemoryPriorityAllocateInfoEXT#sType field.
sType()

public VkMemoryPriorityAllocateInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkMemoryPriorityAllocateInfoEXT#sType field.

public VkMemoryPriorityAllocateInfoEXT.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_MEMORY_PRIORITY_ALLOCATE_INFO_EXT value to the VkMemoryPriorityAllocateInfoEXT#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkMemoryPriorityAllocateInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkMemoryPriorityAllocateInfoEXT.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkMemoryPriorityAllocateInfoEXT#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VkMemoryPriorityAllocateInfoEXT getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkMemoryPriorityAllocateInfoEXT#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkMemoryPriorityAllocateInfoEXT.Buffer pNext(long value)

Sets the specified value to the VkMemoryPriorityAllocateInfoEXT#pNext field.

priorityback to summary
public float priority()
Returns:float

the value of the VkMemoryPriorityAllocateInfoEXT#priority field.

priorityback to summary
public VkMemoryPriorityAllocateInfoEXT.Buffer priority(float value)

Sets the specified value to the VkMemoryPriorityAllocateInfoEXT#priority field.

selfback to summary
protected VkMemoryPriorityAllocateInfoEXT.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkMemoryPriorityAllocateInfoEXT#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkMemoryPriorityAllocateInfoEXT.Buffer sType(int value)

Sets the specified value to the VkMemoryPriorityAllocateInfoEXT#sType field.

sType$Defaultback to summary
public VkMemoryPriorityAllocateInfoEXT.Buffer sType$Default()

Sets the STRUCTURE_TYPE_MEMORY_PRIORITY_ALLOCATE_INFO_EXT value to the VkMemoryPriorityAllocateInfoEXT#sType field.