com.io7m.jcanephora.renderstate

Class JCGLRenderState

java.lang.Object

com.io7m.jcanephora.renderstate.JCGLRenderState

All Implemented Interfaces:

JCGLRenderStateType

@Generated(value={"Immutables.generator","JCGLRenderStateType"})
public final class JCGLRenderState
extends Object
implements JCGLRenderStateType

The type of render states.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
Optional<JCGLBlendStateType>	blendState()
static JCGLRenderState.Builder	builder() Creates a builder for JCGLRenderState.
JCGLColorBufferMaskingStateType	colorBufferMaskingState()
Optional<JCGLCullingStateType>	cullingState()
JCGLDepthStateType	depthState()
boolean	equals(Object another) This instance is equal to all instances of JCGLRenderState that have equal attribute values.
int	hashCode() Computes a hash code from attributes: blendState, cullingState, colorBufferMaskingState, polygonMode, scissor, depthState, stencilState.
static JCGLRenderState	of(Optional<JCGLBlendStateType> blendState, Optional<JCGLCullingStateType> cullingState, JCGLColorBufferMaskingStateType colorBufferMaskingState, JCGLPolygonMode polygonMode, Optional<com.io7m.jregions.core.unparameterized.areas.AreaL> scissor, JCGLDepthStateType depthState, JCGLStencilStateType stencilState) Construct a new immutable JCGLRenderState instance.
JCGLPolygonMode	polygonMode()
Optional<com.io7m.jregions.core.unparameterized.areas.AreaL>	scissor()
JCGLStencilStateType	stencilState()
String	toString() Prints the immutable value JCGLRenderState with attribute values.

Methods inherited from class java.lang.Object

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

Method Detail

blendState

public Optional<JCGLBlendStateType> blendState()

Specified by:

blendState in interface JCGLRenderStateType

Returns:

The blending state, if blending is enabled

cullingState

public Optional<JCGLCullingStateType> cullingState()

Specified by:

cullingState in interface JCGLRenderStateType

Returns:

The culling state, if culling is enabled

colorBufferMaskingState

public JCGLColorBufferMaskingStateType colorBufferMaskingState()

Specified by:

colorBufferMaskingState in interface JCGLRenderStateType

Returns:

The color buffer masking state

polygonMode

public JCGLPolygonMode polygonMode()

Specified by:

polygonMode in interface JCGLRenderStateType

Returns:

The polygon rendering mode

scissor

public Optional<com.io7m.jregions.core.unparameterized.areas.AreaL> scissor()

Specified by:

scissor in interface JCGLRenderStateType

Returns:

The scissor region, if scissoring is enabled

depthState

public JCGLDepthStateType depthState()

Specified by:

depthState in interface JCGLRenderStateType

Returns:

The depth buffer state

stencilState

public JCGLStencilStateType stencilState()

Specified by:

stencilState in interface JCGLRenderStateType

Returns:

The stencil buffer state

equals

public boolean equals(Object another)

This instance is equal to all instances of JCGLRenderState 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: blendState, cullingState, colorBufferMaskingState, polygonMode, scissor, depthState, stencilState.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value JCGLRenderState with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static JCGLRenderState of(Optional<JCGLBlendStateType> blendState,
                                 Optional<JCGLCullingStateType> cullingState,
                                 JCGLColorBufferMaskingStateType colorBufferMaskingState,
                                 JCGLPolygonMode polygonMode,
                                 Optional<com.io7m.jregions.core.unparameterized.areas.AreaL> scissor,
                                 JCGLDepthStateType depthState,
                                 JCGLStencilStateType stencilState)

Construct a new immutable JCGLRenderState instance.

Parameters:

blendState - The value for the blendState attribute

cullingState - The value for the cullingState attribute

colorBufferMaskingState - The value for the colorBufferMaskingState attribute

polygonMode - The value for the polygonMode attribute

scissor - The value for the scissor attribute

depthState - The value for the depthState attribute

stencilState - The value for the stencilState attribute

Returns:

An immutable JCGLRenderState instance

builder

public static JCGLRenderState.Builder builder()

Creates a builder for JCGLRenderState.

Returns:

A new JCGLRenderState builder