Module com.io7m.jcoronado.api
Package com.io7m.jcoronado.api
Class VulkanPipelineColorBlendAttachmentState
- java.lang.Object
-
- com.io7m.jcoronado.api.VulkanPipelineColorBlendAttachmentState
-
- All Implemented Interfaces:
VulkanPipelineColorBlendAttachmentStateType
public final class VulkanPipelineColorBlendAttachmentState extends java.lang.Object implements VulkanPipelineColorBlendAttachmentStateType
Structure specifying a pipeline color blend attachment state.- See Also:
- "VkPipelineColorBlendAttachmentState"
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VulkanPipelineColorBlendAttachmentState.Builder
Builds instances of typeVulkanPipelineColorBlendAttachmentState
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description VulkanBlendOp
alphaBlendOp()
static VulkanPipelineColorBlendAttachmentState.Builder
builder()
Creates a builder forVulkanPipelineColorBlendAttachmentState
.VulkanBlendOp
colorBlendOp()
java.util.Set<VulkanColorComponentFlag>
colorWriteMask()
static VulkanPipelineColorBlendAttachmentState
copyOf(VulkanPipelineColorBlendAttachmentStateType instance)
Creates an immutable copy of aVulkanPipelineColorBlendAttachmentStateType
value.VulkanBlendFactor
dstAlphaBlendFactor()
VulkanBlendFactor
dstColorBlendFactor()
boolean
enable()
boolean
equals(java.lang.Object another)
This instance is equal to all instances ofVulkanPipelineColorBlendAttachmentState
that have equal attribute values.int
hashCode()
Computes a hash code from attributes:enable
,srcColorBlendFactor
,dstColorBlendFactor
,colorBlendOp
,srcAlphaBlendFactor
,dstAlphaBlendFactor
,alphaBlendOp
,colorWriteMask
.static VulkanPipelineColorBlendAttachmentState
of(boolean enable, VulkanBlendFactor srcColorBlendFactor, VulkanBlendFactor dstColorBlendFactor, VulkanBlendOp colorBlendOp, VulkanBlendFactor srcAlphaBlendFactor, VulkanBlendFactor dstAlphaBlendFactor, VulkanBlendOp alphaBlendOp, java.lang.Iterable<VulkanColorComponentFlag> colorWriteMask)
Construct a new immutableVulkanPipelineColorBlendAttachmentState
instance.static VulkanPipelineColorBlendAttachmentState
of(boolean enable, VulkanBlendFactor srcColorBlendFactor, VulkanBlendFactor dstColorBlendFactor, VulkanBlendOp colorBlendOp, VulkanBlendFactor srcAlphaBlendFactor, VulkanBlendFactor dstAlphaBlendFactor, VulkanBlendOp alphaBlendOp, java.util.Set<VulkanColorComponentFlag> colorWriteMask)
Construct a new immutableVulkanPipelineColorBlendAttachmentState
instance.VulkanBlendFactor
srcAlphaBlendFactor()
VulkanBlendFactor
srcColorBlendFactor()
java.lang.String
toString()
Prints the immutable valueVulkanPipelineColorBlendAttachmentState
with attribute values.VulkanPipelineColorBlendAttachmentState
withAlphaBlendOp(VulkanBlendOp value)
Copy the current immutable object by setting a value for thealphaBlendOp
attribute.VulkanPipelineColorBlendAttachmentState
withColorBlendOp(VulkanBlendOp value)
Copy the current immutable object by setting a value for thecolorBlendOp
attribute.VulkanPipelineColorBlendAttachmentState
withColorWriteMask(VulkanColorComponentFlag... elements)
Copy the current immutable object with elements that replace the content ofcolorWriteMask
.VulkanPipelineColorBlendAttachmentState
withColorWriteMask(java.lang.Iterable<VulkanColorComponentFlag> elements)
Copy the current immutable object with elements that replace the content ofcolorWriteMask
.VulkanPipelineColorBlendAttachmentState
withDstAlphaBlendFactor(VulkanBlendFactor value)
Copy the current immutable object by setting a value for thedstAlphaBlendFactor
attribute.VulkanPipelineColorBlendAttachmentState
withDstColorBlendFactor(VulkanBlendFactor value)
Copy the current immutable object by setting a value for thedstColorBlendFactor
attribute.VulkanPipelineColorBlendAttachmentState
withEnable(boolean value)
Copy the current immutable object by setting a value for theenable
attribute.VulkanPipelineColorBlendAttachmentState
withSrcAlphaBlendFactor(VulkanBlendFactor value)
Copy the current immutable object by setting a value for thesrcAlphaBlendFactor
attribute.VulkanPipelineColorBlendAttachmentState
withSrcColorBlendFactor(VulkanBlendFactor value)
Copy the current immutable object by setting a value for thesrcColorBlendFactor
attribute.
-
-
-
Method Detail
-
enable
public boolean enable()
- Specified by:
enable
in interfaceVulkanPipelineColorBlendAttachmentStateType
- Returns:
true
if blending is enabled for the corresponding color attachment. If blending is not enabled, the source fragment’s color for that attachment is passed through unmodified.
-
srcColorBlendFactor
public VulkanBlendFactor srcColorBlendFactor()
- Specified by:
srcColorBlendFactor
in interfaceVulkanPipelineColorBlendAttachmentStateType
- Returns:
- the blend factor used to determine the source factors (Sr,Sg,Sb).
-
dstColorBlendFactor
public VulkanBlendFactor dstColorBlendFactor()
- Specified by:
dstColorBlendFactor
in interfaceVulkanPipelineColorBlendAttachmentStateType
- Returns:
- the blend factor used to determine the destination factors (Dr,Dg,Db).
-
colorBlendOp
public VulkanBlendOp colorBlendOp()
- Specified by:
colorBlendOp
in interfaceVulkanPipelineColorBlendAttachmentStateType
- Returns:
- the blend operation used to calculate the RGB values to write to the color attachment.
-
srcAlphaBlendFactor
public VulkanBlendFactor srcAlphaBlendFactor()
- Specified by:
srcAlphaBlendFactor
in interfaceVulkanPipelineColorBlendAttachmentStateType
- Returns:
- the blend factor used to determine the source factor Sa.
-
dstAlphaBlendFactor
public VulkanBlendFactor dstAlphaBlendFactor()
- Specified by:
dstAlphaBlendFactor
in interfaceVulkanPipelineColorBlendAttachmentStateType
- Returns:
- the blend factor used to determine the destination factor Da.
-
alphaBlendOp
public VulkanBlendOp alphaBlendOp()
- Specified by:
alphaBlendOp
in interfaceVulkanPipelineColorBlendAttachmentStateType
- Returns:
- the blend operation used to calculate the alpha values to write to the color attachment.
-
colorWriteMask
public java.util.Set<VulkanColorComponentFlag> colorWriteMask()
- Specified by:
colorWriteMask
in interfaceVulkanPipelineColorBlendAttachmentStateType
- Returns:
- the R, G, B, and/or A components enabled for writing.
-
withEnable
public final VulkanPipelineColorBlendAttachmentState withEnable(boolean value)
Copy the current immutable object by setting a value for theenable
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for enable- Returns:
- A modified copy of the
this
object
-
withSrcColorBlendFactor
public final VulkanPipelineColorBlendAttachmentState withSrcColorBlendFactor(VulkanBlendFactor value)
Copy the current immutable object by setting a value for thesrcColorBlendFactor
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for srcColorBlendFactor- Returns:
- A modified copy of the
this
object
-
withDstColorBlendFactor
public final VulkanPipelineColorBlendAttachmentState withDstColorBlendFactor(VulkanBlendFactor value)
Copy the current immutable object by setting a value for thedstColorBlendFactor
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for dstColorBlendFactor- Returns:
- A modified copy of the
this
object
-
withColorBlendOp
public final VulkanPipelineColorBlendAttachmentState withColorBlendOp(VulkanBlendOp value)
Copy the current immutable object by setting a value for thecolorBlendOp
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for colorBlendOp- Returns:
- A modified copy of the
this
object
-
withSrcAlphaBlendFactor
public final VulkanPipelineColorBlendAttachmentState withSrcAlphaBlendFactor(VulkanBlendFactor value)
Copy the current immutable object by setting a value for thesrcAlphaBlendFactor
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for srcAlphaBlendFactor- Returns:
- A modified copy of the
this
object
-
withDstAlphaBlendFactor
public final VulkanPipelineColorBlendAttachmentState withDstAlphaBlendFactor(VulkanBlendFactor value)
Copy the current immutable object by setting a value for thedstAlphaBlendFactor
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for dstAlphaBlendFactor- Returns:
- A modified copy of the
this
object
-
withAlphaBlendOp
public final VulkanPipelineColorBlendAttachmentState withAlphaBlendOp(VulkanBlendOp value)
Copy the current immutable object by setting a value for thealphaBlendOp
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for alphaBlendOp- Returns:
- A modified copy of the
this
object
-
withColorWriteMask
public final VulkanPipelineColorBlendAttachmentState withColorWriteMask(VulkanColorComponentFlag... elements)
Copy the current immutable object with elements that replace the content ofcolorWriteMask
.- Parameters:
elements
- The elements to set- Returns:
- A modified copy of
this
object
-
withColorWriteMask
public final VulkanPipelineColorBlendAttachmentState withColorWriteMask(java.lang.Iterable<VulkanColorComponentFlag> elements)
Copy the current immutable object with elements that replace the content ofcolorWriteMask
. A shallow reference equality check is used to prevent copying of the same value by returningthis
.- Parameters:
elements
- An iterable of colorWriteMask 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 ofVulkanPipelineColorBlendAttachmentState
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:enable
,srcColorBlendFactor
,dstColorBlendFactor
,colorBlendOp
,srcAlphaBlendFactor
,dstAlphaBlendFactor
,alphaBlendOp
,colorWriteMask
.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- hashCode value
-
toString
public java.lang.String toString()
Prints the immutable valueVulkanPipelineColorBlendAttachmentState
with attribute values.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of the value
-
of
public static VulkanPipelineColorBlendAttachmentState of(boolean enable, VulkanBlendFactor srcColorBlendFactor, VulkanBlendFactor dstColorBlendFactor, VulkanBlendOp colorBlendOp, VulkanBlendFactor srcAlphaBlendFactor, VulkanBlendFactor dstAlphaBlendFactor, VulkanBlendOp alphaBlendOp, java.util.Set<VulkanColorComponentFlag> colorWriteMask)
Construct a new immutableVulkanPipelineColorBlendAttachmentState
instance.- Parameters:
enable
- The value for theenable
attributesrcColorBlendFactor
- The value for thesrcColorBlendFactor
attributedstColorBlendFactor
- The value for thedstColorBlendFactor
attributecolorBlendOp
- The value for thecolorBlendOp
attributesrcAlphaBlendFactor
- The value for thesrcAlphaBlendFactor
attributedstAlphaBlendFactor
- The value for thedstAlphaBlendFactor
attributealphaBlendOp
- The value for thealphaBlendOp
attributecolorWriteMask
- The value for thecolorWriteMask
attribute- Returns:
- An immutable VulkanPipelineColorBlendAttachmentState instance
-
of
public static VulkanPipelineColorBlendAttachmentState of(boolean enable, VulkanBlendFactor srcColorBlendFactor, VulkanBlendFactor dstColorBlendFactor, VulkanBlendOp colorBlendOp, VulkanBlendFactor srcAlphaBlendFactor, VulkanBlendFactor dstAlphaBlendFactor, VulkanBlendOp alphaBlendOp, java.lang.Iterable<VulkanColorComponentFlag> colorWriteMask)
Construct a new immutableVulkanPipelineColorBlendAttachmentState
instance.- Parameters:
enable
- The value for theenable
attributesrcColorBlendFactor
- The value for thesrcColorBlendFactor
attributedstColorBlendFactor
- The value for thedstColorBlendFactor
attributecolorBlendOp
- The value for thecolorBlendOp
attributesrcAlphaBlendFactor
- The value for thesrcAlphaBlendFactor
attributedstAlphaBlendFactor
- The value for thedstAlphaBlendFactor
attributealphaBlendOp
- The value for thealphaBlendOp
attributecolorWriteMask
- The value for thecolorWriteMask
attribute- Returns:
- An immutable VulkanPipelineColorBlendAttachmentState instance
-
copyOf
public static VulkanPipelineColorBlendAttachmentState copyOf(VulkanPipelineColorBlendAttachmentStateType instance)
Creates an immutable copy of aVulkanPipelineColorBlendAttachmentStateType
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 VulkanPipelineColorBlendAttachmentState instance
-
builder
public static VulkanPipelineColorBlendAttachmentState.Builder builder()
Creates a builder forVulkanPipelineColorBlendAttachmentState
.- Returns:
- A new VulkanPipelineColorBlendAttachmentState builder
-
-