Package org.lwjgl.vulkan

Class VkQueueFamilyProperties2

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkQueueFamilyProperties2>

org.lwjgl.vulkan.VkQueueFamilyProperties2

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkQueueFamilyProperties2KHR

public class VkQueueFamilyProperties2
extends Struct<VkQueueFamilyProperties2>
implements NativeResource

Structure providing information about a queue family.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_QUEUE_FAMILY_PROPERTIES_2
• 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 VkQueueFamilyCheckpointProperties2NV, VkQueueFamilyCheckpointPropertiesNV, VkQueueFamilyGlobalPriorityPropertiesKHR, VkQueueFamilyQueryResultStatusPropertiesKHR, or VkQueueFamilyVideoPropertiesKHR
• The sType value of each struct in the pNext chain must be unique

See Also

VkQueueFamilyProperties, GetPhysicalDeviceQueueFamilyProperties2, GetPhysicalDeviceQueueFamilyProperties2KHR

Layout

 struct VkQueueFamilyProperties2 {
     VkStructureType sType();
     void * pNext();
     VkQueueFamilyProperties queueFamilyProperties();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkQueueFamilyProperties2	calloc()	Returns a new VkQueueFamilyProperties2 instance allocated with memCalloc.
static VkQueueFamilyProperties2.Buffer	calloc(int capacity)	Returns a new VkQueueFamilyProperties2.Buffer instance allocated with memCalloc.
static VkQueueFamilyProperties2.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkQueueFamilyProperties2.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkQueueFamilyProperties2	calloc(MemoryStack stack)	Returns a new VkQueueFamilyProperties2 instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkQueueFamilyProperties2	callocStack()	Deprecated.
static VkQueueFamilyProperties2.Buffer	callocStack(int capacity)	Deprecated.
static VkQueueFamilyProperties2.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkQueueFamilyProperties2	callocStack(MemoryStack stack)	Deprecated.
static VkQueueFamilyProperties2	create()	Returns a new VkQueueFamilyProperties2 instance allocated with BufferUtils.
static VkQueueFamilyProperties2.Buffer	create(int capacity)	Returns a new VkQueueFamilyProperties2.Buffer instance allocated with BufferUtils.
static VkQueueFamilyProperties2	create(long address)	Returns a new VkQueueFamilyProperties2 instance for the specified memory address.
static VkQueueFamilyProperties2.Buffer	create(long address, int capacity)	Create a VkQueueFamilyProperties2.Buffer instance at the specified memory.
static VkQueueFamilyProperties2	createSafe(long address)	Like create, but returns null if address is NULL.
static VkQueueFamilyProperties2.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkQueueFamilyProperties2	malloc()	Returns a new VkQueueFamilyProperties2 instance allocated with memAlloc.
static VkQueueFamilyProperties2.Buffer	malloc(int capacity)	Returns a new VkQueueFamilyProperties2.Buffer instance allocated with memAlloc.
static VkQueueFamilyProperties2.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkQueueFamilyProperties2.Buffer instance allocated on the specified MemoryStack.
static VkQueueFamilyProperties2	malloc(MemoryStack stack)	Returns a new VkQueueFamilyProperties2 instance allocated on the specified MemoryStack.
static VkQueueFamilyProperties2	mallocStack()	Deprecated.
static VkQueueFamilyProperties2.Buffer	mallocStack(int capacity)	Deprecated.
static VkQueueFamilyProperties2.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkQueueFamilyProperties2	mallocStack(MemoryStack stack)	Deprecated.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static VkQueueFamilyProperties	nqueueFamilyProperties(long struct)	Unsafe version of queueFamilyProperties().
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.
VkQueueFamilyProperties2	pNext(long value)	Sets the specified value to the pNext() field.
VkQueueFamilyProperties2	pNext(VkQueueFamilyCheckpointProperties2NV value)	Prepends the specified VkQueueFamilyCheckpointProperties2NV value to the pNext chain.
VkQueueFamilyProperties2	pNext(VkQueueFamilyCheckpointPropertiesNV value)	Prepends the specified VkQueueFamilyCheckpointPropertiesNV value to the pNext chain.
VkQueueFamilyProperties2	pNext(VkQueueFamilyGlobalPriorityPropertiesEXT value)	Prepends the specified VkQueueFamilyGlobalPriorityPropertiesEXT value to the pNext chain.
VkQueueFamilyProperties2	pNext(VkQueueFamilyGlobalPriorityPropertiesKHR value)	Prepends the specified VkQueueFamilyGlobalPriorityPropertiesKHR value to the pNext chain.
VkQueueFamilyProperties2	pNext(VkQueueFamilyQueryResultStatusPropertiesKHR value)	Prepends the specified VkQueueFamilyQueryResultStatusPropertiesKHR value to the pNext chain.
VkQueueFamilyProperties2	pNext(VkQueueFamilyVideoPropertiesKHR value)	Prepends the specified VkQueueFamilyVideoPropertiesKHR value to the pNext chain.
VkQueueFamilyProperties	queueFamilyProperties()	a VkQueueFamilyProperties structure which is populated with the same values as in GetPhysicalDeviceQueueFamilyProperties.
VkQueueFamilyProperties2	set(int sType, long pNext)	Initializes this struct with the specified values.
VkQueueFamilyProperties2	set(VkQueueFamilyProperties2 src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()	a VkStructureType value identifying this structure.
VkQueueFamilyProperties2	sType(int value)	Sets the specified value to the sType() field.
VkQueueFamilyProperties2	sType$Default()	Sets the STRUCTURE_TYPE_QUEUE_FAMILY_PROPERTIES_2 value to the sType() field.

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.

QUEUEFAMILYPROPERTIES

public static final int QUEUEFAMILYPROPERTIES

The struct member offsets.

Constructor Details

VkQueueFamilyProperties2

public VkQueueFamilyProperties2(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

queueFamilyProperties

public VkQueueFamilyProperties queueFamilyProperties()

a VkQueueFamilyProperties structure which is populated with the same values as in GetPhysicalDeviceQueueFamilyProperties.

sType

public VkQueueFamilyProperties2 sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkQueueFamilyProperties2 sType$Default()

Sets the STRUCTURE_TYPE_QUEUE_FAMILY_PROPERTIES_2 value to the sType() field.

pNext

public VkQueueFamilyProperties2 pNext(long value)

Sets the specified value to the pNext() field.

pNext

public VkQueueFamilyProperties2 pNext(VkQueueFamilyCheckpointProperties2NV value)

Prepends the specified VkQueueFamilyCheckpointProperties2NV value to the pNext chain.

pNext

public VkQueueFamilyProperties2 pNext(VkQueueFamilyCheckpointPropertiesNV value)

Prepends the specified VkQueueFamilyCheckpointPropertiesNV value to the pNext chain.

pNext

public VkQueueFamilyProperties2 pNext(VkQueueFamilyGlobalPriorityPropertiesEXT value)

Prepends the specified VkQueueFamilyGlobalPriorityPropertiesEXT value to the pNext chain.

pNext

public VkQueueFamilyProperties2 pNext(VkQueueFamilyGlobalPriorityPropertiesKHR value)

Prepends the specified VkQueueFamilyGlobalPriorityPropertiesKHR value to the pNext chain.

pNext

public VkQueueFamilyProperties2 pNext(VkQueueFamilyQueryResultStatusPropertiesKHR value)

Prepends the specified VkQueueFamilyQueryResultStatusPropertiesKHR value to the pNext chain.

pNext

public VkQueueFamilyProperties2 pNext(VkQueueFamilyVideoPropertiesKHR value)

Prepends the specified VkQueueFamilyVideoPropertiesKHR value to the pNext chain.

set

public VkQueueFamilyProperties2 set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkQueueFamilyProperties2 set(VkQueueFamilyProperties2 src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkQueueFamilyProperties2 malloc()

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

calloc

public static VkQueueFamilyProperties2 calloc()

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

create

public static VkQueueFamilyProperties2 create()

Returns a new VkQueueFamilyProperties2 instance allocated with BufferUtils.

create

public static VkQueueFamilyProperties2 create(long address)

Returns a new VkQueueFamilyProperties2 instance for the specified memory address.

createSafe

@Nullable
public static VkQueueFamilyProperties2 createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkQueueFamilyProperties2.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkQueueFamilyProperties2.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkQueueFamilyProperties2.Buffer create(int capacity)

Returns a new VkQueueFamilyProperties2.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkQueueFamilyProperties2.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkQueueFamilyProperties2 mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkQueueFamilyProperties2 callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkQueueFamilyProperties2 mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkQueueFamilyProperties2 callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

malloc

public static VkQueueFamilyProperties2 malloc(MemoryStack stack)

Returns a new VkQueueFamilyProperties2 instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkQueueFamilyProperties2 calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nqueueFamilyProperties

public static VkQueueFamilyProperties nqueueFamilyProperties(long struct)

Unsafe version of queueFamilyProperties().

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.