Module com.io7m.jcoronado.api

Package com.io7m.jcoronado.api

Class VulkanPipelineDepthStencilStateCreateInfo

java.lang.Object

com.io7m.jcoronado.api.VulkanPipelineDepthStencilStateCreateInfo

All Implemented Interfaces:

VulkanPipelineDepthStencilStateCreateInfoType

public final class VulkanPipelineDepthStencilStateCreateInfo
extends java.lang.Object
implements VulkanPipelineDepthStencilStateCreateInfoType

Structure specifying parameters of a newly created pipeline depth stencil state.

See Also:

"VkPipelineDepthStencilStateCreateInfo"

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
VulkanStencilOpState	back()
static VulkanPipelineDepthStencilStateCreateInfo.Builder	builder()	Creates a builder for VulkanPipelineDepthStencilStateCreateInfo.
static VulkanPipelineDepthStencilStateCreateInfo	copyOf(VulkanPipelineDepthStencilStateCreateInfoType instance)	Creates an immutable copy of a VulkanPipelineDepthStencilStateCreateInfoType value.
boolean	depthBoundsTestEnable()
VulkanCompareOp	depthCompareOp()
boolean	depthTestEnable()
boolean	depthWriteEnable()
boolean	equals(java.lang.Object another)	This instance is equal to all instances of VulkanPipelineDepthStencilStateCreateInfo that have equal attribute values.
java.util.Set<VulkanPipelineDepthStencilStateCreateFlag>	flags()
VulkanStencilOpState	front()
int	hashCode()	Computes a hash code from attributes: flags, depthTestEnable, depthWriteEnable, depthCompareOp, depthBoundsTestEnable, stencilTestEnable, front, back, minDepthBounds, maxDepthBounds.
float	maxDepthBounds()
float	minDepthBounds()
static VulkanPipelineDepthStencilStateCreateInfo	of(java.lang.Iterable<VulkanPipelineDepthStencilStateCreateFlag> flags, boolean depthTestEnable, boolean depthWriteEnable, VulkanCompareOp depthCompareOp, boolean depthBoundsTestEnable, boolean stencilTestEnable, VulkanStencilOpState front, VulkanStencilOpState back, float minDepthBounds, float maxDepthBounds)	Construct a new immutable VulkanPipelineDepthStencilStateCreateInfo instance.
static VulkanPipelineDepthStencilStateCreateInfo	of(java.util.Set<VulkanPipelineDepthStencilStateCreateFlag> flags, boolean depthTestEnable, boolean depthWriteEnable, VulkanCompareOp depthCompareOp, boolean depthBoundsTestEnable, boolean stencilTestEnable, VulkanStencilOpState front, VulkanStencilOpState back, float minDepthBounds, float maxDepthBounds)	Construct a new immutable VulkanPipelineDepthStencilStateCreateInfo instance.
boolean	stencilTestEnable()
java.lang.String	toString()	Prints the immutable value VulkanPipelineDepthStencilStateCreateInfo with attribute values.
VulkanPipelineDepthStencilStateCreateInfo	withBack(VulkanStencilOpState value)	Copy the current immutable object by setting a value for the back attribute.
VulkanPipelineDepthStencilStateCreateInfo	withDepthBoundsTestEnable(boolean value)	Copy the current immutable object by setting a value for the depthBoundsTestEnable attribute.
VulkanPipelineDepthStencilStateCreateInfo	withDepthCompareOp(VulkanCompareOp value)	Copy the current immutable object by setting a value for the depthCompareOp attribute.
VulkanPipelineDepthStencilStateCreateInfo	withDepthTestEnable(boolean value)	Copy the current immutable object by setting a value for the depthTestEnable attribute.
VulkanPipelineDepthStencilStateCreateInfo	withDepthWriteEnable(boolean value)	Copy the current immutable object by setting a value for the depthWriteEnable attribute.
VulkanPipelineDepthStencilStateCreateInfo	withFlags(VulkanPipelineDepthStencilStateCreateFlag... elements)	Copy the current immutable object with elements that replace the content of flags.
VulkanPipelineDepthStencilStateCreateInfo	withFlags(java.lang.Iterable<VulkanPipelineDepthStencilStateCreateFlag> elements)	Copy the current immutable object with elements that replace the content of flags.
VulkanPipelineDepthStencilStateCreateInfo	withFront(VulkanStencilOpState value)	Copy the current immutable object by setting a value for the front attribute.
VulkanPipelineDepthStencilStateCreateInfo	withMaxDepthBounds(float value)	Copy the current immutable object by setting a value for the maxDepthBounds attribute.
VulkanPipelineDepthStencilStateCreateInfo	withMinDepthBounds(float value)	Copy the current immutable object by setting a value for the minDepthBounds attribute.
VulkanPipelineDepthStencilStateCreateInfo	withStencilTestEnable(boolean value)	Copy the current immutable object by setting a value for the stencilTestEnable attribute.

