native_client_sdk/doc_generated/pepper_beta/c/struct_p_p___input_event___wheel.html

{{+bindTo:partials.standard_nacl_api}}
<h1>PP_InputEvent_Wheel Struct Reference</h1>
<div id="doxygen-ref">
{{- dummy div to appease doxygen -}}
  <div>
<!-- Generated by Doxygen 1.7.6.1 -->


</div>
<!--header-->
<div class="contents">
<!-- doxytag: class="PP_InputEvent_Wheel" --><h2>
Data Fields</h2><table class="memberdecls">

<tr><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p___input_event___wheel.html#ad4af418584f964e9191e78be05bbb3f7">modifier</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p___input_event___wheel.html#aed0a1a8148ecfb7efe2443c412b8904d">delta_x</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p___input_event___wheel.html#a51339c7b39cce3073f98f8a7f048f69d">delta_y</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p___input_event___wheel.html#a0ebc9809d9333e68b63ad7dc7c421775">wheel_ticks_x</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p___input_event___wheel.html#af39e6e81fc7166e745e3fdb4b4d3ff4e">wheel_ticks_y</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p___input_event___wheel.html#ad51a5319a1eb82706371d495e397e909">scroll_by_page</a></td></tr>
</table>
<hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The <code><a class="el" href="struct_p_p___input_event___wheel.html" title="The PP_InputEvent_Wheel struct represents all mouse wheel events.">PP_InputEvent_Wheel</a></code> struct represents all mouse wheel events. </p>
</div><hr /><h2>Field Documentation</h2>
<a class="anchor" id="aed0a1a8148ecfb7efe2443c412b8904d"></a><!-- doxytag: member="PP_InputEvent_Wheel::delta_x" ref="aed0a1a8148ecfb7efe2443c412b8904d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="struct_p_p___input_event___wheel.html#aed0a1a8148ecfb7efe2443c412b8904d">PP_InputEvent_Wheel::delta_x</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The mouse wheel's horizontal scroll amount. </p>
<p>A scroll to the right (where the content moves left) is represented as positive values, and a scroll to the left (where the content moves right) is represented as negative values.</p>
<p>The units are either in pixels (when scroll_by_page is false) or pages (when scroll_by_page is true). For example, delta_y = -3 means scroll up 3 pixels when scroll_by_page is false, and scroll up 3 pages when scroll_by_page is true.</p>
<p>This amount is system dependent and will take into account the user's preferred scroll sensitivity and potentially also nonlinear acceleration based on the speed of the scrolling.</p>
<p>Devices will be of varying resolution. Some mice with large detents will only generate integer scroll amounts. But fractional values are also possible, for example, on some trackpads and newer mice that don't have "clicks". </p>
</div>
</div>
<a class="anchor" id="a51339c7b39cce3073f98f8a7f048f69d"></a><!-- doxytag: member="PP_InputEvent_Wheel::delta_y" ref="a51339c7b39cce3073f98f8a7f048f69d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="struct_p_p___input_event___wheel.html#a51339c7b39cce3073f98f8a7f048f69d">PP_InputEvent_Wheel::delta_y</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The mouse wheel's vertical scroll amount. </p>
<p>A scroll down (where the content moves up) is represented as positive values, and a scroll up (where the content moves down) is represented as negative values.</p>
<p>The units are either in pixels (when scroll_by_page is false) or pages (when scroll_by_page is true). For example, delta_y = -3 means scroll up 3 pixels when scroll_by_page is false, and scroll up 3 pages when scroll_by_page is true.</p>
<p>This amount is system dependent and will take into account the user's preferred scroll sensitivity and potentially also nonlinear acceleration based on the speed of the scrolling.</p>
<p>Devices will be of varying resolution. Some mice with large detents will only generate integer scroll amounts. But fractional values are also possible, for example, on some trackpads and newer mice that don't have "clicks". </p>
</div>
</div>
<a class="anchor" id="ad4af418584f964e9191e78be05bbb3f7"></a><!-- doxytag: member="PP_InputEvent_Wheel::modifier" ref="ad4af418584f964e9191e78be05bbb3f7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="struct_p_p___input_event___wheel.html#ad4af418584f964e9191e78be05bbb3f7">PP_InputEvent_Wheel::modifier</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This value represents a combination of the <code>EVENT_MODIFIER</code> flags. </p>
</div>
</div>
<a class="anchor" id="ad51a5319a1eb82706371d495e397e909"></a><!-- doxytag: member="PP_InputEvent_Wheel::scroll_by_page" ref="ad51a5319a1eb82706371d495e397e909" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a> <a class="el" href="struct_p_p___input_event___wheel.html#ad51a5319a1eb82706371d495e397e909">PP_InputEvent_Wheel::scroll_by_page</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Indicates if the scroll <code>delta_x</code>/<code>delta_y</code> indicates pages or lines to scroll by. </p>
<p>When true, the user is requesting to scroll by pages. </p>
</div>
</div>
<a class="anchor" id="a0ebc9809d9333e68b63ad7dc7c421775"></a><!-- doxytag: member="PP_InputEvent_Wheel::wheel_ticks_x" ref="a0ebc9809d9333e68b63ad7dc7c421775" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="struct_p_p___input_event___wheel.html#a0ebc9809d9333e68b63ad7dc7c421775">PP_InputEvent_Wheel::wheel_ticks_x</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The number of "clicks" of the scroll wheel that have produced the event. </p>
<p>The value may have system-specific acceleration applied to it, depending on the device. The positive and negative meanings are the same as for <code>delta_x</code> and <code>delta_y</code>.</p>
<p>If you are scrolling, you probably want to use the delta values above. These tick events can be useful if you aren't doing actual scrolling and don't want or pixel values. An example may be cycling between different items in a game.</p>
<p>You may receive fractional values for the wheel ticks if the mouse wheel is high resolution or doesn't have "clicks". If your program wants discrete events (as in the "picking items" example) you should accumulate fractional click values from multiple messages until the total value reaches positive or negative one. This should represent a similar amount of scrolling as for a mouse that has a discrete mouse wheel. </p>
</div>
</div>
<a class="anchor" id="af39e6e81fc7166e745e3fdb4b4d3ff4e"></a><!-- doxytag: member="PP_InputEvent_Wheel::wheel_ticks_y" ref="af39e6e81fc7166e745e3fdb4b4d3ff4e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="struct_p_p___input_event___wheel.html#af39e6e81fc7166e745e3fdb4b4d3ff4e">PP_InputEvent_Wheel::wheel_ticks_y</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This value represents. </p>
</div>
</div>
<hr />The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="pp__input__event_8h.html">pp_input_event.h</a></li>
</ul>
</div><!-- contents -->
</div>
{{/partials.standard_nacl_api}}