Cg Toolkit Cg 3.1 Toolkit Documentation
Cg / Runtime / Cg / cgSetParameter

Name

cgSetParameter - sets the value of scalar and vector parameters

Synopsis

#include <Cg/cg.h>

/* TYPE is int, float or double */

void cgSetParameter1{ifd}( CGparameter param,
                           TYPE x );

void cgSetParameter2{ifd}( CGparameter param,
                           TYPE x,
                           TYPE y );

void cgSetParameter3{ifd}( CGparameter param,
                           TYPE x,
                           TYPE y,
                           TYPE z );

void cgSetParameter4{ifd}( CGparameter param,
                           TYPE x,
                           TYPE y,
                           TYPE z,
                           TYPE w );

void cgSetParameter{1234}{ifd}v( CGparameter param,
                                 const TYPE * v );

Parameters

param
The parameter that will be set.
x, y, z, and w
The values to which to set the parameter.
v
The values to set the parameter to for the array versions of the set functions.

Return Values

None.

Description

The cgSetParameter functions set the value of a given scalar or vector parameter. The functions are available in various combinations.

Each function takes either 1, 2, 3, or 4 values depending on the function that is used. If more values are passed in than the parameter requires, the extra values will be ignored.

There are versions of each function that take int, float or double values signified by the i, f or d in the function name.

The functions with the v at the end of their names take an array of values instead of explicit parameters.

Once cgSetParameter has been used to set a parameter, the values may be retrieved from the parameter using the CG_CURRENT enumerant with cgGetParameterValues.

If an API-dependant layer of the Cg runtime (e.g. cgGL) is used, these entry points may end up making API (e.g. OpenGL) calls.

Note: Previous releases of Cg allowed you to store more values in a parameter than indicated by the parameter's type. For example, one could use cgGLSetParameter4f to store four values into a parameter of type CG_FLOAT (not CG_FLOAT4). All four values could later be retrieved using a get call which requested more than one value. However, this feature conflicts with the GLSL approach and also leads to issues with parameters mapped into BUFFERS. Therefore, beginning with Cg 2.0 any components beyond the number indicated by the parameter type are ignored.

Examples

to-be-written

Errors

CG_INVALID_PARAM_HANDLE_ERROR is generated if param is not a valid parameter.

CG_INVALID_PARAMETER_ERROR is generated if param is a varying input to a fragment program.

History

The d and f versions of cgSetParameter were introduced in Cg 1.2.

The i versions of cgSetParameter were introduced in Cg 1.4.

See Also

cgGetParameterValue


Cg Toolkit | Cg Toolkit | Download | Release Archive | Profiles | Reference | Books | Discussions |


Cg Runtime Cg

