BlendTexture (org.dayflower.pathtracer API)

java.lang.Object
- org.dayflower.pathtracer.scene.texture.BlendTexture

All Implemented Interfaces:

Texture
```
public final class BlendTexture
extends java.lang.Object
implements Texture
```
A BlendTexture is a Texture implementation that blends two other Textures together.
There is one restriction with this BlendTexture class. None of the Textures to blend can be BlendTextures themselves. The renderer cannot currently handle multiple layers of blending. This restriction might be fixed in the future.

Since:

1.0.0

Author:

Jörgen Lundgren

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`RELATIVE_OFFSET_FACTOR` The relative offset of the Factor parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_TEXTURE_A_OFFSET` The relative offset of the Texture A Offset parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_TEXTURE_B_OFFSET` The relative offset of the Texture B Offset parameter in the `float` array.
`static int`	`SIZE` The size of a `BlendTexture` in the `float` array.
`static int`	`TYPE` The type number associated with a `BlendTexture`.

Fields inherited from interface org.dayflower.pathtracer.scene.Texture
RELATIVE_OFFSET_SIZE, RELATIVE_OFFSET_TYPE

Constructor Summary

Constructors
Constructor and Description
`BlendTexture(Texture textureA, Texture textureB)` Constructs a new `BlendTexture` instance.
`BlendTexture(Texture textureA, Texture textureB, float factor)` Constructs a new `BlendTexture` instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object object)` Compares `object` to this `BlendTexture` instance for equality.
`float`	`getFactor()` Returns the blend factor.
`int`	`getSize()` Returns the size of this `BlendTexture` instance.
`Texture`	`getTextureA()` Returns the `Texture` denoted by `A`.
`Texture`	`getTextureB()` Returns the `Texture` denoted by `B`.
`int`	`getType()` Returns the type of this `BlendTexture` instance.
`int`	`hashCode()` Returns a hash code for this `BlendTexture` instance.
`boolean`	`isEmissive()` Returns `true` if, and only if, this `BlendTexture` instance is emissive, `false` otherwise.
`float[]`	`toArray()` Returns a `float` array representation of this `BlendTexture` instance.
`java.lang.String`	`toString()` Returns a `String` representation of this `BlendTexture` instance.

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

- Field Detail
  - RELATIVE_OFFSET_TEXTURE_A_OFFSET
```
public static final int RELATIVE_OFFSET_TEXTURE_A_OFFSET
```
    The relative offset of the Texture A Offset parameter in the float array. The value is 2.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_TEXTURE_B_OFFSET
```
public static final int RELATIVE_OFFSET_TEXTURE_B_OFFSET
```
    The relative offset of the Texture B Offset parameter in the float array. The value is 3.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_FACTOR
```
public static final int RELATIVE_OFFSET_FACTOR
```
    The relative offset of the Factor parameter in the float array. The value is 4.
    
    See Also:
    
    Constant Field Values
  - SIZE
```
public static final int SIZE
```
    The size of a BlendTexture in the float array. The size is 5.
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final int TYPE
```
    The type number associated with a BlendTexture. The number is 1.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BlendTexture
```
public BlendTexture(Texture textureA,
                    Texture textureB)
```
    Constructs a new BlendTexture instance.
    Calling this constructor is equivalent to calling new BlendTexture(textureA, textureB, 0.5F).
    If either textureA or textureB are null, a NullPointerException will be thrown.
    If either textureA or textureB are BlendTextures, an IllegalArgumentException will be thrown.
    
    Parameters:
    
    textureA - a Texture
    
    textureB - a Texture
    
    Throws:
    
    java.lang.IllegalArgumentException - thrown if, and only if, either textureA or textureB are BlendTextures
    
    java.lang.NullPointerException - thrown if, and only if, either textureA or textureB are null
  - BlendTexture
```
public BlendTexture(Texture textureA,
                    Texture textureB,
                    float factor)
```
    Constructs a new BlendTexture instance.
    If either textureA or textureB are null, a NullPointerException will be thrown.
    If either textureA or textureB are BlendTextures, an IllegalArgumentException will be thrown.
    
    Parameters:
    
    textureA - a Texture
    
    textureB - a Texture
    
    factor - the blend factor
    
    Throws:
    
    java.lang.IllegalArgumentException - thrown if, and only if, either textureA or textureB are BlendTextures
    
    java.lang.NullPointerException - thrown if, and only if, either textureA or textureB are null
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this BlendTexture instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a String representation of this BlendTexture instance
  - getTextureA
```
public Texture getTextureA()
```
    Returns the Texture denoted by A.
    
    Returns:
    
    the Texture denoted by A
  - getTextureB
```
public Texture getTextureB()
```
    Returns the Texture denoted by B.
    
    Returns:
    
    the Texture denoted by B
  - equals
```
public boolean equals(java.lang.Object object)
```
    Compares object to this BlendTexture instance for equality.
    Returns true if, and only if, object is an instance of BlendTexture, and their respective values are equal, false otherwise.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    object - the Object to compare to this BlendTexture instance for equality
    
    Returns:
    
    true if, and only if, object is an instance of BlendTexture, and their respective values are equal, false otherwise
  - isEmissive
```
public boolean isEmissive()
```
    Returns true if, and only if, this BlendTexture instance is emissive, false otherwise.
    
    Specified by:
    
    isEmissive in interface Texture
    
    Returns:
    
    true if, and only if, this BlendTexture instance is emissive, false otherwise
  - getFactor
```
public float getFactor()
```
    Returns the blend factor.
    
    Returns:
    
    the blend factor
  - toArray
```
public float[] toArray()
```
    Returns a float array representation of this BlendTexture instance.
    
    Specified by:
    
    toArray in interface Texture
    
    Returns:
    
    a float array representation of this BlendTexture instance
  - getSize
```
public int getSize()
```
    Returns the size of this BlendTexture instance.
    
    Specified by:
    
    getSize in interface Texture
    
    Returns:
    
    the size of this BlendTexture instance
  - getType
```
public int getType()
```
    Returns the type of this BlendTexture instance.
    
    Specified by:
    
    getType in interface Texture
    
    Returns:
    
    the type of this BlendTexture instance
  - hashCode
```
public int hashCode()
```
    Returns a hash code for this BlendTexture instance.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    a hash code for this BlendTexture instance

Class BlendTexture

Field Summary

Fields inherited from interface org.dayflower.pathtracer.scene.Texture

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RELATIVE_OFFSET_TEXTURE_A_OFFSET

RELATIVE_OFFSET_TEXTURE_B_OFFSET

RELATIVE_OFFSET_FACTOR

SIZE

TYPE

Constructor Detail

BlendTexture

BlendTexture

Method Detail

toString

getTextureA

getTextureB

equals

isEmissive

getFactor

toArray

getSize

getType

hashCode