Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkQueueFamilyGlobalPriorityPropertiesKHR

extends Struct<VkQueueFamilyGlobalPriorityPropertiesKHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkQueueFamilyGlobalPriorityPropertiesEXT
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Return structure for queue family global priority information query.
Description

If the VkQueueFamilyGlobalPriorityPropertiesKHR 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 VkQueueGlobalPriorityKHR enums in the ascending order.

Note

For example, returning priorityCount as 3 with supported priorities as QUEUE_GLOBAL_PRIORITY_LOW_KHR, QUEUE_GLOBAL_PRIORITY_MEDIUM_KHR and QUEUE_GLOBAL_PRIORITY_REALTIME_KHR is not allowed.

Valid Usage (Implicit)

Layout


struct VkQueueFamilyGlobalPriorityPropertiesKHR {
    VkStructureType sType;
    void * pNext;
    uint32_t priorityCount;
    VkQueueGlobalPriorityKHR priorities[VK_MAX_GLOBAL_PRIORITY_SIZE_KHR];
}

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
PNEXT

The struct member offsets.

public static final int
PRIORITIES

The struct member offsets.

public static final int
PRIORITYCOUNT

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
public
VkQueueFamilyGlobalPriorityPropertiesKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkQueueFamilyGlobalPriorityPropertiesKHR
calloc()

Returns a new VkQueueFamilyGlobalPriorityPropertiesKHR instance allocated with memCalloc.

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

Returns a new VkQueueFamilyGlobalPriorityPropertiesKHR.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkQueueFamilyGlobalPriorityPropertiesKHR
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 VkQueueFamilyGlobalPriorityPropertiesKHR
create()

Returns a new VkQueueFamilyGlobalPriorityPropertiesKHR instance allocated with BufferUtils.

public static VkQueueFamilyGlobalPriorityPropertiesKHR
create(long address)

Returns a new VkQueueFamilyGlobalPriorityPropertiesKHR instance for the specified memory address.

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

Returns a new VkQueueFamilyGlobalPriorityPropertiesKHR.Buffer instance allocated with BufferUtils.

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

Create a VkQueueFamilyGlobalPriorityPropertiesKHR.Buffer instance at the specified memory.

public static VkQueueFamilyGlobalPriorityPropertiesKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkQueueFamilyGlobalPriorityPropertiesKHR
malloc()

Returns a new VkQueueFamilyGlobalPriorityPropertiesKHR instance allocated with memAlloc.

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

Returns a new VkQueueFamilyGlobalPriorityPropertiesKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkQueueFamilyGlobalPriorityPropertiesKHR instance allocated on the specified MemoryStack.

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

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

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static IntBuffer
npriorities(long struct)

Unsafe version of priorities.

public static int
npriorities(long struct, int index)

Unsafe version of priorities.

public static void
npriorities(long struct, IntBuffer value)

Unsafe version of priorities.

public static void
npriorities(long struct, int index, int value)

Unsafe version of priorities.

public static int
npriorityCount(long struct)

Unsafe version of priorityCount.

public static void
npriorityCount(long struct, int value)

Unsafe version of priorityCount.

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

Sets the specified value to the pNext field.

public IntBuffer
priorities()

an array of MAX_GLOBAL_PRIORITY_SIZE_EXT VkQueueGlobalPriorityEXT enums representing all supported global queue priorities in this queue family.

public int
priorities(int index)

an array of MAX_GLOBAL_PRIORITY_SIZE_EXT VkQueueGlobalPriorityEXT enums representing all supported global queue priorities in this queue family.

public VkQueueFamilyGlobalPriorityPropertiesKHR
priorities(IntBuffer value)

Copies the specified IntBuffer to the priorities field.

public VkQueueFamilyGlobalPriorityPropertiesKHR
priorities(int index, int value)

Sets the specified value at the specified index of the priorities field.

public int
priorityCount()

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

public VkQueueFamilyGlobalPriorityPropertiesKHR
priorityCount(int value)

Sets the specified value to the priorityCount field.

public VkQueueFamilyGlobalPriorityPropertiesKHR
set(int sType, long pNext, int priorityCount, IntBuffer priorities)