Methods inherited from class java.lang.Object

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

Method Detail

flags

public java.util.Set<VulkanPipelineDepthStencilStateCreateFlag> flags()

Specified by:

flags in interface VulkanPipelineDepthStencilStateCreateInfoType

Returns:

Creation flags

depthTestEnable

public boolean depthTestEnable()

Specified by:

depthTestEnable in interface VulkanPipelineDepthStencilStateCreateInfoType

Returns:

true if depth testing is enabled.

depthWriteEnable

public boolean depthWriteEnable()

Specified by:

depthWriteEnable in interface VulkanPipelineDepthStencilStateCreateInfoType

Returns:

true if depth writing is enabled.

depthCompareOp

public VulkanCompareOp depthCompareOp()

Specified by:

depthCompareOp in interface VulkanPipelineDepthStencilStateCreateInfoType

Returns:

The comparison operator used in the depth test.

depthBoundsTestEnable

public boolean depthBoundsTestEnable()

Specified by:

depthBoundsTestEnable in interface VulkanPipelineDepthStencilStateCreateInfoType

Returns:

true if depth bounds testing is enabled.

stencilTestEnable

public boolean stencilTestEnable()

Specified by:

stencilTestEnable in interface VulkanPipelineDepthStencilStateCreateInfoType

Returns:

true if stencil testing is enabled.

front

public VulkanStencilOpState front()

Specified by:

front in interface VulkanPipelineDepthStencilStateCreateInfoType

Returns:

The stencil op state for front faces.

back

public VulkanStencilOpState back()

Specified by:

back in interface VulkanPipelineDepthStencilStateCreateInfoType

Returns:

The stencil op state for back faces.

minDepthBounds

public float minDepthBounds()

Specified by:

minDepthBounds in interface VulkanPipelineDepthStencilStateCreateInfoType

Returns:

The minimum depth for bounds testing

maxDepthBounds

public float maxDepthBounds()

Specified by:

maxDepthBounds in interface VulkanPipelineDepthStencilStateCreateInfoType

Returns:

The maximum depth for bounds testing

withFlags

public final VulkanPipelineDepthStencilStateCreateInfo withFlags(VulkanPipelineDepthStencilStateCreateFlag... elements)

Copy the current immutable object with elements that replace the content of flags.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withFlags

public final VulkanPipelineDepthStencilStateCreateInfo withFlags(java.lang.Iterable<VulkanPipelineDepthStencilStateCreateFlag> elements)

Copy the current immutable object with elements that replace the content of flags. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of flags elements to set

Returns:

A modified copy of this object

withDepthTestEnable

public final VulkanPipelineDepthStencilStateCreateInfo withDepthTestEnable(boolean value)

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

Parameters:

value - A new value for depthTestEnable

Returns:

A modified copy of the this object

withDepthWriteEnable

public final VulkanPipelineDepthStencilStateCreateInfo withDepthWriteEnable(boolean value)

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

Parameters:

value - A new value for depthWriteEnable

Returns:

A modified copy of the this object

withDepthCompareOp

public final VulkanPipelineDepthStencilStateCreateInfo withDepthCompareOp(VulkanCompareOp value)

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

Parameters:

value - A new value for depthCompareOp

Returns:

A modified copy of the this object

withDepthBoundsTestEnable

public final VulkanPipelineDepthStencilStateCreateInfo withDepthBoundsTestEnable(boolean value)

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

Parameters:

value - A new value for depthBoundsTestEnable

Returns:

A modified copy of the this object

withStencilTestEnable

public final VulkanPipelineDepthStencilStateCreateInfo withStencilTestEnable(boolean value)

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

Parameters:

value - A new value for stencilTestEnable

Returns:

A modified copy of the this object

withFront

public final VulkanPipelineDepthStencilStateCreateInfo withFront(VulkanStencilOpState value)

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

