Module com.io7m.jcoronado.api

Package com.io7m.jcoronado.api

Class VulkanLogicalDeviceQueueCreateInfo

java.lang.Object

com.io7m.jcoronado.api.VulkanLogicalDeviceQueueCreateInfo

All Implemented Interfaces:

VulkanLogicalDeviceQueueCreateInfoType

public final class VulkanLogicalDeviceQueueCreateInfo
extends java.lang.Object
implements VulkanLogicalDeviceQueueCreateInfoType

The information required to create a queue on a device.

See Also:

"VkDeviceQueueCreateInfo"

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VulkanLogicalDeviceQueueCreateInfo.Builder	Builds instances of type VulkanLogicalDeviceQueueCreateInfo.

Method Summary

Modifier and Type	Method	Description
static VulkanLogicalDeviceQueueCreateInfo.Builder	builder()	Creates a builder for VulkanLogicalDeviceQueueCreateInfo.
static VulkanLogicalDeviceQueueCreateInfo	copyOf(VulkanLogicalDeviceQueueCreateInfoType instance)	Creates an immutable copy of a VulkanLogicalDeviceQueueCreateInfoType value.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of VulkanLogicalDeviceQueueCreateInfo that have equal attribute values.
java.util.Set<VulkanDeviceQueueCreationFlag>	flags()
int	hashCode()	Computes a hash code from attributes: flags, queueFamilyIndex, queueCount, queuePriorities.
static VulkanLogicalDeviceQueueCreateInfo	of(java.lang.Iterable<VulkanDeviceQueueCreationFlag> flags, int queueFamilyIndex, int queueCount, float[] queuePriorities)	Construct a new immutable VulkanLogicalDeviceQueueCreateInfo instance.
static VulkanLogicalDeviceQueueCreateInfo	of(java.util.Set<VulkanDeviceQueueCreationFlag> flags, int queueFamilyIndex, int queueCount, float[] queuePriorities)	Construct a new immutable VulkanLogicalDeviceQueueCreateInfo instance.
int	queueCount()
int	queueFamilyIndex()
float[]	queuePriorities()
java.lang.String	toString()	Prints the immutable value VulkanLogicalDeviceQueueCreateInfo with attribute values.
VulkanLogicalDeviceQueueCreateInfo	withFlags(VulkanDeviceQueueCreationFlag... elements)	Copy the current immutable object with elements that replace the content of flags.
VulkanLogicalDeviceQueueCreateInfo	withFlags(java.lang.Iterable<VulkanDeviceQueueCreationFlag> elements)	Copy the current immutable object with elements that replace the content of flags.
VulkanLogicalDeviceQueueCreateInfo	withQueueCount(int value)	Copy the current immutable object by setting a value for the queueCount attribute.
VulkanLogicalDeviceQueueCreateInfo	withQueueFamilyIndex(int value)	Copy the current immutable object by setting a value for the queueFamilyIndex attribute.
VulkanLogicalDeviceQueueCreateInfo	withQueuePriorities(float... elements)	Copy the current immutable object with elements that replace the content of queuePriorities.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.io7m.jcoronado.api.VulkanLogicalDeviceQueueCreateInfoType

checkPreconditions

Method Detail

flags

public java.util.Set<VulkanDeviceQueueCreationFlag> flags()

Specified by:

flags in interface VulkanLogicalDeviceQueueCreateInfoType

Returns:

The flags used to create the queue(s)

queueFamilyIndex

public int queueFamilyIndex()

Specified by:

queueFamilyIndex in interface VulkanLogicalDeviceQueueCreateInfoType

Returns:

The queue family

queueCount

public int queueCount()

Specified by:

queueCount in interface VulkanLogicalDeviceQueueCreateInfoType

Returns:

The number of queues to create

queuePriorities

public float[] queuePriorities()

Specified by:

queuePriorities in interface VulkanLogicalDeviceQueueCreateInfoType

Returns:

The priorities of the queues

withFlags

public final VulkanLogicalDeviceQueueCreateInfo withFlags(VulkanDeviceQueueCreationFlag... elements)

Copy the current immutable object with elements that replace the content of flags.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withFlags

public final VulkanLogicalDeviceQueueCreateInfo withFlags(java.lang.Iterable<VulkanDeviceQueueCreationFlag> elements)

Copy the current immutable object with elements that replace the content of flags. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of flags elements to set

Returns:

A modified copy of this object

withQueueFamilyIndex

public final VulkanLogicalDeviceQueueCreateInfo withQueueFamilyIndex(int value)

Copy the current immutable object by setting a value for the queueFamilyIndex attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for queueFamilyIndex

Returns:

A modified copy of the this object

withQueueCount

public final VulkanLogicalDeviceQueueCreateInfo withQueueCount(int value)

Copy the current immutable object by setting a value for the queueCount attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for queueCount

Returns:

A modified copy of the this object

withQueuePriorities

public final VulkanLogicalDeviceQueueCreateInfo withQueuePriorities(float... elements)

Copy the current immutable object with elements that replace the content of queuePriorities. The array is cloned before being saved as attribute values.

Parameters:

elements - The non-null elements for queuePriorities

Returns:

A modified copy of this object

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of VulkanLogicalDeviceQueueCreateInfo that have equal attribute values.

Overrides:

equals in class java.lang.Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: flags, queueFamilyIndex, queueCount, queuePriorities.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value VulkanLogicalDeviceQueueCreateInfo with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static VulkanLogicalDeviceQueueCreateInfo of(java.util.Set<VulkanDeviceQueueCreationFlag> flags,
                                                    int queueFamilyIndex,
                                                    int queueCount,
                                                    float[] queuePriorities)

Construct a new immutable VulkanLogicalDeviceQueueCreateInfo instance.

Parameters:

flags - The value for the flags attribute

queueFamilyIndex - The value for the queueFamilyIndex attribute

queueCount - The value for the queueCount attribute

queuePriorities - The value for the queuePriorities attribute

Returns:

An immutable VulkanLogicalDeviceQueueCreateInfo instance

of

public static VulkanLogicalDeviceQueueCreateInfo of(java.lang.Iterable<VulkanDeviceQueueCreationFlag> flags,
                                                    int queueFamilyIndex,
                                                    int queueCount,
                                                    float[] queuePriorities)

Construct a new immutable VulkanLogicalDeviceQueueCreateInfo instance.

Parameters:

flags - The value for the flags attribute

queueFamilyIndex - The value for the queueFamilyIndex attribute

queueCount - The value for the queueCount attribute

queuePriorities - The value for the queuePriorities attribute

Returns:

An immutable VulkanLogicalDeviceQueueCreateInfo instance

copyOf

public static VulkanLogicalDeviceQueueCreateInfo copyOf(VulkanLogicalDeviceQueueCreateInfoType instance)

Creates an immutable copy of a VulkanLogicalDeviceQueueCreateInfoType value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable VulkanLogicalDeviceQueueCreateInfo instance

builder

public static VulkanLogicalDeviceQueueCreateInfo.Builder builder()

Creates a builder for VulkanLogicalDeviceQueueCreateInfo.

Returns:

A new VulkanLogicalDeviceQueueCreateInfo builder