Initializes this struct with the specified values.

public VkQueueFamilyGlobalPriorityPropertiesKHR

Returns:

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

Sets the specified value to the sType field.

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

PRIORITIESback to summary
public static final int PRIORITIES

The struct member offsets.

PRIORITYCOUNTback to summary
public static final int PRIORITYCOUNT

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

VkQueueFamilyGlobalPriorityPropertiesKHRback to summary
protected VkQueueFamilyGlobalPriorityPropertiesKHR(long address, ByteBuffer container)
VkQueueFamilyGlobalPriorityPropertiesKHRback to summary
public VkQueueFamilyGlobalPriorityPropertiesKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkQueueFamilyGlobalPriorityPropertiesKHR calloc(MemoryStack stack)

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

Returns a new VkQueueFamilyGlobalPriorityPropertiesKHR.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

createback to summary
protected VkQueueFamilyGlobalPriorityPropertiesKHR 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 VkQueueFamilyGlobalPriorityPropertiesKHR create()

Returns a new VkQueueFamilyGlobalPriorityPropertiesKHR instance allocated with BufferUtils.

createback to summary
public static VkQueueFamilyGlobalPriorityPropertiesKHR create(long address)

Returns a new VkQueueFamilyGlobalPriorityPropertiesKHR instance for the specified memory address.

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

Returns a new VkQueueFamilyGlobalPriorityPropertiesKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkQueueFamilyGlobalPriorityPropertiesKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkQueueFamilyGlobalPriorityPropertiesKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkQueueFamilyGlobalPriorityPropertiesKHR malloc(MemoryStack stack)

Returns a new VkQueueFamilyGlobalPriorityPropertiesKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

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.

nprioritiesback to summary
public static IntBuffer npriorities(long struct)

Unsafe version of priorities.

nprioritiesback to summary
public static int npriorities(long struct, int index)

Unsafe version of priorities.

nprioritiesback to summary
public static void npriorities(long struct, IntBuffer value)

Unsafe version of priorities.

nprioritiesback to summary
public static void npriorities(long struct, int index, int value)

Unsafe version of priorities.

npriorityCountback to summary
public static int npriorityCount(long struct)

Unsafe version of priorityCount.

npriorityCountback to summary
public static void npriorityCount(long struct, int value)

Unsafe version of priorityCount.

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 *
pNextback to summary
public VkQueueFamilyGlobalPriorityPropertiesKHR pNext(long value)

Sets the specified value to the pNext field.

prioritiesback to summary
public IntBuffer priorities()

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

Annotations
@NativeType:VkQueueGlobalPriorityKHR[VK_MAX_GLOBAL_PRIORITY_SIZE_KHR]
prioritiesback to summary
public int priorities(int index)

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

Annotations
@NativeType:VkQueueGlobalPriorityKHR
prioritiesback to summary
public VkQueueFamilyGlobalPriorityPropertiesKHR priorities(IntBuffer value)

Copies the specified IntBuffer to the priorities field.

prioritiesback to summary
public VkQueueFamilyGlobalPriorityPropertiesKHR priorities(int index, int value)

Sets the specified value at the specified index of the priorities field.

priorityCountback to summary
public int priorityCount()

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

Annotations
@NativeType:uint32_t
priorityCountback to summary
public VkQueueFamilyGlobalPriorityPropertiesKHR priorityCount(int value)

Sets the specified value to the priorityCount field.

setback to summary
public VkQueueFamilyGlobalPriorityPropertiesKHR set(int sType, long pNext, int priorityCount, IntBuffer priorities)

Initializes this struct with the specified values.

