LEADTOOLS Filters Help > Filters, Codecs and Interfaces > Video Filters > EFX Fire Filter > ILMVFire Interface |
Data types:
This filter has no specific data types, but includes the following enumerations for use with its programming interface:
DIRECTION
enum DIRECTION
{
DIR_NORTH = 1,
DIR_SOUTH = 2,
DIR_EAST = 4,
DIR_WEST = 8,
DIR_NORTHEAST = 16,
DIR_NORTHWEST = 32,
DIR_SOUTHEAST = 64,
DIR_SOUTHWEST = 128,
DIR_GLOW = 256
};
REFERENCE_FRAME
enum REFERENCE_FRAME
{
REF_USEBUFFER,
REF_USENEXTFRAME,
REF_USECOLOR,
};
Type |
Name |
Description |
VARIANT_BOOL |
Enabled |
Enables or disables the effect. If set to VARIANT_FALSE, the filter will pass the video samples intact. |
DIRECTION |
Direction |
Value that indicates the direction of the flames. Values may be combined using OR. |
long |
Decay |
Controls the spread and height of the flames. A lower decay value will result in a greater spread of fire and higher flames. Range: 1 to 100. |
long |
ColorsOffset |
Changes the colors used in generating the fire flames to another set of colors. Range: 0 to 1000. |
long |
GradientLevel |
A percentage value that controls the colors graduation. For example 0 will result in a very small number of colors used to draw the flame. Higher values result in more colors used to draw the flames' gradient color. Range: 0 to 100. |
VARIANT_BOOL |
Fire |
Enables or disables covering the entire object with flames. If this is VARIANT_TRUE, the entire object will be covered in flames and the Burn property will be turned off automatically (false). |
VARIANT_BOOL |
Burn |
Enables or disables having only parts of the object on fire. If this is VARIANT_TRUE, only parts of the object will be covered in flames the Fire property will be turned off automatically (false). |
VARIANT_BOOL |
ShowBackground |
Enables or disables showing the background of a moving object. If this is VARIANT_TRUE, the background of the moving object will be displayed. Otherwise, a black background is displayed. |
VARIANT_BOOL |
FirstFrameIsReference |
Enables or disables setting the first frame in every play session as the reference frame. If this is VARIANT_TRUE, the first frame in every play session will be set as the reference frame (Usually the first frame in a movie). If this property is VARIANT_FALSE, then the reference frame should be set manually after a number of frames. Setting this property after the stream starts will have no effect. |
long |
Threshold |
Value used to control an object's detection level. A lower threshold provides stronger object detection. Range : 1 to 100. |
VARIANT_BOOL |
NoReferenceFrame |
Flag that controls the reference frame. If this property is VARIANT_TRUE, the reference frame is assumed to be a black buffer. If it is VARIANT_FALSE, the reference frame will be the frame set by the user through the SetReferenceFrame method or by setting the FirstFrameAsReference property. |
Parameters
pBuffer |
buffer contains the reference frame. This buffer should have the same dimensions (width and height), and the same bits per pixel as the movie. |
|
lRGBColor |
pixel color (RGB 24-bit). The reference frame will be set as a solid frame with the color specified in this parameter. |
|
opt |
flag that controls the reference frame. Possible values are: |
|
|
Value |
Meaning |
|
REF_USEBUFFER |
only the pBuffer member is used. |
|
REF_USENEXTFRAME |
the next frame in the movie is taken as the reference frame. |
|
REF_USECOLOR |
the lRGBColor parameter is used. |
Description
Sets the reference frame of the movie.
Return
S_OK if connected, S_FALSE otherwise.