/usr/share/doc/libratbag-dev/html/group__led.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 | <!-- 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: LED configuration</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="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">LED configuration</div> </div>
</div><!--header-->
<div class="contents">
<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__color.html">ratbag_color</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Represents LED color in RGB format. <a href="structratbag__color.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structratbag__led.html">ratbag_led</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Represents a led on the device. <a href="structratbag__led.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="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gad1be32cfd9fa5b3a423211f11bed67d1"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__led.html#gad1be32cfd9fa5b3a423211f11bed67d1">ratbag_led_mode</a> { <a class="el" href="group__led.html#ggad1be32cfd9fa5b3a423211f11bed67d1a3a0c208dc717aa497be7ce44f1d4140f">RATBAG_LED_OFF</a>,
<a class="el" href="group__led.html#ggad1be32cfd9fa5b3a423211f11bed67d1a4ad514c9f66e6de6261b849f2c7bc47f">RATBAG_LED_ON</a>,
<a class="el" href="group__led.html#ggad1be32cfd9fa5b3a423211f11bed67d1a1118650e587ec5fac6ae4969b318e640">RATBAG_LED_CYCLE</a>,
<a class="el" href="group__led.html#ggad1be32cfd9fa5b3a423211f11bed67d1a77a9df31393082ff27cee3361551c26f">RATBAG_LED_BREATHING</a>
}<tr class="memdesc:gad1be32cfd9fa5b3a423211f11bed67d1"><td class="mdescLeft"> </td><td class="mdescRight">RATBAG_LED_OFF - led is now off, RATBAG_LED_ON - led is on with static color, RATBAG_LED_CYCLE - led is cycling between all colors. <a href="group__led.html#gad1be32cfd9fa5b3a423211f11bed67d1">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:gad1be32cfd9fa5b3a423211f11bed67d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gade0742d37e151927d6bc08e37e83c930"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__led.html#gade0742d37e151927d6bc08e37e83c930">ratbag_led_type</a> { <a class="el" href="group__led.html#ggade0742d37e151927d6bc08e37e83c930a6c7e99efb36224e445649010040e6125">RATBAG_LED_TYPE_UNKNOWN</a>,
<a class="el" href="group__led.html#ggade0742d37e151927d6bc08e37e83c930a8d0984c0f2f5e21fa7a85adca3cf6ace">RATBAG_LED_TYPE_LOGO</a>,
<a class="el" href="group__led.html#ggade0742d37e151927d6bc08e37e83c930a87600e3a9f3349f9c27497ded26ca170">RATBAG_LED_TYPE_SIDE</a>
}<tr class="memdesc:gade0742d37e151927d6bc08e37e83c930"><td class="mdescLeft"> </td><td class="mdescRight">LED types, usually based on their physical location. <a href="group__led.html#gade0742d37e151927d6bc08e37e83c930">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:gade0742d37e151927d6bc08e37e83c930"><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:ga539a6d3e5721132efe001f8b6f18b801"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structratbag__led.html">ratbag_led</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__led.html#ga539a6d3e5721132efe001f8b6f18b801">ratbag_profile_get_led</a> (struct <a class="el" href="structratbag__profile.html">ratbag_profile</a> *profile, unsigned int index)</td></tr>
<tr class="memdesc:ga539a6d3e5721132efe001f8b6f18b801"><td class="mdescLeft"> </td><td class="mdescRight">Return a reference to the LED given by the index. <a href="#ga539a6d3e5721132efe001f8b6f18b801">More...</a><br /></td></tr>
<tr class="separator:ga539a6d3e5721132efe001f8b6f18b801"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9836b757484e40d589bb83fe3e258a03"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__led.html#gade0742d37e151927d6bc08e37e83c930">ratbag_led_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__led.html#ga9836b757484e40d589bb83fe3e258a03">ratbag_led_get_type</a> (struct <a class="el" href="structratbag__led.html">ratbag_led</a> *led)</td></tr>
<tr class="memdesc:ga9836b757484e40d589bb83fe3e258a03"><td class="mdescLeft"> </td><td class="mdescRight">This function returns the type for <a class="el" href="structratbag__led.html" title="Represents a led on the device. ">ratbag_led</a>. <a href="#ga9836b757484e40d589bb83fe3e258a03">More...</a><br /></td></tr>
<tr class="separator:ga9836b757484e40d589bb83fe3e258a03"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga38a9ce74dd1befaf1d89d8d367e7a4e3"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__led.html#gad1be32cfd9fa5b3a423211f11bed67d1">ratbag_led_mode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__led.html#ga38a9ce74dd1befaf1d89d8d367e7a4e3">ratbag_led_get_mode</a> (struct <a class="el" href="structratbag__led.html">ratbag_led</a> *led)</td></tr>
<tr class="memdesc:ga38a9ce74dd1befaf1d89d8d367e7a4e3"><td class="mdescLeft"> </td><td class="mdescRight">This function returns the mode for <a class="el" href="structratbag__led.html" title="Represents a led on the device. ">ratbag_led</a>. <a href="#ga38a9ce74dd1befaf1d89d8d367e7a4e3">More...</a><br /></td></tr>
<tr class="separator:ga38a9ce74dd1befaf1d89d8d367e7a4e3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaec2018afcd26bb31ca12ac9e8f995d47"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structratbag__color.html">ratbag_color</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__led.html#gaec2018afcd26bb31ca12ac9e8f995d47">ratbag_led_get_color</a> (struct <a class="el" href="structratbag__led.html">ratbag_led</a> *led)</td></tr>
<tr class="memdesc:gaec2018afcd26bb31ca12ac9e8f995d47"><td class="mdescLeft"> </td><td class="mdescRight">This function returns the led color. <a href="#gaec2018afcd26bb31ca12ac9e8f995d47">More...</a><br /></td></tr>
<tr class="separator:gaec2018afcd26bb31ca12ac9e8f995d47"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa8c8047c8ad6b476dc25ed24d4e50e89"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__led.html#gaa8c8047c8ad6b476dc25ed24d4e50e89">ratbag_led_get_effect_rate</a> (struct <a class="el" href="structratbag__led.html">ratbag_led</a> *led)</td></tr>
<tr class="memdesc:gaa8c8047c8ad6b476dc25ed24d4e50e89"><td class="mdescLeft"> </td><td class="mdescRight">This function returns the LED effect rate. <a href="#gaa8c8047c8ad6b476dc25ed24d4e50e89">More...</a><br /></td></tr>
<tr class="separator:gaa8c8047c8ad6b476dc25ed24d4e50e89"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf0ab94fd921904e83758dc6c0c60d94d"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__led.html#gaf0ab94fd921904e83758dc6c0c60d94d">ratbag_led_get_brightness</a> (struct <a class="el" href="structratbag__led.html">ratbag_led</a> *led)</td></tr>
<tr class="memdesc:gaf0ab94fd921904e83758dc6c0c60d94d"><td class="mdescLeft"> </td><td class="mdescRight">This function returns the LED brightness. <a href="#gaf0ab94fd921904e83758dc6c0c60d94d">More...</a><br /></td></tr>
<tr class="separator:gaf0ab94fd921904e83758dc6c0c60d94d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac1a6918e0c7d94e5e2166d73ba8dfa5b"><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__led.html#gac1a6918e0c7d94e5e2166d73ba8dfa5b">ratbag_led_set_mode</a> (struct <a class="el" href="structratbag__led.html">ratbag_led</a> *led, enum <a class="el" href="group__led.html#gad1be32cfd9fa5b3a423211f11bed67d1">ratbag_led_mode</a> mode)</td></tr>
<tr class="memdesc:gac1a6918e0c7d94e5e2166d73ba8dfa5b"><td class="mdescLeft"> </td><td class="mdescRight">this function sets the LED mode. <a href="#gac1a6918e0c7d94e5e2166d73ba8dfa5b">More...</a><br /></td></tr>
<tr class="separator:gac1a6918e0c7d94e5e2166d73ba8dfa5b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaed6c3fd08b50338c852f9e2271bdf19d"><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__led.html#gaed6c3fd08b50338c852f9e2271bdf19d">ratbag_led_set_color</a> (struct <a class="el" href="structratbag__led.html">ratbag_led</a> *led, struct <a class="el" href="structratbag__color.html">ratbag_color</a> color)</td></tr>
<tr class="memdesc:gaed6c3fd08b50338c852f9e2271bdf19d"><td class="mdescLeft"> </td><td class="mdescRight">If the LED's mode is <a class="el" href="group__led.html#ggad1be32cfd9fa5b3a423211f11bed67d1a4ad514c9f66e6de6261b849f2c7bc47f">RATBAG_LED_ON</a> or <a class="el" href="group__led.html#ggad1be32cfd9fa5b3a423211f11bed67d1a77a9df31393082ff27cee3361551c26f">RATBAG_LED_BREATHING</a> then this function sets the LED color, otherwise it has no effect. <a href="#gaed6c3fd08b50338c852f9e2271bdf19d">More...</a><br /></td></tr>
<tr class="separator:gaed6c3fd08b50338c852f9e2271bdf19d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5c0777440a1b33e864f6513ea8ddbb2e"><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__led.html#ga5c0777440a1b33e864f6513ea8ddbb2e">ratbag_led_set_effect_rate</a> (struct <a class="el" href="structratbag__led.html">ratbag_led</a> *led, unsigned int rate)</td></tr>
<tr class="memdesc:ga5c0777440a1b33e864f6513ea8ddbb2e"><td class="mdescLeft"> </td><td class="mdescRight">If the LED's mode is <a class="el" href="group__led.html#ggad1be32cfd9fa5b3a423211f11bed67d1a1118650e587ec5fac6ae4969b318e640">RATBAG_LED_CYCLE</a> or <a class="el" href="group__led.html#ggad1be32cfd9fa5b3a423211f11bed67d1a77a9df31393082ff27cee3361551c26f">RATBAG_LED_BREATHING</a> then this function sets the LED rate in Hz. <a href="#ga5c0777440a1b33e864f6513ea8ddbb2e">More...</a><br /></td></tr>
<tr class="separator:ga5c0777440a1b33e864f6513ea8ddbb2e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1b4f360abe5a0617b26dd47d22a582f9"><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__led.html#ga1b4f360abe5a0617b26dd47d22a582f9">ratbag_led_set_brightness</a> (struct <a class="el" href="structratbag__led.html">ratbag_led</a> *led, unsigned int brightness)</td></tr>
<tr class="memdesc:ga1b4f360abe5a0617b26dd47d22a582f9"><td class="mdescLeft"> </td><td class="mdescRight">If the LED's mode is <a class="el" href="group__led.html#ggad1be32cfd9fa5b3a423211f11bed67d1a1118650e587ec5fac6ae4969b318e640">RATBAG_LED_CYCLE</a> or <a class="el" href="group__led.html#ggad1be32cfd9fa5b3a423211f11bed67d1a77a9df31393082ff27cee3361551c26f">RATBAG_LED_BREATHING</a> then this function sets the LED brightness, otherwise it has no effect. <a href="#ga1b4f360abe5a0617b26dd47d22a582f9">More...</a><br /></td></tr>
<tr class="separator:ga1b4f360abe5a0617b26dd47d22a582f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaba42b8fbbcabb3756a7c76bf3129b028"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structratbag__led.html">ratbag_led</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__led.html#gaba42b8fbbcabb3756a7c76bf3129b028">ratbag_led_ref</a> (struct <a class="el" href="structratbag__led.html">ratbag_led</a> *led)</td></tr>
<tr class="memdesc:gaba42b8fbbcabb3756a7c76bf3129b028"><td class="mdescLeft"> </td><td class="mdescRight">Add a reference to the led. <a href="#gaba42b8fbbcabb3756a7c76bf3129b028">More...</a><br /></td></tr>
<tr class="separator:gaba42b8fbbcabb3756a7c76bf3129b028"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab5cd5a96754b67cd3bc542cb5775d260"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structratbag__led.html">ratbag_led</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__led.html#gab5cd5a96754b67cd3bc542cb5775d260">ratbag_led_unref</a> (struct <a class="el" href="structratbag__led.html">ratbag_led</a> *led)</td></tr>
<tr class="memdesc:gab5cd5a96754b67cd3bc542cb5775d260"><td class="mdescLeft"> </td><td class="mdescRight">Dereference the ratbag led. <a href="#gab5cd5a96754b67cd3bc542cb5775d260">More...</a><br /></td></tr>
<tr class="separator:gab5cd5a96754b67cd3bc542cb5775d260"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="gad1be32cfd9fa5b3a423211f11bed67d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad1be32cfd9fa5b3a423211f11bed67d1">◆ </a></span>ratbag_led_mode</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__led.html#gad1be32cfd9fa5b3a423211f11bed67d1">ratbag_led_mode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>RATBAG_LED_OFF - led is now off, RATBAG_LED_ON - led is on with static color, RATBAG_LED_CYCLE - led is cycling between all colors. </p>
<p>RATBAG_LED_BREATHING - led is pulsating with static color</p>
<p>Each LED mode has different properties, e.g. the brightness and rate are only available in modes <a class="el" href="group__led.html#ggad1be32cfd9fa5b3a423211f11bed67d1a1118650e587ec5fac6ae4969b318e640">RATBAG_LED_CYCLE</a> and <a class="el" href="group__led.html#ggad1be32cfd9fa5b3a423211f11bed67d1a77a9df31393082ff27cee3361551c26f">RATBAG_LED_BREATHING</a> modes </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggad1be32cfd9fa5b3a423211f11bed67d1a3a0c208dc717aa497be7ce44f1d4140f"></a>RATBAG_LED_OFF </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggad1be32cfd9fa5b3a423211f11bed67d1a4ad514c9f66e6de6261b849f2c7bc47f"></a>RATBAG_LED_ON </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggad1be32cfd9fa5b3a423211f11bed67d1a1118650e587ec5fac6ae4969b318e640"></a>RATBAG_LED_CYCLE </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggad1be32cfd9fa5b3a423211f11bed67d1a77a9df31393082ff27cee3361551c26f"></a>RATBAG_LED_BREATHING </td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<a id="gade0742d37e151927d6bc08e37e83c930"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gade0742d37e151927d6bc08e37e83c930">◆ </a></span>ratbag_led_type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__led.html#gade0742d37e151927d6bc08e37e83c930">ratbag_led_type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>LED types, usually based on their physical location. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggade0742d37e151927d6bc08e37e83c930a6c7e99efb36224e445649010040e6125"></a>RATBAG_LED_TYPE_UNKNOWN </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggade0742d37e151927d6bc08e37e83c930a8d0984c0f2f5e21fa7a85adca3cf6ace"></a>RATBAG_LED_TYPE_LOGO </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggade0742d37e151927d6bc08e37e83c930a87600e3a9f3349f9c27497ded26ca170"></a>RATBAG_LED_TYPE_SIDE </td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaf0ab94fd921904e83758dc6c0c60d94d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf0ab94fd921904e83758dc6c0c60d94d">◆ </a></span>ratbag_led_get_brightness()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int ratbag_led_get_brightness </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structratbag__led.html">ratbag_led</a> * </td>
<td class="paramname"><em>led</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function returns the LED brightness. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">led</td><td>A previously initialized ratbag LED </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The LED brightness 0 - 255</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__led.html#gaf0ab94fd921904e83758dc6c0c60d94d" title="This function returns the LED brightness. ">ratbag_led_get_brightness</a> </dd></dl>
</div>
</div>
<a id="gaec2018afcd26bb31ca12ac9e8f995d47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaec2018afcd26bb31ca12ac9e8f995d47">◆ </a></span>ratbag_led_get_color()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structratbag__color.html">ratbag_color</a> ratbag_led_get_color </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structratbag__led.html">ratbag_led</a> * </td>
<td class="paramname"><em>led</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function returns the led color. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">led</td><td>A previously initialized ratbag LED </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The LED color in <a class="el" href="group__led.html#gad1be32cfd9fa5b3a423211f11bed67d1">ratbag_led_mode</a></dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__led.html#gaed6c3fd08b50338c852f9e2271bdf19d" title="If the LED's mode is RATBAG_LED_ON or RATBAG_LED_BREATHING then this function sets the LED color...">ratbag_led_set_color</a> </dd></dl>
</div>
</div>
<a id="gaa8c8047c8ad6b476dc25ed24d4e50e89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa8c8047c8ad6b476dc25ed24d4e50e89">◆ </a></span>ratbag_led_get_effect_rate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ratbag_led_get_effect_rate </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structratbag__led.html">ratbag_led</a> * </td>
<td class="paramname"><em>led</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function returns the LED effect rate. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">led</td><td>A previously initialized ratbag LED </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The LED rate in Hz, can be 100 - 20000</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__led.html#ga5c0777440a1b33e864f6513ea8ddbb2e" title="If the LED's mode is RATBAG_LED_CYCLE or RATBAG_LED_BREATHING then this function sets the LED rate in...">ratbag_led_set_effect_rate</a> </dd></dl>
</div>
</div>
<a id="ga38a9ce74dd1befaf1d89d8d367e7a4e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga38a9ce74dd1befaf1d89d8d367e7a4e3">◆ </a></span>ratbag_led_get_mode()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__led.html#gad1be32cfd9fa5b3a423211f11bed67d1">ratbag_led_mode</a> ratbag_led_get_mode </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structratbag__led.html">ratbag_led</a> * </td>
<td class="paramname"><em>led</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function returns the mode for <a class="el" href="structratbag__led.html" title="Represents a led on the device. ">ratbag_led</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">led</td><td>A previously initialized ratbag LED </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The LED mod <a class="el" href="group__led.html#gad1be32cfd9fa5b3a423211f11bed67d1">ratbag_led_mode</a></dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__led.html#gac1a6918e0c7d94e5e2166d73ba8dfa5b" title="this function sets the LED mode. ">ratbag_led_set_mode</a> </dd></dl>
</div>
</div>
<a id="ga9836b757484e40d589bb83fe3e258a03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9836b757484e40d589bb83fe3e258a03">◆ </a></span>ratbag_led_get_type()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__led.html#gade0742d37e151927d6bc08e37e83c930">ratbag_led_type</a> ratbag_led_get_type </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structratbag__led.html">ratbag_led</a> * </td>
<td class="paramname"><em>led</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function returns the type for <a class="el" href="structratbag__led.html" title="Represents a led on the device. ">ratbag_led</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">led</td><td>A previously initialized ratbag LED </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The LED type <a class="el" href="group__led.html#gade0742d37e151927d6bc08e37e83c930">ratbag_led_type</a></dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__led.html#gac1a6918e0c7d94e5e2166d73ba8dfa5b" title="this function sets the LED mode. ">ratbag_led_set_mode</a> </dd></dl>
</div>
</div>
<a id="gaba42b8fbbcabb3756a7c76bf3129b028"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaba42b8fbbcabb3756a7c76bf3129b028">◆ </a></span>ratbag_led_ref()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structratbag__led.html">ratbag_led</a>* ratbag_led_ref </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structratbag__led.html">ratbag_led</a> * </td>
<td class="paramname"><em>led</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a reference to the led. </p>
<p>A led is destroyed whenever the reference count reaches 0. See <a class="el" href="group__led.html#gab5cd5a96754b67cd3bc542cb5775d260">ratbag_led_unref</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">led</td><td>A previously initialized valid ratbag led </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The passed ratbag led </dd></dl>
</div>
</div>
<a id="ga1b4f360abe5a0617b26dd47d22a582f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1b4f360abe5a0617b26dd47d22a582f9">◆ </a></span>ratbag_led_set_brightness()</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_led_set_brightness </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structratbag__led.html">ratbag_led</a> * </td>
<td class="paramname"><em>led</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>brightness</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>If the LED's mode is <a class="el" href="group__led.html#ggad1be32cfd9fa5b3a423211f11bed67d1a1118650e587ec5fac6ae4969b318e640">RATBAG_LED_CYCLE</a> or <a class="el" href="group__led.html#ggad1be32cfd9fa5b3a423211f11bed67d1a77a9df31393082ff27cee3361551c26f">RATBAG_LED_BREATHING</a> then this function sets the LED brightness, otherwise it has no effect. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">led</td><td>A previously initialized ratbag LED </td></tr>
<tr><td class="paramname">brightness</td><td>Effect brightness 0 - 255 </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code otherwise.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__led.html#gaf0ab94fd921904e83758dc6c0c60d94d" title="This function returns the LED brightness. ">ratbag_led_get_brightness</a> </dd></dl>
</div>
</div>
<a id="gaed6c3fd08b50338c852f9e2271bdf19d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaed6c3fd08b50338c852f9e2271bdf19d">◆ </a></span>ratbag_led_set_color()</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_led_set_color </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structratbag__led.html">ratbag_led</a> * </td>
<td class="paramname"><em>led</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structratbag__color.html">ratbag_color</a> </td>
<td class="paramname"><em>color</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>If the LED's mode is <a class="el" href="group__led.html#ggad1be32cfd9fa5b3a423211f11bed67d1a4ad514c9f66e6de6261b849f2c7bc47f">RATBAG_LED_ON</a> or <a class="el" href="group__led.html#ggad1be32cfd9fa5b3a423211f11bed67d1a77a9df31393082ff27cee3361551c26f">RATBAG_LED_BREATHING</a> then this function sets the LED color, otherwise it has no effect. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">led</td><td>A previously initialized ratbag LED </td></tr>
<tr><td class="paramname">color</td><td>A LED color. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code otherwise.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__led.html#gaec2018afcd26bb31ca12ac9e8f995d47" title="This function returns the led color. ">ratbag_led_get_color</a> </dd></dl>
</div>
</div>
<a id="ga5c0777440a1b33e864f6513ea8ddbb2e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5c0777440a1b33e864f6513ea8ddbb2e">◆ </a></span>ratbag_led_set_effect_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_led_set_effect_rate </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structratbag__led.html">ratbag_led</a> * </td>
<td class="paramname"><em>led</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>rate</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>If the LED's mode is <a class="el" href="group__led.html#ggad1be32cfd9fa5b3a423211f11bed67d1a1118650e587ec5fac6ae4969b318e640">RATBAG_LED_CYCLE</a> or <a class="el" href="group__led.html#ggad1be32cfd9fa5b3a423211f11bed67d1a77a9df31393082ff27cee3361551c26f">RATBAG_LED_BREATHING</a> then this function sets the LED rate in Hz. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">led</td><td>A previously initialized ratbag LED </td></tr>
<tr><td class="paramname">rate</td><td>Effect rate in hz, 100 - 20000 </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code otherwise.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__led.html#gaa8c8047c8ad6b476dc25ed24d4e50e89" title="This function returns the LED effect rate. ">ratbag_led_get_effect_rate</a> </dd></dl>
</div>
</div>
<a id="gac1a6918e0c7d94e5e2166d73ba8dfa5b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac1a6918e0c7d94e5e2166d73ba8dfa5b">◆ </a></span>ratbag_led_set_mode()</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_led_set_mode </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structratbag__led.html">ratbag_led</a> * </td>
<td class="paramname"><em>led</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="group__led.html#gad1be32cfd9fa5b3a423211f11bed67d1">ratbag_led_mode</a> </td>
<td class="paramname"><em>mode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>this function sets the LED mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">led</td><td>A previously initialized ratbag LED </td></tr>
<tr><td class="paramname">mode</td><td>LED mode <a class="el" href="group__led.html#gad1be32cfd9fa5b3a423211f11bed67d1">ratbag_led_mode</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code otherwise.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__led.html#ga38a9ce74dd1befaf1d89d8d367e7a4e3" title="This function returns the mode for ratbag_led. ">ratbag_led_get_mode</a> </dd></dl>
</div>
</div>
<a id="gab5cd5a96754b67cd3bc542cb5775d260"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab5cd5a96754b67cd3bc542cb5775d260">◆ </a></span>ratbag_led_unref()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structratbag__led.html">ratbag_led</a>* ratbag_led_unref </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structratbag__led.html">ratbag_led</a> * </td>
<td class="paramname"><em>led</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Dereference the ratbag led. </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">led</td><td>A previously initialized ratbag led </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Always NULL </dd></dl>
</div>
</div>
<a id="ga539a6d3e5721132efe001f8b6f18b801"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga539a6d3e5721132efe001f8b6f18b801">◆ </a></span>ratbag_profile_get_led()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structratbag__led.html">ratbag_led</a>* ratbag_profile_get_led </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structratbag__profile.html">ratbag_profile</a> * </td>
<td class="paramname"><em>profile</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>index</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a reference to the LED given by the index. </p>
<p>The order of the LEDs is device-specific though.</p>
<p>The LED is refcounted with an initial value of at least 1. Use <a class="el" href="group__led.html#gab5cd5a96754b67cd3bc542cb5775d260" title="Dereference the ratbag led. ">ratbag_led_unref()</a> to release the LED.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">profile</td><td>A previously initialized ratbag profile </td></tr>
<tr><td class="paramname">index</td><td>The index of the LED</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A LED context, or NULL if the LED does not exist.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__profile.html#ga7678b274a5307f764fe829849c313088" title="This function creates if necessary and returns a profile for the given index. ">ratbag_device_get_profile</a> </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>
|