Class VulkanPipelineRasterizationStateCreateInfo

java.lang.Object

com.io7m.jcoronado.api.VulkanPipelineRasterizationStateCreateInfo

All Implemented Interfaces:

VulkanPipelineRasterizationStateCreateInfoType

public final class VulkanPipelineRasterizationStateCreateInfo
extends Object
implements VulkanPipelineRasterizationStateCreateInfoType

See Also:

• "VkPipelineRasterizationStateCreateInfo"

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VulkanPipelineRasterizationStateCreateInfo.Builder	builder()	Creates a builder for VulkanPipelineRasterizationStateCreateInfo.
static VulkanPipelineRasterizationStateCreateInfo	copyOf(VulkanPipelineRasterizationStateCreateInfoType instance)	Creates an immutable copy of a VulkanPipelineRasterizationStateCreateInfoType value.
Set<VulkanCullModeFlag>	cullMode()
float	depthBiasClamp()
float	depthBiasConstantFactor()
boolean	depthBiasEnable()
float	depthBiasSlopeFactor()
boolean	depthClampEnable()
boolean	equals(Object another)	This instance is equal to all instances of VulkanPipelineRasterizationStateCreateInfo that have equal attribute values.
Set<VulkanPipelineRasterizationStateCreateFlag>	flags()
VulkanFrontFace	frontFace()
int	hashCode()	Computes a hash code from attributes: flags, depthClampEnable, rasterizerDiscardEnable, polygonMode, cullMode, frontFace, depthBiasEnable, depthBiasConstantFactor, depthBiasClamp, depthBiasSlopeFactor, lineWidth.
float	lineWidth()
VulkanPolygonMode	polygonMode()
boolean	rasterizerDiscardEnable()
String	toString()	Prints the immutable value VulkanPipelineRasterizationStateCreateInfo with attribute values.
final VulkanPipelineRasterizationStateCreateInfo	withCullMode(VulkanCullModeFlag... elements)	Copy the current immutable object with elements that replace the content of cullMode.
final VulkanPipelineRasterizationStateCreateInfo	withCullMode(Iterable<VulkanCullModeFlag> elements)	Copy the current immutable object with elements that replace the content of cullMode.
final VulkanPipelineRasterizationStateCreateInfo	withDepthBiasClamp(float value)	Copy the current immutable object by setting a value for the depthBiasClamp attribute.
final VulkanPipelineRasterizationStateCreateInfo	withDepthBiasConstantFactor(float value)	Copy the current immutable object by setting a value for the depthBiasConstantFactor attribute.
final VulkanPipelineRasterizationStateCreateInfo	withDepthBiasEnable(boolean value)	Copy the current immutable object by setting a value for the depthBiasEnable attribute.
final VulkanPipelineRasterizationStateCreateInfo	withDepthBiasSlopeFactor(float value)	Copy the current immutable object by setting a value for the depthBiasSlopeFactor attribute.
final VulkanPipelineRasterizationStateCreateInfo	withDepthClampEnable(boolean value)	Copy the current immutable object by setting a value for the depthClampEnable attribute.
final VulkanPipelineRasterizationStateCreateInfo	withFlags(VulkanPipelineRasterizationStateCreateFlag... elements)	Copy the current immutable object with elements that replace the content of flags.
final VulkanPipelineRasterizationStateCreateInfo	withFlags(Iterable<VulkanPipelineRasterizationStateCreateFlag> elements)	Copy the current immutable object with elements that replace the content of flags.
final VulkanPipelineRasterizationStateCreateInfo	withFrontFace(VulkanFrontFace value)	Copy the current immutable object by setting a value for the frontFace attribute.
final VulkanPipelineRasterizationStateCreateInfo	withLineWidth(float value)	Copy the current immutable object by setting a value for the lineWidth attribute.
final VulkanPipelineRasterizationStateCreateInfo	withPolygonMode(VulkanPolygonMode value)	Copy the current immutable object by setting a value for the polygonMode attribute.
final VulkanPipelineRasterizationStateCreateInfo	withRasterizerDiscardEnable(boolean value)	Copy the current immutable object by setting a value for the rasterizerDiscardEnable attribute.

Methods inherited from class Object

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

Method Details

flags

public Set<VulkanPipelineRasterizationStateCreateFlag> flags()

Specified by:

flags in interface VulkanPipelineRasterizationStateCreateInfoType

Returns:

State creation flags

depthClampEnable

public boolean depthClampEnable()

Specified by:

depthClampEnable in interface VulkanPipelineRasterizationStateCreateInfoType

Returns:

controls whether to clamp the fragment’s depth values instead of clipping primitives to the z planes of the frustum.

rasterizerDiscardEnable

public boolean rasterizerDiscardEnable()

Specified by:

rasterizerDiscardEnable in interface VulkanPipelineRasterizationStateCreateInfoType

Returns:

controls whether primitives are discarded immediately before the rasterization stage.

polygonMode

public VulkanPolygonMode polygonMode()

Specified by:

polygonMode in interface VulkanPipelineRasterizationStateCreateInfoType

Returns:

the triangle rendering mode.

cullMode

public Set<VulkanCullModeFlag> cullMode()

Specified by:

cullMode in interface VulkanPipelineRasterizationStateCreateInfoType

Returns:

the triangle facing direction used for primitive culling.

frontFace

public VulkanFrontFace frontFace()

Specified by:

frontFace in interface VulkanPipelineRasterizationStateCreateInfoType

Returns:

the front-facing triangle orientation to be used for culling.

depthBiasEnable

public boolean depthBiasEnable()

Specified by:

