com.jme3.material

Enum TechniqueDef.LightMode

java.lang.Object

java.lang.Enum<TechniqueDef.LightMode>

com.jme3.material.TechniqueDef.LightMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TechniqueDef.LightMode>

Enclosing class:

TechniqueDef

public static enum TechniqueDef.LightMode
extends java.lang.Enum<TechniqueDef.LightMode>

Describes light rendering mode.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Disable Disable light-based rendering
FixedPipeline Deprecated. OpenGL1 is not supported anymore
MultiPass Enable light rendering by using multi-pass rendering.
SinglePass Enable light rendering by using a single pass.
SinglePassAndImageBased Enable light rendering by using a single pass, and also uses Image based lighting for global lighting Usually used for PBR
StaticPass Similar to SinglePass except the type of each light is known at shader compile time.

Method Summary

Modifier and Type	Method and Description
static TechniqueDef.LightMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TechniqueDef.LightMode[]	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

Disable

public static final TechniqueDef.LightMode Disable

Disable light-based rendering

SinglePass

public static final TechniqueDef.LightMode SinglePass

Enable light rendering by using a single pass.

An array of light positions and light colors is passed to the shader containing the world light list for the geometry being rendered.

MultiPass

public static final TechniqueDef.LightMode MultiPass

Enable light rendering by using multi-pass rendering.

The geometry will be rendered once for each light. Each time the light position and light color uniforms are updated to contain the values for the current light. The ambient light color uniform is only set to the ambient light color on the first pass, future passes have it set to black.

SinglePassAndImageBased

public static final TechniqueDef.LightMode SinglePassAndImageBased

Enable light rendering by using a single pass, and also uses Image based lighting for global lighting Usually used for PBR

An array of light positions and light colors is passed to the shader containing the world light list for the geometry being rendered. Light probes are also passed to the shader.

FixedPipeline

@Deprecated
public static final TechniqueDef.LightMode FixedPipeline

Deprecated. OpenGL1 is not supported anymore

StaticPass

public static final TechniqueDef.LightMode StaticPass

Similar to SinglePass except the type of each light is known at shader compile time.

The advantage is that the shader can be much more efficient, i.e. not do operations required for spot and point lights if it knows the light is a directional light. The disadvantage is that the number of shaders used balloons because of the variations in the number of lights used by objects.

Method Detail

values

public static TechniqueDef.LightMode[] 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 (TechniqueDef.LightMode c : TechniqueDef.LightMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static TechniqueDef.LightMode 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