com.jme3.renderer.queue

Enum RenderQueue.Bucket

java.lang.Object

java.lang.Enum<RenderQueue.Bucket>

com.jme3.renderer.queue.RenderQueue.Bucket

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RenderQueue.Bucket>

Enclosing class:

RenderQueue

public static enum RenderQueue.Bucket
extends java.lang.Enum<RenderQueue.Bucket>

The render queue Bucket specifies the bucket to which the spatial will be placed when rendered.

The behavior of the rendering will differ depending on which bucket the spatial is placed. A spatial's queue bucket can be set via Spatial.setQueueBucket(com.jme3.renderer.queue.RenderQueue.Bucket).

Enum Constant Summary

Enum Constants

Enum Constant and Description
Gui This is a special mode, for drawing 2D object without perspective (such as GUI or HUD parts).
Inherit A special mode, that will ensure that this spatial uses the same mode as the parent Node does.
Opaque The renderer will try to find the optimal order for rendering all objects using this mode.
Sky A special mode used for rendering really far away, flat objects - e.g.
Translucent A special mode used for rendering transparent objects that should not be affected by SceneProcessor.
Transparent This is the mode you should use for object with transparency in them.

Method Summary

Modifier and Type	Method and Description
static RenderQueue.Bucket	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RenderQueue.Bucket[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Opaque

public static final RenderQueue.Bucket Opaque

The renderer will try to find the optimal order for rendering all objects using this mode. You should use this mode for most normal objects, except transparent ones, as it could give a nice performance boost to your application.

Transparent

public static final RenderQueue.Bucket Transparent

This is the mode you should use for object with transparency in them. It will ensure the objects furthest away are rendered first. That ensures when another transparent object is drawn on top of previously drawn objects, you can see those (and the object drawn using Opaque) through the transparent parts of the newly drawn object.

Sky

public static final RenderQueue.Bucket Sky

A special mode used for rendering really far away, flat objects - e.g. skies. In this mode, the depth is set to infinity so spatials in this bucket will appear behind everything, the downside to this bucket is that 3D objects will not be rendered correctly due to lack of depth testing.

Translucent

public static final RenderQueue.Bucket Translucent

A special mode used for rendering transparent objects that should not be affected by SceneProcessor. Generally this would contain translucent objects, and also objects that do not write to the depth buffer such as particle emitters.

Gui

public static final RenderQueue.Bucket Gui

This is a special mode, for drawing 2D object without perspective (such as GUI or HUD parts). The spatial's world coordinate system has the range of [0, 0, -1] to [Width, Height, 1] where Width/Height is the resolution of the screen rendered to. Any spatials outside of that range are culled.

Inherit

public static final RenderQueue.Bucket Inherit

A special mode, that will ensure that this spatial uses the same mode as the parent Node does.

Method Detail

values

public static RenderQueue.Bucket[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RenderQueue.Bucket c : RenderQueue.Bucket.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RenderQueue.Bucket valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null