RenderState (jMonkeyEngine3)

java.lang.Object
- com.jme3.material.RenderState

All Implemented Interfaces:

Savable, java.lang.Cloneable
```
public class RenderState
extends java.lang.Object
implements java.lang.Cloneable, Savable
```
RenderState specifies material rendering properties that cannot be controlled by a shader on a Material. The properties allow manipulation of rendering features such as depth testing, alpha blending, face culling, stencil operations, and much more.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RenderState.BlendEquation` `BlendEquation` specifies the blending equation to combine pixels.
`static class`	`RenderState.BlendEquationAlpha` `BlendEquationAlpha` specifies the blending equation to combine pixels for the alpha component.
`static class`	`RenderState.BlendFunc` `BlendFunc` defines the blending functions for use with `BlendMode.Custom`.
`static class`	`RenderState.BlendMode` `BlendMode` specifies the blending operation to use.
`static class`	`RenderState.FaceCullMode` `FaceCullMode` specifies the criteria for faces to be culled.
`static class`	`RenderState.StencilOperation` `StencilOperation` specifies the stencil operation to use in a certain scenario as specified in `setStencil(boolean, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.TestFunction, com.jme3.material.RenderState.TestFunction)`
`static class`	`RenderState.TestFunction` `TestFunction` specifies the testing function for stencil test function.

Field Summary

Fields
Modifier and Type	Field and Description
`static RenderState`	`ADDITIONAL` The `ADDITIONAL` render state is identical to the `DEFAULT` render state except that all apply values are set to false.
`static RenderState`	`DEFAULT` The `DEFAULT` render state is the one used by default on all materials unless changed otherwise by the user.
`static RenderState`	`NULL` The `NULL` render state is identical to the `DEFAULT` render state except that depth testing and face culling are disabled.

Constructor Summary

Constructors
Constructor and Description

RenderState()

Constructors
Constructor and Description
`RenderState()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`RenderState`	`clone()` Create a clone of this `RenderState`
`int`	`contentHashCode()`
`RenderState`	`copyMergedTo(RenderState additionalState, RenderState state)` Merges `this` state and `additionalState` into the parameter `state` based on a specific criteria.
`boolean`	`equals(java.lang.Object o)` Tests for equivalence with the argument.
`float`	`getAlphaFallOff()` Deprecated.
`RenderState.TestFunction`	`getAlphaFunc()` Deprecated.
`RenderState.StencilOperation`	`getBackStencilDepthFailOperation()` Retrieve the back depth test fail operation.
`RenderState.StencilOperation`	`getBackStencilDepthPassOperation()` Retrieve the back depth test pass operation.
`RenderState.TestFunction`	`getBackStencilFunction()` Retrieve the back stencil function.
`int`	`getBackStencilMask()` Returns the back stencil mask.
`int`	`getBackStencilReference()` Returns the back stencil reference.
`RenderState.StencilOperation`	`getBackStencilStencilFailOperation()` Retrieve the back stencil fail operation.
`RenderState.BlendEquation`	`getBlendEquation()` Returns the blend equation.
`RenderState.BlendEquationAlpha`	`getBlendEquationAlpha()` Returns the blend equation used for the alpha component.
`RenderState.BlendMode`	`getBlendMode()` Returns the blend mode.
`RenderState.BlendFunc`	`getCustomDfactorAlpha()` Returns the destination factor for the alpha component in `BlendMode.Custom`.
`RenderState.BlendFunc`	`getCustomDfactorRGB()` Returns the destination factor for the RGB components in `BlendMode.Custom`.
`RenderState.BlendFunc`	`getCustomSfactorAlpha()` Returns the source factor for the alpha component in `BlendMode.Custom`.
`RenderState.BlendFunc`	`getCustomSfactorRGB()` Returns the source factor for the RGB components in `BlendMode.Custom`.
`RenderState.TestFunction`	`getDepthFunc()` Retrieve the depth comparison function
`RenderState.FaceCullMode`	`getFaceCullMode()` Retrieve the face cull mode.
`RenderState.StencilOperation`	`getFrontStencilDepthFailOperation()` Retrieve the front depth test fail operation.
`RenderState.StencilOperation`	`getFrontStencilDepthPassOperation()` Retrieve the front depth test pass operation.
`RenderState.TestFunction`	`getFrontStencilFunction()` Retrieve the front stencil function.
`int`	`getFrontStencilMask()` Returns the front stencil mask.
`int`	`getFrontStencilReference()` Returns the front stencil reference.
`RenderState.StencilOperation`	`getFrontStencilStencilFailOperation()` Retrieve the front stencil fail operation.
`float`	`getLineWidth()` returns the wireframe line width
`float`	`getPolyOffsetFactor()` Retrieve the poly offset factor value.
`float`	`getPolyOffsetUnits()` Retrieve the poly offset units value.
`boolean`	`isAlphaTest()` Deprecated. To use alpha test, set the `AlphaDiscardThreshold` material parameter.
`boolean`	`isApplyBlendMode()`
`boolean`	`isApplyColorWrite()`
`boolean`	`isApplyCullMode()`
`boolean`	`isApplyDepthFunc()`
`boolean`	`isApplyDepthTest()`
`boolean`	`isApplyDepthWrite()`
`boolean`	`isApplyLineWidth()`
`boolean`	`isApplyPolyOffset()`
`boolean`	`isApplyWireFrame()`
`boolean`	`isColorWrite()` Check if color writing is enabled.
`boolean`	`isDepthTest()` Check if depth test is enabled.
`boolean`	`isDepthWrite()` Check if depth write is enabled.
`boolean`	`isPointSprite()` Deprecated. Always returns true since point sprite is always enabled.
`boolean`	`isPolyOffset()` Check if polygon offset is enabled.
`boolean`	`isStencilTest()` Check if stencil test is enabled.
`boolean`	`isWireframe()` Check if wireframe mode is enabled.
`void`	`read(JmeImporter im)`
`void`	`set(RenderState state)`
`void`	`setBackStencilMask(int backStencilMask)` Sets the back stencil mask.
`void`	`setBackStencilReference(int backStencilReference)` Sets the back stencil reference.
`void`	`setBlendEquation(RenderState.BlendEquation blendEquation)` Set the blending equation for the color component (RGB).
`void`	`setBlendEquationAlpha(RenderState.BlendEquationAlpha blendEquationAlpha)` Set the blending equation for the alpha component.
`void`	`setBlendMode(RenderState.BlendMode blendMode)` Set the blending mode.
`void`	`setColorWrite(boolean colorWrite)` Enable writing color.
`void`	`setCustomBlendFactors(RenderState.BlendFunc sfactorRGB, RenderState.BlendFunc dfactorRGB, RenderState.BlendFunc sfactorAlpha, RenderState.BlendFunc dfactorAlpha)` Sets the blend factors used for the source and destination color.
`void`	`setDepthFunc(RenderState.TestFunction depthFunc)` Set the depth comparison function to the given TestFunction default is LessOrEqual (GL_LEQUAL)
`void`	`setDepthTest(boolean depthTest)` Enable depth testing.
`void`	`setDepthWrite(boolean depthWrite)` Enable depth writing.
`void`	`setFaceCullMode(RenderState.FaceCullMode cullMode)` Set the face culling mode.
`void`	`setFrontStencilMask(int frontStencilMask)` Sets the front stencil mask.
`void`	`setFrontStencilReference(int frontStencilReference)` Sets the front stencil reference.
`void`	`setLineWidth(float lineWidth)` Sets the mesh line width.
`void`	`setPolyOffset(float factor, float units)` Offsets the on-screen z-order of the material's polygons, to combat visual artefacts like stitching, bleeding and z-fighting for overlapping polygons.
`void`	setStencil(boolean enabled, RenderState.StencilOperation _frontStencilStencilFailOperation, RenderState.StencilOperation _frontStencilDepthFailOperation, RenderState.StencilOperation _frontStencilDepthPassOperation, RenderState.StencilOperation _backStencilStencilFailOperation, RenderState.StencilOperation _backStencilDepthFailOperation, RenderState.StencilOperation _backStencilDepthPassOperation, RenderState.TestFunction _frontStencilFunction, RenderState.TestFunction _backStencilFunction) Enable stencil testing.
`void`	`setWireframe(boolean wireframe)` Enables wireframe rendering mode.
`java.lang.String`	`toString()`
`void`	`write(JmeExporter ex)`

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

