Module com.io7m.jcoronado.api

Package com.io7m.jcoronado.api

Class VulkanPhysicalDeviceMemoryProperties

java.lang.Object

com.io7m.jcoronado.api.VulkanPhysicalDeviceMemoryProperties

All Implemented Interfaces:

VulkanPhysicalDeviceMemoryPropertiesType

public final class VulkanPhysicalDeviceMemoryProperties
extends java.lang.Object
implements VulkanPhysicalDeviceMemoryPropertiesType

The memory properties for a physical device.

See Also:

"VkPhysicalDeviceMemoryProperties"

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VulkanPhysicalDeviceMemoryProperties.Builder	builder()	Creates a builder for VulkanPhysicalDeviceMemoryProperties.
static VulkanPhysicalDeviceMemoryProperties	copyOf(VulkanPhysicalDeviceMemoryPropertiesType instance)	Creates an immutable copy of a VulkanPhysicalDeviceMemoryPropertiesType value.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of VulkanPhysicalDeviceMemoryProperties that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: heaps, types.
java.util.List<VulkanMemoryHeap>	heaps()
static VulkanPhysicalDeviceMemoryProperties	of(java.lang.Iterable<? extends VulkanMemoryHeap> heaps, java.lang.Iterable<? extends VulkanMemoryType> types)	Construct a new immutable VulkanPhysicalDeviceMemoryProperties instance.
static VulkanPhysicalDeviceMemoryProperties	of(java.util.List<VulkanMemoryHeap> heaps, java.util.List<VulkanMemoryType> types)	Construct a new immutable VulkanPhysicalDeviceMemoryProperties instance.
java.lang.String	toString()	Prints the immutable value VulkanPhysicalDeviceMemoryProperties with attribute values.
java.util.List<VulkanMemoryType>	types()
VulkanPhysicalDeviceMemoryProperties	withHeaps(VulkanMemoryHeap... elements)	Copy the current immutable object with elements that replace the content of heaps.
VulkanPhysicalDeviceMemoryProperties	withHeaps(java.lang.Iterable<? extends VulkanMemoryHeap> elements)	Copy the current immutable object with elements that replace the content of heaps.
VulkanPhysicalDeviceMemoryProperties	withTypes(VulkanMemoryType... elements)	Copy the current immutable object with elements that replace the content of types.
VulkanPhysicalDeviceMemoryProperties	withTypes(java.lang.Iterable<? extends VulkanMemoryType> elements)	Copy the current immutable object with elements that replace the content of types.

Methods inherited from class java.lang.Object

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

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

findSuitableMemoryType

Method Detail

heaps

public java.util.List<VulkanMemoryHeap> heaps()

Specified by:

heaps in interface VulkanPhysicalDeviceMemoryPropertiesType

Returns:

The memory heaps from which memory can be allocated.

types

public java.util.List<VulkanMemoryType> types()

Specified by:

types in interface VulkanPhysicalDeviceMemoryPropertiesType

Returns:

The memory types that can be used to access memory allocated from the heaps specified by heaps()

withHeaps

public final VulkanPhysicalDeviceMemoryProperties withHeaps(VulkanMemoryHeap... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withHeaps

public final VulkanPhysicalDeviceMemoryProperties withHeaps(java.lang.Iterable<? extends VulkanMemoryHeap> elements)

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

Parameters:

elements - An iterable of heaps elements to set

Returns:

A modified copy of this object

withTypes

public final VulkanPhysicalDeviceMemoryProperties withTypes(VulkanMemoryType... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withTypes

public final VulkanPhysicalDeviceMemoryProperties withTypes(java.lang.Iterable<? extends VulkanMemoryType> elements)

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

Parameters:

elements - An iterable of types 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 VulkanPhysicalDeviceMemoryProperties 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: heaps, types.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value VulkanPhysicalDeviceMemoryProperties with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static VulkanPhysicalDeviceMemoryProperties of(java.util.List<VulkanMemoryHeap> heaps,
                                                      java.util.List<VulkanMemoryType> types)

Construct a new immutable VulkanPhysicalDeviceMemoryProperties instance.

Parameters:

heaps - The value for the heaps attribute

types - The value for the types attribute

Returns:

An immutable VulkanPhysicalDeviceMemoryProperties instance

of

public static VulkanPhysicalDeviceMemoryProperties of(java.lang.Iterable<? extends VulkanMemoryHeap> heaps,
                                                      java.lang.Iterable<? extends VulkanMemoryType> types)

Construct a new immutable VulkanPhysicalDeviceMemoryProperties instance.

Parameters:

heaps - The value for the heaps attribute

types - The value for the types attribute

Returns:

An immutable VulkanPhysicalDeviceMemoryProperties instance

copyOf

public static VulkanPhysicalDeviceMemoryProperties copyOf(VulkanPhysicalDeviceMemoryPropertiesType instance)

Creates an immutable copy of a VulkanPhysicalDeviceMemoryPropertiesType 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 VulkanPhysicalDeviceMemoryProperties instance

builder

public static VulkanPhysicalDeviceMemoryProperties.Builder builder()

Creates a builder for VulkanPhysicalDeviceMemoryProperties.

Returns:

A new VulkanPhysicalDeviceMemoryProperties builder