Module com.io7m.jcoronado.api

Package com.io7m.jcoronado.api

Class VulkanStencilOpState.Builder

java.lang.Object

com.io7m.jcoronado.api.VulkanStencilOpState.Builder

Enclosing class:

VulkanStencilOpState

public static final class VulkanStencilOpState.Builder
extends java.lang.Object

Builds instances of type VulkanStencilOpState. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method	Description
VulkanStencilOpState	build()	Builds a new VulkanStencilOpState.
VulkanStencilOpState.Builder	from(VulkanStencilOpStateType instance)	Fill a builder with attribute values from the provided VulkanStencilOpStateType instance.
VulkanStencilOpState.Builder	setCompareMask(int compareMask)	Initializes the value for the compareMask attribute.
VulkanStencilOpState.Builder	setCompareOp(VulkanCompareOp compareOp)	Initializes the value for the compareOp attribute.
VulkanStencilOpState.Builder	setDepthFailOp(VulkanStencilOp depthFailOp)	Initializes the value for the depthFailOp attribute.
VulkanStencilOpState.Builder	setFailOp(VulkanStencilOp failOp)	Initializes the value for the failOp attribute.
VulkanStencilOpState.Builder	setPassOp(VulkanStencilOp passOp)	Initializes the value for the passOp attribute.
VulkanStencilOpState.Builder	setReference(int reference)	Initializes the value for the reference attribute.
VulkanStencilOpState.Builder	setWriteMask(int writeMask)	Initializes the value for the writeMask attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public final VulkanStencilOpState.Builder from(VulkanStencilOpStateType instance)

Fill a builder with attribute values from the provided VulkanStencilOpStateType instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

setFailOp

public final VulkanStencilOpState.Builder setFailOp(VulkanStencilOp failOp)

Initializes the value for the failOp attribute.

Parameters:

failOp - The value for failOp

Returns:

this builder for use in a chained invocation

setPassOp

public final VulkanStencilOpState.Builder setPassOp(VulkanStencilOp passOp)

Initializes the value for the passOp attribute.

Parameters:

passOp - The value for passOp

Returns:

this builder for use in a chained invocation

setDepthFailOp

public final VulkanStencilOpState.Builder setDepthFailOp(VulkanStencilOp depthFailOp)

Initializes the value for the depthFailOp attribute.

Parameters:

depthFailOp - The value for depthFailOp

Returns:

this builder for use in a chained invocation

setCompareOp

public final VulkanStencilOpState.Builder setCompareOp(VulkanCompareOp compareOp)

Initializes the value for the compareOp attribute.

Parameters:

compareOp - The value for compareOp

Returns:

this builder for use in a chained invocation

setCompareMask

public final VulkanStencilOpState.Builder setCompareMask(int compareMask)

Initializes the value for the compareMask attribute.

Parameters:

compareMask - The value for compareMask

Returns:

this builder for use in a chained invocation

setWriteMask

public final VulkanStencilOpState.Builder setWriteMask(int writeMask)

Initializes the value for the writeMask attribute.

Parameters:

writeMask - The value for writeMask

Returns:

this builder for use in a chained invocation

setReference

public final VulkanStencilOpState.Builder setReference(int reference)

Initializes the value for the reference attribute.

Parameters:

reference - The value for reference

Returns:

this builder for use in a chained invocation

build

public VulkanStencilOpState build()

Builds a new VulkanStencilOpState.

Returns:

An immutable instance of VulkanStencilOpState

Throws:

java.lang.IllegalStateException - if any required attributes are missing