Dragengine.Scenery.EffectFilterKernel Class Reference
Inheritance diagram for Dragengine.Scenery.EffectFilterKernel:
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 Dragengine.Scenery.Effect | |
| bool | getEnabled () |
| Effect is enabled. More... | |
| void | setEnabled (bool enabled) |
| Set if effect is enabled. More... | |
Additional Inherited Members | |
Constructors |
Detailed Description
Effect filter kernel.
This is a native class.
Member Function Documentation
◆ equals()
| bool Dragengine.Scenery.EffectFilterKernel.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.
Reimplemented from Dragengine.Scenery.Effect.
◆ getScale()
| float Dragengine.Scenery.EffectFilterKernel.getScale | ( | ) |
Scale of kernel.
◆ hashCode()
| int Dragengine.Scenery.EffectFilterKernel.hashCode | ( | ) |
Hash code for use as dictionary keys.
Implements Object.hashCode().
Reimplemented from Dragengine.Scenery.Effect.
◆ new()
| EffectFilterKernel Dragengine.Scenery.EffectFilterKernel.new | ( | ) |
Create effect filter kernel.
Reimplemented from Dragengine.Scenery.Effect.
◆ setKernelSize()
| void Dragengine.Scenery.EffectFilterKernel.setKernelSize | ( | int | rows, |
| int | cols | ||
| ) |
Set filter kernel size.
- Exceptions
-
EInvalidParam rows is less than 1. EInvalidParam cols is less than 1.
◆ setKernelValue()
| void Dragengine.Scenery.EffectFilterKernel.setKernelValue | ( | int | row, |
| int | col, | ||
| float | value | ||
| ) |
Set filter kernel value.
- Exceptions
-
EOutOfBoundary row is less than 0 or larger than or equal to kernel row count. EOutOfBoundary col is less than 0 or larger than or equal to kernel colon count.
◆ setScale()
| void Dragengine.Scenery.EffectFilterKernel.setScale | ( | float | scale | ) |
Set scale of kernel.
The documentation for this class was generated from the following file:
