Package org.lwjgl.vulkan

Class VkQueueFamilyProperties

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkQueueFamilyProperties>

org.lwjgl.vulkan.VkQueueFamilyProperties

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkQueueFamilyProperties
extends Struct<VkQueueFamilyProperties>
implements NativeResource

 struct VkQueueFamilyProperties {
     VkQueueFlags queueFlags;
     uint32_t queueCount;
     uint32_t timestampValidBits;
     {@link VkExtent3D VkExtent3D} minImageTransferGranularity;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkQueueFamilyProperties.Buffer	An array of VkQueueFamilyProperties 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	MINIMAGETRANSFERGRANULARITY	The struct member offsets.
static final int	QUEUECOUNT	The struct member offsets.
static final int	QUEUEFLAGS	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final 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	Description
VkQueueFamilyProperties(ByteBuffer container)	Creates a VkQueueFamilyProperties instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	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.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkQueueFamilyProperties.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkQueueFamilyProperties	calloc(MemoryStack stack)	Returns a new VkQueueFamilyProperties instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkQueueFamilyProperties	callocStack()	Deprecated.
static VkQueueFamilyProperties.Buffer	callocStack(int capacity)	Deprecated.
static VkQueueFamilyProperties.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkQueueFamilyProperties	callocStack(MemoryStack stack)	Deprecated.
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 @Nullable VkQueueFamilyProperties	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable 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.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkQueueFamilyProperties.Buffer instance allocated on the specified MemoryStack.
static VkQueueFamilyProperties	malloc(MemoryStack stack)	Returns a new VkQueueFamilyProperties instance allocated on the specified MemoryStack.
static VkQueueFamilyProperties	mallocStack()	Deprecated.
static VkQueueFamilyProperties.Buffer	mallocStack(int capacity)	Deprecated.
static VkQueueFamilyProperties.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkQueueFamilyProperties	mallocStack(MemoryStack stack)	Deprecated.
VkExtent3D	minImageTransferGranularity()
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()
int	queueFlags()
int	sizeof()	Returns sizeof(struct).
int	timestampValidBits()

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, 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.

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 Details

VkQueueFamilyProperties

public VkQueueFamilyProperties(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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkQueueFamilyProperties>

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

public static @Nullable 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

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkQueueFamilyProperties mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkQueueFamilyProperties callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkQueueFamilyProperties mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkQueueFamilyProperties callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

malloc

public static VkQueueFamilyProperties malloc(MemoryStack stack)

Returns a new VkQueueFamilyProperties instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkQueueFamilyProperties calloc(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

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

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().