% -*- latex -*-


\setDate{August 24, 2010}
% The following must all be on one line for latex2man to work.
\begin{Name}{3}{icetImageIsNull}{Kenneth Moreland}{\IceT Reference}{\CFunc{icetImageIsNull} -- check for a null image}

  \mansection{Synopsis}

  \textC{\#include <IceT.h>}

  \begin{Table}{3}
    \textC{IceTBoolean}\textC{ }\CFunc{icetImageIsNull}\textC{(}&\CType{IceTImage}&\CArg{image}\quad\textC{);}
  \end{Table}

  
  \mansection{Description}

  Tests whether \CArg{image} is a \index{image!null}null image.  A null
  image is one that has no memory allocated to it.  Null images have no
  pixels and empty pixel formats.

  Null images are created with the \CFunc{icetImageNull} function.


  \mansection{Return Value}

  Returns \CEnum{ICET\_TRUE} if \CArg{image} is a null image,
  \CEnum{ICET\_FALSE} otherwise.


  \mansection{Errors}

  None.


  \mansection{Warnings}

  None.


  \mansection{Bugs}

  None known.


  \mansection{Copyright}
  Copyright \copyright 2010 Sandia Corporation

  @copyright@

  \mansection{See Also}

  \CFuncSeeAlso{icetImageNull}

\end{Name}


% These are emacs settings that go at the end of the file.
% Local Variables:
% writestamp-format: "%B %e, %Y"
% writestamp-prefix: "^\\\\setDate{"
% writestamp-suffix: "}$"
% End:
