VkQueueFamilyProperties (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkQueueFamilyProperties

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkQueueFamilyProperties
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure providing information about a queue family.
Description

The value returned in minImageTransferGranularity has a unit of compressed texel blocks for images having a block-compressed format, and a unit of texels otherwise.

Possible values of minImageTransferGranularity are:
- (0,0,0) which indicates that only whole mip levels must be transferred using the image transfer operations on the corresponding queues. In this case, the following restrictions apply to all offset and extent parameters of image transfer operations:
  - The x, y, and z members of a VkOffset3D parameter must always be zero.
  - The width, height, and depth members of a VkExtent3D parameter must always match the width, height, and depth of the image subresource corresponding to the parameter, respectively.
- (A_x, A_y, A_z) where A_x, A_y, and A_z are all integer powers of two. In this case the following restrictions apply to all image transfer operations:
  - x, y, and z of a VkOffset3D parameter must be integer multiples of A_x, A_y, and A_z, respectively.
  - width of a VkExtent3D parameter must be an integer multiple of A_x, or else x + width must equal the width of the image subresource corresponding to the parameter.
  - height of a VkExtent3D parameter must be an integer multiple of A_y, or else y + height must equal the height of the image subresource corresponding to the parameter.
  - depth of a VkExtent3D parameter must be an integer multiple of A_z, or else z + depth must equal the depth of the image subresource corresponding to the parameter.
  - If the format of the image corresponding to the parameters is one of the block-compressed formats then for the purposes of the above calculations the granularity must be scaled up by the compressed texel block dimensions.
Queues supporting graphics and/or compute operations must report (1,1,1) in minImageTransferGranularity, meaning that there are no additional restrictions on the granularity of image transfer operations for these queues. Other queues supporting image transfer operations are only required: to support whole mip level transfers, thus minImageTransferGranularity for queues belonging to such queue families may be (0,0,0).

The Device Memory section describes memory properties queried from the physical device.

For physical device feature queries see the Features chapter.

See Also

VkExtent3D, VkQueueFamilyProperties2, GetPhysicalDeviceQueueFamilyProperties

Member documentation
- queueFlags – a bitmask of VkQueueFlagBits indicating capabilities of the queues in this queue family.
- queueCount – the unsigned integer count of queues in this queue family. Each queue family must support at least one queue.
- timestampValidBits – the unsigned integer count of meaningful bits in the timestamps written via vkCmdWriteTimestamp. The valid range for the count is 36..64 bits, or a value of 0, indicating no support for timestamps. Bits outside the valid range are guaranteed to be zeros.
- minImageTransferGranularity – the minimum granularity supported for image transfer operations on the queues in this queue family.
Layout
```
 struct VkQueueFamilyProperties {
     VkQueueFlags queueFlags;
     uint32_t queueCount;
     uint32_t timestampValidBits;
     VkExtent3D minImageTransferGranularity;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkQueueFamilyProperties.Buffer
An array of VkQueueFamilyProperties structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkQueueFamilyProperties.Buffer` An array of `VkQueueFamilyProperties` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`MINIMAGETRANSFERGRANULARITY` The struct member offsets.
`static int`	`QUEUECOUNT` The struct member offsets.
`static int`	`QUEUEFLAGS` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`TIMESTAMPVALIDBITS` 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 and Description
`VkQueueFamilyProperties(java.nio.ByteBuffer container)` Creates a `VkQueueFamilyProperties` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VkQueueFamilyProperties`	`calloc()` Returns a new `VkQueueFamilyProperties` instance allocated with `memCalloc`.
`static VkQueueFamilyProperties.Buffer`	`calloc(int capacity)` Returns a new `VkQueueFamilyProperties.Buffer` instance allocated with `memCalloc`.
`static VkQueueFamilyProperties`	`callocStack()` Returns a new `VkQueueFamilyProperties` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkQueueFamilyProperties.Buffer`	`callocStack(int capacity)` Returns a new `VkQueueFamilyProperties.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkQueueFamilyProperties.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkQueueFamilyProperties.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkQueueFamilyProperties`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkQueueFamilyProperties` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkQueueFamilyProperties`	`create()` Returns a new `VkQueueFamilyProperties` instance allocated with `BufferUtils`.
`static VkQueueFamilyProperties.Buffer`	`create(int capacity)` Returns a new `VkQueueFamilyProperties.Buffer` instance allocated with `BufferUtils`.
`static VkQueueFamilyProperties`	`create(long address)` Returns a new `VkQueueFamilyProperties` instance for the specified memory address.
`static VkQueueFamilyProperties.Buffer`	`create(long address, int capacity)` Create a `VkQueueFamilyProperties.Buffer` instance at the specified memory.
`static VkQueueFamilyProperties`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkQueueFamilyProperties.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkQueueFamilyProperties`	`malloc()` Returns a new `VkQueueFamilyProperties` instance allocated with `memAlloc`.
`static VkQueueFamilyProperties.Buffer`	`malloc(int capacity)` Returns a new `VkQueueFamilyProperties.Buffer` instance allocated with `memAlloc`.
`static VkQueueFamilyProperties`	`mallocStack()` Returns a new `VkQueueFamilyProperties` instance allocated on the thread-local `MemoryStack`.
`static VkQueueFamilyProperties.Buffer`	`mallocStack(int capacity)` Returns a new `VkQueueFamilyProperties.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkQueueFamilyProperties.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkQueueFamilyProperties.Buffer` instance allocated on the specified `MemoryStack`.
`static VkQueueFamilyProperties`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkQueueFamilyProperties` instance allocated on the specified `MemoryStack`.
`VkExtent3D`	`minImageTransferGranularity()` Returns a `VkExtent3D` view of the `minImageTransferGranularity` field.
`static VkExtent3D`	`nminImageTransferGranularity(long struct)` Unsafe version of `minImageTransferGranularity()`.
`static int`	`nqueueCount(long struct)` Unsafe version of `queueCount()`.
`static int`	`nqueueFlags(long struct)` Unsafe version of `queueFlags()`.
`static int`	`ntimestampValidBits(long struct)` Unsafe version of `timestampValidBits()`.
`int`	`queueCount()` Returns the value of the `queueCount` field.
`int`	`queueFlags()` Returns the value of the `queueFlags` field.
`int`	`sizeof()`
`int`	`timestampValidBits()` Returns the value of the `timestampValidBits` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

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 Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - QUEUEFLAGS
```
public static final int QUEUEFLAGS
```
    The struct member offsets.
  - QUEUECOUNT
```
public static final int QUEUECOUNT
```
    The struct member offsets.
  - TIMESTAMPVALIDBITS
```
public static final int TIMESTAMPVALIDBITS
```
    The struct member offsets.
  - MINIMAGETRANSFERGRANULARITY
```
public static final int MINIMAGETRANSFERGRANULARITY
```
    The struct member offsets.
- Constructor Detail
  - VkQueueFamilyProperties
```
public VkQueueFamilyProperties(java.nio.ByteBuffer container)
```
    Creates a VkQueueFamilyProperties 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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - queueFlags
```
public int queueFlags()
```
    Returns the value of the queueFlags field.
  - queueCount
```
public int queueCount()
```
    Returns the value of the queueCount field.
  - timestampValidBits
```
public int timestampValidBits()
```
    Returns the value of the timestampValidBits field.
  - minImageTransferGranularity
```
public VkExtent3D minImageTransferGranularity()
```
    Returns a VkExtent3D view of the minImageTransferGranularity field.
  - malloc
```
public static VkQueueFamilyProperties malloc()
```
    Returns a new VkQueueFamilyProperties instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkQueueFamilyProperties calloc()
```
    Returns a new VkQueueFamilyProperties instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkQueueFamilyProperties create()
```
    Returns a new VkQueueFamilyProperties instance allocated with BufferUtils.
  - create
```
public static VkQueueFamilyProperties create(long address)
```
    Returns a new VkQueueFamilyProperties instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkQueueFamilyProperties createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkQueueFamilyProperties.Buffer malloc(int capacity)
```
    Returns a new VkQueueFamilyProperties.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkQueueFamilyProperties.Buffer calloc(int capacity)
```
    Returns a new VkQueueFamilyProperties.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkQueueFamilyProperties.Buffer create(int capacity)
```
    Returns a new VkQueueFamilyProperties.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkQueueFamilyProperties.Buffer create(long address,
                                                    int capacity)
```
    Create a VkQueueFamilyProperties.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkQueueFamilyProperties.Buffer createSafe(long address,
                                                                  int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkQueueFamilyProperties mallocStack()
```
    Returns a new VkQueueFamilyProperties instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkQueueFamilyProperties callocStack()
```
    Returns a new VkQueueFamilyProperties instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkQueueFamilyProperties mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkQueueFamilyProperties instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkQueueFamilyProperties callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkQueueFamilyProperties instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkQueueFamilyProperties.Buffer mallocStack(int capacity)
```
    Returns a new VkQueueFamilyProperties.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkQueueFamilyProperties.Buffer callocStack(int capacity)
```
    Returns a new VkQueueFamilyProperties.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkQueueFamilyProperties.Buffer mallocStack(int capacity,
                                                         org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkQueueFamilyProperties.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkQueueFamilyProperties.Buffer callocStack(int capacity,
                                                         org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkQueueFamilyProperties.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nqueueFlags
```
public static int nqueueFlags(long struct)
```
    Unsafe version of queueFlags().
  - nqueueCount
```
public static int nqueueCount(long struct)
```
    Unsafe version of queueCount().
  - ntimestampValidBits
```
public static int ntimestampValidBits(long struct)
```
    Unsafe version of timestampValidBits().
  - nminImageTransferGranularity
```
public static VkExtent3D nminImageTransferGranularity(long struct)
```
    Unsafe version of minImageTransferGranularity().

Class VkQueueFamilyProperties

Description

See Also

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

QUEUEFLAGS

QUEUECOUNT

TIMESTAMPVALIDBITS

MINIMAGETRANSFERGRANULARITY

Constructor Detail

VkQueueFamilyProperties

Method Detail

sizeof

queueFlags

queueCount

timestampValidBits

minImageTransferGranularity

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nqueueFlags

nqueueCount

ntimestampValidBits

nminImageTransferGranularity