Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkDeviceQueueInfo2

extends Struct<VkDeviceQueueInfo2>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying the parameters used for device queue creation.
Description

The queue returned by vkGetDeviceQueue2 must have the same flags value from this structure as that used at device creation time in a VkDeviceQueueCreateInfo structure.

Note

Normally, if you create both protected-capable and non-protected-capable queues with the same family, they are treated as separate lists of queues and queueIndex is relative to the start of the list of queues specified by both queueFamilyIndex and flags. However, for historical reasons, some implementations may exhibit different behavior. These divergent implementations instead concatenate the lists of queues and treat queueIndex as relative to the start of the first list of queues with the given queueFamilyIndex. This only matters in cases where an application has created both protected-capable and non-protected-capable queues from the same queue family.

For such divergent implementations, the maximum value of queueIndex is equal to the sum of VkDeviceQueueCreateInfo::queueCount minus one, for all VkDeviceQueueCreateInfo structures that share a common queueFamilyIndex.

Such implementations will return NULL for either the protected or unprotected queues when calling vkGetDeviceQueue2 with queueIndex in the range zero to VkDeviceQueueCreateInfo::queueCount minus one. In cases where these implementations returned NULL, the corresponding queues are instead located in the extended range described in the preceding two paragraphs.

This behaviour will not be observed on any driver that has passed Vulkan conformance test suite version 1.3.3.0, or any subsequent version. This information can be found by querying VkPhysicalDeviceDriverProperties::conformanceVersion.

Valid Usage
Valid Usage (Implicit)
See Also

GetDeviceQueue2

Layout


