/usr/share/doc/libratbag-dev/html/group__resolution.html is in libratbag-doc 0.9-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 | <!-- HTML header for doxygen 1.8.8-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<!-- For Mobile Devices -->
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<script type="text/javascript" src="file:///usr/share/javascript/jquery/jquery.js"></script>
<title>libratbag: Resolution and frequency mappings</title>
<!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="file:///usr/share/javascript/mathjax/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
<link href="bootstrap.css" rel="stylesheet" type="text/css"/>
<link href="bootstrap.css" rel="stylesheet" type="text/css" />
<script src="file:///usr/share/javascript/bootstrap/js/bootstrap.js"></script>
<script type="text/javascript" src="doxy-boot.js"></script>
</head>
<body>
<nav class="navbar navbar-default" role="navigation">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand">libratbag 0.9.0</a>
</div>
</div>
</nav>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div class="content" id="content">
<div class="container">
<div class="row">
<div class="col-sm-12 panel panel-default" style="padding-bottom: 15px;">
<div style="margin-bottom: 15px;">
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Resolution and frequency mappings</div> </div>
</div><!--header-->
<div class="contents">
<p>A device's sensor resolution and report rate can be configured per profile, with each profile reporting a number of resolution modes (see <a class="el" href="structratbag__resolution.html">ratbag_resolution</a>).
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structratbag__resolution.html">ratbag_resolution</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Represents a resolution setting on the device. <a href="structratbag__resolution.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga0718f2922e37ed10704fad2d2aeefece"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__resolution.html#ga0718f2922e37ed10704fad2d2aeefece">ratbag_resolution_ref</a> (struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> *resolution)</td></tr>
<tr class="memdesc:ga0718f2922e37ed10704fad2d2aeefece"><td class="mdescLeft"> </td><td class="mdescRight">Add a reference to the resolution. <a href="#ga0718f2922e37ed10704fad2d2aeefece">More...</a><br /></td></tr>
<tr class="separator:ga0718f2922e37ed10704fad2d2aeefece"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3b207a0de53cd01460af70494b7493b6"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__resolution.html#ga3b207a0de53cd01460af70494b7493b6">ratbag_resolution_unref</a> (struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> *resolution)</td></tr>
<tr class="memdesc:ga3b207a0de53cd01460af70494b7493b6"><td class="mdescLeft"> </td><td class="mdescRight">Dereference the ratbag resolution. <a href="#ga3b207a0de53cd01460af70494b7493b6">More...</a><br /></td></tr>
<tr class="separator:ga3b207a0de53cd01460af70494b7493b6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac0d204063f6e14dbf1cac1348bea14e5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__resolution.html#gac0d204063f6e14dbf1cac1348bea14e5">ratbag_resolution_set_user_data</a> (struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> *resolution, void *userdata)</td></tr>
<tr class="memdesc:gac0d204063f6e14dbf1cac1348bea14e5"><td class="mdescLeft"> </td><td class="mdescRight">Set caller-specific data associated with this resolution. <a href="#gac0d204063f6e14dbf1cac1348bea14e5">More...</a><br /></td></tr>
<tr class="separator:gac0d204063f6e14dbf1cac1348bea14e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac0687e5dd24d1842cc9450db536f82c4"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__resolution.html#gac0687e5dd24d1842cc9450db536f82c4">ratbag_resolution_get_user_data</a> (const struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> *resolution)</td></tr>
<tr class="memdesc:gac0687e5dd24d1842cc9450db536f82c4"><td class="mdescLeft"> </td><td class="mdescRight">Get the caller-specific data associated with this resolution, if any. <a href="#gac0687e5dd24d1842cc9450db536f82c4">More...</a><br /></td></tr>
<tr class="separator:gac0687e5dd24d1842cc9450db536f82c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga45c509541bacca70c1cf1a5726a3d7d2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__resolution.html#ga45c509541bacca70c1cf1a5726a3d7d2">ratbag_resolution_has_capability</a> (struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> *resolution, enum <a class="el" href="libratbag_8h.html#a4d5d0b9251bde32091d278b4f2cde0f3">ratbag_resolution_capability</a> cap)</td></tr>
<tr class="memdesc:ga45c509541bacca70c1cf1a5726a3d7d2"><td class="mdescLeft"> </td><td class="mdescRight">Check if a resolution has a specific capability. <a href="#ga45c509541bacca70c1cf1a5726a3d7d2">More...</a><br /></td></tr>
<tr class="separator:ga45c509541bacca70c1cf1a5726a3d7d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac77329eb260520654e5a12b3bed9fe75"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__base.html#ga778f6aa9aeee462860007415895baec1">ratbag_error_code</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__resolution.html#gac77329eb260520654e5a12b3bed9fe75">ratbag_resolution_set_dpi</a> (struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> *resolution, unsigned int dpi)</td></tr>
<tr class="memdesc:gac77329eb260520654e5a12b3bed9fe75"><td class="mdescLeft"> </td><td class="mdescRight">Set the resolution in DPI for the resolution mode. <a href="#gac77329eb260520654e5a12b3bed9fe75">More...</a><br /></td></tr>
<tr class="separator:gac77329eb260520654e5a12b3bed9fe75"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga66b841bb901766ca23dad631d2a0d7a4"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__base.html#ga778f6aa9aeee462860007415895baec1">ratbag_error_code</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__resolution.html#ga66b841bb901766ca23dad631d2a0d7a4">ratbag_resolution_set_dpi_xy</a> (struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> *resolution, unsigned int x, unsigned int y)</td></tr>
<tr class="memdesc:ga66b841bb901766ca23dad631d2a0d7a4"><td class="mdescLeft"> </td><td class="mdescRight">Set the x and y resolution in DPI for the resolution mode. <a href="#ga66b841bb901766ca23dad631d2a0d7a4">More...</a><br /></td></tr>
<tr class="separator:ga66b841bb901766ca23dad631d2a0d7a4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae26eaf50161f9f3d83b4c93c7f9ef49f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__resolution.html#gae26eaf50161f9f3d83b4c93c7f9ef49f">ratbag_resolution_get_dpi</a> (struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> *resolution)</td></tr>
<tr class="memdesc:gae26eaf50161f9f3d83b4c93c7f9ef49f"><td class="mdescLeft"> </td><td class="mdescRight">Get the resolution in DPI for the resolution mode. <a href="#gae26eaf50161f9f3d83b4c93c7f9ef49f">More...</a><br /></td></tr>
<tr class="separator:gae26eaf50161f9f3d83b4c93c7f9ef49f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gace364969e6ad48504f23869ab0e7751d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__resolution.html#gace364969e6ad48504f23869ab0e7751d">ratbag_resolution_get_dpi_x</a> (struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> *resolution)</td></tr>
<tr class="memdesc:gace364969e6ad48504f23869ab0e7751d"><td class="mdescLeft"> </td><td class="mdescRight">Get the x resolution in DPI for the resolution mode. <a href="#gace364969e6ad48504f23869ab0e7751d">More...</a><br /></td></tr>
<tr class="separator:gace364969e6ad48504f23869ab0e7751d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8d3a916a9e79b92f271bb4a1758e74d7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__resolution.html#ga8d3a916a9e79b92f271bb4a1758e74d7">ratbag_resolution_get_dpi_y</a> (struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> *resolution)</td></tr>
<tr class="memdesc:ga8d3a916a9e79b92f271bb4a1758e74d7"><td class="mdescLeft"> </td><td class="mdescRight">Get the y resolution in DPI for the resolution mode. <a href="#ga8d3a916a9e79b92f271bb4a1758e74d7">More...</a><br /></td></tr>
<tr class="separator:ga8d3a916a9e79b92f271bb4a1758e74d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac1f8e59e543527306649fec849066d11"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__base.html#ga778f6aa9aeee462860007415895baec1">ratbag_error_code</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__resolution.html#gac1f8e59e543527306649fec849066d11">ratbag_resolution_set_report_rate</a> (struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> *resolution, unsigned int hz)</td></tr>
<tr class="memdesc:gac1f8e59e543527306649fec849066d11"><td class="mdescLeft"> </td><td class="mdescRight">Set the report rate in Hz for the resolution mode. <a href="#gac1f8e59e543527306649fec849066d11">More...</a><br /></td></tr>
<tr class="separator:gac1f8e59e543527306649fec849066d11"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabb45f662b634e7452852d835179109d3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__resolution.html#gabb45f662b634e7452852d835179109d3">ratbag_resolution_get_report_rate</a> (struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> *resolution)</td></tr>
<tr class="memdesc:gabb45f662b634e7452852d835179109d3"><td class="mdescLeft"> </td><td class="mdescRight">Get the report rate in Hz for the resolution mode. <a href="#gabb45f662b634e7452852d835179109d3">More...</a><br /></td></tr>
<tr class="separator:gabb45f662b634e7452852d835179109d3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga398d09762ac2e7bd2b8f29770f1b3ae7"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__base.html#ga778f6aa9aeee462860007415895baec1">ratbag_error_code</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__resolution.html#ga398d09762ac2e7bd2b8f29770f1b3ae7">ratbag_resolution_set_active</a> (struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> *resolution)</td></tr>
<tr class="memdesc:ga398d09762ac2e7bd2b8f29770f1b3ae7"><td class="mdescLeft"> </td><td class="mdescRight">Activate the given resolution mode. <a href="#ga398d09762ac2e7bd2b8f29770f1b3ae7">More...</a><br /></td></tr>
<tr class="separator:ga398d09762ac2e7bd2b8f29770f1b3ae7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacdef33344806b7bf188ac4c62ad576d2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__resolution.html#gacdef33344806b7bf188ac4c62ad576d2">ratbag_resolution_is_active</a> (const struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> *resolution)</td></tr>
<tr class="memdesc:gacdef33344806b7bf188ac4c62ad576d2"><td class="mdescLeft"> </td><td class="mdescRight">Check if the resolution mode is the currently active one. <a href="#gacdef33344806b7bf188ac4c62ad576d2">More...</a><br /></td></tr>
<tr class="separator:gacdef33344806b7bf188ac4c62ad576d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga26c8a1ed15dd7f8df86ce71427cd151f"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__base.html#ga778f6aa9aeee462860007415895baec1">ratbag_error_code</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__resolution.html#ga26c8a1ed15dd7f8df86ce71427cd151f">ratbag_resolution_set_default</a> (struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> *resolution)</td></tr>
<tr class="memdesc:ga26c8a1ed15dd7f8df86ce71427cd151f"><td class="mdescLeft"> </td><td class="mdescRight">Set the default resolution mode for the associated profile. <a href="#ga26c8a1ed15dd7f8df86ce71427cd151f">More...</a><br /></td></tr>
<tr class="separator:ga26c8a1ed15dd7f8df86ce71427cd151f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadf53fe8bfc5fd3272073d11e90a125c8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__resolution.html#gadf53fe8bfc5fd3272073d11e90a125c8">ratbag_resolution_is_default</a> (const struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> *resolution)</td></tr>
<tr class="memdesc:gadf53fe8bfc5fd3272073d11e90a125c8"><td class="mdescLeft"> </td><td class="mdescRight">Check if the resolution mode is the default one in this profile. <a href="#gadf53fe8bfc5fd3272073d11e90a125c8">More...</a><br /></td></tr>
<tr class="separator:gadf53fe8bfc5fd3272073d11e90a125c8"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>A device's sensor resolution and report rate can be configured per profile, with each profile reporting a number of resolution modes (see <a class="el" href="structratbag__resolution.html">ratbag_resolution</a>). </p>
<p>The number depends on the hardware, but at least one is provided by libratbag.</p>
<p>Each resolution mode is a tuple of a resolution and report rate and represents the modes that the mouse can switch through, usually with the use of a button on the mouse to cycle through the preconfigured resolutions.</p>
<p>The resolutions have a default resolution and a currently active resolution. The currently active one is the one used by the device now and only applies if the profile is currently active too. The default resolution is the one the device will chose when the profile is selected next. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="gae26eaf50161f9f3d83b4c93c7f9ef49f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae26eaf50161f9f3d83b4c93c7f9ef49f">◆ </a></span>ratbag_resolution_get_dpi()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ratbag_resolution_get_dpi </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> * </td>
<td class="paramname"><em>resolution</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the resolution in DPI for the resolution mode. </p>
<p>If the resolution has the <a class="el" href="libratbag_8h.html#a4d5d0b9251bde32091d278b4f2cde0f3a99ee14f4fe1f3a571316e1c8c3068ed6">RATBAG_RESOLUTION_CAP_SEPARATE_XY_RESOLUTION</a> capability, this function returns the x resolution, see <a class="el" href="group__resolution.html#gace364969e6ad48504f23869ab0e7751d" title="Get the x resolution in DPI for the resolution mode. ">ratbag_resolution_get_dpi_x()</a>.</p>
<p>A value of 0 for dpi indicates the mode is disabled.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">resolution</td><td>A previously initialized ratbag resolution</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The resolution in dpi </dd></dl>
</div>
</div>
<a id="gace364969e6ad48504f23869ab0e7751d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gace364969e6ad48504f23869ab0e7751d">◆ </a></span>ratbag_resolution_get_dpi_x()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ratbag_resolution_get_dpi_x </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> * </td>
<td class="paramname"><em>resolution</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the x resolution in DPI for the resolution mode. </p>
<p>If the resolution does not have the <a class="el" href="libratbag_8h.html#a4d5d0b9251bde32091d278b4f2cde0f3a99ee14f4fe1f3a571316e1c8c3068ed6">RATBAG_RESOLUTION_CAP_SEPARATE_XY_RESOLUTION</a> capability, this function is identical to <a class="el" href="group__resolution.html#gae26eaf50161f9f3d83b4c93c7f9ef49f" title="Get the resolution in DPI for the resolution mode. ">ratbag_resolution_get_dpi()</a>.</p>
<p>A value of 0 for dpi indicates the mode is disabled.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">resolution</td><td>A previously initialized ratbag resolution with the <a class="el" href="libratbag_8h.html#a4d5d0b9251bde32091d278b4f2cde0f3a99ee14f4fe1f3a571316e1c8c3068ed6">RATBAG_RESOLUTION_CAP_SEPARATE_XY_RESOLUTION</a> capability</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The resolution in dpi </dd></dl>
</div>
</div>
<a id="ga8d3a916a9e79b92f271bb4a1758e74d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8d3a916a9e79b92f271bb4a1758e74d7">◆ </a></span>ratbag_resolution_get_dpi_y()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ratbag_resolution_get_dpi_y </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> * </td>
<td class="paramname"><em>resolution</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the y resolution in DPI for the resolution mode. </p>
<p>If the resolution does not have the <a class="el" href="libratbag_8h.html#a4d5d0b9251bde32091d278b4f2cde0f3a99ee14f4fe1f3a571316e1c8c3068ed6">RATBAG_RESOLUTION_CAP_SEPARATE_XY_RESOLUTION</a> capability, this function is identical to <a class="el" href="group__resolution.html#gae26eaf50161f9f3d83b4c93c7f9ef49f" title="Get the resolution in DPI for the resolution mode. ">ratbag_resolution_get_dpi()</a>.</p>
<p>A value of 0 for dpi indicates the mode is disabled.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">resolution</td><td>A previously initialized ratbag resolution with the <a class="el" href="libratbag_8h.html#a4d5d0b9251bde32091d278b4f2cde0f3a99ee14f4fe1f3a571316e1c8c3068ed6">RATBAG_RESOLUTION_CAP_SEPARATE_XY_RESOLUTION</a> capability</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The resolution in dpi </dd></dl>
</div>
</div>
<a id="gabb45f662b634e7452852d835179109d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabb45f662b634e7452852d835179109d3">◆ </a></span>ratbag_resolution_get_report_rate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ratbag_resolution_get_report_rate </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> * </td>
<td class="paramname"><em>resolution</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the report rate in Hz for the resolution mode. </p>
<p>A value of 0 hz indicates the mode is disabled.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">resolution</td><td>A previously initialized ratbag resolution</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The report rate for this resolution in Hz </dd></dl>
</div>
</div>
<a id="gac0687e5dd24d1842cc9450db536f82c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac0687e5dd24d1842cc9450db536f82c4">◆ </a></span>ratbag_resolution_get_user_data()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* ratbag_resolution_get_user_data </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> * </td>
<td class="paramname"><em>resolution</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the caller-specific data associated with this resolution, if any. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">resolution</td><td>A previously initialized ratbag resolution </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The caller-specific data previously assigned in <a class="el" href="group__resolution.html#gac0d204063f6e14dbf1cac1348bea14e5" title="Set caller-specific data associated with this resolution. ">ratbag_resolution_set_user_data()</a>. </dd></dl>
</div>
</div>
<a id="ga45c509541bacca70c1cf1a5726a3d7d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga45c509541bacca70c1cf1a5726a3d7d2">◆ </a></span>ratbag_resolution_has_capability()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ratbag_resolution_has_capability </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> * </td>
<td class="paramname"><em>resolution</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="libratbag_8h.html#a4d5d0b9251bde32091d278b4f2cde0f3">ratbag_resolution_capability</a> </td>
<td class="paramname"><em>cap</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a resolution has a specific capability. </p>
<dl class="section return"><dt>Returns</dt><dd>non-zero if the capability is available, zero otherwise. </dd></dl>
</div>
</div>
<a id="gacdef33344806b7bf188ac4c62ad576d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacdef33344806b7bf188ac4c62ad576d2">◆ </a></span>ratbag_resolution_is_active()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ratbag_resolution_is_active </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> * </td>
<td class="paramname"><em>resolution</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the resolution mode is the currently active one. </p>
<p>If the profile is the currently active profile, the mode is the one currently active. For profiles not currently active, this always returns 0.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">resolution</td><td>A previously initialized ratbag resolution</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Non-zero if the resolution mode is the active one, zero otherwise. </dd></dl>
</div>
</div>
<a id="gadf53fe8bfc5fd3272073d11e90a125c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadf53fe8bfc5fd3272073d11e90a125c8">◆ </a></span>ratbag_resolution_is_default()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ratbag_resolution_is_default </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> * </td>
<td class="paramname"><em>resolution</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the resolution mode is the default one in this profile. </p>
<p>The default resolution is the one the device selects when switching to the corresponding profile. It may not be the currently active resolution, use <a class="el" href="group__resolution.html#gacdef33344806b7bf188ac4c62ad576d2" title="Check if the resolution mode is the currently active one. ">ratbag_resolution_is_active()</a> instead.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">resolution</td><td>A previously initialized ratbag resolution</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Non-zero if the resolution mode is the default one, zero otherwise. </dd></dl>
</div>
</div>
<a id="ga0718f2922e37ed10704fad2d2aeefece"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0718f2922e37ed10704fad2d2aeefece">◆ </a></span>ratbag_resolution_ref()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a>* ratbag_resolution_ref </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> * </td>
<td class="paramname"><em>resolution</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a reference to the resolution. </p>
<p>A resolution is destroyed whenever the reference count reaches 0. See <a class="el" href="group__resolution.html#ga3b207a0de53cd01460af70494b7493b6">ratbag_resolution_unref</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">resolution</td><td>A previously initialized valid ratbag resolution </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The passed ratbag resolution </dd></dl>
</div>
</div>
<a id="ga398d09762ac2e7bd2b8f29770f1b3ae7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga398d09762ac2e7bd2b8f29770f1b3ae7">◆ </a></span>ratbag_resolution_set_active()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__base.html#ga778f6aa9aeee462860007415895baec1">ratbag_error_code</a> ratbag_resolution_set_active </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> * </td>
<td class="paramname"><em>resolution</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Activate the given resolution mode. </p>
<p>If the mode is not configured, this function returns an error and the result is undefined.</p>
<p>The mode must be one of the current profile, otherwise an error is returned.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">resolution</td><td>A previously initialized ratbag resolution</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
<a id="ga26c8a1ed15dd7f8df86ce71427cd151f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga26c8a1ed15dd7f8df86ce71427cd151f">◆ </a></span>ratbag_resolution_set_default()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__base.html#ga778f6aa9aeee462860007415895baec1">ratbag_error_code</a> ratbag_resolution_set_default </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> * </td>
<td class="paramname"><em>resolution</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the default resolution mode for the associated profile. </p>
<p>When the device switches to the profile next, this mode will be the active resolution. If the mode is not configured, this function returns an error and the result is undefined.</p>
<p>This only switches the default resolution, not the currently active resolution. Use <a class="el" href="group__resolution.html#ga398d09762ac2e7bd2b8f29770f1b3ae7" title="Activate the given resolution mode. ">ratbag_resolution_set_active()</a> instead.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">resolution</td><td>A previously initialized ratbag resolution</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
<a id="gac77329eb260520654e5a12b3bed9fe75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac77329eb260520654e5a12b3bed9fe75">◆ </a></span>ratbag_resolution_set_dpi()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__base.html#ga778f6aa9aeee462860007415895baec1">ratbag_error_code</a> ratbag_resolution_set_dpi </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> * </td>
<td class="paramname"><em>resolution</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>dpi</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the resolution in DPI for the resolution mode. </p>
<p>If the resolution has the <a class="el" href="libratbag_8h.html#a4d5d0b9251bde32091d278b4f2cde0f3a99ee14f4fe1f3a571316e1c8c3068ed6">RATBAG_RESOLUTION_CAP_SEPARATE_XY_RESOLUTION</a> capability, this function sets both x and y resolution to the given value.</p>
<p>A value of 0 for dpi disables the mode.</p>
<p>If the resolution mode is the currently active mode and the profile is the currently active profile, the change takes effect immediately.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">resolution</td><td>A previously initialized ratbag resolution </td></tr>
<tr><td class="paramname">dpi</td><td>Set to the resolution in dpi, 0 to disable</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
<a id="ga66b841bb901766ca23dad631d2a0d7a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga66b841bb901766ca23dad631d2a0d7a4">◆ </a></span>ratbag_resolution_set_dpi_xy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__base.html#ga778f6aa9aeee462860007415895baec1">ratbag_error_code</a> ratbag_resolution_set_dpi_xy </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> * </td>
<td class="paramname"><em>resolution</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>y</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the x and y resolution in DPI for the resolution mode. </p>
<p>If the resolution does not have the <a class="el" href="libratbag_8h.html#a4d5d0b9251bde32091d278b4f2cde0f3a99ee14f4fe1f3a571316e1c8c3068ed6">RATBAG_RESOLUTION_CAP_SEPARATE_XY_RESOLUTION</a> capability, this function returns an error and does nothing.</p>
<p>A value of 0 for both x and y disables the mode. If either value is 0 and the other value is non-zero, this function returns an error and does nothing.</p>
<p>If the resolution mode is the currently active mode and the profile is the currently active profile, the change takes effect immediately.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">resolution</td><td>A previously initialized ratbag resolution with the <a class="el" href="libratbag_8h.html#a4d5d0b9251bde32091d278b4f2cde0f3a99ee14f4fe1f3a571316e1c8c3068ed6">RATBAG_RESOLUTION_CAP_SEPARATE_XY_RESOLUTION</a> capability </td></tr>
<tr><td class="paramname">x</td><td>The x resolution in dpi </td></tr>
<tr><td class="paramname">y</td><td>The y resolution in dpi</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
<a id="gac1f8e59e543527306649fec849066d11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac1f8e59e543527306649fec849066d11">◆ </a></span>ratbag_resolution_set_report_rate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__base.html#ga778f6aa9aeee462860007415895baec1">ratbag_error_code</a> ratbag_resolution_set_report_rate </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> * </td>
<td class="paramname"><em>resolution</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>hz</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the report rate in Hz for the resolution mode. </p>
<p>A value of 0 hz disables the mode.</p>
<p>If the resolution mode is the currently active mode and the profile is the currently active profile, the change takes effect immediately.</p>
<p>If the resolution does not have the <a class="el" href="libratbag_8h.html#a4d5d0b9251bde32091d278b4f2cde0f3a7ba0b0c4048bd5315f4eda12a4cd4342">RATBAG_RESOLUTION_CAP_INDIVIDUAL_REPORT_RATE</a> capability, changing the report rate on one resolution changes the report rate for all resolutions in this profile.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">resolution</td><td>A previously initialized ratbag resolution </td></tr>
<tr><td class="paramname">hz</td><td>Set to the report rate in Hz, may be 0</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
<a id="gac0d204063f6e14dbf1cac1348bea14e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac0d204063f6e14dbf1cac1348bea14e5">◆ </a></span>ratbag_resolution_set_user_data()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ratbag_resolution_set_user_data </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> * </td>
<td class="paramname"><em>resolution</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>userdata</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set caller-specific data associated with this resolution. </p>
<p>libratbag does not manage, look at, or modify this data. The caller must ensure the data is valid.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">resolution</td><td>A previously initialized resolution </td></tr>
<tr><td class="paramname">userdata</td><td>Caller-specific data passed to the various callback interfaces. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga3b207a0de53cd01460af70494b7493b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3b207a0de53cd01460af70494b7493b6">◆ </a></span>ratbag_resolution_unref()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a>* ratbag_resolution_unref </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structratbag__resolution.html">ratbag_resolution</a> * </td>
<td class="paramname"><em>resolution</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Dereference the ratbag resolution. </p>
<p>When the internal refcount reaches zero, all resources associated with this object are released. The object must be considered invalid once unref is called.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">resolution</td><td>A previously initialized ratbag resolution </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Always NULL </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.8-->
<!-- start footer part -->
</div>
</div>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jan 10 2018 18:56:06 for libratbag by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
|