depthBiasEnable in interface VulkanPipelineRasterizationStateCreateInfoType

Returns:

controls whether to bias fragment depth values.

depthBiasConstantFactor

public float depthBiasConstantFactor()

Specified by:

depthBiasConstantFactor in interface VulkanPipelineRasterizationStateCreateInfoType

Returns:

a scalar factor controlling the constant depth value added to each fragment.

depthBiasClamp

public float depthBiasClamp()

Specified by:

depthBiasClamp in interface VulkanPipelineRasterizationStateCreateInfoType

Returns:

the maximum (or minimum) depth bias of a fragment.

depthBiasSlopeFactor

public float depthBiasSlopeFactor()

Specified by:

depthBiasSlopeFactor in interface VulkanPipelineRasterizationStateCreateInfoType

Returns:

a scalar factor applied to a fragment’s slope in depth bias calculations.

lineWidth

public float lineWidth()

Specified by:

lineWidth in interface VulkanPipelineRasterizationStateCreateInfoType

Returns:

the width of rasterized line segments.

withFlags

public final VulkanPipelineRasterizationStateCreateInfo withFlags(VulkanPipelineRasterizationStateCreateFlag... 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 VulkanPipelineRasterizationStateCreateInfo withFlags(Iterable<VulkanPipelineRasterizationStateCreateFlag> 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 or this if not changed

withDepthClampEnable

public final VulkanPipelineRasterizationStateCreateInfo withDepthClampEnable(boolean value)

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

Parameters:

value - A new value for depthClampEnable

Returns:

A modified copy or the this object

withRasterizerDiscardEnable

public final VulkanPipelineRasterizationStateCreateInfo withRasterizerDiscardEnable(boolean value)

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

Parameters:

value - A new value for rasterizerDiscardEnable

Returns:

A modified copy or the this object

withPolygonMode

public final VulkanPipelineRasterizationStateCreateInfo withPolygonMode(VulkanPolygonMode value)

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

Parameters:

value - A new value for polygonMode

Returns:

A modified copy or the this object

withCullMode

public final VulkanPipelineRasterizationStateCreateInfo withCullMode(VulkanCullModeFlag... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withCullMode

public final VulkanPipelineRasterizationStateCreateInfo withCullMode(Iterable<VulkanCullModeFlag> elements)

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

Parameters:

elements - An iterable of cullMode elements to set

Returns:

A modified copy or this if not changed

withFrontFace

public final VulkanPipelineRasterizationStateCreateInfo withFrontFace(VulkanFrontFace value)

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

Parameters:

value - A new value for frontFace

Returns:

A modified copy or the this object

withDepthBiasEnable

public final VulkanPipelineRasterizationStateCreateInfo withDepthBiasEnable(boolean value)

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

Parameters:

value - A new value for depthBiasEnable

Returns:

A modified copy or the this object

withDepthBiasConstantFactor

public final VulkanPipelineRasterizationStateCreateInfo withDepthBiasConstantFactor(float value)

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

Parameters:

value - A new value for depthBiasConstantFactor

Returns:

A modified copy or the this object

withDepthBiasClamp

public final VulkanPipelineRasterizationStateCreateInfo withDepthBiasClamp(float value)

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

Parameters:

value - A new value for depthBiasClamp

Returns:

A modified copy or the this object

withDepthBiasSlopeFactor

public final VulkanPipelineRasterizationStateCreateInfo withDepthBiasSlopeFactor(float value)

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

Parameters:

value - A new value for depthBiasSlopeFactor

Returns:

A modified copy or the this object

withLineWidth

public final VulkanPipelineRasterizationStateCreateInfo withLineWidth(float value)

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

Parameters:

value - A new value for lineWidth

Returns:

A modified copy or the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of VulkanPipelineRasterizationStateCreateInfo 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: flags, depthClampEnable, rasterizerDiscardEnable, polygonMode, cullMode, frontFace, depthBiasEnable, depthBiasConstantFactor, depthBiasClamp, depthBiasSlopeFactor, lineWidth.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value VulkanPipelineRasterizationStateCreateInfo with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static VulkanPipelineRasterizationStateCreateInfo copyOf(VulkanPipelineRasterizationStateCreateInfoType instance)

Creates an immutable copy of a VulkanPipelineRasterizationStateCreateInfoType 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 VulkanPipelineRasterizationStateCreateInfo instance

builder

public static VulkanPipelineRasterizationStateCreateInfo.Builder builder()

Creates a builder for VulkanPipelineRasterizationStateCreateInfo.

VulkanPipelineRasterizationStateCreateInfo.builder()
   .addFlags|addAllFlags(com.io7m.jcoronado.api.VulkanPipelineRasterizationStateCreateFlag) // flags elements
   .setDepthClampEnable(boolean) // optional depthClampEnable
   .setRasterizerDiscardEnable(boolean) // optional rasterizerDiscardEnable
   .setPolygonMode(com.io7m.jcoronado.api.VulkanPolygonMode) // optional polygonMode
   .addCullMode|addAllCullMode(com.io7m.jcoronado.api.VulkanCullModeFlag) // cullMode elements
   .setFrontFace(com.io7m.jcoronado.api.VulkanFrontFace) // optional frontFace
   .setDepthBiasEnable(boolean) // optional depthBiasEnable
   .setDepthBiasConstantFactor(float) // optional depthBiasConstantFactor
   .setDepthBiasClamp(float) // optional depthBiasClamp
   .setDepthBiasSlopeFactor(float) // optional depthBiasSlopeFactor
   .setLineWidth(float) // optional lineWidth
   .build();

Returns:

A new VulkanPipelineRasterizationStateCreateInfo builder