com.io7m.r2.core

Class R2ImageBufferDescription

java.lang.Object

com.io7m.r2.core.R2ImageBufferDescription

All Implemented Interfaces:

R2ImageBufferDescriptionType, R2RenderTargetDescriptionType

@Generated(value={"Immutables.generator","R2ImageBufferDescriptionType"})
public final class R2ImageBufferDescription
extends Object
implements R2ImageBufferDescriptionType

The type of image buffer descriptions.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
com.io7m.jareas.core.AreaInclusiveUnsignedLType	area()
static R2ImageBufferDescription.Builder	builder() Creates a builder for R2ImageBufferDescription.
static R2ImageBufferDescription	copyOf(R2ImageBufferDescriptionType instance) Creates an immutable copy of a R2ImageBufferDescriptionType value.
Optional<R2DepthAttachmentSpecificationType>	depthAttachment() A specification of whether a new depth attachment should be created, a depth attachment should be shared with an existing framebuffer, or no depth attachment should exist at all.
boolean	equals(Object another) This instance is equal to all instances of R2ImageBufferDescription that have equal attribute values.
int	hashCode() Computes a hash code from attributes: area, depthAttachment.
static R2ImageBufferDescription	of(com.io7m.jareas.core.AreaInclusiveUnsignedLType area, Optional<R2DepthAttachmentSpecificationType> depthAttachment) Construct a new immutable R2ImageBufferDescription instance.
String	toString() Prints the immutable value R2ImageBufferDescription with attribute values.
R2ImageBufferDescription	withArea(com.io7m.jareas.core.AreaInclusiveUnsignedLType value) Copy the current immutable object by setting a value for the area attribute.
R2ImageBufferDescription	withDepthAttachment(Optional<R2DepthAttachmentSpecificationType> optional) Copy the current immutable object by setting an optional value for the depthAttachment attribute.
R2ImageBufferDescription	withDepthAttachment(R2DepthAttachmentSpecificationType value) Copy the current immutable object by setting a present value for the optional depthAttachment attribute.

Methods inherited from class java.lang.Object

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

Method Detail

area

public com.io7m.jareas.core.AreaInclusiveUnsignedLType area()

Specified by:

area in interface R2ImageBufferDescriptionType

Specified by:

area in interface R2RenderTargetDescriptionType

Returns:

The value of the area attribute

depthAttachment

public Optional<R2DepthAttachmentSpecificationType> depthAttachment()

A specification of whether a new depth attachment should be created, a depth attachment should be shared with an existing framebuffer, or no depth attachment should exist at all.

Specified by:

depthAttachment in interface R2ImageBufferDescriptionType

Returns:

The specification of the attachment, if one is to be provided

withArea

public final R2ImageBufferDescription withArea(com.io7m.jareas.core.AreaInclusiveUnsignedLType value)

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

Parameters:

value - A new value for area

Returns:

A modified copy of the this object

withDepthAttachment

public final R2ImageBufferDescription withDepthAttachment(R2DepthAttachmentSpecificationType value)

Copy the current immutable object by setting a present value for the optional depthAttachment attribute.

Parameters:

value - The value for depthAttachment

Returns:

A modified copy of this object

withDepthAttachment

public final R2ImageBufferDescription withDepthAttachment(Optional<R2DepthAttachmentSpecificationType> optional)

Copy the current immutable object by setting an optional value for the depthAttachment attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.

Parameters:

optional - A value for depthAttachment

Returns:

A modified copy of this object

equals

public boolean equals(Object another)

This instance is equal to all instances of R2ImageBufferDescription that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: area, depthAttachment.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value R2ImageBufferDescription with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static R2ImageBufferDescription of(com.io7m.jareas.core.AreaInclusiveUnsignedLType area,
                                          Optional<R2DepthAttachmentSpecificationType> depthAttachment)

Construct a new immutable R2ImageBufferDescription instance.

Parameters:

area - The value for the area attribute

depthAttachment - The value for the depthAttachment attribute

Returns:

An immutable R2ImageBufferDescription instance

copyOf

public static R2ImageBufferDescription copyOf(R2ImageBufferDescriptionType instance)

Creates an immutable copy of a R2ImageBufferDescriptionType 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 R2ImageBufferDescription instance

builder

public static R2ImageBufferDescription.Builder builder()

Creates a builder for R2ImageBufferDescription.

Returns:

A new R2ImageBufferDescription builder