/usr/share/doc/libcal3d-doc/html/classCalRenderer.html is in libcal3d-doc 0.11.0-6.
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 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 | <html>
<head>
<title>CalRenderer Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table width="100%" border="0" cellspacing="0" cellpadding="5" align="center">
<tr>
<td class="md" align="center">
<small>
<b>- Cal3D 0.11 API Reference -</b>
</small>
</td>
</tr>
</table>
<br>
<!-- Generated by Doxygen 1.8.9.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classCalRenderer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CalRenderer Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa78ac07d96d5d4051c2cb522de4e0267"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#aa78ac07d96d5d4051c2cb522de4e0267">CalRenderer</a> (<a class="el" href="classCalModel.html">CalModel</a> *pModel)</td></tr>
<tr class="memdesc:aa78ac07d96d5d4051c2cb522de4e0267"><td class="mdescLeft"> </td><td class="mdescRight">Constructs the renderer instance. <a href="#aa78ac07d96d5d4051c2cb522de4e0267">More...</a><br /></td></tr>
<tr class="separator:aa78ac07d96d5d4051c2cb522de4e0267"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b04fc61c87debc6b62c56289d1880dd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#a6b04fc61c87debc6b62c56289d1880dd">CalRenderer</a> (<a class="el" href="classCalRenderer.html">CalRenderer</a> *pRenderer)</td></tr>
<tr class="memdesc:a6b04fc61c87debc6b62c56289d1880dd"><td class="mdescLeft"> </td><td class="mdescRight">Copy-constructor for the renderer instance. <a href="#a6b04fc61c87debc6b62c56289d1880dd">More...</a><br /></td></tr>
<tr class="separator:a6b04fc61c87debc6b62c56289d1880dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad3d149bdc55ef5891b9e643b0e3d51ab"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#ad3d149bdc55ef5891b9e643b0e3d51ab">beginRendering</a> ()</td></tr>
<tr class="memdesc:ad3d149bdc55ef5891b9e643b0e3d51ab"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the rendering query phase. <a href="#ad3d149bdc55ef5891b9e643b0e3d51ab">More...</a><br /></td></tr>
<tr class="separator:ad3d149bdc55ef5891b9e643b0e3d51ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a044ed875bcfcb8cd010e2fdeb7c36e5c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#a044ed875bcfcb8cd010e2fdeb7c36e5c">endRendering</a> ()</td></tr>
<tr class="memdesc:a044ed875bcfcb8cd010e2fdeb7c36e5c"><td class="mdescLeft"> </td><td class="mdescRight">Finishes the rendering query phase. <a href="#a044ed875bcfcb8cd010e2fdeb7c36e5c">More...</a><br /></td></tr>
<tr class="separator:a044ed875bcfcb8cd010e2fdeb7c36e5c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a489d8bd747e8169986788e354aa843c9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#a489d8bd747e8169986788e354aa843c9">getAmbientColor</a> (unsigned char *pColorBuffer)</td></tr>
<tr class="memdesc:a489d8bd747e8169986788e354aa843c9"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the ambient color. <a href="#a489d8bd747e8169986788e354aa843c9">More...</a><br /></td></tr>
<tr class="separator:a489d8bd747e8169986788e354aa843c9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae9f4078253ec34f0c058dd6e42bfc5e0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#ae9f4078253ec34f0c058dd6e42bfc5e0">getDiffuseColor</a> (unsigned char *pColorBuffer)</td></tr>
<tr class="memdesc:ae9f4078253ec34f0c058dd6e42bfc5e0"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the diffuse color. <a href="#ae9f4078253ec34f0c058dd6e42bfc5e0">More...</a><br /></td></tr>
<tr class="separator:ae9f4078253ec34f0c058dd6e42bfc5e0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acfd31b7550f4b249b3d45d4fcb163157"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#acfd31b7550f4b249b3d45d4fcb163157">getFaceCount</a> ()</td></tr>
<tr class="memdesc:acfd31b7550f4b249b3d45d4fcb163157"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of faces. <a href="#acfd31b7550f4b249b3d45d4fcb163157">More...</a><br /></td></tr>
<tr class="separator:acfd31b7550f4b249b3d45d4fcb163157"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a02ac0eb4d493105b6909c99b930121d7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#a02ac0eb4d493105b6909c99b930121d7">getFaces</a> (CalIndex *pFaceBuffer)</td></tr>
<tr class="memdesc:a02ac0eb4d493105b6909c99b930121d7"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the face data. <a href="#a02ac0eb4d493105b6909c99b930121d7">More...</a><br /></td></tr>
<tr class="separator:a02ac0eb4d493105b6909c99b930121d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0f75fd9dd63f0e788d3d8abc27d960fc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#a0f75fd9dd63f0e788d3d8abc27d960fc">getMapCount</a> ()</td></tr>
<tr class="memdesc:a0f75fd9dd63f0e788d3d8abc27d960fc"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of maps. <a href="#a0f75fd9dd63f0e788d3d8abc27d960fc">More...</a><br /></td></tr>
<tr class="separator:a0f75fd9dd63f0e788d3d8abc27d960fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae1f5c03a210f5473137a388d49a161ad"><td class="memItemLeft" align="right" valign="top">Cal::UserData </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#ae1f5c03a210f5473137a388d49a161ad">getMapUserData</a> (int mapId)</td></tr>
<tr class="memdesc:ae1f5c03a210f5473137a388d49a161ad"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to a specified map user data. <a href="#ae1f5c03a210f5473137a388d49a161ad">More...</a><br /></td></tr>
<tr class="separator:ae1f5c03a210f5473137a388d49a161ad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac992b85a611724351cb5d1c02e7a7920"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#ac992b85a611724351cb5d1c02e7a7920">getMeshCount</a> ()</td></tr>
<tr class="memdesc:ac992b85a611724351cb5d1c02e7a7920"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of attached meshes. <a href="#ac992b85a611724351cb5d1c02e7a7920">More...</a><br /></td></tr>
<tr class="separator:ac992b85a611724351cb5d1c02e7a7920"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a264e0f4b518e6e0e551c5e582f803728"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#a264e0f4b518e6e0e551c5e582f803728">getNormals</a> (float *pNormalBuffer, int stride=0)</td></tr>
<tr class="memdesc:a264e0f4b518e6e0e551c5e582f803728"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the normal data. <a href="#a264e0f4b518e6e0e551c5e582f803728">More...</a><br /></td></tr>
<tr class="separator:a264e0f4b518e6e0e551c5e582f803728"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab013d95f90c0475eb89981b487774a30"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#ab013d95f90c0475eb89981b487774a30">getShininess</a> ()</td></tr>
<tr class="memdesc:ab013d95f90c0475eb89981b487774a30"><td class="mdescLeft"> </td><td class="mdescRight">Returns the shininess factor. <a href="#ab013d95f90c0475eb89981b487774a30">More...</a><br /></td></tr>
<tr class="separator:ab013d95f90c0475eb89981b487774a30"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a269d35a0e36dbab40b3eb81b1102d687"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#a269d35a0e36dbab40b3eb81b1102d687">getSpecularColor</a> (unsigned char *pColorBuffer)</td></tr>
<tr class="memdesc:a269d35a0e36dbab40b3eb81b1102d687"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the specular color. <a href="#a269d35a0e36dbab40b3eb81b1102d687">More...</a><br /></td></tr>
<tr class="separator:a269d35a0e36dbab40b3eb81b1102d687"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa75bc37a240c536f3467c4280e9a3fed"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#aa75bc37a240c536f3467c4280e9a3fed">getSubmeshCount</a> (int meshId)</td></tr>
<tr class="memdesc:aa75bc37a240c536f3467c4280e9a3fed"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of submeshes. <a href="#aa75bc37a240c536f3467c4280e9a3fed">More...</a><br /></td></tr>
<tr class="separator:aa75bc37a240c536f3467c4280e9a3fed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b7bb1917049bac48d495fc124f8bfe5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#a7b7bb1917049bac48d495fc124f8bfe5">getTextureCoordinates</a> (int mapId, float *pTextureCoordinateBuffer, int stride=0)</td></tr>
<tr class="memdesc:a7b7bb1917049bac48d495fc124f8bfe5"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the texture coordinate data. <a href="#a7b7bb1917049bac48d495fc124f8bfe5">More...</a><br /></td></tr>
<tr class="separator:a7b7bb1917049bac48d495fc124f8bfe5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae7e3a1998c518ad17e9d7a4dea0e89ec"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#ae7e3a1998c518ad17e9d7a4dea0e89ec">getVertexCount</a> ()</td></tr>
<tr class="memdesc:ae7e3a1998c518ad17e9d7a4dea0e89ec"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of vertices. <a href="#ae7e3a1998c518ad17e9d7a4dea0e89ec">More...</a><br /></td></tr>
<tr class="separator:ae7e3a1998c518ad17e9d7a4dea0e89ec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a528cf5f6646954849a9ba410a4d26578"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#a528cf5f6646954849a9ba410a4d26578">getVertices</a> (float *pVertexBuffer, int stride=0)</td></tr>
<tr class="memdesc:a528cf5f6646954849a9ba410a4d26578"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the vertex data. <a href="#a528cf5f6646954849a9ba410a4d26578">More...</a><br /></td></tr>
<tr class="separator:a528cf5f6646954849a9ba410a4d26578"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adef90b4961037ef84de16163fef1eb75"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#adef90b4961037ef84de16163fef1eb75">getTangentSpaces</a> (int mapId, float *pTangentSpaceBuffer, int stride=0)</td></tr>
<tr class="memdesc:adef90b4961037ef84de16163fef1eb75"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the tangent space data. <a href="#adef90b4961037ef84de16163fef1eb75">More...</a><br /></td></tr>
<tr class="separator:adef90b4961037ef84de16163fef1eb75"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a5bbe6f436ca8fdd250dad94e466166"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#a0a5bbe6f436ca8fdd250dad94e466166">getVerticesAndNormals</a> (float *pVertexBuffer, int stride=0)</td></tr>
<tr class="memdesc:a0a5bbe6f436ca8fdd250dad94e466166"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the submesh data. <a href="#a0a5bbe6f436ca8fdd250dad94e466166">More...</a><br /></td></tr>
<tr class="separator:a0a5bbe6f436ca8fdd250dad94e466166"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a66959d79e408c494844f782d6b44230f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#a66959d79e408c494844f782d6b44230f">getVerticesNormalsAndTexCoords</a> (float *pVertexBuffer, int NumTexCoords=1)</td></tr>
<tr class="memdesc:a66959d79e408c494844f782d6b44230f"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the submesh data. <a href="#a66959d79e408c494844f782d6b44230f">More...</a><br /></td></tr>
<tr class="separator:a66959d79e408c494844f782d6b44230f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acb840ece54d3daf934ac393ca360041f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#acb840ece54d3daf934ac393ca360041f">isTangentsEnabled</a> (int mapId)</td></tr>
<tr class="memdesc:acb840ece54d3daf934ac393ca360041f"><td class="mdescLeft"> </td><td class="mdescRight">Returns if tangent are enabled. <a href="#acb840ece54d3daf934ac393ca360041f">More...</a><br /></td></tr>
<tr class="separator:acb840ece54d3daf934ac393ca360041f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad6e008adb4c63863076a3baf1934ba02"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#ad6e008adb4c63863076a3baf1934ba02">selectMeshSubmesh</a> (int meshId, int submeshId)</td></tr>
<tr class="memdesc:ad6e008adb4c63863076a3baf1934ba02"><td class="mdescLeft"> </td><td class="mdescRight">Selects a mesh/submesh for rendering data queries. <a href="#ad6e008adb4c63863076a3baf1934ba02">More...</a><br /></td></tr>
<tr class="separator:ad6e008adb4c63863076a3baf1934ba02"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaf319142738931b75685e9c7d07385ee"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#aaf319142738931b75685e9c7d07385ee">setNormalization</a> (bool normalize)</td></tr>
<tr class="memdesc:aaf319142738931b75685e9c7d07385ee"><td class="mdescLeft"> </td><td class="mdescRight">Sets the normalization flag to true or false. <a href="#aaf319142738931b75685e9c7d07385ee">More...</a><br /></td></tr>
<tr class="separator:aaf319142738931b75685e9c7d07385ee"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa78ac07d96d5d4051c2cb522de4e0267"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CalRenderer::CalRenderer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCalModel.html">CalModel</a> * </td>
<td class="paramname"><em>pModel</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs the renderer instance. </p>
<p>This function is the default constructor of the renderer instance. </p>
</div>
</div>
<a class="anchor" id="a6b04fc61c87debc6b62c56289d1880dd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CalRenderer::CalRenderer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCalRenderer.html">CalRenderer</a> * </td>
<td class="paramname"><em>pRenderer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy-constructor for the renderer instance. </p>
<p>This function is the copy constructor of the renderer instance. This is useful for multi-pipe parallel rendering. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ad3d149bdc55ef5891b9e643b0e3d51ab"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CalRenderer::beginRendering </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes the rendering query phase. </p>
<p>This function initializes the rendering query phase. It must be called before any rendering queries are executed. </p>
</div>
</div>
<a class="anchor" id="a044ed875bcfcb8cd010e2fdeb7c36e5c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalRenderer::endRendering </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Finishes the rendering query phase. </p>
<p>This function finishes the rendering query phase. It must be called after all rendering queries have been executed. </p>
</div>
</div>
<a class="anchor" id="a489d8bd747e8169986788e354aa843c9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalRenderer::getAmbientColor </td>
<td>(</td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>pColorBuffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the ambient color. </p>
<p>This function returns the ambient color of the material of the selected mesh/submesh.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pColorBuffer</td><td>A pointer to the user-provided buffer where the color data is written to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae9f4078253ec34f0c058dd6e42bfc5e0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalRenderer::getDiffuseColor </td>
<td>(</td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>pColorBuffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the diffuse color. </p>
<p>This function returns the diffuse color of the material of the selected mesh/submesh.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pColorBuffer</td><td>A pointer to the user-provided buffer where the color data is written to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="acfd31b7550f4b249b3d45d4fcb163157"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalRenderer::getFaceCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of faces. </p>
<p>This function returns the number of faces in the selected mesh/submesh.</p>
<dl class="section return"><dt>Returns</dt><dd>The number of faces. </dd></dl>
</div>
</div>
<a class="anchor" id="a02ac0eb4d493105b6909c99b930121d7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalRenderer::getFaces </td>
<td>(</td>
<td class="paramtype">CalIndex * </td>
<td class="paramname"><em>pFaceBuffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the face data. </p>
<p>This function returns the face data (vertex indices) of the selected mesh/submesh. The LOD setting is taken into account.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pFaceBuffer</td><td>A pointer to the user-provided buffer where the face data is written to.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of faces written to the buffer. </dd></dl>
</div>
</div>
<a class="anchor" id="a0f75fd9dd63f0e788d3d8abc27d960fc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalRenderer::getMapCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of maps. </p>
<p>This function returns the number of maps in the selected mesh/submesh.</p>
<dl class="section return"><dt>Returns</dt><dd>The number of maps. </dd></dl>
</div>
</div>
<a class="anchor" id="ae1f5c03a210f5473137a388d49a161ad"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Cal::UserData CalRenderer::getMapUserData </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>mapId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to a specified map user data. </p>
<p>This function returns the user data stored in the specified map of the material of the selected mesh/submesh.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mapId</td><td>The ID of the map.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>One of the following values: <ul>
<li>the user data stored in the specified map </li>
<li><b>0</b> if an error happend </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="ac992b85a611724351cb5d1c02e7a7920"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalRenderer::getMeshCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of attached meshes. </p>
<p>This function returns the number of meshes attached to the renderer instance.</p>
<dl class="section return"><dt>Returns</dt><dd>The number of attached meshes. </dd></dl>
</div>
</div>
<a class="anchor" id="a264e0f4b518e6e0e551c5e582f803728"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalRenderer::getNormals </td>
<td>(</td>
<td class="paramtype">float * </td>
<td class="paramname"><em>pNormalBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>stride</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the normal data. </p>
<p>This function returns the normal data of the selected mesh/submesh.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pNormalBuffer</td><td>A pointer to the user-provided buffer where the normal data is written to.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of normals written to the buffer. </dd></dl>
</div>
</div>
<a class="anchor" id="ab013d95f90c0475eb89981b487774a30"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float CalRenderer::getShininess </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the shininess factor. </p>
<p>This function returns the shininess factor of the material of the selected mesh/submesh..</p>
<dl class="section return"><dt>Returns</dt><dd>The shininess factor. </dd></dl>
</div>
</div>
<a class="anchor" id="a269d35a0e36dbab40b3eb81b1102d687"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalRenderer::getSpecularColor </td>
<td>(</td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>pColorBuffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the specular color. </p>
<p>This function returns the specular color of the material of the selected mesh/submesh.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pColorBuffer</td><td>A pointer to the user-provided buffer where the color data is written to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa75bc37a240c536f3467c4280e9a3fed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalRenderer::getSubmeshCount </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>meshId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of submeshes. </p>
<p>This function returns the number of submeshes in a given mesh.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">meshId</td><td>The ID of the mesh for which the number of submeshes should be returned..</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of submeshes. </dd></dl>
</div>
</div>
<a class="anchor" id="adef90b4961037ef84de16163fef1eb75"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalRenderer::getTangentSpaces </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>mapId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float * </td>
<td class="paramname"><em>pTangentSpaceBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>stride</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the tangent space data. </p>
<p>This function returns the tangent space data of the selected mesh/submesh.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mapID</td><td></td></tr>
<tr><td class="paramname">pTangentSpaceBuffer</td><td>A pointer to the user-provided buffer where the normal data is written to.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of tangent space written to the buffer. </dd></dl>
</div>
</div>
<a class="anchor" id="a7b7bb1917049bac48d495fc124f8bfe5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalRenderer::getTextureCoordinates </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>mapId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float * </td>
<td class="paramname"><em>pTextureCoordinateBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>stride</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the texture coordinate data. </p>
<p>This function returns the texture coordinate data for a given map of the selected mesh/submesh.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mapId</td><td>The ID of the map to get the texture coordinate data from. </td></tr>
<tr><td class="paramname">pTextureCoordinateBuffer</td><td>A pointer to the user-provided buffer where the texture coordinate data is written to.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of texture coordinates written to the buffer. </dd></dl>
</div>
</div>
<a class="anchor" id="ae7e3a1998c518ad17e9d7a4dea0e89ec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalRenderer::getVertexCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of vertices. </p>
<p>This function returns the number of vertices in the selected mesh/submesh.</p>
<dl class="section return"><dt>Returns</dt><dd>The number of vertices. </dd></dl>
</div>
</div>
<a class="anchor" id="a528cf5f6646954849a9ba410a4d26578"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalRenderer::getVertices </td>
<td>(</td>
<td class="paramtype">float * </td>
<td class="paramname"><em>pVertexBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>stride</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the vertex data. </p>
<p>This function returns the vertex data of the selected mesh/submesh.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pVertexBuffer</td><td>A pointer to the user-provided buffer where the vertex data is written to.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of vertices written to the buffer. </dd></dl>
</div>
</div>
<a class="anchor" id="a0a5bbe6f436ca8fdd250dad94e466166"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalRenderer::getVerticesAndNormals </td>
<td>(</td>
<td class="paramtype">float * </td>
<td class="paramname"><em>pVertexBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>stride</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the submesh data. </p>
<p>This function returns the vertex and normal data of the selected mesh/submesh.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pVertexBuffer</td><td>A pointer to the user-provided buffer where the vertex and normal data is written to.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of vertex written to the buffer. </dd></dl>
</div>
</div>
<a class="anchor" id="a66959d79e408c494844f782d6b44230f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalRenderer::getVerticesNormalsAndTexCoords </td>
<td>(</td>
<td class="paramtype">float * </td>
<td class="paramname"><em>pVertexBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>NumTexCoords</em> = <code>1</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the submesh data. </p>
<p>This function returns the vertex and normal data of the selected mesh/submesh.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pVertexBuffer</td><td>A pointer to the user-provided buffer where the vertex and normal data is written to.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of vertex written to the buffer. </dd></dl>
</div>
</div>
<a class="anchor" id="acb840ece54d3daf934ac393ca360041f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CalRenderer::isTangentsEnabled </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>mapId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns if tangent are enabled. </p>
<p>This function returns if tangent of the current submesh are enabled</p>
<dl class="section return"><dt>Returns</dt><dd>True is tangent is enabled. </dd></dl>
</div>
</div>
<a class="anchor" id="ad6e008adb4c63863076a3baf1934ba02"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CalRenderer::selectMeshSubmesh </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>meshId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>submeshId</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Selects a mesh/submesh for rendering data queries. </p>
<p>This function selects a mesh/submesh for further rendering data queries.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">meshId</td><td>The ID of the mesh that should be used for further rendering data queries. </td></tr>
<tr><td class="paramname">submeshId</td><td>The ID of the submesh that should be used for further rendering data queries.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>One of the following values: <ul>
<li><b>true</b> if successful </li>
<li><b>false</b> if an error happend </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="aaf319142738931b75685e9c7d07385ee"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalRenderer::setNormalization </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>normalize</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the normalization flag to true or false. </p>
<p>This function sets the normalization flag on or off. If off, the normals calculated by Cal3D will not be normalized. Instead, this transform is left up to the user. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="renderer_8h_source.html">renderer.h</a></li>
<li>renderer.cpp</li>
</ul>
</div><!-- contents -->
<hr>
<center>
<small>
Generated by
<a href="http://gna.org/projects/cal3d/">The Cal3D Team</a>
with
<a href="http://www.doxygen.org/index.html">
Doxygen 1.8.9.1
</a>
</small>
</center>
</body>
</html>
|