Module com.io7m.jcoronado.api

Package com.io7m.jcoronado.api

Class VulkanMemoryAllocateInfo

java.lang.Object

com.io7m.jcoronado.api.VulkanMemoryAllocateInfo

All Implemented Interfaces:

VulkanMemoryAllocateInfoType

public final class VulkanMemoryAllocateInfo
extends java.lang.Object
implements VulkanMemoryAllocateInfoType

See Also:

"VkMemoryAllocateInfo"

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

size

public long size()

Specified by:

size in interface VulkanMemoryAllocateInfoType

Returns:

The size of the allocation in bytes

memoryTypeIndex

public int memoryTypeIndex()

Specified by:

memoryTypeIndex in interface VulkanMemoryAllocateInfoType

Returns:

An index identifying a memory type from the memoryTypes array of the VkPhysicalDeviceMemoryProperties structure

withSize

public final VulkanMemoryAllocateInfo 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

withMemoryTypeIndex

public final VulkanMemoryAllocateInfo withMemoryTypeIndex(int value)

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

Parameters:

value - A new value for memoryTypeIndex

Returns:

A modified copy of the this object

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of VulkanMemoryAllocateInfo 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: size, memoryTypeIndex.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value VulkanMemoryAllocateInfo with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static VulkanMemoryAllocateInfo of(long size,
                                          int memoryTypeIndex)

Construct a new immutable VulkanMemoryAllocateInfo instance.

Parameters:

size - The value for the size attribute

memoryTypeIndex - The value for the memoryTypeIndex attribute

Returns:

An immutable VulkanMemoryAllocateInfo instance

copyOf

public static VulkanMemoryAllocateInfo copyOf(VulkanMemoryAllocateInfoType instance)

Creates an immutable copy of a VulkanMemoryAllocateInfoType 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 VulkanMemoryAllocateInfo instance

builder

public static VulkanMemoryAllocateInfo.Builder builder()

Creates a builder for VulkanMemoryAllocateInfo.

Returns:

A new VulkanMemoryAllocateInfo builder