Module com.io7m.jcoronado.api

Package com.io7m.jcoronado.api

Class VulkanBufferCreateInfo

java.lang.Object

com.io7m.jcoronado.api.VulkanBufferCreateInfo

All Implemented Interfaces:

VulkanBufferCreateInfoType

public final class VulkanBufferCreateInfo
extends java.lang.Object
implements VulkanBufferCreateInfoType

Information required to create a buffer.

See Also:

"VkBufferCreateInfo"

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VulkanBufferCreateInfo.Builder	builder()	Creates a builder for VulkanBufferCreateInfo.
static VulkanBufferCreateInfo	copyOf(VulkanBufferCreateInfoType instance)	Creates an immutable copy of a VulkanBufferCreateInfoType value.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of VulkanBufferCreateInfo that have equal attribute values.
java.util.Set<VulkanBufferCreateFlag>	flags()
int	hashCode()	Computes a hash code from attributes: flags, size, usageFlags, sharingMode, queueFamilyIndices.
static VulkanBufferCreateInfo	of(java.lang.Iterable<VulkanBufferCreateFlag> flags, long size, java.lang.Iterable<VulkanBufferUsageFlag> usageFlags, VulkanSharingMode sharingMode, java.lang.Iterable<java.lang.Integer> queueFamilyIndices)	Construct a new immutable VulkanBufferCreateInfo instance.
static VulkanBufferCreateInfo	of(java.util.Set<VulkanBufferCreateFlag> flags, long size, java.util.Set<VulkanBufferUsageFlag> usageFlags, VulkanSharingMode sharingMode, java.util.List<java.lang.Integer> queueFamilyIndices)	Construct a new immutable VulkanBufferCreateInfo instance.
java.util.List<java.lang.Integer>	queueFamilyIndices()
VulkanSharingMode	sharingMode()
long	size()
java.lang.String	toString()	Prints the immutable value VulkanBufferCreateInfo with attribute values.
java.util.Set<VulkanBufferUsageFlag>	usageFlags()
VulkanBufferCreateInfo	withFlags(VulkanBufferCreateFlag... elements)	Copy the current immutable object with elements that replace the content of flags.
VulkanBufferCreateInfo	withFlags(java.lang.Iterable<VulkanBufferCreateFlag> elements)	Copy the current immutable object with elements that replace the content of flags.
VulkanBufferCreateInfo	withQueueFamilyIndices(int... elements)	Copy the current immutable object with elements that replace the content of queueFamilyIndices.
VulkanBufferCreateInfo	withQueueFamilyIndices(java.lang.Iterable<java.lang.Integer> elements)	Copy the current immutable object with elements that replace the content of queueFamilyIndices.
VulkanBufferCreateInfo	withSharingMode(VulkanSharingMode value)	Copy the current immutable object by setting a value for the sharingMode attribute.
VulkanBufferCreateInfo	withSize(long value)	Copy the current immutable object by setting a value for the size attribute.
VulkanBufferCreateInfo	withUsageFlags(VulkanBufferUsageFlag... elements)	Copy the current immutable object with elements that replace the content of usageFlags.
VulkanBufferCreateInfo	withUsageFlags(java.lang.Iterable<VulkanBufferUsageFlag> elements)	Copy the current immutable object with elements that replace the content of usageFlags.

Methods inherited from class java.lang.Object

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

Method Detail

flags

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

Specified by:

flags in interface VulkanBufferCreateInfoType

Returns:

A bitmask of VkBufferCreateFlagBits specifying additional parameters of the buffer.

size

public long size()

Specified by:

size in interface VulkanBufferCreateInfoType

Returns:

The size in bytes of the buffer to be created.

usageFlags

public java.util.Set<VulkanBufferUsageFlag> usageFlags()

Specified by:

usageFlags in interface VulkanBufferCreateInfoType

Returns:

A bitmask of VkBufferUsageFlagBits specifying allowed usages of the buffer.

sharingMode

public VulkanSharingMode sharingMode()

Specified by:

sharingMode in interface VulkanBufferCreateInfoType

Returns:

A VkSharingMode value specifying the sharing mode of the buffer when it will be accessed by multiple queue families.

queueFamilyIndices

public java.util.List<java.lang.Integer> queueFamilyIndices()

Specified by:

queueFamilyIndices in interface VulkanBufferCreateInfoType

Returns:

A list of queue families that will access this buffer (ignored if sharingMode is not VK_SHARING_MODE_CONCURRENT).

withFlags

public final VulkanBufferCreateInfo withFlags(VulkanBufferCreateFlag... 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 VulkanBufferCreateInfo withFlags(java.lang.Iterable<VulkanBufferCreateFlag> 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

withSize

public final VulkanBufferCreateInfo withSize(long value)

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

Parameters:

value - A new value for size

Returns:

A modified copy of the this object

withUsageFlags

public final VulkanBufferCreateInfo withUsageFlags(VulkanBufferUsageFlag... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withUsageFlags

public final VulkanBufferCreateInfo withUsageFlags(java.lang.Iterable<VulkanBufferUsageFlag> elements)

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

Parameters:

elements - An iterable of usageFlags elements to set

Returns:

A modified copy of this object

withSharingMode

public final VulkanBufferCreateInfo withSharingMode(VulkanSharingMode value)

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

Parameters:

value - A new value for sharingMode

Returns:

A modified copy of the this object

withQueueFamilyIndices

public final VulkanBufferCreateInfo withQueueFamilyIndices(int... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withQueueFamilyIndices

public final VulkanBufferCreateInfo withQueueFamilyIndices(java.lang.Iterable<java.lang.Integer> elements)

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

Parameters:

elements - An iterable of queueFamilyIndices elements to set

Returns:

A modified copy of this object

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of VulkanBufferCreateInfo 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, size, usageFlags, sharingMode, queueFamilyIndices.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value VulkanBufferCreateInfo with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static VulkanBufferCreateInfo of(java.util.Set<VulkanBufferCreateFlag> flags,
                                        long size,
                                        java.util.Set<VulkanBufferUsageFlag> usageFlags,
                                        VulkanSharingMode sharingMode,
                                        java.util.List<java.lang.Integer> queueFamilyIndices)

Construct a new immutable VulkanBufferCreateInfo instance.

Parameters:

flags - The value for the flags attribute

size - The value for the size attribute

usageFlags - The value for the usageFlags attribute

sharingMode - The value for the sharingMode attribute

queueFamilyIndices - The value for the queueFamilyIndices attribute

Returns:

An immutable VulkanBufferCreateInfo instance

of

public static VulkanBufferCreateInfo of(java.lang.Iterable<VulkanBufferCreateFlag> flags,
                                        long size,
                                        java.lang.Iterable<VulkanBufferUsageFlag> usageFlags,
                                        VulkanSharingMode sharingMode,
                                        java.lang.Iterable<java.lang.Integer> queueFamilyIndices)

Construct a new immutable VulkanBufferCreateInfo instance.

Parameters:

flags - The value for the flags attribute

size - The value for the size attribute

usageFlags - The value for the usageFlags attribute

sharingMode - The value for the sharingMode attribute

queueFamilyIndices - The value for the queueFamilyIndices attribute

Returns:

An immutable VulkanBufferCreateInfo instance

copyOf

public static VulkanBufferCreateInfo copyOf(VulkanBufferCreateInfoType instance)

Creates an immutable copy of a VulkanBufferCreateInfoType 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 VulkanBufferCreateInfo instance

builder

public static VulkanBufferCreateInfo.Builder builder()

Creates a builder for VulkanBufferCreateInfo.

Returns:

A new VulkanBufferCreateInfo builder