NAME

cgD3D9GetOptimalOptions - get the best set of compiler options for a profile

SYNOPSIS

  #include <Cg/cgD3D9.h>

  char const ** cgD3D9GetOptimalOptions( CGprofile profile );

PARAMETERS

profile

The profile whose optimal arguments are requested.

RETURN VALUES

cgD3D9GetOptimalOptions returns a null-terminated array of strings representing the optimal set of compiler options for the given profile. The elements of this array are meant to be used as part of the args parameter to cgCreateProgram or cgCreateProgramFromFile.

If no D3D device is currently set, the return value is NULL.

DESCRIPTION

cgD3D9GetOptimalOptions returns the best set of compiler options for a given profile. This is an expanded interface function because it needs to know about the D3D device to determine the most optimal options.

The returned string does not need to be destroyed by the application. However, the contents could change if the function is called again for the same profile but a different D3D device.

EXAMPLES

The following example code illustrates the use of cgD3D9GetOptimalOptions:

  const char* vertOptions[]  = { myCustomArgs,
                                 cgD3D9GetOptimalOptions(vertProfile),
                                 NULL };

  // create the vertex shader
  CGprogram myVS = cgCreateProgramFromFile( context,
                                            CG_SOURCE,
                                            "vshader.cg",
                                            vertProfile,
                                            "VertexShader",
                                            vertOptions);

ERRORS

cgD3D9GetOptimalOptions does not generate any errors.

    or

to-be-written

HISTORY

cgD3D9GetOptimalOptions was introduced in Cg to-be-written.

SEE ALSO

cgD3D9GetLatestVertexProfile, cgD3D9GetLatestPixelProfile, cgCreateProgram, cgCreateProgramFromFile