Dragengine.Scenery.EffectOverlayImage Class Reference

Effect overlay image. More...

Inheritance diagram for Dragengine.Scenery.EffectOverlayImage:

Public Member Functions
Constructors
EffectOverlayImage	new ()
	Create effect overlay image.
Management
void	setImage (Image image)
	Set overlay image or null if not set.
void	setTransparency (float transparency)
	Set overlay transparency clamped to the range from 0 to 1.
bool	equals (Object other)
	Effect is equal to another object.
int	hashCode ()
	Hash code for use as dictionary keys.
Public Member Functions inherited from Dragengine.Scenery.Effect
bool	getEnabled ()
	Effect is enabled.
void	setEnabled (bool enabled)
	Set if effect is enabled.

Additional Inherited Members

Constructors

Detailed Description

Effect overlay image.

This is a native class.

Member Function Documentation

equals()

bool Dragengine.Scenery.EffectOverlayImage.equals

(

Object

other

)

Effect is equal to another object.

Implements Object.equals(Object).

Returns

true if other is of type EffectOverlayImage and effect are equal.

Reimplemented from Dragengine.Scenery.Effect.

hashCode()

int Dragengine.Scenery.EffectOverlayImage.hashCode

(

)

Hash code for use as dictionary keys.

Implements Object.hashCode().

Reimplemented from Dragengine.Scenery.Effect.

new()

EffectOverlayImage Dragengine.Scenery.EffectOverlayImage.new

(

)

Create effect overlay image.

Reimplemented from Dragengine.Scenery.Effect.

setImage()

void Dragengine.Scenery.EffectOverlayImage.setImage

(

Image

image

)

Set overlay image or null if not set.

setTransparency()

void Dragengine.Scenery.EffectOverlayImage.setTransparency

(

float

transparency

)

Set overlay transparency clamped to the range from 0 to 1.

---

The documentation for this class was generated from the following file:

• EffectOverlayImage.ds