Module com.io7m.jcoronado.api

Package com.io7m.jcoronado.api

Class VulkanAttachmentReference

java.lang.Object

com.io7m.jcoronado.api.VulkanAttachmentReference

All Implemented Interfaces:

VulkanAttachmentReferenceType

public final class VulkanAttachmentReference
extends java.lang.Object
implements VulkanAttachmentReferenceType

Structure specifying an attachment reference.

See Also:

"VkAttachmentReference"

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

attachment

public int attachment()

Specified by:

attachment in interface VulkanAttachmentReferenceType

Returns:

The index of the attachment of the render pass

layout

public VulkanImageLayout layout()

Specified by:

layout in interface VulkanAttachmentReferenceType

Returns:

The layout the attachment uses during the subpass.

withAttachment

public final VulkanAttachmentReference withAttachment(int value)

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

Parameters:

value - A new value for attachment

Returns:

A modified copy of the this object

withLayout

public final VulkanAttachmentReference withLayout(VulkanImageLayout value)

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

Parameters:

value - A new value for layout

Returns:

A modified copy of the this object

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of VulkanAttachmentReference 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: attachment, layout.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value VulkanAttachmentReference with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static VulkanAttachmentReference of(int attachment,
                                           VulkanImageLayout layout)

Construct a new immutable VulkanAttachmentReference instance.

Parameters:

attachment - The value for the attachment attribute

layout - The value for the layout attribute

Returns:

An immutable VulkanAttachmentReference instance

copyOf

public static VulkanAttachmentReference copyOf(VulkanAttachmentReferenceType instance)

Creates an immutable copy of a VulkanAttachmentReferenceType 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 VulkanAttachmentReference instance

builder

public static VulkanAttachmentReference.Builder builder()

Creates a builder for VulkanAttachmentReference.

Returns:

A new VulkanAttachmentReference builder