APIdia Launch Partner
Top Description Fields Constructors Methods
com.badlogic.gdx.graphics.g3d.attributes

public Class PointLightsAttribute

extends Attribute
Class Inheritance
Imports
com.badlogic.gdx.graphics.g3d.Attribute, .Shader, com.badlogic.gdx.graphics.g3d.environment.PointLight, com.badlogic.gdx.utils.Array
An Attribute which can be used to send an Array of PointLight instances to the Shader. The lights are stored by reference, the copy() or PointLightsAttribute(PointLightsAttribute) method will not create new lights.
Author
Xoppa

Field Summary

Modifier and TypeField and Description
public static final String
Alias

public final Array<PointLight>
lights

public static final long
Type

Inherited from com.badlogic.gdx.graphics.g3d.Attribute:
type

Constructor Summary

AccessConstructor and Description
public
PointLightsAttribute()

public
PointLightsAttribute(final PointLightsAttribute copyFrom)

Method Summary

Modifier and TypeMethod and Description
public int
compareTo(Attribute o)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.

public PointLightsAttribute
copy()

Implements abstract com.badlogic.gdx.graphics.g3d.Attribute.copy.

public int
hashCode()

Overrides com.badlogic.gdx.graphics.g3d.Attribute.hashCode.

Returns a hash code value for this object.

public static final boolean
is(final long mask)

Inherited from com.badlogic.gdx.graphics.g3d.Attribute:
equalsequalsgetAttributeAliasgetAttributeTyperegistertoString

Field Detail

Aliasback to summary
public static final String Alias
lightsback to summary
public final Array<PointLight> lights
Typeback to summary
public static final long Type

Constructor Detail

PointLightsAttributeback to summary
public PointLightsAttribute()
PointLightsAttributeback to summary
public PointLightsAttribute(final PointLightsAttribute copyFrom)

Method Detail

compareToback to summary
public int compareTo(Attribute o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Annotations
@Override
copyback to summary
public PointLightsAttribute copy()

Implements abstract com.badlogic.gdx.graphics.g3d.Attribute.copy.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides com.badlogic.gdx.graphics.g3d.Attribute.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Annotations
@Override
isback to summary
public static final boolean is(final long mask)