- Field Detail
  - DEFAULT
```
public static final RenderState DEFAULT
```
    The DEFAULT render state is the one used by default on all materials unless changed otherwise by the user.
    It has the following properties:
    - Back Face Culling
    - Depth Testing Enabled
    - Depth Writing Enabled
  - NULL
```
public static final RenderState NULL
```
    The NULL render state is identical to the DEFAULT render state except that depth testing and face culling are disabled.
  - ADDITIONAL
```
public static final RenderState ADDITIONAL
```
    The ADDITIONAL render state is identical to the DEFAULT render state except that all apply values are set to false. This allows the ADDITIONAL render state to be combined with other state but only influencing values that were changed from the original.
- Constructor Detail
  - RenderState
```
public RenderState()
```
- Method Detail
  - write
```
public void write(JmeExporter ex)
           throws java.io.IOException
```
    Specified by:
    
    write in interface Savable
    
    Throws:
    
    java.io.IOException
  - read
```
public void read(JmeImporter im)
          throws java.io.IOException
```
    Specified by:
    
    read in interface Savable
    
    Throws:
    
    java.io.IOException
  - clone
```
public RenderState clone()
```
    Create a clone of this RenderState
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    Clone of this render state.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Tests for equivalence with the argument. If o is null, false is returned. Either way, the current instance is unaffected.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    o - the object to compare (may be null, unaffected)
    
    Returns:
    
    true if this and o are equivalent, otherwise false
  - setColorWrite