struct VkDeviceQueueInfo2 {
    VkStructureType sType;
    void const * pNext;
    VkDeviceQueueCreateFlags flags;
    uint32_t queueFamilyIndex;
    uint32_t queueIndex;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
FLAGS

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
QUEUEFAMILYINDEX

The struct member offsets.

public static final int
QUEUEINDEX

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
VkDeviceQueueInfo2(long address, ByteBuffer container)

public
VkDeviceQueueInfo2(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkDeviceQueueInfo2
calloc()

Returns a new VkDeviceQueueInfo2 instance allocated with memCalloc.

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

Returns a new VkDeviceQueueInfo2.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkDeviceQueueInfo2
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
protected VkDeviceQueueInfo2
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 VkDeviceQueueInfo2
create()

Returns a new VkDeviceQueueInfo2 instance allocated with BufferUtils.

public static VkDeviceQueueInfo2
create(long address)

Returns a new VkDeviceQueueInfo2 instance for the specified memory address.

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

Returns a new VkDeviceQueueInfo2.Buffer instance allocated with BufferUtils.

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

Create a VkDeviceQueueInfo2.Buffer instance at the specified memory.

public static VkDeviceQueueInfo2
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
flags()

a VkDeviceQueueCreateFlags value indicating the flags used to create the device queue.

public VkDeviceQueueInfo2
flags(int value)

Sets the specified value to the flags field.

public static VkDeviceQueueInfo2
malloc()

Returns a new VkDeviceQueueInfo2 instance allocated with memAlloc.

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

Returns a new VkDeviceQueueInfo2.Buffer instance allocated with memAlloc.

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

Returns a new VkDeviceQueueInfo2 instance allocated on the specified MemoryStack.

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

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

public static VkDeviceQueueInfo2
mallocStack()

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

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

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

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

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nqueueFamilyIndex(long struct)

Unsafe version of queueFamilyIndex.

public static void
nqueueFamilyIndex(long struct, int value)

Unsafe version of queueFamilyIndex.

public static int
nqueueIndex(long struct)

Unsafe version of queueIndex.

public static void
nqueueIndex(long struct, int value)

Unsafe version of queueIndex.

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 VkDeviceQueueInfo2
pNext(long value)

Sets the specified value to the pNext field.

public int
queueFamilyIndex()

the index of the queue family to which the queue belongs.

public VkDeviceQueueInfo2
queueFamilyIndex(int value)

Sets the specified value to the queueFamilyIndex field.

public int
queueIndex()

the index of the queue to retrieve from within the set of queues that share both the queue family and flags specified.

public VkDeviceQueueInfo2
queueIndex(int value)

Sets the specified value to the queueIndex field.

public VkDeviceQueueInfo2
set(int sType, long pNext, int flags, int queueFamilyIndex, int queueIndex)

Initializes this struct with the specified values.

public VkDeviceQueueInfo2

Returns:

this struct
set
(VkDeviceQueueInfo2
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 VkDeviceQueueInfo2
sType(int value)

Sets the specified value to the sType field.

public VkDeviceQueueInfo2
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.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

QUEUEFAMILYINDEXback to summary
public static final int QUEUEFAMILYINDEX

The struct member offsets.

QUEUEINDEXback to summary
public static final int QUEUEINDEX

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

VkDeviceQueueInfo2back to summary
protected VkDeviceQueueInfo2(long address, ByteBuffer container)
VkDeviceQueueInfo2back to summary
public VkDeviceQueueInfo2(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkDeviceQueueInfo2 calloc(MemoryStack stack)

Returns a new VkDeviceQueueInfo2 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 VkDeviceQueueInfo2.Buffer calloc(int capacity, MemoryStack stack)

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkDeviceQueueInfo2.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 VkDeviceQueueInfo2 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 VkDeviceQueueInfo2 create()

Returns a new VkDeviceQueueInfo2 instance allocated with BufferUtils.

createback to summary
public static VkDeviceQueueInfo2 create(long address)

Returns a new VkDeviceQueueInfo2 instance for the specified memory address.

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

Returns a new VkDeviceQueueInfo2.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkDeviceQueueInfo2.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkDeviceQueueInfo2 createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public int flags()

a VkDeviceQueueCreateFlags value indicating the flags used to create the device queue.

Annotations
@NativeType:VkDeviceQueueCreateFlags
flagsback to summary
public VkDeviceQueueInfo2 flags(int value)

Sets the specified value to the flags field.

mallocback to summary
public static VkDeviceQueueInfo2 malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkDeviceQueueInfo2 malloc(MemoryStack stack)

Returns a new VkDeviceQueueInfo2 instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nflagsback to summary
public static int nflags(long struct)

Unsafe version of flags.

nflagsback to summary
public static void nflags(long struct, int value)

Unsafe version of flags.

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.

nqueueFamilyIndexback to summary
public static int nqueueFamilyIndex(long struct)

Unsafe version of queueFamilyIndex.

nqueueFamilyIndexback to summary
public static void nqueueFamilyIndex(long struct, int value)

Unsafe version of queueFamilyIndex.

nqueueIndexback to summary
public static int nqueueIndex(long struct)

Unsafe version of queueIndex.

nqueueIndexback to summary
public static void nqueueIndex(long struct, int value)

Unsafe version of queueIndex.

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. The pNext chain of VkDeviceQueueInfo2 can be used to provide additional device queue parameters to vkGetDeviceQueue2.

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

Sets the specified value to the pNext field.

queueFamilyIndexback to summary
public int queueFamilyIndex()

the index of the queue family to which the queue belongs.

Annotations
@NativeType:uint32_t
queueFamilyIndexback to summary
public VkDeviceQueueInfo2 queueFamilyIndex(int value)

Sets the specified value to the queueFamilyIndex field.

queueIndexback to summary
public int queueIndex()

the index of the queue to retrieve from within the set of queues that share both the queue family and flags specified.

Annotations
@NativeType:uint32_t
queueIndexback to summary
public VkDeviceQueueInfo2 queueIndex(int value)

Sets the specified value to the queueIndex field.

setback to summary
public VkDeviceQueueInfo2 set(int sType, long pNext, int flags, int queueFamilyIndex, int queueIndex)

Initializes this struct with the specified values.

setback to summary
public VkDeviceQueueInfo2 set(VkDeviceQueueInfo2 src)

Copies the specified struct data to this struct.

Parameters
src:VkDeviceQueueInfo2

the source struct

Returns:VkDeviceQueueInfo2

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 VkDeviceQueueInfo2 sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_DEVICE_QUEUE_INFO_2 value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkDeviceQueueInfo2.Buffer

extends StructBuffer<VkDeviceQueueInfo2, VkDeviceQueueInfo2.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkDeviceQueueInfo2 structs.

Field Summary

Modifier and TypeField and Description
private static final VkDeviceQueueInfo2

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkDeviceQueueInfo2.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
public int

Returns:

the value of the VkDeviceQueueInfo2#flags field.
flags
()

public VkDeviceQueueInfo2.Buffer
flags(int value)

Sets the specified value to the VkDeviceQueueInfo2#flags field.

protected VkDeviceQueueInfo2
public long

Returns:

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

public VkDeviceQueueInfo2.Buffer
pNext(long value)

Sets the specified value to the VkDeviceQueueInfo2#pNext field.

public int

Returns:

the value of the VkDeviceQueueInfo2#queueFamilyIndex field.
queueFamilyIndex
()

public VkDeviceQueueInfo2.Buffer
queueFamilyIndex(int value)

Sets the specified value to the VkDeviceQueueInfo2#queueFamilyIndex field.

public int

Returns:

the value of the VkDeviceQueueInfo2#queueIndex field.
queueIndex
()

public VkDeviceQueueInfo2.Buffer
queueIndex(int value)

Sets the specified value to the VkDeviceQueueInfo2#queueIndex field.

protected VkDeviceQueueInfo2.Buffer
public int

Returns:

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

public VkDeviceQueueInfo2.Buffer
sType(int value)

Sets the specified value to the VkDeviceQueueInfo2#sType field.

public VkDeviceQueueInfo2.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkDeviceQueueInfo2 ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkDeviceQueueInfo2.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 VkDeviceQueueInfo2#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

flagsback to summary
public int flags()
Returns:int

the value of the VkDeviceQueueInfo2#flags field.

Annotations
@NativeType:VkDeviceQueueCreateFlags
flagsback to summary
public VkDeviceQueueInfo2.Buffer flags(int value)

Sets the specified value to the VkDeviceQueueInfo2#flags field.

getElementFactoryback to summary
protected VkDeviceQueueInfo2 getElementFactory()

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

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

the value of the VkDeviceQueueInfo2#pNext field.

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

Sets the specified value to the VkDeviceQueueInfo2#pNext field.

queueFamilyIndexback to summary
public int queueFamilyIndex()
Returns:int

the value of the VkDeviceQueueInfo2#queueFamilyIndex field.

Annotations
@NativeType:uint32_t
queueFamilyIndexback to summary
public VkDeviceQueueInfo2.Buffer queueFamilyIndex(int value)

Sets the specified value to the VkDeviceQueueInfo2#queueFamilyIndex field.

queueIndexback to summary
public int queueIndex()
Returns:int

the value of the VkDeviceQueueInfo2#queueIndex field.

Annotations
@NativeType:uint32_t
queueIndexback to summary
public VkDeviceQueueInfo2.Buffer queueIndex(int value)

Sets the specified value to the VkDeviceQueueInfo2#queueIndex field.

selfback to summary
protected VkDeviceQueueInfo2.Buffer self()

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

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

the value of the VkDeviceQueueInfo2#sType field.

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

Sets the specified value to the VkDeviceQueueInfo2#sType field.

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

Sets the STRUCTURE_TYPE_DEVICE_QUEUE_INFO_2 value to the VkDeviceQueueInfo2#sType field.