Name

cgGLSetParameter3f - set the values of a scalar or vector parameter

Synopsis

#include <Cg/cgGL.h>

void cgGLSetParameter3f( CGparameter param,
                         float x,
                         float y,
                         float z );

Parameters

param

The parameter that will be set.

x, y, z

The values to which param will be set.

Return Values

None.

Description

cgGLSetParameter3f sets the value of a scalar or vector parameter.

If more values are passed in than the parameter requires, the extra values will be ignored.

cgGLSetParameter3f may be called with uniform or varying parameters. When called with a varying parameter, the appropriate immediate mode OpenGL entry point will be called. However, the cgGLGetParameter functions only work with uniform parameters.

Examples

float x, y, z;

// assign appropriate values to x, y, & z, then...

cgGLSetParameter3f(param, x, y, z);

Errors

CG_INVALID_PROFILE_ERROR is generated if param's profile is not a supported OpenGL profile.

CG_INVALID_PARAM_HANDLE_ERROR is generated if param is not a valid parameter.

CG_INVALID_PARAMETER_ERROR is generated if the parameter fails to set for any other reason.

History

cgGLSetParameter3f was introduced in Cg 1.1.

See Also

cgGLGetParameter, cgGLSetParameterArray, cgGLSetMatrixParameter, cgGLSetMatrixParameterArray, cgGLSetTextureParameter, cgGLBindProgram