# Class VulkanPipelineMultisampleStateCreateInfo

java.lang.Object
com.io7m.jcoronado.api.VulkanPipelineMultisampleStateCreateInfo

All Implemented Interfaces:
  `VulkanPipelineMultisampleStateCreateInfoType`

public final class VulkanPipelineMultisampleStateCreateInfo extends Object implements VulkanPipelineMultisampleStateCreateInfoType

See Also:
  - "VkPipelineMultisampleStateCreateInfo"

- ## Nested Class Summary

  Nested Classes
  Modifier and Type
  Class
  Description
  `static final class`
  `VulkanPipelineMultisampleStateCreateInfo.Builder`
  Builds instances of type `VulkanPipelineMultisampleStateCreateInfo`.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `boolean`
  `alphaToCoverageEnable()`
  `boolean`
  `alphaToOneEnable()`
  `static VulkanPipelineMultisampleStateCreateInfo.Builder`
  `builder()`
  Creates a builder for `VulkanPipelineMultisampleStateCreateInfo`.
  `static VulkanPipelineMultisampleStateCreateInfo`
  `copyOf(VulkanPipelineMultisampleStateCreateInfoType instance)`
  Creates an immutable copy of a `VulkanPipelineMultisampleStateCreateInfoType` value.
  `boolean`
  `equals(Object another)`
  This instance is equal to all instances of `VulkanPipelineMultisampleStateCreateInfo` that have equal attribute values.
  `Set<VulkanPipelineMultisampleStateCreateFlag>`
  `flags()`
  `int`
  `hashCode()`
  Computes a hash code from attributes: `flags`, `rasterizationSamples`, `sampleShadingEnable`, `minSampleShading`, `sampleMask`, `alphaToCoverageEnable`, `alphaToOneEnable`.
  `float`
  `minSampleShading()`
  `VulkanSampleCountFlag`
  `rasterizationSamples()`
  `Optional<int[]>`
  `sampleMask()`
  `boolean`
  `sampleShadingEnable()`
  `String`
  `toString()`
  Prints the immutable value `VulkanPipelineMultisampleStateCreateInfo` with attribute values.
  `final VulkanPipelineMultisampleStateCreateInfo`
  `withAlphaToCoverageEnable(boolean value)`
  Copy the current immutable object by setting a value for the `alphaToCoverageEnable` attribute.
  `final VulkanPipelineMultisampleStateCreateInfo`
  `withAlphaToOneEnable(boolean value)`
  Copy the current immutable object by setting a value for the `alphaToOneEnable` attribute.
  `final VulkanPipelineMultisampleStateCreateInfo`
  `withFlags(VulkanPipelineMultisampleStateCreateFlag... elements)`
  Copy the current immutable object with elements that replace the content of `flags`.
  `final VulkanPipelineMultisampleStateCreateInfo`
  `withFlags(Iterable<VulkanPipelineMultisampleStateCreateFlag> elements)`
  Copy the current immutable object with elements that replace the content of `flags`.
  `final VulkanPipelineMultisampleStateCreateInfo`
  `withMinSampleShading(float value)`
  Copy the current immutable object by setting a value for the `minSampleShading` attribute.
  `final VulkanPipelineMultisampleStateCreateInfo`
  `withRasterizationSamples(VulkanSampleCountFlag value)`
  Copy the current immutable object by setting a value for the `rasterizationSamples` attribute.
  `final VulkanPipelineMultisampleStateCreateInfo`
  `withSampleMask(int[] value)`
  Copy the current immutable object by setting a present value for the optional `sampleMask` attribute.
  `final VulkanPipelineMultisampleStateCreateInfo`
  `withSampleMask(Optional<? extends int[]> optional)`
  Copy the current immutable object by setting an optional value for the `sampleMask` attribute.
  `final VulkanPipelineMultisampleStateCreateInfo`
  `withSampleShadingEnable(boolean value)`
  Copy the current immutable object by setting a value for the `sampleShadingEnable` attribute.

  ### Methods inherited from class Object

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

