Package org.lwjgl.vulkan

Class VkDeviceQueueCreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDeviceQueueCreateInfo>

org.lwjgl.vulkan.VkDeviceQueueCreateInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkDeviceQueueCreateInfo
extends Struct<VkDeviceQueueCreateInfo>
implements NativeResource

Structure specifying parameters of a newly created device queue.

Valid Usage

• queueFamilyIndex must be less than pQueueFamilyPropertyCount returned by vkGetPhysicalDeviceQueueFamilyProperties
• queueCount must be less than or equal to the queueCount member of the VkQueueFamilyProperties structure, as returned by vkGetPhysicalDeviceQueueFamilyProperties in the pQueueFamilyProperties[queueFamilyIndex]
• Each element of pQueuePriorities must be between 0.0 and 1.0 inclusive
• If the protectedMemory feature is not enabled, the DEVICE_QUEUE_CREATE_PROTECTED_BIT bit of flags must not be set
• If flags includes DEVICE_QUEUE_CREATE_PROTECTED_BIT, queueFamilyIndex must be the index of a queue family that includes the QUEUE_PROTECTED_BIT capability
• If the pNext chain includes a VkDeviceQueueShaderCoreControlCreateInfoARM structure then VkPhysicalDeviceSchedulingControlsPropertiesARM::schedulingControlsFlags must contain PHYSICAL_DEVICE_SCHEDULING_CONTROLS_SHADER_CORE_COUNT_ARM.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DEVICE_QUEUE_CREATE_INFO
• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkDeviceQueueGlobalPriorityCreateInfoKHR or VkDeviceQueueShaderCoreControlCreateInfoARM
• The sType value of each struct in the pNext chain must be unique
• flags must be a valid combination of VkDeviceQueueCreateFlagBits values
• pQueuePriorities must be a valid pointer to an array of queueCount float values
• queueCount must be greater than 0

See Also

VkDeviceCreateInfo

