Package org.lwjgl.vulkan

Class VkQueueFamilyGlobalPriorityProperties

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkQueueFamilyGlobalPriorityProperties>

org.lwjgl.vulkan.VkQueueFamilyGlobalPriorityProperties

All Implemented Interfaces:

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

Direct Known Subclasses:

VkQueueFamilyGlobalPriorityPropertiesEXT, VkQueueFamilyGlobalPriorityPropertiesKHR

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

Return structure for queue family global priority information query.

Description

If the VkQueueFamilyGlobalPriorityProperties structure is included in the pNext chain of the VkQueueFamilyProperties2 structure passed to GetPhysicalDeviceQueueFamilyProperties2, it is filled in with the list of supported global queue priorities for the indicated family.

The valid elements of priorities must not contain any duplicate values.

The valid elements of priorities must be a continuous sequence of VkQueueGlobalPriority enums in the ascending order.

Note

For example, returning priorityCount as 3 with supported priorities as QUEUE_GLOBAL_PRIORITY_LOW, QUEUE_GLOBAL_PRIORITY_MEDIUM and QUEUE_GLOBAL_PRIORITY_REALTIME is not allowed.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_QUEUE_FAMILY_GLOBAL_PRIORITY_PROPERTIES

Layout

 struct VkQueueFamilyGlobalPriorityProperties {
     VkStructureType sType();
     void * pNext();
     uint32_t priorityCount();
     VkQueueGlobalPriority priorities()[VK_MAX_GLOBAL_PRIORITY_SIZE];
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkQueueFamilyGlobalPriorityProperties	calloc()	Returns a new VkQueueFamilyGlobalPriorityProperties instance allocated with memCalloc.
static VkQueueFamilyGlobalPriorityProperties.Buffer	calloc(int capacity)	Returns a new VkQueueFamilyGlobalPriorityProperties.Buffer instance allocated with memCalloc.
static VkQueueFamilyGlobalPriorityProperties.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkQueueFamilyGlobalPriorityProperties.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkQueueFamilyGlobalPriorityProperties	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkQueueFamilyGlobalPriorityProperties instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkQueueFamilyGlobalPriorityProperties	create()	Returns a new VkQueueFamilyGlobalPriorityProperties instance allocated with BufferUtils.
static VkQueueFamilyGlobalPriorityProperties.Buffer	create(int capacity)	Returns a new VkQueueFamilyGlobalPriorityProperties.Buffer instance allocated with BufferUtils.
static VkQueueFamilyGlobalPriorityProperties	create(long address)	Returns a new VkQueueFamilyGlobalPriorityProperties instance for the specified memory address.
static VkQueueFamilyGlobalPriorityProperties.Buffer	create(long address, int capacity)	Create a VkQueueFamilyGlobalPriorityProperties.Buffer instance at the specified memory.
static @Nullable VkQueueFamilyGlobalPriorityProperties	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkQueueFamilyGlobalPriorityProperties.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkQueueFamilyGlobalPriorityProperties	malloc()	Returns a new VkQueueFamilyGlobalPriorityProperties instance allocated with memAlloc.
static VkQueueFamilyGlobalPriorityProperties.Buffer	malloc(int capacity)	Returns a new VkQueueFamilyGlobalPriorityProperties.Buffer instance allocated with memAlloc.
static VkQueueFamilyGlobalPriorityProperties.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkQueueFamilyGlobalPriorityProperties.Buffer instance allocated on the specified MemoryStack.
static VkQueueFamilyGlobalPriorityProperties	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkQueueFamilyGlobalPriorityProperties instance allocated on the specified MemoryStack.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static IntBuffer	npriorities(long struct)	Unsafe version of priorities().
static int	npriorities(long struct, int index)	Unsafe version of priorities.
static int	npriorityCount(long struct)	Unsafe version of priorityCount().
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.
VkQueueFamilyGlobalPriorityProperties	pNext(long value)	Sets the specified value to the pNext() field.
IntBuffer	priorities()	an array of MAX_GLOBAL_PRIORITY_SIZE VkQueueGlobalPriority enums representing all supported global queue priorities in this queue family.
int	priorities(int index)	an array of MAX_GLOBAL_PRIORITY_SIZE VkQueueGlobalPriority enums representing all supported global queue priorities in this queue family.
int	priorityCount()	the number of supported global queue priorities in this queue family, and it must be greater than 0.
VkQueueFamilyGlobalPriorityProperties	set(int sType, long pNext)	Initializes this struct with the specified values.
VkQueueFamilyGlobalPriorityProperties	set(VkQueueFamilyGlobalPriorityProperties src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkQueueFamilyGlobalPriorityProperties	sType(int value)	Sets the specified value to the sType() field.
VkQueueFamilyGlobalPriorityProperties	sType$Default()	Sets the STRUCTURE_TYPE_QUEUE_FAMILY_GLOBAL_PRIORITY_PROPERTIES 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.

PRIORITYCOUNT

public static final int PRIORITYCOUNT

The struct member offsets.

PRIORITIES

public static final int PRIORITIES

The struct member offsets.

Constructor Details

VkQueueFamilyGlobalPriorityProperties

public VkQueueFamilyGlobalPriorityProperties(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

priorityCount

public int priorityCount()

the number of supported global queue priorities in this queue family, and it must be greater than 0.

priorities

public IntBuffer priorities()

an array of MAX_GLOBAL_PRIORITY_SIZE VkQueueGlobalPriority enums representing all supported global queue priorities in this queue family. The first priorityCount elements of the array will be valid.

priorities

public int priorities(int index)

an array of MAX_GLOBAL_PRIORITY_SIZE VkQueueGlobalPriority enums representing all supported global queue priorities in this queue family. The first priorityCount elements of the array will be valid.

sType

public VkQueueFamilyGlobalPriorityProperties sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkQueueFamilyGlobalPriorityProperties sType$Default()

Sets the STRUCTURE_TYPE_QUEUE_FAMILY_GLOBAL_PRIORITY_PROPERTIES value to the sType() field.

pNext

public VkQueueFamilyGlobalPriorityProperties pNext(long value)

Sets the specified value to the pNext() field.

set

public VkQueueFamilyGlobalPriorityProperties set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkQueueFamilyGlobalPriorityProperties set(VkQueueFamilyGlobalPriorityProperties src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkQueueFamilyGlobalPriorityProperties malloc()

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

calloc

public static VkQueueFamilyGlobalPriorityProperties calloc()

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

create

public static VkQueueFamilyGlobalPriorityProperties create()

Returns a new VkQueueFamilyGlobalPriorityProperties instance allocated with BufferUtils.

create

public static VkQueueFamilyGlobalPriorityProperties create(long address)

Returns a new VkQueueFamilyGlobalPriorityProperties instance for the specified memory address.

createSafe

public static @Nullable VkQueueFamilyGlobalPriorityProperties createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkQueueFamilyGlobalPriorityProperties.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkQueueFamilyGlobalPriorityProperties.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkQueueFamilyGlobalPriorityProperties.Buffer create(int capacity)

Returns a new VkQueueFamilyGlobalPriorityProperties.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkQueueFamilyGlobalPriorityProperties.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkQueueFamilyGlobalPriorityProperties instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

npriorityCount

public static int npriorityCount(long struct)

Unsafe version of priorityCount().

npriorities

public static IntBuffer npriorities(long struct)

Unsafe version of priorities().

npriorities

public static int npriorities(long struct,
 int index)

Unsafe version of priorities.

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.