Drag[en]gine Script Module DragonScript Script API  1.0
EffectFilterKernel Class Reference

Effect filter kernel. More...

Inheritance diagram for EffectFilterKernel:
Effect

Public Member Functions

Constructors
EffectFilterKernel new ()
 Create effect filter kernel. More...
 
Management
void setKernelSize (int rows, int cols)
 Set filter kernel size. More...
 
void setKernelValue (int row, int col, float value)
 Set filter kernel value. More...
 
float getScale ()
 Scale of kernel. More...
 
void setScale (float scale)
 Set scale of kernel. More...
 
bool equals (Object other)
 Effect is equal to another object. More...
 
int hashCode ()
 Hash code for use as dictionary keys. More...
 
- Public Member Functions inherited from Effect
bool getEnabled ()
 Effect is enabled. More...
 
void setEnabled (bool enabled)
 Set if effect is enabled. More...
 
bool equals (Object other)
 Effect is equal to another object. More...
 
int hashCode ()
 Hash code for use as dictionary keys. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Effect
Effect new ()
 Create effect. More...
 

Detailed Description

Effect filter kernel.

This is a native class.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ equals()

bool equals ( Object  other)

Effect is equal to another object.

Implements Object.equals(Object).

Returns
true if other is of type EffectFilterKernel and effect are equal.

§ getScale()

float getScale ( )

Scale of kernel.

§ hashCode()

int hashCode ( )

Hash code for use as dictionary keys.

Implements Object.hashCode().

§ new()

Create effect filter kernel.

§ setKernelSize()

void setKernelSize ( int  rows,
int  cols 
)

Set filter kernel size.

Exceptions
EInvalidParamrows is less than 1.
EInvalidParamcols is less than 1.

§ setKernelValue()

void setKernelValue ( int  row,
int  col,
float  value 
)

Set filter kernel value.

Exceptions
EOutOfBoundaryrow is less than 0 or larger than or equal to kernel row count.
EOutOfBoundarycol is less than 0 or larger than or equal to kernel colon count.

§ setScale()

void setScale ( float  scale)

Set scale of kernel.


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