- java.lang.Object
-
- com.io7m.jcoronado.api.VulkanComponentMapping
-
- All Implemented Interfaces:
VulkanComponentMappingType
public final class VulkanComponentMapping extends java.lang.Object implements VulkanComponentMappingType
A structure specifying a color component mapping.- See Also:
- "VkComponentMapping"
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VulkanComponentMapping.Builder
Builds instances of typeVulkanComponentMapping
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description VulkanComponentSwizzle
a()
VulkanComponentSwizzle
b()
static VulkanComponentMapping.Builder
builder()
Creates a builder forVulkanComponentMapping
.static VulkanComponentMapping
copyOf(VulkanComponentMappingType instance)
Creates an immutable copy of aVulkanComponentMappingType
value.boolean
equals(java.lang.Object another)
This instance is equal to all instances ofVulkanComponentMapping
that have equal attribute values.VulkanComponentSwizzle
g()
int
hashCode()
Computes a hash code from attributes:r
,g
,b
,a
.static VulkanComponentMapping
of(VulkanComponentSwizzle r, VulkanComponentSwizzle g, VulkanComponentSwizzle b, VulkanComponentSwizzle a)
Construct a new immutableVulkanComponentMapping
instance.VulkanComponentSwizzle
r()
java.lang.String
toString()
Prints the immutable valueVulkanComponentMapping
with attribute values.VulkanComponentMapping
withA(VulkanComponentSwizzle value)
Copy the current immutable object by setting a value for thea
attribute.VulkanComponentMapping
withB(VulkanComponentSwizzle value)
Copy the current immutable object by setting a value for theb
attribute.VulkanComponentMapping
withG(VulkanComponentSwizzle value)
Copy the current immutable object by setting a value for theg
attribute.VulkanComponentMapping
withR(VulkanComponentSwizzle value)
Copy the current immutable object by setting a value for ther
attribute.
-
-
-
Method Detail
-
r
public VulkanComponentSwizzle r()
- Specified by:
r
in interfaceVulkanComponentMappingType
- Returns:
- The component value placed in the R component of the output vector.
-
g
public VulkanComponentSwizzle g()
- Specified by:
g
in interfaceVulkanComponentMappingType
- Returns:
- The component value placed in the G component of the output vector.
-
b
public VulkanComponentSwizzle b()
- Specified by:
b
in interfaceVulkanComponentMappingType
- Returns:
- The component value placed in the G component of the output vector.
-
a
public VulkanComponentSwizzle a()
- Specified by:
a
in interfaceVulkanComponentMappingType
- Returns:
- The component value placed in the A component of the output vector.
-
withR
public final VulkanComponentMapping withR(VulkanComponentSwizzle value)
Copy the current immutable object by setting a value for ther
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for r- Returns:
- A modified copy of the
this
object
-
withG
public final VulkanComponentMapping withG(VulkanComponentSwizzle value)
Copy the current immutable object by setting a value for theg
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for g- Returns:
- A modified copy of the
this
object
-
withB
public final VulkanComponentMapping withB(VulkanComponentSwizzle value)
Copy the current immutable object by setting a value for theb
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for b- Returns:
- A modified copy of the
this
object
-
withA
public final VulkanComponentMapping withA(VulkanComponentSwizzle value)
Copy the current immutable object by setting a value for thea
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for a- Returns:
- A modified copy of the
this
object
-
equals
public boolean equals(java.lang.Object another)
This instance is equal to all instances ofVulkanComponentMapping
that have equal attribute values.- Overrides:
equals
in classjava.lang.Object
- Returns:
true
ifthis
is equal toanother
instance
-
hashCode
public int hashCode()
Computes a hash code from attributes:r
,g
,b
,a
.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- hashCode value
-
toString
public java.lang.String toString()
Prints the immutable valueVulkanComponentMapping
with attribute values.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of the value
-
of
public static VulkanComponentMapping of(VulkanComponentSwizzle r, VulkanComponentSwizzle g, VulkanComponentSwizzle b, VulkanComponentSwizzle a)
Construct a new immutableVulkanComponentMapping
instance.- Parameters:
r
- The value for ther
attributeg
- The value for theg
attributeb
- The value for theb
attributea
- The value for thea
attribute- Returns:
- An immutable VulkanComponentMapping instance
-
copyOf
public static VulkanComponentMapping copyOf(VulkanComponentMappingType instance)
Creates an immutable copy of aVulkanComponentMappingType
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 VulkanComponentMapping instance
-
builder
public static VulkanComponentMapping.Builder builder()
Creates a builder forVulkanComponentMapping
.- Returns:
- A new VulkanComponentMapping builder
-
-