- ## Method Details

  - ### flags

    public Set<VulkanPipelineMultisampleStateCreateFlag> flags()
    Specified by:
      `flags` in interface `VulkanPipelineMultisampleStateCreateInfoType`
    Returns:
      Flags reserved for future use

  - ### rasterizationSamples

    public VulkanSampleCountFlag rasterizationSamples()
    Specified by:
      `rasterizationSamples` in interface `VulkanPipelineMultisampleStateCreateInfoType`
    Returns:
      The number of samples per pixel used in rasterization.

  - ### sampleShadingEnable

    public boolean sampleShadingEnable()
    Specified by:
      `sampleShadingEnable` in interface `VulkanPipelineMultisampleStateCreateInfoType`
    Returns:
      `true` if sample shading should be enabled

  - ### minSampleShading

    public float minSampleShading()
    Specified by:
      `minSampleShading` in interface `VulkanPipelineMultisampleStateCreateInfoType`
    Returns:
      minimum fraction of sample shading if `sampleShadingEnable()` is `true`

  - ### sampleMask

    public Optional<int[]> sampleMask()
    Specified by:
      `sampleMask` in interface `VulkanPipelineMultisampleStateCreateInfoType`
    Returns:
      static coverage information that is ANDed with the coverage information generated during rasterization.

  - ### alphaToCoverageEnable

    public boolean alphaToCoverageEnable()
    Specified by:
      `alphaToCoverageEnable` in interface `VulkanPipelineMultisampleStateCreateInfoType`
    Returns:
      `true` if a temporary coverage value is generated based on the alpha component of the fragment’s first color output

  - ### alphaToOneEnable

    public boolean alphaToOneEnable()
    Specified by:
      `alphaToOneEnable` in interface `VulkanPipelineMultisampleStateCreateInfoType`
    Returns:
      `true` if the alpha component of the fragment’s first color output is replaced with one as described in "Multisample Coverage".

  - ### withFlags

    public final VulkanPipelineMultisampleStateCreateInfo withFlags(VulkanPipelineMultisampleStateCreateFlag... 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 VulkanPipelineMultisampleStateCreateInfo withFlags(Iterable<VulkanPipelineMultisampleStateCreateFlag> 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

  - ### withRasterizationSamples

    public final VulkanPipelineMultisampleStateCreateInfo withRasterizationSamples(VulkanSampleCountFlag value)
    Copy the current immutable object by setting a value for the `rasterizationSamples` attribute. A value equality check is used to prevent copying of the same value by returning `this`.
    Parameters:
      `value` - A new value for rasterizationSamples
    Returns:
      A modified copy or the `this` object

  - ### withSampleShadingEnable

    public final VulkanPipelineMultisampleStateCreateInfo withSampleShadingEnable(boolean value)
    Copy the current immutable object by setting a value for the `sampleShadingEnable` attribute. A value equality check is used to prevent copying of the same value by returning `this`.
    Parameters:
      `value` - A new value for sampleShadingEnable
    Returns:
      A modified copy or the `this` object

  - ### withMinSampleShading

    public final VulkanPipelineMultisampleStateCreateInfo withMinSampleShading(float value)
    Copy the current immutable object by setting a value for the `minSampleShading` attribute. A value strict bits equality used to prevent copying of the same value by returning `this`.
    Parameters:
      `value` - A new value for minSampleShading
    Returns:
      A modified copy or the `this` object

  - ### withSampleMask

    public final VulkanPipelineMultisampleStateCreateInfo withSampleMask(int[] value)
    Copy the current immutable object by setting a present value for the optional `sampleMask` attribute.
    Parameters:
      `value` - The value for sampleMask
    Returns:
      A modified copy or `this` if not changed

  - ### withSampleMask

    public final VulkanPipelineMultisampleStateCreateInfo withSampleMask(Optional<? extends int[]> optional)
    Copy the current immutable object by setting an optional value for the `sampleMask` attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning `this`.
    Parameters:
      `optional` - An optional value for sampleMask
    Returns:
      A modified copy or `this` if not changed

  - ### withAlphaToCoverageEnable

    public final VulkanPipelineMultisampleStateCreateInfo withAlphaToCoverageEnable(boolean value)
    Copy the current immutable object by setting a value for the `alphaToCoverageEnable` attribute. A value equality check is used to prevent copying of the same value by returning `this`.
    Parameters:
      `value` - A new value for alphaToCoverageEnable
    Returns:
      A modified copy or the `this` object

  - ### withAlphaToOneEnable

    public final VulkanPipelineMultisampleStateCreateInfo withAlphaToOneEnable(boolean value)
    Copy the current immutable object by setting a value for the `alphaToOneEnable` attribute. A value equality check is used to prevent copying of the same value by returning `this`.
    Parameters:
      `value` - A new value for alphaToOneEnable
    Returns:
      A modified copy or the `this` object

  - ### equals

    public boolean equals(Object another)
    This instance is equal to all instances of `VulkanPipelineMultisampleStateCreateInfo` 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`, `rasterizationSamples`, `sampleShadingEnable`, `minSampleShading`, `sampleMask`, `alphaToCoverageEnable`, `alphaToOneEnable`.
    Overrides:
      `hashCode` in class `Object`
    Returns:
      hashCode value

  - ### toString

    public String toString()
    Prints the immutable value `VulkanPipelineMultisampleStateCreateInfo` with attribute values.
    Overrides:
      `toString` in class `Object`
    Returns:
      A string representation of the value

  - ### copyOf

    public static VulkanPipelineMultisampleStateCreateInfo copyOf(VulkanPipelineMultisampleStateCreateInfoType instance)
    Creates an immutable copy of a `VulkanPipelineMultisampleStateCreateInfoType` 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 VulkanPipelineMultisampleStateCreateInfo instance

  - ### builder

    public static VulkanPipelineMultisampleStateCreateInfo.Builder builder()
    Creates a builder for `VulkanPipelineMultisampleStateCreateInfo`.

        VulkanPipelineMultisampleStateCreateInfo.builder()
           .addFlags|addAllFlags(com.io7m.jcoronado.api.VulkanPipelineMultisampleStateCreateFlag) // flags elements
           .setRasterizationSamples(com.io7m.jcoronado.api.VulkanSampleCountFlag) // optional rasterizationSamples
           .setSampleShadingEnable(boolean) // optional sampleShadingEnable
           .setMinSampleShading(float) // optional minSampleShading
           .setSampleMask(Optional<int[]>) // optional sampleMask
           .setAlphaToCoverageEnable(boolean) // optional alphaToCoverageEnable
           .setAlphaToOneEnable(boolean) // optional alphaToOneEnable
           .build();

    Returns:
      A new VulkanPipelineMultisampleStateCreateInfo builder