Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 727fa15453fcace956b835e2377d4269 > files > 1216

player-doc-3.0.2-5.fc14.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   "http://www.w3.org/TR/html4/strict.dtd">

<html>
<!-- $Id: header.html 8799 2010-06-28 04:12:42Z jpgr87 $ -->

<HEAD>


<meta HTTP-EQUIV="Content-Type" CONTENT="text/html;CHARSET=utf-8">
<meta name="keywords" content="stage, robot, simulation, player, player/stage">
<link href="doxygen.css" rel="stylesheet" type="text/css">

<style type="text/css">

.floatright { float: right; margin: 0 0 1em 1em; }

body {
  font-family: sans-serif;
  #font-family: Geneva, Verdana, Helvetica, Arial, sans-serif;
  background-color: #FFF;
  color:#000;
}


a:link { 
	color: #A00;
}

a:visited { 
	color: #800;
}

a { text-decoration: none; }
a:hover { text-decoration: underline; }


.timestamp { text-align:right; background-color: #DDD; font-size:75%;}

h1 { 
  font-size:160%; 
}

h2 {
  font-size:110%;
  #color: #FFF;
  #background-color: #666;
  #padding:3px;
}

h3 { text-align:left; }

img {
  border: 0;
}

ul.menu { 
    position:relative;
    left:-2.5em;
    margin-bottom:0px;
    margin-top:0px;
}

ul.menu1 { 
    position:relative;
    left:-2.1em;
    margin-bottom:0px;
    margin-top:0px;
}

li.menu { 
    list-style-type: none;
    position:relative;
    #left:-0.5em;
}


#sidebar { position: absolute; left:0px; padding:2em; top:0em; width:12em;}

#content { position: absolute; left:12em; top:0em; padding-left:3em; padding-right:3em; padding-bottom:2em; margin-top:1em; margin-right:2em; }

div.box { background-color:#EEE; border: 1px solid #000; padding: 0.5ex 0.4em 0.5ex 0.6em; margin:1em;  }
div.title { font-weight:bold; background-color:#eee; margin-bottom:2px;}

div.topbar { position: absolute; top:0px; left:9em; margin:1em; }

</style>

<TITLE>Player Manual</TITLE>

</HEAD>

<body>

<div id="sidebar"> 

<h2 style="text-align:center;">
<a href="index.html">
<img width=140 src="http://playerstage.sourceforge.net/images/player_button_v3.png" alt="Player logo"><br></a>
</h2>



<div class="box">
<div class=title>Player</div>

<ul class=menu>
<li class=menu><a href="index.html">Frontpage</a>
<li class=menu><a href="modules.html">Contents</a>
</ul>
</div>

<div class="box">
<div class=title>User</div>

<ul class=menu>
<li class=menu><a href="install.html">Installation</a>
<li class=menu><a href="start.html">Quick start</a>
<li class=menu><a href="supported_hardware.html">Supported&nbsp;devices</a>
<li class=menu><a href="group__tutorials.html">Tutorials</a>
<li class=menu><a href="group__utils.html">Utilities</a>
<li class=menu><a href="group__clientlibs.html">Client&nbsp;libraries</a>
<li class=menu><a href="http://playerstage.sourceforge.net/wiki/Basic_FAQ">FAQ</a>
<li class=menu><a href="help.html">Help</a>

</ul>
</div>

<div class=box>
<div class="title">Developer</div>
<ul class=menu>
<li class=menu><a href="architecture.html">Architecture</a>
<li class=menu><a href="group__libplayercore.html">libplayercore</a>
<ul class=menu1>
<li class=menu><a href="group__interfaces.html">interfaces</a></li>
</ul>
<li class=menu><a href="group__libplayerdrivers.html">libplayerdrivers</a>
<ul class=menu1>
<li class=menu><a href="group__drivers.html">drivers</a></li>
</ul>
<li class=menu><a href="group__libplayercommon.html">libplayercommon</a>
<li class=menu><a href="group__libplayerutils.html">libplayerutils</a>
<li class=menu><a href="group__libplayersd.html">libplayersd</a>
<li class=menu><a href="group__libplayertcp.html">libplayertcp</a>
<li class=menu><a href="group__libplayerxdr.html">libplayerxdr</a>
<li class=menu><a href="todo.html">TODO</a>
</ul>
</div>

<div class=box>
<!-- <a href="http://sourceforge.net"><img border=0 src="http://sourceforge.net/sflogo.php?group_id=42445&type=1"></a> -->
<div class="title">Online</div>
<a href="http://playerstage.sourceforge.net">Homepage</a><br>
<a href="http://sourceforge.net/project/showfiles.php?group_id=42445">Download</a><br>
<a href="http://sourceforge.net/projects/playerstage">Project</a><br>
<a href="http://sourceforge.net/tracker/?group_id=42445">Bugs</a><br>
<a href="http://sourceforge.net/mail/?group_id=42445">Help</a>
</div>


</div>

<div id="content" >
<!-- Generated by Doxygen 1.7.1 -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Public Attributes</a>  </div>
  <div class="headertitle">
<h1>player_camera_data Struct Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="player_camera_data" -->
<p>Data: state (<a class="el" href="group__interface__camera.html#gac695a7265d5a3ddbc8e9792bd711d5a3">PLAYER_CAMERA_DATA_STATE</a>).  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="player__interfaces_8h_source.html">player_interfaces.h</a>&gt;</code></p>

<p><a href="structplayer__camera__data-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__camera__data.html#a51875beada5030d4dd159d5ae91c1dc9">width</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Image dimensions [pixels].  <a href="#a51875beada5030d4dd159d5ae91c1dc9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__camera__data.html#a6abed73d3ac124061c457e36d0a89893">height</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Image dimensions [pixels].  <a href="#a6abed73d3ac124061c457e36d0a89893"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__camera__data.html#a3457008a7dc52a4fb45e440a40ccf8e5">bpp</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Image bits-per-pixel (8, 16, 24, 32).  <a href="#a3457008a7dc52a4fb45e440a40ccf8e5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__camera__data.html#a9deba275693548883f8e75284148d375">format</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Image format (must be compatible with depth).  <a href="#a9deba275693548883f8e75284148d375"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__camera__data.html#aeba7ebb2bfc7940b505d88cfd61d52ef">fdiv</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Some images (such as disparity maps) use scaled pixel values; for these images, fdiv specifies the scale divisor (i.e., divide the integer pixel value by fdiv to recover the real pixel value).  <a href="#aeba7ebb2bfc7940b505d88cfd61d52ef"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__camera__data.html#aa5c4ff0aedc44d073477291ed4c4c1c6">compression</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Image compression; <a class="el" href="group__interface__camera.html#gab491ae8b2a6f01eb6dc2175078c72997">PLAYER_CAMERA_COMPRESS_RAW</a> indicates no compression.  <a href="#aa5c4ff0aedc44d073477291ed4c4c1c6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afe85a18e4c72244a3dedbc1634ec1c31"></a><!-- doxytag: member="player_camera_data::image_count" ref="afe85a18e4c72244a3dedbc1634ec1c31" args="" -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__camera__data.html#afe85a18e4c72244a3dedbc1634ec1c31">image_count</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Size of image data as stored in image buffer (bytes). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__camera__data.html#a8b907a957de3ccbf7bbe27ad8e37de0d">image</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compressed image data (byte-aligned, row major order).  <a href="#a8b907a957de3ccbf7bbe27ad8e37de0d"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Data: state (<a class="el" href="group__interface__camera.html#gac695a7265d5a3ddbc8e9792bd711d5a3">PLAYER_CAMERA_DATA_STATE</a>). </p>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a3457008a7dc52a4fb45e440a40ccf8e5"></a><!-- doxytag: member="player_camera_data::bpp" ref="a3457008a7dc52a4fb45e440a40ccf8e5" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t <a class="el" href="structplayer__camera__data.html#a3457008a7dc52a4fb45e440a40ccf8e5">player_camera_data::bpp</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Image bits-per-pixel (8, 16, 24, 32). </p>

<p>Referenced by <a class="el" href="classCameraUvc.html#aa36dfa343b6711548bcc0a09565c4bb6">CameraUvc::Main()</a>, and <a class="el" href="classImageBase.html#ae5a2a84cbe890dd5b257b2c7bb43d250">ImageBase::ProcessMessage()</a>.</p>

</div>
</div>
<a class="anchor" id="aa5c4ff0aedc44d073477291ed4c4c1c6"></a><!-- doxytag: member="player_camera_data::compression" ref="aa5c4ff0aedc44d073477291ed4c4c1c6" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t <a class="el" href="structplayer__camera__data.html#aa5c4ff0aedc44d073477291ed4c4c1c6">player_camera_data::compression</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Image compression; <a class="el" href="group__interface__camera.html#gab491ae8b2a6f01eb6dc2175078c72997">PLAYER_CAMERA_COMPRESS_RAW</a> indicates no compression. </p>

<p>Referenced by <a class="el" href="classCameraUvc.html#aa36dfa343b6711548bcc0a09565c4bb6">CameraUvc::Main()</a>, and <a class="el" href="classImageBase.html#ae5a2a84cbe890dd5b257b2c7bb43d250">ImageBase::ProcessMessage()</a>.</p>

</div>
</div>
<a class="anchor" id="aeba7ebb2bfc7940b505d88cfd61d52ef"></a><!-- doxytag: member="player_camera_data::fdiv" ref="aeba7ebb2bfc7940b505d88cfd61d52ef" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t <a class="el" href="structplayer__camera__data.html#aeba7ebb2bfc7940b505d88cfd61d52ef">player_camera_data::fdiv</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Some images (such as disparity maps) use scaled pixel values; for these images, fdiv specifies the scale divisor (i.e., divide the integer pixel value by fdiv to recover the real pixel value). </p>

<p>Referenced by <a class="el" href="classCameraUvc.html#aa36dfa343b6711548bcc0a09565c4bb6">CameraUvc::Main()</a>, and <a class="el" href="classImageBase.html#ae5a2a84cbe890dd5b257b2c7bb43d250">ImageBase::ProcessMessage()</a>.</p>

</div>
</div>
<a class="anchor" id="a9deba275693548883f8e75284148d375"></a><!-- doxytag: member="player_camera_data::format" ref="a9deba275693548883f8e75284148d375" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t <a class="el" href="structplayer__camera__data.html#a9deba275693548883f8e75284148d375">player_camera_data::format</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Image format (must be compatible with depth). </p>

<p>Referenced by <a class="el" href="classCameraUvc.html#aa36dfa343b6711548bcc0a09565c4bb6">CameraUvc::Main()</a>, <a class="el" href="classSphereDriver.html#a16a4d91e9b4e78cb2f3ef5466c929fe1">SphereDriver::MainSetup()</a>, and <a class="el" href="classImageBase.html#ae5a2a84cbe890dd5b257b2c7bb43d250">ImageBase::ProcessMessage()</a>.</p>

</div>
</div>
<a class="anchor" id="a6abed73d3ac124061c457e36d0a89893"></a><!-- doxytag: member="player_camera_data::height" ref="a6abed73d3ac124061c457e36d0a89893" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t <a class="el" href="structplayer__camera__data.html#a6abed73d3ac124061c457e36d0a89893">player_camera_data::height</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Image dimensions [pixels]. </p>

<p>Referenced by <a class="el" href="classCameraUvc.html#aa36dfa343b6711548bcc0a09565c4bb6">CameraUvc::Main()</a>, and <a class="el" href="classImageBase.html#ae5a2a84cbe890dd5b257b2c7bb43d250">ImageBase::ProcessMessage()</a>.</p>

</div>
</div>
<a class="anchor" id="a8b907a957de3ccbf7bbe27ad8e37de0d"></a><!-- doxytag: member="player_camera_data::image" ref="a8b907a957de3ccbf7bbe27ad8e37de0d" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t* <a class="el" href="structplayer__camera__data.html#a8b907a957de3ccbf7bbe27ad8e37de0d">player_camera_data::image</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Compressed image data (byte-aligned, row major order). </p>
<p>Multi-byte image formats (such as MONO16) must be converted to network byte ordering. </p>

<p>Referenced by <a class="el" href="classCameraUvc.html#aa36dfa343b6711548bcc0a09565c4bb6">CameraUvc::Main()</a>, and <a class="el" href="classImageBase.html#ae5a2a84cbe890dd5b257b2c7bb43d250">ImageBase::ProcessMessage()</a>.</p>

</div>
</div>
<a class="anchor" id="a51875beada5030d4dd159d5ae91c1dc9"></a><!-- doxytag: member="player_camera_data::width" ref="a51875beada5030d4dd159d5ae91c1dc9" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t <a class="el" href="structplayer__camera__data.html#a51875beada5030d4dd159d5ae91c1dc9">player_camera_data::width</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Image dimensions [pixels]. </p>

<p>Referenced by <a class="el" href="classCameraUvc.html#aa36dfa343b6711548bcc0a09565c4bb6">CameraUvc::Main()</a>, and <a class="el" href="classImageBase.html#ae5a2a84cbe890dd5b257b2c7bb43d250">ImageBase::ProcessMessage()</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="player__interfaces_8h_source.html">player_interfaces.h</a></li>
</ul>
</div>
<!-- render the modification time of the source file -->


<div class="timestamp">
<hr>

<table style="width:100%;">
<tr>
<td style="text-align:left;">
Last updated 12 September 2005 21:38:45
<!--
<td style="text-align:right;">
<a href="http://validator.w3.org/check/referer"><img style="vertical-align:middle;border:0;width:88px;height:31px"
          src="http://www.w3.org/Icons/valid-html401"
          alt="Valid HTML 4.01!"></a>

 <a href="http://jigsaw.w3.org/css-validator/">
  <img style="vertical-align:middle;border:0;width:88px;height:31px"
       src="http://jigsaw.w3.org/css-validator/images/vcss"
       alt="Valid CSS!">
 </a>
-->
</tr>
</table>
</div>


</tr>
</table>

</BODY>
</HTML>