1/* 2 * Copyright 2020 Haiku, Inc. All rights reserved. 3 * Distributed under the terms of the MIT License. 4 * 5 * Authors: 6 * Name, email@email.com 7 * 8 * Corresponds to: 9 * headers/os/interface/Gradient.h hrev54502 10 * src/kits/interface/Gradient.cpp hrev54502 11 */ 12 13 14//! \cond INTERNAL 15 16 17/*! 18 \file Gradient.h 19 \ingroup interface 20 \brief Undocumented file. 21 22 \since Haiku R1 23*/ 24 25 26/*! 27 \class BGradient 28 \ingroup interface 29 \ingroup libbe 30 \brief Undocumented class. 31 32 \since Haiku R1 33*/ 34 35 36/*! 37 \struct BGradient::ColorStop 38 \brief Undocumented class. 39 40 \since Haiku R1 41*/ 42 43 44/*! 45 \var rgb_color BGradient::ColorStop::color 46 \brief Undocumented public variable 47 48 \since Haiku R1 49*/ 50 51 52/*! 53 \var float BGradient::ColorStop::offset 54 \brief Undocumented public variable 55 56 \since Haiku R1 57*/ 58 59 60/*! 61 \fn BGradient::ColorStop::ColorStop() 62 \brief Undocumented public method 63 64 \return Undocumented 65 \retval <value> Undocumented 66 67 \since Haiku R1 68*/ 69 70 71/*! 72 \fn BGradient::ColorStop::ColorStop(const ColorStop &other) 73 \brief Undocumented public method 74 75 \param other Undocumented 76 77 \return Undocumented 78 \retval <value> Undocumented 79 80 \since Haiku R1 81*/ 82 83 84/*! 85 \fn BGradient::ColorStop::ColorStop(const rgb_color c, float o) 86 \brief Undocumented public method 87 88 \param c Undocumented 89 \param o Undocumented 90 91 \return Undocumented 92 \retval <value> Undocumented 93 94 \since Haiku R1 95*/ 96 97 98/*! 99 \fn BGradient::ColorStop::ColorStop(uint8 r, uint8 g, uint8 b, uint8 a, 100 float o) 101 \brief Undocumented public method 102 103 \param r Undocumented 104 \param g Undocumented 105 \param b Undocumented 106 \param a Undocumented 107 \param o Undocumented 108 109 \return Undocumented 110 \retval <value> Undocumented 111 112 \since Haiku R1 113*/ 114 115 116/*! 117 \fn bool BGradient::ColorStop::operator!=(const ColorStop &other) const 118 \brief Undocumented public method 119 120 \param other Undocumented 121 122 \return Undocumented 123 \retval <value> Undocumented 124 125 \since Haiku R1 126*/ 127 128 129/*! 130 \enum BGradient::Type 131 \brief Undocumented enum. 132 133 \since Haiku R1 134*/ 135 136 137/*! 138 \var Type BGradient::TYPE_LINEAR 139 \brief Undocumented enum value. 140 141 \since Haiku R1 142*/ 143 144 145/*! 146 \var Type BGradient::TYPE_RADIAL 147 \brief Undocumented enum value. 148 149 \since Haiku R1 150*/ 151 152 153/*! 154 \var Type BGradient::TYPE_RADIAL_FOCUS 155 \brief Undocumented enum value. 156 157 \since Haiku R1 158*/ 159 160 161/*! 162 \var Type BGradient::TYPE_DIAMOND 163 \brief Undocumented enum value. 164 165 \since Haiku R1 166*/ 167 168 169/*! 170 \var Type BGradient::TYPE_CONIC 171 \brief Undocumented enum value. 172 173 \since Haiku R1 174*/ 175 176 177/*! 178 \var Type BGradient::TYPE_NONE 179 \brief Undocumented enum value. 180 181 \since Haiku R1 182*/ 183 184 185/*! 186 \fn BGradient::BGradient() 187 \brief Undocumented public method 188 189 \return Undocumented 190 \retval <value> Undocumented 191 192 \since Haiku R1 193*/ 194 195 196/*! 197 \fn BGradient::BGradient(BMessage *archive) 198 \brief Undocumented public method 199 200 \param archive Undocumented 201 202 \return Undocumented 203 \retval <value> Undocumented 204 205 \since Haiku R1 206*/ 207 208 209/*! 210 \fn BGradient::BGradient(const BGradient &other) 211 \brief Undocumented public method 212 213 \param other Undocumented 214 215 \return Undocumented 216 \retval <value> Undocumented 217 218 \since Haiku R1 219*/ 220 221 222/*! 223 \fn virtual BGradient::~BGradient() 224 \brief Undocumented public method 225 226 \return Undocumented 227 \retval <value> Undocumented 228 229 \since Haiku R1 230*/ 231 232 233/*! 234 \fn int32 BGradient::AddColor(const rgb_color &color, float offset) 235 \brief Undocumented public method 236 237 \param color Undocumented 238 \param offset Undocumented 239 240 \return Undocumented 241 \retval <value> Undocumented 242 243 \since Haiku R1 244*/ 245 246 247/*! 248 \fn bool BGradient::AddColorStop(const ColorStop &colorStop, int32 index) 249 \brief Undocumented public method 250 251 \param colorStop Undocumented 252 \param index Undocumented 253 254 \return Undocumented 255 \retval <value> Undocumented 256 257 \since Haiku R1 258*/ 259 260 261/*! 262 \fn virtual status_t BGradient::Archive(BMessage *into, 263 bool deep=true) const 264 \brief Undocumented public method 265 266 \param into Undocumented 267 \param deep Undocumented 268 269 \return Undocumented 270 \retval <value> Undocumented 271 272 \since Haiku R1 273*/ 274 275 276/*! 277 \fn ColorStop* BGradient::ColorStopAt(int32 index) const 278 \brief Undocumented public method 279 280 \param index Undocumented 281 282 \return Undocumented 283 \retval <value> Undocumented 284 285 \since Haiku R1 286*/ 287 288 289/*! 290 \fn ColorStop* BGradient::ColorStopAtFast(int32 index) const 291 \brief Undocumented public method 292 293 \param index Undocumented 294 295 \return Undocumented 296 \retval <value> Undocumented 297 298 \since Haiku R1 299*/ 300 301 302/*! 303 \fn ColorStop* BGradient::ColorStops() const 304 \brief Undocumented public method 305 306 \return Undocumented 307 \retval <value> Undocumented 308 309 \since Haiku R1 310*/ 311 312 313/*! 314 \fn bool BGradient::ColorStopsAreEqual(const BGradient &other) const 315 \brief Undocumented public method 316 317 \param other Undocumented 318 319 \return Undocumented 320 \retval <value> Undocumented 321 322 \since Haiku R1 323*/ 324 325 326/*! 327 \fn int32 BGradient::CountColorStops() const 328 \brief Undocumented public method 329 330 \return Undocumented 331 \retval <value> Undocumented 332 333 \since Haiku R1 334*/ 335 336 337/*! 338 \fn status_t BGradient::Flatten(BDataIO *stream) const 339 \brief Undocumented public method 340 341 \param stream Undocumented 342 343 \return Undocumented 344 \retval <value> Undocumented 345 346 \since Haiku R1 347*/ 348 349 350/*! 351 \fn Type BGradient::GetType() const 352 \brief Undocumented public method 353 354 \return Undocumented 355 \retval <value> Undocumented 356 357 \since Haiku R1 358*/ 359 360 361/*! 362 \fn void BGradient::MakeEmpty() 363 \brief Undocumented public method 364 365 \since Haiku R1 366*/ 367 368 369/*! 370 \fn bool BGradient::operator!=(const BGradient &other) const 371 \brief Undocumented public method 372 373 \param other Undocumented 374 375 \return Undocumented 376 \retval <value> Undocumented 377 378 \since Haiku R1 379*/ 380 381 382/*! 383 \fn BGradient& BGradient::operator=(const BGradient &other) 384 \brief Undocumented public method 385 386 \param other Undocumented 387 388 \return Undocumented 389 \retval <value> Undocumented 390 391 \since Haiku R1 392*/ 393 394 395/*! 396 \fn bool BGradient::operator==(const BGradient &other) const 397 \brief Undocumented public method 398 399 \param other Undocumented 400 401 \return Undocumented 402 \retval <value> Undocumented 403 404 \since Haiku R1 405*/ 406 407 408/*! 409 \fn bool BGradient::RemoveColor(int32 index) 410 \brief Undocumented public method 411 412 \param index Undocumented 413 414 \return Undocumented 415 \retval <value> Undocumented 416 417 \since Haiku R1 418*/ 419 420 421/*! 422 \fn bool BGradient::SetColor(int32 index, const rgb_color &color) 423 \brief Undocumented public method 424 425 \param index Undocumented 426 \param color Undocumented 427 428 \return Undocumented 429 \retval <value> Undocumented 430 431 \since Haiku R1 432*/ 433 434 435/*! 436 \fn bool BGradient::SetColorStop(int32 index, const ColorStop &colorStop) 437 \brief Undocumented public method 438 439 \param index Undocumented 440 \param colorStop Undocumented 441 442 \return Undocumented 443 \retval <value> Undocumented 444 445 \since Haiku R1 446*/ 447 448 449/*! 450 \fn void BGradient::SetColorStops(const BGradient &other) 451 \brief Undocumented public method 452 453 \param other Undocumented 454 455 \since Haiku R1 456*/ 457 458 459/*! 460 \fn bool BGradient::SetOffset(int32 index, float offset) 461 \brief Undocumented public method 462 463 \param index Undocumented 464 \param offset Undocumented 465 466 \return Undocumented 467 \retval <value> Undocumented 468 469 \since Haiku R1 470*/ 471 472 473/*! 474 \fn void BGradient::SortColorStopsByOffset() 475 \brief Undocumented public method 476 477 \since Haiku R1 478*/ 479 480 481/*! 482 \fn static status_t BGradient::Unflatten(BGradient *&output, 483 BDataIO *stream) 484 \brief Undocumented public method 485 486 \param output Undocumented 487 \param stream Undocumented 488 489 \return Undocumented 490 \retval <value> Undocumented 491 492 \since Haiku R1 493*/ 494 495 496/*! 497 \struct BGradient::ColorStop 498 \ingroup <group name> 499 \ingroup libbe 500 \brief Undocumented class. 501 502 \since Haiku R1 503*/ 504 505 506/*! 507 \var rgb_color BGradient::ColorStop::color 508 \brief Undocumented public variable 509 510 \since Haiku R1 511*/ 512 513 514/*! 515 \var float BGradient::ColorStop::offset 516 \brief Undocumented public variable 517 518 \since Haiku R1 519*/ 520 521 522/*! 523 \fn BGradient::ColorStop::ColorStop() 524 \brief Undocumented public method 525 526 \return Undocumented 527 \retval <value> Undocumented 528 529 \since Haiku R1 530*/ 531 532 533/*! 534 \fn BGradient::ColorStop::ColorStop(const ColorStop &other) 535 \brief Undocumented public method 536 537 \param other Undocumented 538 539 \return Undocumented 540 \retval <value> Undocumented 541 542 \since Haiku R1 543*/ 544 545 546/*! 547 \fn BGradient::ColorStop::ColorStop(const rgb_color c, float o) 548 \brief Undocumented public method 549 550 \param c Undocumented 551 \param o Undocumented 552 553 \return Undocumented 554 \retval <value> Undocumented 555 556 \since Haiku R1 557*/ 558 559 560/*! 561 \fn BGradient::ColorStop::ColorStop(uint8 r, uint8 g, uint8 b, uint8 a, 562 float o) 563 \brief Undocumented public method 564 565 \param r Undocumented 566 \param g Undocumented 567 \param b Undocumented 568 \param a Undocumented 569 \param o Undocumented 570 571 \return Undocumented 572 \retval <value> Undocumented 573 574 \since Haiku R1 575*/ 576 577 578/*! 579 \fn bool BGradient::ColorStop::operator!=(const ColorStop &other) const 580 \brief Undocumented public method 581 582 \param other Undocumented 583 584 \return Undocumented 585 \retval <value> Undocumented 586 587 \since Haiku R1 588*/ 589 590 591//! \endcond INTERNAL 592