Java Doc for RenderingAttributes.java in  » 6.0-JDK-Modules » java-3d » javax » media » j3d » Java Source Code / Java DocumentationJava Source Code and Java Documentation

• Depth test function - used to compare the incoming (source) depth of each pixel with depth of the pixel stored in frame buffer. If the test passes, the pixel is written, otherwise the pixel is not written. The depth test function is set with the setDepthTestFunction method. By default, LESS_OR_EQUAL is the function used. The depth test function is one of the following:
• ALWAYS - pixels are always drawn, irrespective of the depth value. This effectively disables depth testing.
• NEVER - pixels are never drawn, irrespective of the depth value.
• EQUAL - pixels are drawn if the incoming pixel depth is equal to the stored pixel depth in the frame buffer.
• NOT_EQUAL - pixels are drawn if the incoming pixel depth is not equal to the stored pixel depth in the frame buffer.
• LESS - pixels are drawn if the incoming pixel depth is less than the stored pixel depth in the frame buffer.
• LESS_OR_EQUAL - pixels are drawn if the incoming pixel depth is less than or equal to the stored pixel depth in the frame buffer. This is the default setting.
• GREATER - pixels are drawn if the incoming pixel depth is greater than the stored pixel depth in the frame buffer.
• GREATER_OR_EQUAL - pixels are drawn if the incoming pixel depth is greater than or equal to the stored pixel depth in the frame buffer.

• Alpha test function - used to compare the incoming (source) alpha value of each pixel with the alpha test value. If the test passes, the pixel is written, otherwise the pixel is not written. The alpha test function is set with the setAlphaTestFunction method. The alpha test function is one of the following:
• ALWAYS - pixels are always drawn, irrespective of the alpha value. This effectively disables alpha testing. This is the default setting.
• NEVER - pixels are never drawn, irrespective of the alpha value.
• EQUAL - pixels are drawn if the incoming pixel alpha value is equal to the alpha test value.
• NOT_EQUAL - pixels are drawn if the incoming pixel alpha value is not equal to the alpha test value.
• LESS - pixels are drawn if the incoming pixel alpha value is less than the alpha test value.
• LESS_OR_EQUAL - pixels are drawn if the incoming pixel alpha value is less than or equal to the alpha test value.
• GREATER - pixels are drawn if the incoming pixel alpha value is greater than the alpha test value.
• GREATER_OR_EQUAL - pixels are drawn if the incoming pixel alpha value is greater than or equal to the alpha test value.

• Alpha test value - the test value used by the alpha test function. This value is compared to the alpha value of each rendered pixel. The alpha test value is set with the setAlphaTestValue method. The default alpha test value is 0.0.
• Raster operation - the raster operation function for this RenderingAttributes component object. The raster operation is set with the setRasterOp method. The raster operation is enabled or disabled with the setRasterOpEnable method. The raster operation is one of the following:
• ROP_CLEAR - DST = 0.
• ROP_AND DST = SRC & DST.
• ROP_AND_REVERSE DST = SRC & ~DST.
• ROP_COPY - DST = SRC. This is the default operation.
• ROP_AND_INVERTED - DST = ~SRC & DST.
• ROP_NOOP - DST = DST.
• ROP_XOR - DST = SRC ^ DST.
• ROP_OR - DST = DST | SRC.
• ROP_NOR - DST = ~( DST | SRC .)
• ROP_EQUIV - DST = ~( DST ^ SRC .)
• ROP_INVERT - DST = ~DST.
• ROP_OR_REVERSE - DST = src | ~DST.
• ROP_COPY_INVERTED - DST = ~SRC.
• ROP_OR_INVERTED - DST = ~SRC | DST.
• ROP_NAND - DST = ~(SRC & DST.)
• ROP_SET - DST = 1.

