Class VulkanClearValueColorIntegerUnsigned

java.lang.Object

com.io7m.jcoronado.api.VulkanClearValueColorIntegerUnsigned

All Implemented Interfaces:

VulkanClearValueType, VulkanClearValueType.VulkanClearValueColorIntegerUnsignedType, VulkanClearValueType.VulkanClearValueColorType

public final class VulkanClearValueColorIntegerUnsigned
extends Object
implements VulkanClearValueType.VulkanClearValueColorIntegerUnsignedType

A color consisting of unsigned integer components.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface VulkanClearValueType

VulkanClearValueType.VulkanClearValueColorFloatingPointType, VulkanClearValueType.VulkanClearValueColorIntegerSignedType, VulkanClearValueType.VulkanClearValueColorIntegerUnsignedType, VulkanClearValueType.VulkanClearValueColorType, VulkanClearValueType.VulkanClearValueDepthStencilType

Method Summary

Modifier and Type	Method	Description
int	alpha()
int	blue()
static VulkanClearValueColorIntegerUnsigned.Builder	builder()	Creates a builder for VulkanClearValueColorIntegerUnsigned.
static VulkanClearValueColorIntegerUnsigned	copyOf(VulkanClearValueType.VulkanClearValueColorIntegerUnsignedType instance)	Creates an immutable copy of a VulkanClearValueType.VulkanClearValueColorIntegerUnsignedType value.
boolean	equals(Object another)	This instance is equal to all instances of VulkanClearValueColorIntegerUnsigned that have equal attribute values.
int	green()
int	hashCode()	Computes a hash code from attributes: red, green, blue, alpha.
int	red()
String	toString()	Prints the immutable value VulkanClearValueColorIntegerUnsigned with attribute values.
final VulkanClearValueColorIntegerUnsigned	withAlpha(int value)	Copy the current immutable object by setting a value for the alpha attribute.
final VulkanClearValueColorIntegerUnsigned	withBlue(int value)	Copy the current immutable object by setting a value for the blue attribute.
final VulkanClearValueColorIntegerUnsigned	withGreen(int value)	Copy the current immutable object by setting a value for the green attribute.
final VulkanClearValueColorIntegerUnsigned	withRed(int value)	Copy the current immutable object by setting a value for the red attribute.

Methods inherited from class Object

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

Methods inherited from interface VulkanClearValueType.VulkanClearValueColorIntegerUnsignedType

asFillBufferInteger

Methods inherited from interface VulkanClearValueType.VulkanClearValueColorType

asFillBufferInteger

Method Details

red

public int red()

Specified by:

red in interface VulkanClearValueType.VulkanClearValueColorIntegerUnsignedType

Returns:

The red channel

green

public int green()

Specified by:

green in interface VulkanClearValueType.VulkanClearValueColorIntegerUnsignedType

Returns:

The green channel

blue

public int blue()

Specified by:

blue in interface VulkanClearValueType.VulkanClearValueColorIntegerUnsignedType

Returns:

The blue channel

alpha

public int alpha()

Specified by:

alpha in interface VulkanClearValueType.VulkanClearValueColorIntegerUnsignedType

Returns:

The alpha channel

withRed

public final VulkanClearValueColorIntegerUnsigned withRed(int value)

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

Parameters:

value - A new value for red

Returns:

A modified copy or the this object

withGreen

public final VulkanClearValueColorIntegerUnsigned withGreen(int value)

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

Parameters:

value - A new value for green

Returns:

A modified copy or the this object

withBlue

public final VulkanClearValueColorIntegerUnsigned withBlue(int value)

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

Parameters:

value - A new value for blue

Returns:

A modified copy or the this object

withAlpha

public final VulkanClearValueColorIntegerUnsigned withAlpha(int value)

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

Parameters:

value - A new value for alpha

Returns:

A modified copy or the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of VulkanClearValueColorIntegerUnsigned 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: red, green, blue, alpha.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value VulkanClearValueColorIntegerUnsigned with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static VulkanClearValueColorIntegerUnsigned copyOf(VulkanClearValueType.VulkanClearValueColorIntegerUnsignedType instance)

Creates an immutable copy of a VulkanClearValueType.VulkanClearValueColorIntegerUnsignedType 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 VulkanClearValueColorIntegerUnsigned instance

builder

public static VulkanClearValueColorIntegerUnsigned.Builder builder()

Creates a builder for VulkanClearValueColorIntegerUnsigned.

VulkanClearValueColorIntegerUnsigned.builder()
   .setRed(int) // optional red
   .setGreen(int) // optional green
   .setBlue(int) // optional blue
   .setAlpha(int) // optional alpha
   .build();

Returns:

A new VulkanClearValueColorIntegerUnsigned builder