cgAddStateEnumerant
cgCallStateResetCallback
cgCallStateSetCallback
cgCallStateValidateCallback
cgCombinePrograms2
cgCombinePrograms3
cgCombinePrograms4
cgCombinePrograms5
cgCombinePrograms
cgCompileProgram
cgConnectParameter
cgCopyEffect
cgCopyProgram
cgCreateArraySamplerState
cgCreateArrayState
cgCreateBuffer
cgCreateContext
cgCreateEffectAnnotation
cgCreateEffectFromFile
cgCreateEffectParameterArray
cgCreateEffectParameterMultiDimArray
cgCreateEffectParameter
cgCreateEffect
cgCreateObjFromFile
cgCreateObj
cgCreateParameterAnnotation
cgCreateParameterArray
cgCreateParameterMultiDimArray
cgCreateParameter
cgCreatePassAnnotation
cgCreatePass
cgCreateProgramAnnotation
cgCreateProgramFromEffect
cgCreateProgramFromFile
cgCreateProgram
cgCreateSamplerStateAssignment
cgCreateSamplerState
cgCreateStateAssignmentIndex
cgCreateStateAssignment
cgCreateState
cgCreateTechniqueAnnotation
cgCreateTechnique
cgDestroyBuffer
cgDestroyContext
cgDestroyEffect
cgDestroyObj
cgDestroyParameter
cgDestroyProgram
cgDisconnectParameter
cgEvaluateProgram
cgGetAnnotationName
cgGetAnnotationType
cgGetArrayDimension
cgGetArrayParameter
cgGetArraySize
cgGetArrayTotalSize
cgGetArrayType
cgGetAutoCompile
cgGetBehavior
cgGetBehaviorString
cgGetBoolAnnotationValues
cgGetBooleanAnnotationValues
cgGetBoolStateAssignmentValues
cgGetBufferSize
cgGetCompilerIncludeCallback
cgGetConnectedParameter
cgGetConnectedStateAssignmentParameter
cgGetConnectedToParameter
cgGetContextBehavior
cgGetDependentAnnotationParameter
cgGetDependentProgramArrayStateAssignmentParameter
cgGetDependentStateAssignmentParameter
cgGetDomain
cgGetDomainString
cgGetEffectContext
cgGetEffectName
cgGetEffectParameterBuffer
cgGetEffectParameterBySemantic
cgGetEnum
cgGetEnumString
cgGetErrorCallback
cgGetErrorHandler
cgGetError
cgGetErrorString
cgGetFirstDependentParameter
cgGetFirstEffectAnnotation
cgGetFirstEffectParameter
cgGetFirstEffect
cgGetFirstError
cgGetFirstLeafEffectParameter
cgGetFirstLeafParameter
cgGetFirstParameterAnnotation
cgGetFirstParameter
cgGetFirstPassAnnotation
cgGetFirstPass
cgGetFirstProgramAnnotation
cgGetFirstProgram
cgGetFirstSamplerStateAssignment
cgGetFirstSamplerState
cgGetFirstStateAssignment
cgGetFirstState
cgGetFirstStructParameter
cgGetFirstTechniqueAnnotation
cgGetFirstTechnique
cgGetFirstUniformBufferParameter
cgGetFloatAnnotationValues
cgGetFloatStateAssignmentValues
cgGetIntAnnotationValues
cgGetIntStateAssignmentValues
cgGetLastErrorString
cgGetLastListing
cgGetLockingPolicy
cgGetMatrixParameterdc
cgGetMatrixParameterdr
cgGetMatrixParameterfc
cgGetMatrixParameterfr
cgGetMatrixParameteric
cgGetMatrixParameterir
cgGetMatrixParameterOrder
cgGetMatrixParameter
cgGetMatrixSize
cgGetNamedEffectAnnotation
cgGetNamedEffectParameter
cgGetNamedEffect
cgGetNamedEffectUniformBuffer
cgGetNamedParameterAnnotation
cgGetNamedParameter
cgGetNamedPassAnnotation
cgGetNamedPass
cgGetNamedProgramAnnotation
cgGetNamedProgramParameter
cgGetNamedProgramUniformBuffer
cgGetNamedSamplerStateAssignment
cgGetNamedSamplerState
cgGetNamedStateAssignment
cgGetNamedState
cgGetNamedStructParameter
cgGetNamedSubParameter
cgGetNamedTechniqueAnnotation
cgGetNamedTechnique
cgGetNamedUniformBufferParameter
cgGetNamedUserType
cgGetNextAnnotation
cgGetNextEffect
cgGetNextLeafParameter
cgGetNextParameter
cgGetNextPass
cgGetNextProgram
cgGetNextStateAssignment
cgGetNextState
cgGetNextTechnique
cgGetNumConnectedToParameters
cgGetNumDependentAnnotationParameters
cgGetNumDependentProgramArrayStateAssignmentParameters
cgGetNumDependentStateAssignmentParameters
cgGetNumParentTypes
cgGetNumProgramDomains
cgGetNumStateEnumerants
cgGetNumSupportedProfiles
cgGetNumUserTypes
cgGetParameterBaseResource
cgGetParameterBaseType
cgGetParameterBufferIndex
cgGetParameterBufferOffset
cgGetParameterClassEnum
cgGetParameterClass
cgGetParameterClassString
cgGetParameterColumns
cgGetParameterContext
cgGetParameterDefaultValuedc
cgGetParameterDefaultValuedr
cgGetParameterDefaultValuefc
cgGetParameterDefaultValuefr
cgGetParameterDefaultValueic
cgGetParameterDefaultValueir
cgGetParameterDefaultValue
cgGetParameterDirection
cgGetParameterEffect
cgGetParameterIndex
cgGetParameterNamedType
cgGetParameterName
cgGetParameterOrdinalNumber
cgGetParameterProgram
cgGetParameterResourceIndex
cgGetParameterResourceName
cgGetParameterResource
cgGetParameterResourceSize
cgGetParameterResourceType
cgGetParameterRows
cgGetParameterSemantic
cgGetParameterSettingMode
cgGetParameterType
cgGetParameterValuedc
cgGetParameterValuedr
cgGetParameterValuefc
cgGetParameterValuefr
cgGetParameterValueic
cgGetParameterValueir
cgGetParameterValue
cgGetParameterValues
cgGetParameterVariability
cgGetParentType
cgGetPassName
cgGetPassProgram
cgGetPassTechnique
cgGetProfileDomain
cgGetProfile
cgGetProfileProperty
cgGetProfileSibling
cgGetProfileString
cgGetProgramBufferMaxIndex
cgGetProgramBufferMaxSize
cgGetProgramBuffer
cgGetProgramContext
cgGetProgramDomain
cgGetProgramDomainProfile
cgGetProgramDomainProgram
cgGetProgramInput
cgGetProgramOptions
cgGetProgramOutput
cgGetProgramOutputVertices
cgGetProgramProfile
cgGetProgramStateAssignmentValue
cgGetProgramString
cgGetResource
cgGetResourceString
cgGetSamplerStateAssignmentParameter
cgGetSamplerStateAssignmentState
cgGetSamplerStateAssignmentValue
cgGetSemanticCasePolicy
cgGetStateAssignmentIndex
cgGetStateAssignmentPass
cgGetStateAssignmentState
cgGetStateContext
cgGetStateEnumerantName
cgGetStateEnumerant
cgGetStateEnumerantValue
cgGetStateLatestProfile
cgGetStateName
cgGetStateResetCallback
cgGetStateSetCallback
cgGetStateType
cgGetStateValidateCallback
cgGetStringAnnotationValue
cgGetStringAnnotationValues
cgGetStringParameterValue
cgGetString
cgGetStringStateAssignmentValue
cgGetSupportedProfile
cgGetTechniqueEffect
cgGetTechniqueName
cgGetTextureStateAssignmentValue
cgGetTypeBase
cgGetTypeClass
cgGetType
cgGetTypeSizes
cgGetTypeString
cgGetUniformBufferBlockName
cgGetUniformBufferParameter
cgGetUserType
cgIsAnnotation
cgIsBuffer
cgIsContext
cgIsEffect
cgIsInterfaceType
cgIsParameterGlobal
cgIsParameter
cgIsParameterReferenced
cgIsParameterUsed
cgIsParentType
cgIsPass
cgIsProfileSupported
cgIsProgramCompiled
cgIsProgram
cgIsStateAssignment
cgIsState
cgIsTechnique
cgIsTechniqueValidated
cgMapBuffer
cgResetPassState
cgSetArraySize
cgSetAutoCompile
cgSetBoolAnnotation
cgSetBoolArrayStateAssignment
cgSetBoolStateAssignment
cgSetBufferData
cgSetBufferSubData
cgSetCompilerIncludeCallback
cgSetCompilerIncludeFile
cgSetCompilerIncludeString
cgSetContextBehavior
cgSetEffectName
cgSetEffectParameterBuffer
cgSetErrorCallback
cgSetErrorHandler
cgSetFloatAnnotation
cgSetFloatArrayStateAssignment
cgSetFloatStateAssignment
cgSetIntAnnotation
cgSetIntArrayStateAssignment
cgSetIntStateAssignment
cgSetLastListing
cgSetLockingPolicy
cgSetMatrixParameterdc
cgSetMatrixParameterdr
cgSetMatrixParameterfc
cgSetMatrixParameterfr
cgSetMatrixParameteric
cgSetMatrixParameterir
cgSetMatrixParameter
cgSetMultiDimArraySize
cgSetParameter1d
cgSetParameter1dv
cgSetParameter1f
cgSetParameter1fv
cgSetParameter1i
cgSetParameter1iv
cgSetParameter2d
cgSetParameter2dv
cgSetParameter2f
cgSetParameter2fv
cgSetParameter2i
cgSetParameter2iv
cgSetParameter3d
cgSetParameter3dv
cgSetParameter3f
cgSetParameter3fv
cgSetParameter3i
cgSetParameter3iv
cgSetParameter4d
cgSetParameter4dv
cgSetParameter4f
cgSetParameter4fv
cgSetParameter4i
cgSetParameter4iv
cgSetParameter
cgSetParameterSemantic
cgSetParameterSettingMode
cgSetParameterValuedc
cgSetParameterValuedr
cgSetParameterValuefc
cgSetParameterValuefr
cgSetParameterValueic
cgSetParameterValueir
cgSetParameterValue
cgSetParameterVariability
cgSetPassProgramParameters
cgSetPassState
cgSetProgramBuffer
cgSetProgramOutputVertices
cgSetProgramProfile
cgSetProgramStateAssignment
cgSetSamplerStateAssignment
cgSetSamplerState
cgSetSemanticCasePolicy
cgSetStateCallbacks
cgSetStateLatestProfile
cgSetStringAnnotation
cgSetStringParameterValue
cgSetStringStateAssignment
cgSetTextureStateAssignment
cgSetUniformBufferParameter
cgUnmapBuffer
cgUpdatePassParameters
cgUpdateProgramParameters
cgValidateTechnique