• Vertex colors - vertex colors can be ignored for this RenderingAttributes object. This capability is set with the setIgnoreVertexColors method. If ignoreVertexColors is false, per-vertex colors are used, when present in the associated geometry objects, taking precedence over the ColoringAttributes color and the specified Material color(s). If ignoreVertexColors is true, per-vertex colors are ignored. In this case, if lighting is enabled, the Material diffuse color will be used as the object color. if lighting is disabled, the ColoringAttributes color is used. The default value is false.
• Visibility flag - when set, invisible objects are not rendered (subject to the visibility policy for the current view), but they can be picked or collided with. This flag is set with the setVisible method. By default, the visibility flag is true.
• Depth buffer - can be enabled or disabled for this RenderingAttributes component object. The setDepthBufferEnable method enables or disabled the depth buffer. The setDepthBufferWriteEnable method enables or disables writing the depth buffer for this object. During the transparent rendering pass, this attribute can be overridden by the depthBufferFreezeTransparent attribute in the View object. Transparent objects include BLENDED transparent and antialiased lines and points. Transparent objects do not include opaque objects or primitives rendered with SCREEN_DOOR transparency. By default, the depth buffer is enabled and the depth buffer write is enabled.
• Stencil buffer - can be enabled or disabled for this RenderingAttributes component object using the setStencilEnable method. If the stencil buffer is disabled, the stencil operation and function are ignored. If a scene graph is rendered on a Canvas3D that does not have a stencil buffer, the stencil buffer will be implicitly disabled for that canvas.
• Stencil write mask - mask that controls which bits of the stencil buffer are written when the stencil buffer is enabled. The default value is ~0 (all ones).
• Stencil operation - a set of three stencil operations performed when: 1) the stencil test fails; 2) the stencil test passes, but the depth test fails; or 3) both the stencil test and depth test pass. The stencil operations are set with the setStencilOp method. The stencil operation is one of the following:
• STENCIL_KEEP - keeps the current value (no operation performed). This is the default setting.
• STENCIL_ZERO - Sets the stencil buffer value to 0.
• STENCIL_REPLACE - Sets the stencil buffer value to refValue, as specified by setStencilFunction.
• STENCIL_INCR - Increments the current stencil buffer value.
• STENCIL_DECR - Decrements the current stencil buffer value.
• STENCIL_INVERT - Bitwise inverts the current stencil buffer value.

• Stencil test function - used to compare the stencil reference value with the per-pixel stencil value stored in the frame buffer. If the test passes, the pixel is written, otherwise the pixel is not written. The stencil test function, reference value, and comparison mask are set with the setStencilFunction method. The stencil comparison mask is bitwise-ANDed with both the stencil reference value and the stored stencil value prior to doing the comparison. The default value for the reference value is 0. The default value for the comparison mask is ~0 (all ones). The stencil test function is one of the following:
• ALWAYS - pixels are always drawn, irrespective of the stencil value. This effectively disables stencil testing. This is the default setting.
• NEVER - pixels are never drawn, irrespective of the stencil value.
• EQUAL - pixels are drawn if the stencil reference value is equal to the stored stencil value in the frame buffer.
• NOT_EQUAL - pixels are drawn if the stencil reference value is not equal to the stored stencil value in the frame buffer.
• LESS - pixels are drawn if the stencil reference value is less than the stored stencil value in the frame buffer.
• LESS_OR_EQUAL - pixels are drawn if the stencil reference value is less than or equal to the stored stencil value in the frame buffer.
• GREATER - pixels are drawn if the stencil reference value is greater than the stored stencil value in the frame buffer.
• GREATER_OR_EQUAL - pixels are drawn if the stencil reference value is greater than or equal to the stored stencil value in the frame buffer.

Note: the alpha test, depth test, and stencil functions all use the same enums.

depth buffer enable : true
depth buffer write enable : true
alpha test function : ALWAYS
alpha test value : 0.0f
visible : true
ignore vertex colors : false
raster operation enable : false
raster operation : ROP_COPY
depth test: LESS_OR_EQUAL
stencil enable : false
stencil write mask : ~0 (all ones)
stencil op - failOp : STENCIL_KEEP
stencil op - zFailOp : STENCIL_KEEP
stencil op - zPassOp : STENCIL_KEEP
stencil function : ALWAYS
stencil reference value : 0
stencil comparison mask : ~0 (all ones)