```
public void setColorWrite(boolean colorWrite)
```
    Enable writing color.
    When color write is enabled, the result of a fragment shader, the gl_FragColor, will be rendered into the color buffer (including alpha).
    
    Parameters:
    
    colorWrite - Set to true to enable color writing.
  - setFaceCullMode
```
public void setFaceCullMode(RenderState.FaceCullMode cullMode)
```
    Set the face culling mode.
    See the RenderState.FaceCullMode enum on what each value does. Face culling will project the triangle's points onto the screen and determine if the triangle is in counter-clockwise order or clockwise order. If a triangle is in counter-clockwise order, then it is considered a front-facing triangle, otherwise, it is considered a back-facing triangle.
    
    Parameters:
    
    cullMode - the face culling mode.
  - setBlendMode
```
public void setBlendMode(RenderState.BlendMode blendMode)
```
    Set the blending mode.
    When blending is enabled, (blendMode is not RenderState.BlendMode.Off) the input pixel will be blended with the pixel already in the color buffer. The blending operation is determined by the RenderState.BlendMode. For example, the RenderState.BlendMode.Additive will add the input pixel's color to the color already in the color buffer:
    Result = Source Color + Destination Color
    
    Parameters:
    
    blendMode - The blend mode to use. Set to RenderState.BlendMode.Off to disable blending.
  - setBlendEquation
```
public void setBlendEquation(RenderState.BlendEquation blendEquation)
```
    Set the blending equation for the color component (RGB).
    The blending equation determines, how the RGB values of the input pixel will be blended with the RGB values of the pixel already in the color buffer.
    For example, RenderState.BlendEquation.Add will add the input pixel's color to the color already in the color buffer:
    Result = Source Color + Destination Color
    Note: This gets only used in RenderState.BlendMode.Custom mode. All other blend modes will ignore this setting.
    
    Parameters:
    
    blendEquation - The RenderState.BlendEquation to use.
  - setBlendEquationAlpha
```
public void setBlendEquationAlpha(RenderState.BlendEquationAlpha blendEquationAlpha)
```
    Set the blending equation for the alpha component.
    The alpha blending equation determines, how the alpha values of the input pixel will be blended with the alpha values of the pixel already in the color buffer.
    For example, RenderState.BlendEquationAlpha.Add will add the input pixel's color to the color already in the color buffer:
    Result = Source Color + Destination Color
    Note: This gets only used in RenderState.BlendMode.Custom mode. All other blend modes will ignore this setting.
    
    Parameters:
    
    blendEquationAlpha - The RenderState.BlendEquationAlpha to use.
  - setCustomBlendFactors
