structth__img__plane.tex 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. \section{th\_\-img\_\-plane Struct Reference}
  2. \label{structth__img__plane}\index{th\_\-img\_\-plane@{th\_\-img\_\-plane}}
  3. A buffer for a single color plane in an uncompressed image.
  4. {\ttfamily \#include $<$codec.h$>$}\subsection*{Data Fields}
  5. \begin{DoxyCompactItemize}
  6. \item
  7. int {\bf width}
  8. \begin{DoxyCompactList}\small\item\em The width of this plane. \item\end{DoxyCompactList}\item
  9. int {\bf height}
  10. \begin{DoxyCompactList}\small\item\em The height of this plane. \item\end{DoxyCompactList}\item
  11. int {\bf stride}
  12. \begin{DoxyCompactList}\small\item\em The offset in bytes between successive rows. \item\end{DoxyCompactList}\item
  13. unsigned char $\ast$ {\bf data}
  14. \begin{DoxyCompactList}\small\item\em A pointer to the beginning of the first row. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
  15. \subsection{Detailed Description}
  16. A buffer for a single color plane in an uncompressed image. This contains the image data in a left-\/to-\/right, top-\/down format. Each row of pixels is stored contiguously in memory, but successive rows need not be. Use {\itshape stride\/} to compute the offset of the next row. The encoder accepts both positive {\itshape stride\/} values (top-\/down in memory) and negative (bottom-\/up in memory). The decoder currently always generates images with positive strides.
  17. \subsection{Field Documentation}
  18. \index{th\_\-img\_\-plane@{th\_\-img\_\-plane}!data@{data}}
  19. \index{data@{data}!th_img_plane@{th\_\-img\_\-plane}}
  20. \subsubsection[{data}]{\setlength{\rightskip}{0pt plus 5cm}unsigned char$\ast$ {\bf th\_\-img\_\-plane::data}}\label{structth__img__plane_af8133681516ce88b5a201c1b4b7e6ba2}
  21. A pointer to the beginning of the first row. \index{th\_\-img\_\-plane@{th\_\-img\_\-plane}!height@{height}}
  22. \index{height@{height}!th_img_plane@{th\_\-img\_\-plane}}
  23. \subsubsection[{height}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf th\_\-img\_\-plane::height}}\label{structth__img__plane_a21aea1367894468de489d529d7eaf44d}
  24. The height of this plane. \index{th\_\-img\_\-plane@{th\_\-img\_\-plane}!stride@{stride}}
  25. \index{stride@{stride}!th_img_plane@{th\_\-img\_\-plane}}
  26. \subsubsection[{stride}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf th\_\-img\_\-plane::stride}}\label{structth__img__plane_ab1100f071ffee3b37e07e3222f819bad}
  27. The offset in bytes between successive rows. \index{th\_\-img\_\-plane@{th\_\-img\_\-plane}!width@{width}}
  28. \index{width@{width}!th_img_plane@{th\_\-img\_\-plane}}
  29. \subsubsection[{width}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf th\_\-img\_\-plane::width}}\label{structth__img__plane_a58cc297a99cd4594c3d30e56f2ed6b74}
  30. The width of this plane.
  31. The documentation for this struct was generated from the following file:\begin{DoxyCompactItemize}
  32. \item
  33. {\bf codec.h}\end{DoxyCompactItemize}