Parameters:

value - A new value for front

Returns:

A modified copy of the this object

withBack

public final VulkanPipelineDepthStencilStateCreateInfo withBack(VulkanStencilOpState value)

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

Parameters:

value - A new value for back

Returns:

A modified copy of the this object

withMinDepthBounds

public final VulkanPipelineDepthStencilStateCreateInfo withMinDepthBounds(float value)

Copy the current immutable object by setting a value for the minDepthBounds attribute. A value strict bits equality used to prevent copying of the same value by returning this.

Parameters:

value - A new value for minDepthBounds

Returns:

A modified copy of the this object

withMaxDepthBounds

public final VulkanPipelineDepthStencilStateCreateInfo withMaxDepthBounds(float value)

Copy the current immutable object by setting a value for the maxDepthBounds attribute. A value strict bits equality used to prevent copying of the same value by returning this.

Parameters:

value - A new value for maxDepthBounds

Returns:

A modified copy of the this object

equals

public boolean equals(java.lang.Object another)

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

Overrides:

equals in class java.lang.Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: flags, depthTestEnable, depthWriteEnable, depthCompareOp, depthBoundsTestEnable, stencilTestEnable, front, back, minDepthBounds, maxDepthBounds.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value VulkanPipelineDepthStencilStateCreateInfo with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static VulkanPipelineDepthStencilStateCreateInfo of(java.util.Set<VulkanPipelineDepthStencilStateCreateFlag> flags,
                                                           boolean depthTestEnable,
                                                           boolean depthWriteEnable,
                                                           VulkanCompareOp depthCompareOp,
                                                           boolean depthBoundsTestEnable,
                                                           boolean stencilTestEnable,
                                                           VulkanStencilOpState front,
                                                           VulkanStencilOpState back,
                                                           float minDepthBounds,
                                                           float maxDepthBounds)

Construct a new immutable VulkanPipelineDepthStencilStateCreateInfo instance.

Parameters:

flags - The value for the flags attribute

depthTestEnable - The value for the depthTestEnable attribute

depthWriteEnable - The value for the depthWriteEnable attribute

depthCompareOp - The value for the depthCompareOp attribute

depthBoundsTestEnable - The value for the depthBoundsTestEnable attribute

stencilTestEnable - The value for the stencilTestEnable attribute

front - The value for the front attribute

back - The value for the back attribute

minDepthBounds - The value for the minDepthBounds attribute

maxDepthBounds - The value for the maxDepthBounds attribute

Returns:

An immutable VulkanPipelineDepthStencilStateCreateInfo instance

of

public static VulkanPipelineDepthStencilStateCreateInfo of(java.lang.Iterable<VulkanPipelineDepthStencilStateCreateFlag> flags,
                                                           boolean depthTestEnable,
                                                           boolean depthWriteEnable,
                                                           VulkanCompareOp depthCompareOp,
                                                           boolean depthBoundsTestEnable,
                                                           boolean stencilTestEnable,
                                                           VulkanStencilOpState front,
                                                           VulkanStencilOpState back,
                                                           float minDepthBounds,
                                                           float maxDepthBounds)

Construct a new immutable VulkanPipelineDepthStencilStateCreateInfo instance.

Parameters:

flags - The value for the flags attribute

depthTestEnable - The value for the depthTestEnable attribute

depthWriteEnable - The value for the depthWriteEnable attribute

depthCompareOp - The value for the depthCompareOp attribute

depthBoundsTestEnable - The value for the depthBoundsTestEnable attribute

stencilTestEnable - The value for the stencilTestEnable attribute

front - The value for the front attribute

back - The value for the back attribute

minDepthBounds - The value for the minDepthBounds attribute

maxDepthBounds - The value for the maxDepthBounds attribute

Returns:

An immutable VulkanPipelineDepthStencilStateCreateInfo instance

copyOf

public static VulkanPipelineDepthStencilStateCreateInfo copyOf(VulkanPipelineDepthStencilStateCreateInfoType instance)

Creates an immutable copy of a VulkanPipelineDepthStencilStateCreateInfoType 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 VulkanPipelineDepthStencilStateCreateInfo instance

builder

public static VulkanPipelineDepthStencilStateCreateInfo.Builder builder()

Creates a builder for VulkanPipelineDepthStencilStateCreateInfo.

Returns:

A new VulkanPipelineDepthStencilStateCreateInfo builder