```
public void setCustomBlendFactors(RenderState.BlendFunc sfactorRGB,
                                  RenderState.BlendFunc dfactorRGB,
                                  RenderState.BlendFunc sfactorAlpha,
                                  RenderState.BlendFunc dfactorAlpha)
```
    Sets the blend factors used for the source and destination color.
    These factors will be multiplied with the color values of the input pixel and the pixel already in the color buffer, before both colors gets combined by the RenderState.BlendEquation.
    Note: This gets only used in RenderState.BlendMode.Custom mode. All other blend modes will ignore this setting.
    
    Parameters:
    
    sfactorRGB - The source blend factor for RGB components.
    
    dfactorRGB - The destination blend factor for RGB components.
    
    sfactorAlpha - The source blend factor for the alpha component.
    
    dfactorAlpha - The destination blend factor for the alpha component.
  - setDepthTest
```
public void setDepthTest(boolean depthTest)
```
    Enable depth testing.
    When depth testing is enabled, a pixel must pass the depth test before it is written to the color buffer. The input pixel's depth value must be less than or equal than the value already in the depth buffer to pass the depth test.
    
    Parameters:
    
    depthTest - Enable or disable depth testing.
  - setDepthWrite
```
public void setDepthWrite(boolean depthWrite)
```
    Enable depth writing.
    After passing the depth test, a pixel's depth value will be written into the depth buffer if depth writing is enabled.
    
    Parameters:
    
    depthWrite - True to enable writing to the depth buffer.
  - setWireframe
```
public void setWireframe(boolean wireframe)
```
    Enables wireframe rendering mode.
    When in wireframe mode, meshes rendered in triangle mode will not be solid, but instead, only the edges of the triangles will be rendered.
    
    Parameters:
    
    wireframe - True to enable wireframe mode.
  - setPolyOffset
```
public void setPolyOffset(float factor,
                          float units)
```
    Offsets the on-screen z-order of the material's polygons, to combat visual artefacts like stitching, bleeding and z-fighting for overlapping polygons. Factor and units are summed to produce the depth offset. This offset is applied in screen space, typically with positive Z pointing into the screen. Typical values are (1.0f, 1.0f) or (-1.0f, -1.0f)
    
    Parameters:
    
    factor - scales the maximum Z slope, with respect to X or Y of the polygon
    
    units - scales the minimum resolvable depth buffer value
    
    See Also:
    
    http://www.opengl.org/resources/faq/technical/polygonoffset.htm
  - setStencil
```
public void setStencil(boolean enabled,
                       RenderState.StencilOperation _frontStencilStencilFailOperation,
                       RenderState.StencilOperation _frontStencilDepthFailOperation,
                       RenderState.StencilOperation _frontStencilDepthPassOperation,
                       RenderState.StencilOperation _backStencilStencilFailOperation,
                       RenderState.StencilOperation _backStencilDepthFailOperation,
                       RenderState.StencilOperation _backStencilDepthPassOperation,
                       RenderState.TestFunction _frontStencilFunction,
                       RenderState.TestFunction _backStencilFunction)
```
    Enable stencil testing.
    Stencil testing can be used to filter pixels according to the stencil buffer. Objects can be rendered with some stencil operation to manipulate the values in the stencil buffer, then, other objects can be rendered to test against the values written previously.
    
    Parameters:
    
    enabled - Set to true to enable stencil functionality. If false all other parameters are ignored.
    
    _frontStencilStencilFailOperation - Sets the operation to occur when a front-facing triangle fails the front stencil function.
    
    _frontStencilDepthFailOperation - Sets the operation to occur when a front-facing triangle fails the depth test.
    
    _frontStencilDepthPassOperation - Set the operation to occur when a front-facing triangle passes the depth test.
    
    _backStencilStencilFailOperation - Set the operation to occur when a back-facing triangle fails the back stencil function.
    
    _backStencilDepthFailOperation - Set the operation to occur when a back-facing triangle fails the depth test.
    
    _backStencilDepthPassOperation - Set the operation to occur when a back-facing triangle passes the depth test.
    
    _frontStencilFunction - Set the test function for front-facing triangles.
    
    _backStencilFunction - Set the test function for back-facing triangles.
  - setDepthFunc