Layout

 struct VkDeviceQueueCreateInfo {
     VkStructureType sType();
     void const * pNext();
     VkDeviceQueueCreateFlags flags();
     uint32_t queueFamilyIndex();
     uint32_t queueCount();
     float const * pQueuePriorities();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkDeviceQueueCreateInfo.Buffer	An array of VkDeviceQueueCreateInfo structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	FLAGS	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	PQUEUEPRIORITIES	The struct member offsets.
static final int	QUEUECOUNT	The struct member offsets.
static final int	QUEUEFAMILYINDEX	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
VkDeviceQueueCreateInfo(ByteBuffer container)	Creates a VkDeviceQueueCreateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkDeviceQueueCreateInfo	calloc()	Returns a new VkDeviceQueueCreateInfo instance allocated with memCalloc.
static VkDeviceQueueCreateInfo.Buffer	calloc(int capacity)	Returns a new VkDeviceQueueCreateInfo.Buffer instance allocated with memCalloc.
static VkDeviceQueueCreateInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkDeviceQueueCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDeviceQueueCreateInfo	calloc(MemoryStack stack)	Returns a new VkDeviceQueueCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDeviceQueueCreateInfo	callocStack()	Deprecated.
static VkDeviceQueueCreateInfo.Buffer	callocStack(int capacity)	Deprecated.
static VkDeviceQueueCreateInfo.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkDeviceQueueCreateInfo	callocStack(MemoryStack stack)	Deprecated.
static VkDeviceQueueCreateInfo	create()	Returns a new VkDeviceQueueCreateInfo instance allocated with BufferUtils.
static VkDeviceQueueCreateInfo.Buffer	create(int capacity)	Returns a new VkDeviceQueueCreateInfo.Buffer instance allocated with BufferUtils.
static VkDeviceQueueCreateInfo	create(long address)	Returns a new VkDeviceQueueCreateInfo instance for the specified memory address.
static VkDeviceQueueCreateInfo.Buffer	create(long address, int capacity)	Create a VkDeviceQueueCreateInfo.Buffer instance at the specified memory.
static VkDeviceQueueCreateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static VkDeviceQueueCreateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()	a bitmask indicating behavior of the queues.
VkDeviceQueueCreateInfo	flags(int value)	Sets the specified value to the flags() field.
static VkDeviceQueueCreateInfo	malloc()	Returns a new VkDeviceQueueCreateInfo instance allocated with memAlloc.
static VkDeviceQueueCreateInfo.Buffer	malloc(int capacity)	Returns a new VkDeviceQueueCreateInfo.Buffer instance allocated with memAlloc.
static VkDeviceQueueCreateInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkDeviceQueueCreateInfo.Buffer instance allocated on the specified MemoryStack.
static VkDeviceQueueCreateInfo	malloc(MemoryStack stack)	Returns a new VkDeviceQueueCreateInfo instance allocated on the specified MemoryStack.
static VkDeviceQueueCreateInfo	mallocStack()	Deprecated.
static VkDeviceQueueCreateInfo.Buffer	mallocStack(int capacity)	Deprecated.
static VkDeviceQueueCreateInfo.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkDeviceQueueCreateInfo	mallocStack(MemoryStack stack)	Deprecated.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static FloatBuffer	npQueuePriorities(long struct)	Unsafe version of pQueuePriorities.
static void	npQueuePriorities(long struct, FloatBuffer value)	Unsafe version of pQueuePriorities.
static int	nqueueCount(long struct)	Unsafe version of queueCount().
static void	nqueueCount(long struct, int value)	Sets the specified value to the queueCount field of the specified struct.
static int	nqueueFamilyIndex(long struct)	Unsafe version of queueFamilyIndex().
static void	nqueueFamilyIndex(long struct, int value)	Unsafe version of queueFamilyIndex.
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.
VkDeviceQueueCreateInfo	pNext(long value)	Sets the specified value to the pNext() field.
VkDeviceQueueCreateInfo	pNext(VkDeviceQueueGlobalPriorityCreateInfoEXT value)	Prepends the specified VkDeviceQueueGlobalPriorityCreateInfoEXT value to the pNext chain.
VkDeviceQueueCreateInfo	pNext(VkDeviceQueueGlobalPriorityCreateInfoKHR value)	Prepends the specified VkDeviceQueueGlobalPriorityCreateInfoKHR value to the pNext chain.
VkDeviceQueueCreateInfo	pNext(VkDeviceQueueShaderCoreControlCreateInfoARM value)	Prepends the specified VkDeviceQueueShaderCoreControlCreateInfoARM value to the pNext chain.
FloatBuffer	pQueuePriorities()	a pointer to an array of queueCount normalized floating point values, specifying priorities of work that will be submitted to each created queue.
VkDeviceQueueCreateInfo	pQueuePriorities(FloatBuffer value)	Sets the address of the specified FloatBuffer to the pQueuePriorities() field.
int	queueCount()	an unsigned integer specifying the number of queues to create in the queue family indicated by queueFamilyIndex, and with the behavior specified by flags.
int	queueFamilyIndex()	an unsigned integer indicating the index of the queue family in which to create the queues on this device.
VkDeviceQueueCreateInfo	queueFamilyIndex(int value)	Sets the specified value to the queueFamilyIndex() field.
VkDeviceQueueCreateInfo	set(int sType, long pNext, int flags, int queueFamilyIndex, FloatBuffer pQueuePriorities)	Initializes this struct with the specified values.
VkDeviceQueueCreateInfo	set(VkDeviceQueueCreateInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()	a VkStructureType value identifying this structure.
VkDeviceQueueCreateInfo	sType(int value)	Sets the specified value to the sType() field.
VkDeviceQueueCreateInfo	sType$Default()	Sets the STRUCTURE_TYPE_DEVICE_QUEUE_CREATE_INFO value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

FLAGS

public static final int FLAGS

The struct member offsets.

QUEUEFAMILYINDEX

public static final int QUEUEFAMILYINDEX

The struct member offsets.

QUEUECOUNT

public static final int QUEUECOUNT

The struct member offsets.

PQUEUEPRIORITIES

public static final int PQUEUEPRIORITIES

The struct member offsets.

Constructor Details

VkDeviceQueueCreateInfo

public VkDeviceQueueCreateInfo(ByteBuffer container)

Creates a VkDeviceQueueCreateInfo 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()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkDeviceQueueCreateInfo>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

flags

public int flags()

a bitmask indicating behavior of the queues.

queueFamilyIndex

public int queueFamilyIndex()

an unsigned integer indicating the index of the queue family in which to create the queues on this device. This index corresponds to the index of an element of the pQueueFamilyProperties array that was returned by vkGetPhysicalDeviceQueueFamilyProperties.

queueCount

public int queueCount()

an unsigned integer specifying the number of queues to create in the queue family indicated by queueFamilyIndex, and with the behavior specified by flags.

pQueuePriorities

public FloatBuffer pQueuePriorities()

a pointer to an array of queueCount normalized floating point values, specifying priorities of work that will be submitted to each created queue. See Queue Priority for more information.

sType

public VkDeviceQueueCreateInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkDeviceQueueCreateInfo sType$Default()

Sets the STRUCTURE_TYPE_DEVICE_QUEUE_CREATE_INFO value to the sType() field.

pNext

public VkDeviceQueueCreateInfo pNext(long value)

Sets the specified value to the pNext() field.

pNext

public VkDeviceQueueCreateInfo pNext(VkDeviceQueueGlobalPriorityCreateInfoEXT value)

Prepends the specified VkDeviceQueueGlobalPriorityCreateInfoEXT value to the pNext chain.

pNext

public VkDeviceQueueCreateInfo pNext(VkDeviceQueueGlobalPriorityCreateInfoKHR value)

Prepends the specified VkDeviceQueueGlobalPriorityCreateInfoKHR value to the pNext chain.

pNext

public VkDeviceQueueCreateInfo pNext(VkDeviceQueueShaderCoreControlCreateInfoARM value)

Prepends the specified VkDeviceQueueShaderCoreControlCreateInfoARM value to the pNext chain.

flags

public VkDeviceQueueCreateInfo flags(int value)

Sets the specified value to the flags() field.

queueFamilyIndex

public VkDeviceQueueCreateInfo queueFamilyIndex(int value)

Sets the specified value to the queueFamilyIndex() field.

pQueuePriorities

public VkDeviceQueueCreateInfo pQueuePriorities(FloatBuffer value)

Sets the address of the specified FloatBuffer to the pQueuePriorities() field.

set

public VkDeviceQueueCreateInfo set(int sType,
 long pNext,
 int flags,
 int queueFamilyIndex,
 FloatBuffer pQueuePriorities)

Initializes this struct with the specified values.

set

public VkDeviceQueueCreateInfo set(VkDeviceQueueCreateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDeviceQueueCreateInfo malloc()

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

calloc

public static VkDeviceQueueCreateInfo calloc()

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

create

public static VkDeviceQueueCreateInfo create()

Returns a new VkDeviceQueueCreateInfo instance allocated with BufferUtils.

create

public static VkDeviceQueueCreateInfo create(long address)

Returns a new VkDeviceQueueCreateInfo instance for the specified memory address.

createSafe

@Nullable
public static VkDeviceQueueCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDeviceQueueCreateInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDeviceQueueCreateInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDeviceQueueCreateInfo.Buffer create(int capacity)

Returns a new VkDeviceQueueCreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDeviceQueueCreateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkDeviceQueueCreateInfo mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkDeviceQueueCreateInfo callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkDeviceQueueCreateInfo mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkDeviceQueueCreateInfo callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkDeviceQueueCreateInfo.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkDeviceQueueCreateInfo.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static VkDeviceQueueCreateInfo malloc(MemoryStack stack)

Returns a new VkDeviceQueueCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkDeviceQueueCreateInfo calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkDeviceQueueCreateInfo.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkDeviceQueueCreateInfo.Buffer calloc(int capacity,
 MemoryStack stack)

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

nflags

public static int nflags(long struct)

Unsafe version of flags().

nqueueFamilyIndex

public static int nqueueFamilyIndex(long struct)

Unsafe version of queueFamilyIndex().

nqueueCount

public static int nqueueCount(long struct)

Unsafe version of queueCount().

npQueuePriorities

public static FloatBuffer npQueuePriorities(long struct)

Unsafe version of pQueuePriorities.

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.

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.

nqueueFamilyIndex

public static void nqueueFamilyIndex(long struct,
 int value)

Unsafe version of queueFamilyIndex.

nqueueCount

public static void nqueueCount(long struct,
 int value)

Sets the specified value to the queueCount field of the specified struct.

npQueuePriorities

public static void npQueuePriorities(long struct,
 FloatBuffer value)

Unsafe version of pQueuePriorities.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate