Module com.io7m.jcoronado.vma

Package com.io7m.jcoronado.vma

Class VMAAllocatorCreateInfo

java.lang.Object

com.io7m.jcoronado.vma.VMAAllocatorCreateInfo

All Implemented Interfaces:

VMAAllocatorCreateInfoType

public final class VMAAllocatorCreateInfo
extends java.lang.Object
implements VMAAllocatorCreateInfoType

Information required to create an allocator.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VMAAllocatorCreateInfo.Builder	builder()	Creates a builder for VMAAllocatorCreateInfo.
static VMAAllocatorCreateInfo	copyOf(VMAAllocatorCreateInfoType instance)	Creates an immutable copy of a VMAAllocatorCreateInfoType value.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of VMAAllocatorCreateInfo that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: logicalDevice.
VulkanLogicalDeviceType	logicalDevice()
static VMAAllocatorCreateInfo	of(VulkanLogicalDeviceType logicalDevice)	Construct a new immutable VMAAllocatorCreateInfo instance.
java.lang.String	toString()	Prints the immutable value VMAAllocatorCreateInfo with attribute values.
VMAAllocatorCreateInfo	withLogicalDevice(VulkanLogicalDeviceType value)	Copy the current immutable object by setting a value for the logicalDevice attribute.

Methods inherited from class java.lang.Object

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

Method Detail

logicalDevice

public VulkanLogicalDeviceType logicalDevice()

Specified by:

logicalDevice in interface VMAAllocatorCreateInfoType

Returns:

The logical device used for allocations

withLogicalDevice

public final VMAAllocatorCreateInfo withLogicalDevice(VulkanLogicalDeviceType value)

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

Parameters:

value - A new value for logicalDevice

Returns:

A modified copy of the this object

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of VMAAllocatorCreateInfo 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: logicalDevice.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value VMAAllocatorCreateInfo with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static VMAAllocatorCreateInfo of(VulkanLogicalDeviceType logicalDevice)

Construct a new immutable VMAAllocatorCreateInfo instance.

Parameters:

logicalDevice - The value for the logicalDevice attribute

Returns:

An immutable VMAAllocatorCreateInfo instance

copyOf

public static VMAAllocatorCreateInfo copyOf(VMAAllocatorCreateInfoType instance)

Creates an immutable copy of a VMAAllocatorCreateInfoType 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 VMAAllocatorCreateInfo instance

builder

public static VMAAllocatorCreateInfo.Builder builder()

Creates a builder for VMAAllocatorCreateInfo.

Returns:

A new VMAAllocatorCreateInfo builder