NAME

cgGetParameterBaseResource - get a program parameter's base resource

SYNOPSIS

  #include <Cg/cg.h>

  CGresource cgGetParameterBaseResource( CGparameter param );

PARAMETERS

param

Specifies the program parameter.

DESCRIPTION

cgGetParameterBaseResource allows the application to retrieve the base resource for a parameter in a Cg program. The base resource is the first resource in a set of sequential resources. For example, if a given parameter has a resource of CG_ATTR7, it's base resource would be CG_ATTR0. Only parameters with resources whose name ends with a number will have a base resource. All other parameters will return the undefined resource CG_UNDEFINED when calling cgGetParameterBaseResource.

The numerical portion of the resource may be retrieved with the cgGetParameterResourceIndex function. For example, if the resource for a given parameter is CG_ATTR7, cgGetParameterResourceIndex will return 7.

RETURN VALUES

Returns the base resource of param. If no base resource exists for the given parameter, CG_UNDEFINED is returned.

ERRORS

CG_INVALID_PARAM_HANDLE_ERROR is generated if the handle param is invalid.

CG_INVALID_PARAMETER_ERROR is generated if the parameter is not a leaf node.

SEE ALSO

the "cgGetParameterResource" document, the "cgGetParameterResourceIndex" document, and the "cgGetResourceString" document