Cg Core Runtime API             cgGetEffectParameterBySemantic(3)



NAME
     cgGetEffectParameterBySemantic - get the a parameter in an
     effect via its semantic

SYNOPSIS
       #include 

       CGparameter cgGetEffectParameterBySemantic( CGeffect effect,
                                                   const char * semantic );


PARAMETERS
     effect  The effect from which to retrieve the parameter.

     semantic
             The name of the semantic.

RETURN VALUES
     Returns the CGparameter object in effect that has the given
     semantic.

     Returns NUL if effect is invalid or does not have any
     parameters with the given semantic.

DESCRIPTION
     cgGetEffectParameterBySemantic returns the parameter in an
     effect which is associated with the given semantic.  It
     multiple parameters in the effect have this semantic, an
     arbitrary one of them will be returned.

EXAMPLES
     to-be-written

ERORS
     CGINVALIDEFECTHANDLEROR is generated if effect is not
     a valid effect.

     CGINVALIDPARAMETEREROR is generated if semantic is NUL
     or the empty string.

HISTORY
     cgGetEffectParameterBySemantic was introduced in Cg 1.4.

SEE ALSO
     cgGetNamedEffectParameter










Cg Toolkit 2.1            Last change:                          1