NveEffectInstance Class Reference

Effect instance. More...

Inheritance diagram for NveEffectInstance:

Public Member Functions
	constructor ()
	The constructor of NveEffectInstance.
	release ()
	Release the instance of effect You must call release() if you won't use this effect instance object anymore, otherwise there will be severe internal resources leak!
	setIntVal (fxParam, val)
	Set the integer parameter value of the effect. More...
	getIntVal (fxParam)
	Get the integer parameter value of the effect. More...
	setFloatVal (fxParam, val)
	Set the float parameter value of the effect. More...
	getFloatVal (fxParam)
	Get the float parameter value of the effect. More...
	setBooleanVal (fxParam, val)
	Set the boolean parameter value of the effect. More...
	getBooleanVal (fxParam)
	Get the boolean parameter value of the effect. More...
	setMenuVal (fxParam, val)
	Set the menu parameter value of the effect. More...
	getMenuVal (fxParam)
	Get the menu parameter value of the effect. More...
	setStringVal (fxParam, val)
	Set the string parameter value of the effect. More...
	getStringVal (fxParam)
	Get the string parameter value of the effect. More...
	setColorVal (fxParam, val)
	Set the color parameter value of the effect. More...
	getColorVal (fxParam)
	Get the color parameter value of the effect. More...
	setFilterIntensity (intensity)
	Set the intensity of the filter. More...
	getFilterIntensity ()
	Get the intensity of the filter. More...
	getARSceneManipulate ()
	Get the manipulate of ARScene. More...
	getInPoint ()
	Get in-point of effect. More...
	getOutPoint ()
	Get out point of effect. More...
	changeInPoint (newInPoint)
	Changes in-point of effect. More...
	changeOutPoint (newOutPoint)
	Changes out-point of effect. More...

Detailed Description

Effect instance.

Member Function Documentation

changeInPoint()

NveEffectInstance::changeInPoint (   newInPoint )

inline

Changes in-point of effect.

Parameters

{Number}

newInPoint The new in-point of effect (in microseconds)

Returns

{Number} The new in-point of effect (in microseconds).

changeOutPoint()

NveEffectInstance::changeOutPoint (   newOutPoint )

inline

Changes out-point of effect.

Parameters

{Number}

newOutPoint The new out-point of effect (in microseconds)

Returns

{Number} The new out-point of effect (in microseconds).

getARSceneManipulate()

NveEffectInstance::getARSceneManipulate ( )

inline

Get the manipulate of ARScene.

Returns

{NveARSceneManipulate} Return the manipulate of ARScene.

getBooleanVal()

NveEffectInstance::getBooleanVal (   fxParam )

inline

Get the boolean parameter value of the effect.

Parameters

{String}

fxParam The name of the parameter of the effect.

Returns

{Boolean} Boolean value

getColorVal()

NveEffectInstance::getColorVal (   fxParam )

inline

Get the color parameter value of the effect.

Parameters

{String}

fxParam The name of the parameter of the effect.

Returns

{NveColor} Color value

getFilterIntensity()

NveEffectInstance::getFilterIntensity ( )

inline

Get the intensity of the filter.

Returns

{Number} The intensity value of the filter.

getFloatVal()

NveEffectInstance::getFloatVal (   fxParam )

inline

Get the float parameter value of the effect.

Parameters

{String}

fxParam The name of the parameter of the effect.

Returns

{Number} Float value

getInPoint()

NveEffectInstance::getInPoint ( )

inline

Get in-point of effect.

Returns

{Number} In-point of effect (in microseconds)

getIntVal()

NveEffectInstance::getIntVal (   fxParam )

inline

Get the integer parameter value of the effect.

Parameters

{String}

fxParam The name of the parameter of the effect.

Returns

{Number} Integer value

getMenuVal()

NveEffectInstance::getMenuVal (   fxParam )

inline

Get the menu parameter value of the effect.

Parameters

{String}

fxParam The name of the parameter of the effect.

Returns

{String} Menu value

getOutPoint()

NveEffectInstance::getOutPoint ( )

inline

Get out point of effect.

Returns

{Number} Out point of effect (in microseconds)

getStringVal()

NveEffectInstance::getStringVal (   fxParam )

inline

Get the string parameter value of the effect.

Parameters

{String}

fxParam The name of the parameter of the effect.

Returns

{String} String value

setBooleanVal()

NveEffectInstance::setBooleanVal (   fxParam,   val  )

inline

Set the boolean parameter value of the effect.

Parameters

{String}	fxParam The name of the parameter of the effect.
{Boolean}	val Boolean value

setColorVal()

NveEffectInstance::setColorVal (   fxParam,   val  )

inline

Set the color parameter value of the effect.

Parameters

{String}	fxParam The name of the parameter of the effect.
{NveColor}	val Color value

setFilterIntensity()

NveEffectInstance::setFilterIntensity (   intensity )

inline

Set the intensity of the filter.

Parameters

{Number}

intensity The filter intensity value, the value range is generally [0,1]. 0 means no effect, while 1 indicates the default effect.

setFloatVal()

NveEffectInstance::setFloatVal (   fxParam,   val  )

inline

Set the float parameter value of the effect.

Parameters

{String}	fxParam The name of the parameter of the effect.
{Number}	val Float value

setIntVal()

NveEffectInstance::setIntVal (   fxParam,   val  )

inline

Set the integer parameter value of the effect.

Parameters

{String}	fxParam The name of the parameter of the effect.
{Number}	val Integer value

setMenuVal()

NveEffectInstance::setMenuVal (   fxParam,   val  )

inline

Set the menu parameter value of the effect.

Parameters

{String}	fxParam The name of the parameter of the effect.
{String}	val Menu value

setStringVal()

NveEffectInstance::setStringVal (   fxParam,   val  )

inline

Set the string parameter value of the effect.

Parameters

{String}	fxParam The name of the parameter of the effect.
{String}	val String value

---

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

• src/js/NvEffectSdk.js