R2ShaderParametersViewMutable (io7m-r2-documentation 0.2.1 API)

java.lang.Object
- com.io7m.r2.core.shaders.types.R2ShaderParametersViewMutable

All Implemented Interfaces:

R2ShaderParametersViewType
```
@Generated(value={"Modifiables.generator","R2ShaderParametersViewType"})
public final class R2ShaderParametersViewMutable
extends Object
implements R2ShaderParametersViewType
```
A modifiable implementation of the R2ShaderParametersViewType type.
Use the create() static factory methods to create new instances. Use the toImmutable() method to convert to canonical immutable instances.
R2ShaderParametersViewMutable is not thread-safe

See Also:

R2ShaderParametersView

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`R2ShaderParametersViewMutable`	`clear()` Clears the object by setting all attributes to their initial values.
`static R2ShaderParametersViewMutable`	`create()` Construct a modifiable instance of `R2ShaderParametersViewType`.
`static R2ShaderParametersViewMutable`	`create(R2MatricesObserverValuesType observerMatrices, com.io7m.jareas.core.AreaInclusiveUnsignedLType viewport)` Construct a modifiable instance of `R2ShaderParametersViewType`.
`boolean`	`equals(Object another)` This instance is equal to all instances of `R2ShaderParametersViewMutable` that have equal attribute values.
`R2ShaderParametersViewMutable`	`from(R2ShaderParametersViewType instance)` Fill this modifiable instance with attribute values from the provided `R2ShaderParametersViewType` instance.
`int`	`hashCode()` Computes a hash code from attributes: `observerMatrices`, `viewport`.
`boolean`	`isInitialized()` Returns `true` if all required attributes are set, indicating that the object is initialized.
`R2MatricesObserverValuesType`	`observerMatrices()`
`boolean`	`observerMatricesIsSet()` Returns `true` if the required attribute `observerMatrices` is set.
`R2ShaderParametersViewMutable`	`setObserverMatrices(R2MatricesObserverValuesType observerMatrices)` Assigns a value to the `observerMatrices` attribute.
`R2ShaderParametersViewMutable`	`setViewport(com.io7m.jareas.core.AreaInclusiveUnsignedLType viewport)` Assigns a value to the `viewport` attribute.
`R2ShaderParametersView`	`toImmutable()` Converts to `R2ShaderParametersView`.
`String`	`toString()` Generates a string representation of this `R2ShaderParametersViewType`.
`R2ShaderParametersViewMutable`	`unsetObserverMatrices()` Reset an attribute to its initial value.
`R2ShaderParametersViewMutable`	`unsetViewport()` Reset an attribute to its initial value.
`com.io7m.jareas.core.AreaInclusiveUnsignedLType`	`viewport()` A specification of the viewport to which rendering is occurring.
`boolean`	`viewportIsSet()` Returns `true` if the required attribute `viewport` is set.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - create
```
public static R2ShaderParametersViewMutable create(R2MatricesObserverValuesType observerMatrices,
                                                   com.io7m.jareas.core.AreaInclusiveUnsignedLType viewport)
```
    Construct a modifiable instance of R2ShaderParametersViewType.
    
    Parameters:
    
    observerMatrices - The value for the observerMatrices attribute
    
    viewport - The value for the viewport attribute
    
    Returns:
    
    A new modifiable instance
  - create
```
public static R2ShaderParametersViewMutable create()
```
    Construct a modifiable instance of R2ShaderParametersViewType.
    
    Returns:
    
    A new modifiable instance
  - observerMatrices
```
public final R2MatricesObserverValuesType observerMatrices()
```
    Specified by:
    
    observerMatrices in interface R2ShaderParametersViewType
    
    Returns:
    
    The current observer matrices
  - viewport
```
public final com.io7m.jareas.core.AreaInclusiveUnsignedLType viewport()
```
    A specification of the viewport to which rendering is occurring.
    
    Specified by:
    
    viewport in interface R2ShaderParametersViewType
    
    Returns:
    
    The current viewport
  - clear
```
public R2ShaderParametersViewMutable clear()
```
    Clears the object by setting all attributes to their initial values.
    
    Returns:
    
    this for use in a chained invocation
  - from
```
public R2ShaderParametersViewMutable from(R2ShaderParametersViewType instance)
```
    Fill this modifiable instance with attribute values from the provided R2ShaderParametersViewType instance. Regular attribute values will be overridden, i.e. replaced with ones of an instance. Any of the instance's absent optional values will not be copied (will not override current values).
    
    Parameters:
    
    instance - The instance from which to copy values
    
    Returns:
    
    this for use in a chained invocation
  - setObserverMatrices
```
public R2ShaderParametersViewMutable setObserverMatrices(R2MatricesObserverValuesType observerMatrices)
```
    Assigns a value to the observerMatrices attribute.
    
    Parameters:
    
    observerMatrices - The value for observerMatrices
    
    Returns:
    
    this for use in a chained invocation
  - setViewport
```
public R2ShaderParametersViewMutable setViewport(com.io7m.jareas.core.AreaInclusiveUnsignedLType viewport)
```
    Assigns a value to the viewport attribute.
    
    Parameters:
    
    viewport - The value for viewport
    
    Returns:
    
    this for use in a chained invocation
  - observerMatricesIsSet
```
public final boolean observerMatricesIsSet()
```
    Returns true if the required attribute observerMatrices is set.
    
    Returns:
    
    true if set
  - viewportIsSet
```
public final boolean viewportIsSet()
```
    Returns true if the required attribute viewport is set.
    
    Returns:
    
    true if set
  - unsetObserverMatrices
```
public final R2ShaderParametersViewMutable unsetObserverMatrices()
```
    Reset an attribute to its initial value.
    
    Returns:
    
    this for use in a chained invocation
  - unsetViewport
```
public final R2ShaderParametersViewMutable unsetViewport()
```
    Reset an attribute to its initial value.
    
    Returns:
    
    this for use in a chained invocation
  - isInitialized
```
public final boolean isInitialized()
```
    Returns true if all required attributes are set, indicating that the object is initialized.
    
    Returns:
    
    true if set
  - toImmutable
```
public final R2ShaderParametersView toImmutable()
```
    Converts to R2ShaderParametersView.
    
    Returns:
    
    An immutable instance of R2ShaderParametersView
  - equals
```
public boolean equals(Object another)
```
    This instance is equal to all instances of R2ShaderParametersViewMutable that have equal attribute values. An uninitialized instance is equal only to itself.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if this is equal to another instance
  - hashCode
```
public int hashCode()
```
    Computes a hash code from attributes: observerMatrices, viewport.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Generates a string representation of this R2ShaderParametersViewType. If uninitialized, some attribute values may appear as question marks.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation

Class R2ShaderParametersViewMutable

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

create

observerMatrices

viewport

clear

from

setObserverMatrices

setViewport

observerMatricesIsSet

viewportIsSet

unsetObserverMatrices

unsetViewport

isInitialized

toImmutable

equals

hashCode

toString