Name

cgD3D9TranslateCGerror - convert a Cg runtime error into a string

Synopsis

#include <Cg/cgD3D9.h>

const char * cgD3D9TranslateCGerror( CGerror error );

Parameters

error

The error code to translate. Can be a core runtime error or a D3D runtime error.

Return Values

Returns a pointer to a string describing error.

Description

cgD3D9TranslateCGerror converts a Cg runtime error into a string. This routine should be called instead of the core runtime routine cgGetErrorString because it will also translate errors that the Cg D3D runtime generates.

This routine will typically be called in debugging situations such as inside an error callback set using cgSetErrorCallback.

Examples

char buf[512];
CGerror error = cgGetLastError();
if (error != CG_NO_ERROR)
{
    sprintf(buf, "An error occurred. Error description: '%s'\n",
            cgD3D9TranslateCGerror(error));
    OutputDebugString(buf);
}

Errors

None.

History

cgD3D9TranslateCGerror was introduced in Cg 1.1.

See Also

cgGetErrorString, cgSetErrorCallback