Package org.lwjgl.vulkan

Class VkDeviceQueueGlobalPriorityCreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDeviceQueueGlobalPriorityCreateInfo>

org.lwjgl.vulkan.VkDeviceQueueGlobalPriorityCreateInfo

All Implemented Interfaces:

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

Direct Known Subclasses:

VkDeviceQueueGlobalPriorityCreateInfoEXT, VkDeviceQueueGlobalPriorityCreateInfoKHR

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

Specify a system wide priority.

Description

Queues created without specifying VkDeviceQueueGlobalPriorityCreateInfo will default to QUEUE_GLOBAL_PRIORITY_MEDIUM.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DEVICE_QUEUE_GLOBAL_PRIORITY_CREATE_INFO
• globalPriority must be a valid VkQueueGlobalPriority value

Layout

 struct VkDeviceQueueGlobalPriorityCreateInfo {
     VkStructureType sType();
     void const * pNext();
     VkQueueGlobalPriority globalPriority();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkDeviceQueueGlobalPriorityCreateInfo	calloc()	Returns a new VkDeviceQueueGlobalPriorityCreateInfo instance allocated with memCalloc.
static VkDeviceQueueGlobalPriorityCreateInfo.Buffer	calloc(int capacity)	Returns a new VkDeviceQueueGlobalPriorityCreateInfo.Buffer instance allocated with memCalloc.
static VkDeviceQueueGlobalPriorityCreateInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDeviceQueueGlobalPriorityCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDeviceQueueGlobalPriorityCreateInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDeviceQueueGlobalPriorityCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDeviceQueueGlobalPriorityCreateInfo	create()	Returns a new VkDeviceQueueGlobalPriorityCreateInfo instance allocated with BufferUtils.
static VkDeviceQueueGlobalPriorityCreateInfo.Buffer	create(int capacity)	Returns a new VkDeviceQueueGlobalPriorityCreateInfo.Buffer instance allocated with BufferUtils.
static VkDeviceQueueGlobalPriorityCreateInfo	create(long address)	Returns a new VkDeviceQueueGlobalPriorityCreateInfo instance for the specified memory address.
static VkDeviceQueueGlobalPriorityCreateInfo.Buffer	create(long address, int capacity)	Create a VkDeviceQueueGlobalPriorityCreateInfo.Buffer instance at the specified memory.
static @Nullable VkDeviceQueueGlobalPriorityCreateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDeviceQueueGlobalPriorityCreateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	globalPriority()	the system-wide priority associated to these queues as specified by VkQueueGlobalPriority
VkDeviceQueueGlobalPriorityCreateInfo	globalPriority(int value)	Sets the specified value to the globalPriority() field.
static VkDeviceQueueGlobalPriorityCreateInfo	malloc()	Returns a new VkDeviceQueueGlobalPriorityCreateInfo instance allocated with memAlloc.
static VkDeviceQueueGlobalPriorityCreateInfo.Buffer	malloc(int capacity)	Returns a new VkDeviceQueueGlobalPriorityCreateInfo.Buffer instance allocated with memAlloc.
static VkDeviceQueueGlobalPriorityCreateInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDeviceQueueGlobalPriorityCreateInfo.Buffer instance allocated on the specified MemoryStack.
static VkDeviceQueueGlobalPriorityCreateInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDeviceQueueGlobalPriorityCreateInfo instance allocated on the specified MemoryStack.
static int	nglobalPriority(long struct)	Unsafe version of globalPriority().
static void	nglobalPriority(long struct, int value)	Unsafe version of globalPriority.
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.
VkDeviceQueueGlobalPriorityCreateInfo	pNext(long value)	Sets the specified value to the pNext() field.
VkDeviceQueueGlobalPriorityCreateInfo	set(int sType, long pNext, int globalPriority)	Initializes this struct with the specified values.
VkDeviceQueueGlobalPriorityCreateInfo	set(VkDeviceQueueGlobalPriorityCreateInfo src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkDeviceQueueGlobalPriorityCreateInfo	sType(int value)	Sets the specified value to the sType() field.
VkDeviceQueueGlobalPriorityCreateInfo	sType$Default()	Sets the STRUCTURE_TYPE_DEVICE_QUEUE_GLOBAL_PRIORITY_CREATE_INFO 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.

GLOBALPRIORITY

public static final int GLOBALPRIORITY

The struct member offsets.

Constructor Details

VkDeviceQueueGlobalPriorityCreateInfo

public VkDeviceQueueGlobalPriorityCreateInfo(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

globalPriority

public int globalPriority()

the system-wide priority associated to these queues as specified by VkQueueGlobalPriority

sType

public VkDeviceQueueGlobalPriorityCreateInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkDeviceQueueGlobalPriorityCreateInfo sType$Default()

Sets the STRUCTURE_TYPE_DEVICE_QUEUE_GLOBAL_PRIORITY_CREATE_INFO value to the sType() field.

pNext

public VkDeviceQueueGlobalPriorityCreateInfo pNext(long value)

Sets the specified value to the pNext() field.

globalPriority

public VkDeviceQueueGlobalPriorityCreateInfo globalPriority(int value)

Sets the specified value to the globalPriority() field.

set

public VkDeviceQueueGlobalPriorityCreateInfo set(int sType,
 long pNext,
 int globalPriority)

Initializes this struct with the specified values.

set

public VkDeviceQueueGlobalPriorityCreateInfo set(VkDeviceQueueGlobalPriorityCreateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDeviceQueueGlobalPriorityCreateInfo malloc()

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

calloc

public static VkDeviceQueueGlobalPriorityCreateInfo calloc()

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

create

public static VkDeviceQueueGlobalPriorityCreateInfo create()

Returns a new VkDeviceQueueGlobalPriorityCreateInfo instance allocated with BufferUtils.

create

public static VkDeviceQueueGlobalPriorityCreateInfo create(long address)

Returns a new VkDeviceQueueGlobalPriorityCreateInfo instance for the specified memory address.

createSafe

public static @Nullable VkDeviceQueueGlobalPriorityCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDeviceQueueGlobalPriorityCreateInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDeviceQueueGlobalPriorityCreateInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDeviceQueueGlobalPriorityCreateInfo.Buffer create(int capacity)

Returns a new VkDeviceQueueGlobalPriorityCreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDeviceQueueGlobalPriorityCreateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkDeviceQueueGlobalPriorityCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nglobalPriority

public static int nglobalPriority(long struct)

Unsafe version of globalPriority().

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.

nglobalPriority

public static void nglobalPriority(long struct,
 int value)

Unsafe version of globalPriority.