NAME

cgD3D9ValidateVertexDeclaration - validate a custom D3D9 vertex declaration stream

SYNOPSIS

  #include <Cg/cgD3D9.h>

  CGbool cgD3D9ValidateVertexDeclaration( CGprogram program,
                                          const D3DVERTEXELEMENT9 * decl );

PARAMETERS

program

Indicates the program to test for compatibility.

decl

The D3D9 custom vertex declaration stream to test for compatibility. It must be terminated by D3DDECL_END().

RETURN VALUES

cgD3D9ValidateVertexDeclaration returns CG_TRUE if the vertex stream is compatible and CG_FALSE otherwise.

DESCRIPTION

cgD3D9ValidateVertexDeclaration tests a custom D3D9 vertex declaration stream for compatibility with the inputs expected by a program.

For a vertex stream to be compatible with a program's expected inputs it must have a D3DVERTEXELEMENT9 element for each varying input parameter that the program uses.

EXAMPLES

The following example code illustrates the use of cgD3D9ValidateVertexDeclaration:

  // example code to-be-written

ERRORS

cgD3D9ValidateVertexDeclaration does not generate any errors.

    or

to-be-written

HISTORY

cgD3D9ValidateVertexDeclaration was introduced in Cg to-be-written.

SEE ALSO

cgD3D9ResourceToDeclUsage