Cg Toolkit Cg 3.1 Toolkit Documentation
Cg / Runtime / CgD3D11 / cgD3D11TranslateCGerror

Name

cgD3D11TranslateCGerror - convert a Cg runtime error into a string

Synopsis

#include <Cg/cgD3D11.h>

const char * cgD3D11TranslateCGerror( 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

cgD3D11TranslateCGerror 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",
            cgD3D11TranslateCGerror(error));
    OutputDebugString(buf);
}

Errors

None.

History

cgD3D11TranslateCGerror was introduced in Cg 3.0.

See Also

cgGetErrorString, cgSetErrorCallback


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


Cg Runtime CgD3D11

cgD3D11BindProgram
cgD3D11CreateBufferFromObject
cgD3D11CreateBuffer
cgD3D11GetBufferByIndex
cgD3D11GetBufferObject
cgD3D11GetCompiledProgram
cgD3D11GetDevice
cgD3D11GetIASignatureByPass
cgD3D11GetLastError
cgD3D11GetLatestDomainProfile
cgD3D11GetLatestGeometryProfile
cgD3D11GetLatestHullProfile
cgD3D11GetLatestPixelProfile
cgD3D11GetLatestVertexProfile
cgD3D11GetManageTextureParameters
cgD3D11GetOptimalOptions
cgD3D11GetProgramErrors
cgD3D11IsProfileSupported
cgD3D11IsProgramLoaded
cgD3D11LoadProgram
cgD3D11RegisterStates
cgD3D11SetDevice
cgD3D11SetManageTextureParameters
cgD3D11SetSamplerStateParameter
cgD3D11SetTextureParameter
cgD3D11SetTextureSamplerStateParameter
cgD3D11TranslateCGerror
cgD3D11TranslateHRESULT
cgD3D11TypeToSize
cgD3D11UnbindProgram
cgD3D11UnloadProgram