```
public void setDepthFunc(RenderState.TestFunction depthFunc)
```
    Set the depth comparison function to the given TestFunction default is LessOrEqual (GL_LEQUAL)
    
    Parameters:
    
    depthFunc - the depth comparison function
    
    See Also:
    
    RenderState.TestFunction, setDepthTest(boolean)
  - setLineWidth
```
public void setLineWidth(float lineWidth)
```
    Sets the mesh line width. Use this in conjunction with setWireframe(boolean) or with a mesh in Mesh.Mode.Lines mode.
    
    Parameters:
    
    lineWidth - the line width.
  - isStencilTest
```
public boolean isStencilTest()
```
    Check if stencil test is enabled.
    
    Returns:
    
    True if stencil test is enabled.
  - getFrontStencilStencilFailOperation
```
public RenderState.StencilOperation getFrontStencilStencilFailOperation()
```
    Retrieve the front stencil fail operation.
    
    Returns:
    
    the front stencil fail operation.
    
    See Also:
    
    setStencil(boolean, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.TestFunction, com.jme3.material.RenderState.TestFunction)
  - getFrontStencilDepthFailOperation
```
public RenderState.StencilOperation getFrontStencilDepthFailOperation()
```
    Retrieve the front depth test fail operation.
    
    Returns:
    
    the front depth test fail operation.
    
    See Also:
    
    setStencil(boolean, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.TestFunction, com.jme3.material.RenderState.TestFunction)
  - getFrontStencilDepthPassOperation
```
public RenderState.StencilOperation getFrontStencilDepthPassOperation()
```
    Retrieve the front depth test pass operation.
    
    Returns:
    
    the front depth test pass operation.
    
    See Also:
    
    setStencil(boolean, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.TestFunction, com.jme3.material.RenderState.TestFunction)
  - getBackStencilStencilFailOperation
```
public RenderState.StencilOperation getBackStencilStencilFailOperation()
```
    Retrieve the back stencil fail operation.
    
    Returns:
    
    the back stencil fail operation.
    
    See Also:
    
    setStencil(boolean, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.TestFunction, com.jme3.material.RenderState.TestFunction)
  - getBackStencilDepthFailOperation
```
public RenderState.StencilOperation getBackStencilDepthFailOperation()
```
    Retrieve the back depth test fail operation.
    
    Returns:
    
    the back depth test fail operation.
    
    See Also:
    
    setStencil(boolean, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.TestFunction, com.jme3.material.RenderState.TestFunction)
  - getBackStencilDepthPassOperation
```
public RenderState.StencilOperation getBackStencilDepthPassOperation()
```
    Retrieve the back depth test pass operation.
    
    Returns:
    
    the back depth test pass operation.
    
    See Also:
    
    setStencil(boolean, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.TestFunction, com.jme3.material.RenderState.TestFunction)
  - getFrontStencilFunction
```
public RenderState.TestFunction getFrontStencilFunction()
```
    Retrieve the front stencil function.
    
    Returns:
    
    the front stencil function.
    
    See Also:
    
    setStencil(boolean, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.TestFunction, com.jme3.material.RenderState.TestFunction)
  - getBackStencilFunction
```
public RenderState.TestFunction getBackStencilFunction()
```
    Retrieve the back stencil function.
    
    Returns:
    
    the back stencil function.
    
    See Also:
    
    setStencil(boolean, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.TestFunction, com.jme3.material.RenderState.TestFunction)
  - setFrontStencilMask
```
public void setFrontStencilMask(int frontStencilMask)
```
    Sets the front stencil mask.
    
    Parameters:
    
    frontStencilMask - the desired bitmask (default=0x7fffffff)
  - setBackStencilMask
```
public void setBackStencilMask(int backStencilMask)
```
    Sets the back stencil mask.
    
    Parameters:
    
    backStencilMask - the desired bitmask (default=0x7fffffff)
  - setFrontStencilReference
```
public void setFrontStencilReference(int frontStencilReference)
```
    Sets the front stencil reference.
    
    Parameters:
    
    frontStencilReference - the desired reference (default=0x0)
  - setBackStencilReference
```
public void setBackStencilReference(int backStencilReference)
```
    Sets the back stencil reference.
    
    Parameters:
    
    backStencilReference - the desired bitmask (default=0x0)
  - getFrontStencilMask
```
public int getFrontStencilMask()
```
    Returns the front stencil mask.
    
    Returns:
    
    the bitmask applied before comparing the front stencil to its reference value
  - getFrontStencilReference
```
public int getFrontStencilReference()
```
    Returns the front stencil reference.
    
    Returns:
    
    the reference value for the front stencil
  - getBackStencilMask
```
public int getBackStencilMask()
```
    Returns the back stencil mask.
    
    Returns:
    
    the bitmask applied before comparing the back stencil to its reference value
  - getBackStencilReference
```
public int getBackStencilReference()
```
    Returns the back stencil reference.
    
    Returns:
    
    the reference value for the back stencil
  - getBlendEquation
```
public RenderState.BlendEquation getBlendEquation()
```
    Returns the blend equation.
    
    Returns:
    
    the blend equation.
  - getBlendEquationAlpha
```
public RenderState.BlendEquationAlpha getBlendEquationAlpha()
```
    Returns the blend equation used for the alpha component.
    
    Returns:
    
    the blend equation for the alpha component.
  - getBlendMode
```
public RenderState.BlendMode getBlendMode()
```
    Returns the blend mode.
    
    Returns:
    
    the blend mode.
  - getCustomSfactorRGB
```
public RenderState.BlendFunc getCustomSfactorRGB()
```
    Returns the source factor for the RGB components in BlendMode.Custom.
    
    Returns:
    
    the custom source factor for RGB components.
  - getCustomDfactorRGB
```
public RenderState.BlendFunc getCustomDfactorRGB()
```
    Returns the destination factor for the RGB components in BlendMode.Custom.
    
    Returns:
    
    the custom destination factor for RGB components.
  - getCustomSfactorAlpha
```
public RenderState.BlendFunc getCustomSfactorAlpha()
```
    Returns the source factor for the alpha component in BlendMode.Custom.
    
    Returns:
    
    the custom destination factor for alpha component.
  - getCustomDfactorAlpha
```
public RenderState.BlendFunc getCustomDfactorAlpha()
```
    Returns the destination factor for the alpha component in BlendMode.Custom.
    
    Returns:
    
    the custom destination factor for alpha component.
  - isPointSprite
```
@Deprecated
public boolean isPointSprite()
```
    Deprecated. Always returns true since point sprite is always enabled.
    
    Returns:
    
    true
  - isAlphaTest
```
@Deprecated
public boolean isAlphaTest()
```
    Deprecated. To use alpha test, set the AlphaDiscardThreshold material parameter.
    
    Returns:
    
    false
  - getFaceCullMode
```
public RenderState.FaceCullMode getFaceCullMode()
```
    Retrieve the face cull mode.
    
    Returns:
    
    the face cull mode.
    
    See Also:
    
    setFaceCullMode(com.jme3.material.RenderState.FaceCullMode)
  - isDepthTest
```
public boolean isDepthTest()
```
    Check if depth test is enabled.
    
    Returns:
    
    True if depth test is enabled.
    
    See Also:
    
    setDepthTest(boolean)
  - isDepthWrite
```
public boolean isDepthWrite()
```
    Check if depth write is enabled.
    
    Returns:
    
    True if depth write is enabled.
    
    See Also:
    
    setDepthWrite(boolean)
  - isWireframe
```
public boolean isWireframe()
```
    Check if wireframe mode is enabled.
    
    Returns:
    
    True if wireframe mode is enabled.
    
    See Also:
    
    setWireframe(boolean)
  - isColorWrite
```
public boolean isColorWrite()
```
    Check if color writing is enabled.
    
    Returns:
    
    True if color writing is enabled.
    
    See Also:
    
    setColorWrite(boolean)
  - getPolyOffsetFactor
```
public float getPolyOffsetFactor()
```
    Retrieve the poly offset factor value.
    
    Returns:
    
    the poly offset factor value.
    
    See Also:
    
    setPolyOffset(float, float)
  - getPolyOffsetUnits
```
public float getPolyOffsetUnits()
```
    Retrieve the poly offset units value.
    
    Returns:
    
    the poly offset units value.
    
    See Also:
    
    setPolyOffset(float, float)
  - isPolyOffset
```
public boolean isPolyOffset()
```
    Check if polygon offset is enabled.
    
    Returns:
    
    True if polygon offset is enabled.
    
    See Also:
    
    setPolyOffset(float, float)
  - getAlphaFallOff
```
@Deprecated
public float getAlphaFallOff()
```
    Deprecated.
    
    Returns:
    
    0
  - getDepthFunc
```
public RenderState.TestFunction getDepthFunc()
```
    Retrieve the depth comparison function
    
    Returns:
    
    the depth comparison function
    
    See Also:
    
    setDepthFunc(com.jme3.material.RenderState.TestFunction)
  - getAlphaFunc
```
@Deprecated
public RenderState.TestFunction getAlphaFunc()
```
    Deprecated.
    
    Returns:
    
    RenderState.TestFunction.Greater.
  - getLineWidth
```
public float getLineWidth()
```
    returns the wireframe line width
    
    Returns:
    
    the line width
  - isApplyBlendMode
```
public boolean isApplyBlendMode()
```
  - isApplyColorWrite
```
public boolean isApplyColorWrite()
```
  - isApplyCullMode
```
public boolean isApplyCullMode()
```
  - isApplyDepthTest
```
public boolean isApplyDepthTest()
```
  - isApplyDepthWrite
```
public boolean isApplyDepthWrite()
```
  - isApplyPolyOffset
```
public boolean isApplyPolyOffset()
```
  - isApplyWireFrame
```
public boolean isApplyWireFrame()
```
  - isApplyDepthFunc
```
public boolean isApplyDepthFunc()
```
  - isApplyLineWidth
```
public boolean isApplyLineWidth()
```
  - contentHashCode
```
public int contentHashCode()
```
    Returns:
    
    value for use in hashing
  - copyMergedTo
```
public RenderState copyMergedTo(RenderState additionalState,
                                RenderState state)
```
    Merges this state and additionalState into the parameter state based on a specific criteria.
    The criteria for this merge is the following:
    For every given property, such as alpha test or depth write, check if it was modified from the original in the additionalState if it was modified, then copy the property from the additionalState into the parameter state, otherwise, copy the property from this into the parameter state. If additionalState is null, then no modifications are made and this is returned, otherwise, the parameter state is returned with the result of the merge.
    
    Parameters:
    
    additionalState - The additionalState, from which data is taken only if it was modified by the user.
    
    state - Contains output of the method if additionalState is not null.
    
    Returns:
    
    state if additionalState is non-null, otherwise returns this
  - set
```
public void set(RenderState state)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class RenderState

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT

NULL

ADDITIONAL

Constructor Detail

RenderState

Method Detail

write

read

clone

equals

setColorWrite

setFaceCullMode

setBlendMode

setBlendEquation

setBlendEquationAlpha

setCustomBlendFactors

setDepthTest

setDepthWrite

setWireframe

setPolyOffset

setStencil

setDepthFunc

setLineWidth

isStencilTest

getFrontStencilStencilFailOperation

getFrontStencilDepthFailOperation

getFrontStencilDepthPassOperation

getBackStencilStencilFailOperation

getBackStencilDepthFailOperation

getBackStencilDepthPassOperation

getFrontStencilFunction

getBackStencilFunction

setFrontStencilMask

setBackStencilMask

setFrontStencilReference

setBackStencilReference

getFrontStencilMask

getFrontStencilReference

getBackStencilMask

getBackStencilReference

getBlendEquation

getBlendEquationAlpha

getBlendMode

getCustomSfactorRGB

getCustomDfactorRGB

getCustomSfactorAlpha

getCustomDfactorAlpha

isPointSprite

isAlphaTest

getFaceCullMode

isDepthTest

isDepthWrite

isWireframe

isColorWrite

getPolyOffsetFactor

getPolyOffsetUnits

isPolyOffset

getAlphaFallOff

getDepthFunc

getAlphaFunc

getLineWidth

isApplyBlendMode

isApplyColorWrite

isApplyCullMode

isApplyDepthTest

isApplyDepthWrite

isApplyPolyOffset

isApplyWireFrame

isApplyDepthFunc

isApplyLineWidth

contentHashCode

copyMergedTo

set