In This Topic ▼

ILMVFire Interface

Data Types

This filter has no specific data types, but includes the following enumerations for use with its programming interface:

DIRECTION

Summary

Specifies the direction of the flames.

Syntax

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 
};

Members

DIR_NORTH

Flames to the North.

DIR_SOUTH

Flames to the South.

DIR_EAST

Flames to the East.

DIR_WEST

Flames to the West.

DIR_NORTHEAST

Flames to the North-East.

DIR_NORTHWEST

Flames to the North-West.

DIR_SOUTHEAST

Flames to the South-East.

DIR_SOUTHWEST

Flames to the South-West.

DIR_GLOW

Flames all around the object, giving a glowing effect.

Values may be combined using OR.

REFERENCE_FRAME

Summary

Specifies the reference frame.

Syntax

enum REFERENCE_FRAME 
{ 
   REF_USEBUFFER, 
   REF_USENEXTFRAME, 
   REF_USECOLOR, 
};

Members

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.

Properties

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.
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. Possible values are:
		• VARIANT_TRUE - the background of the moving object will be displayed.
		• VARIANT_FALSE - a black background is displayed.
VARIANT_BOOL	FirstFrameIsReference	Enables or disables setting the first frame in every play session as the reference frame. Possible values are:
		• VARIANT_TRUE - the first frame in every play session will be set as the reference frame (Usually the first frame in a movie).
		• VARIANT_FALSE - 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. Possible values are:
		• VARIANT_TRUE - the reference frame is assumed to be a black buffer.
		• VARIANT_FALSE - the reference frame will be the frame set by the user through the SetReferenceFrame method or by setting the FirstFrameAsReference property.