setback to summary
public VkQueueFamilyGlobalPriorityPropertiesKHR set(VkQueueFamilyGlobalPriorityPropertiesKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkQueueFamilyGlobalPriorityPropertiesKHR

the source struct

Returns:VkQueueFamilyGlobalPriorityPropertiesKHR

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_QUEUE_FAMILY_GLOBAL_PRIORITY_PROPERTIES_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkQueueFamilyGlobalPriorityPropertiesKHR.Buffer

extends StructBuffer<VkQueueFamilyGlobalPriorityPropertiesKHR, VkQueueFamilyGlobalPriorityPropertiesKHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkQueueFamilyGlobalPriorityPropertiesEXT.Buffer

An array of VkQueueFamilyGlobalPriorityPropertiesKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkQueueFamilyGlobalPriorityPropertiesKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkQueueFamilyGlobalPriorityPropertiesKHR.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 VkQueueFamilyGlobalPriorityPropertiesKHR
public long

Returns:

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

public VkQueueFamilyGlobalPriorityPropertiesKHR.Buffer
pNext(long value)

Sets the specified value to the VkQueueFamilyGlobalPriorityPropertiesKHR#pNext field.

public IntBuffer
public int

Returns:

the value at the specified index of the VkQueueFamilyGlobalPriorityPropertiesKHR#priorities field.
priorities
(int index)

public VkQueueFamilyGlobalPriorityPropertiesKHR.Buffer
public VkQueueFamilyGlobalPriorityPropertiesKHR.Buffer
priorities(int index, int value)

Sets the specified value at the specified index of the VkQueueFamilyGlobalPriorityPropertiesKHR#priorities field.

public int
public VkQueueFamilyGlobalPriorityPropertiesKHR.Buffer
priorityCount(int value)

Sets the specified value to the VkQueueFamilyGlobalPriorityPropertiesKHR#priorityCount field.

protected VkQueueFamilyGlobalPriorityPropertiesKHR.Buffer
public int

Returns:

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

public VkQueueFamilyGlobalPriorityPropertiesKHR.Buffer
sType(int value)

Sets the specified value to the VkQueueFamilyGlobalPriorityPropertiesKHR#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkQueueFamilyGlobalPriorityPropertiesKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkQueueFamilyGlobalPriorityPropertiesKHR.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 VkQueueFamilyGlobalPriorityPropertiesKHR#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 VkQueueFamilyGlobalPriorityPropertiesKHR getElementFactory()

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

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

the value of the VkQueueFamilyGlobalPriorityPropertiesKHR#pNext field.

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

Sets the specified value to the VkQueueFamilyGlobalPriorityPropertiesKHR#pNext field.

prioritiesback to summary
public IntBuffer priorities()
Returns:IntBuffer

a IntBuffer view of the VkQueueFamilyGlobalPriorityPropertiesKHR#priorities field.

Annotations
@NativeType:VkQueueGlobalPriorityKHR[VK_MAX_GLOBAL_PRIORITY_SIZE_KHR]
prioritiesback to summary
public int priorities(int index)
Returns:int

the value at the specified index of the VkQueueFamilyGlobalPriorityPropertiesKHR#priorities field.

Annotations
@NativeType:VkQueueGlobalPriorityKHR
prioritiesback to summary
public VkQueueFamilyGlobalPriorityPropertiesKHR.Buffer priorities(IntBuffer value)

Copies the specified IntBuffer to the VkQueueFamilyGlobalPriorityPropertiesKHR#priorities field.

prioritiesback to summary
public VkQueueFamilyGlobalPriorityPropertiesKHR.Buffer priorities(int index, int value)

Sets the specified value at the specified index of the VkQueueFamilyGlobalPriorityPropertiesKHR#priorities field.

priorityCountback to summary
public int priorityCount()
Returns:int

the value of the VkQueueFamilyGlobalPriorityPropertiesKHR#priorityCount field.

Annotations
@NativeType:uint32_t
priorityCountback to summary
public VkQueueFamilyGlobalPriorityPropertiesKHR.Buffer priorityCount(int value)

Sets the specified value to the VkQueueFamilyGlobalPriorityPropertiesKHR#priorityCount field.

selfback to summary
protected VkQueueFamilyGlobalPriorityPropertiesKHR.Buffer self()

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

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

the value of the VkQueueFamilyGlobalPriorityPropertiesKHR#sType field.

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

Sets the specified value to the VkQueueFamilyGlobalPriorityPropertiesKHR#sType field.

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

Sets the STRUCTURE_TYPE_QUEUE_FAMILY_GLOBAL_PRIORITY_PROPERTIES_KHR value to the VkQueueFamilyGlobalPriorityPropertiesKHR#sType field.