cgGLGetLatestProfile

Langue: en

Version: 46832 (openSuse - 09/10/07)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

cgGLGetLatestProfile - get the latest profile for a profile class

SYNOPSIS


  #include <Cg/cgGL.h>







  CGprofile cgGLGetLatestProfile( CGGLenum profileClass );

PARAMETERS


profileClass
The class of profile that will be returned. Must be one of the following :

* CG_GL_VERTEX

* CG_GL_FRAGMENT

RETURN VALUES

Returns a profile enumerant for the latest profile of the given class.

Returns CG_PROFILE_UNKNOWN if no appropriate profile is available or an error occurs.

DESCRIPTION

cgGLGetLatestProfile returns the best available profile of a given class. The OpenGL extensions are checked to determine the best profile which is supported by the current GPU, driver, and cgGL library combination.

profileClass may be one of the following enumerants :

* CG_GL_VERTEX
The latest available vertex profile will be returned.
* CG_GL_FRAGMENT
The latest available fragment profile will be returned.

cgGLGetLatestProfile can be used in conjuction with cgCreateProgram to ensure that more optimal profiles are used as they are made available, even though they might not have been available at compile time or with a different version of the runtime.

EXAMPLES

to-be-written

ERRORS

CG_INVALID_ENUMERANT_ERROR is generated if profileClass is not CG_GL_VERTEX or CG_GL_FRAGMENT.

HISTORY

cgGLGetLatestProfile was introduced in Cg 1.1.

SEE ALSO

cgGLSetOptimalOptions, cgCreateProgram