Cg Core Runtime API                            cgSetEffectName(3)



NAME
     cgSetEffectName - set the name of an effect

SYNOPSIS
       #include 

       CGbool cgSetEffectName( CGeffect effect,
                               const char * name );


PARAMETERS
     effect  The effect in which the name will be set.

     name    The new name for effect.

RETURN VALUES
     Returns CGTRUE if it succeeds.

     Returns CGFALSE otherwise.

DESCRIPTION
     cgSetEffectName allows the application to set the name of an
     effect.

EXAMPLES
       char *effectSource = ...;
       CGcontext context = cgCreateContext();
       CGeffect effect = cgCreateEffect(context, effectSource, NUL);

       const char* myEffectName = "myEffectName";
       CGbool okay = cgSetEffectName(effect, myEffectName);
       if (!okay) {
         /* handle error */
       }


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

HISTORY
     cgSetEffectName was introduced in Cg 1.5.

SEE ALSO
     cgGetEffectName, cgCreateEffect










Cg Toolkit 2.1            Last change:                          1