(C) Zeriph Enterprises, LLC
omni/drawing/color.hpp
001:
002:
003:
004:
005:
006:
007:
008:
009:
010:
011:
012:
013:
014:
015:
016:
017:
018:
019:
020:
021:
022:
023:
024:
025:
026:
027:
028:
029:
030:
031:
032:
033:
034:
035:
036:
037:
038:
039:
040:
041:
042:
043:
044:
045:
046:
047:
048:
049:
050:
051:
052:
053:
054:
055:
056:
057:
058:
059:
060:
061:
062:
063:
064:
065:
066:
067:
068:
069:
070:
071:
072:
073:
074:
075:
076:
077:
078:
079:
080:
081:
082:
083:
084:
085:
086:
087:
088:
089:
090:
091:
092:
093:
094:
095:
096:
097:
098:
099:
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:
775:
776:
777:
778:
779:
780:
781:
782:
783:
784:
785:
786:
787:
788:
789:
790:
791:
792:
793:
794:
795:
796:
797:
798:
799:
800:
801:
802:
803:
804:
805:
806:
807:
808:
809:
810:
811:
812:
813:
814:
815:
816:
817:
818:
819:
820:
821:
822:
823:
824:
825:
826:
827:
828:
829:
830:
831:
832:
833:
834:
835:
836:
837:
838:
839:
840:
841:
842:
843:
844:
845:
846:
847:
848:
849:
850:
851:
852:
853:
854:
855:
856:
857:
858:
859:
860:
861:
862:
863:
864:
865:
866:
867:
868:
869:
870:
871:
872:
873:
874:
875:
876:
877:
878:
879:
880:
















































































































































































































































































































































































































































































































































































































































































































































































































































































































/*
* Copyright (c), Zeriph Enterprises
* All rights reserved.
*
* Contributor(s):
* Zechariah Perez, omni (at) zeriph (dot) com
*
* THIS SOFTWARE IS PROVIDED BY ZERIPH AND CONTRIBUTORS "AS IS" AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL ZERIPH AND CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
 #if !defined(OMNI_COLOR_HPP)
#define OMNI_COLOR_HPP 1
#include <omni/defs/global.hpp>
#include <omni/defs/class_macros.hpp>

#if defined(OMNI_SAFE_COLOR)
    #include <omni/sync/basic_lock.hpp>
    #define OMNI_SAFE_CLRDMTX_FW ,m_mtx()
    #define OMNI_SAFE_CLRLOCK_FW this->m_mtx.lock();
    #define OMNI_SAFE_CLRUNLOCK_FW this->m_mtx.unlock();
    #define OMNI_SAFE_CLRALOCK_FW omni::sync::scoped_basic_lock uuid12345(&this->m_mtx);
    #define OMNI_SAFE_CLROALOCK_FW(o) omni::sync::scoped_basic_lock uuid54321(&o.m_mtx);
#else
    #define OMNI_SAFE_CLRDMTX_FW
    #define OMNI_SAFE_CLRLOCK_FW
    #define OMNI_SAFE_CLRUNLOCK_FW
    #define OMNI_SAFE_CLRALOCK_FW
    #define OMNI_SAFE_CLROALOCK_FW(o)
#endif

namespace omni {
    namespace drawing {
        template < typename BitDepth, typename RgbType, uint8_t BitSize = sizeof(BitDepth) * CHAR_BIT >
        class color
        {
            public:
                typedef BitDepth int_t;
                typedef RgbType rgb_t;

                // gets the L of the HSL
                static float brightness(BitDepth red, BitDepth green, BitDepth blue)
                {
                    // ((max + min) / 2) / BitDepth::max
                    return
                    (
                        (
                            static_cast<float>(std::max(std::max(red, green), blue) + std::min(std::min(red, green), blue))
                            / 2.0f
                        )
                        / std::numeric_limits<BitDepth>::max()
                    );
                }

                static uint32_t bits()
                {
                    return BitSize;
                }

                static color<BitDepth, RgbType, BitSize> from_hsl(float hue, float saturation, float lightness)
                {
                    return omni::drawing::color<BitDepth, RgbType, BitSize>(hue, saturation, lightness);
                }

                static color<BitDepth, RgbType, BitSize> from_hsl(float hue, uint32_t saturation, uint32_t lightness)
                {
                    return omni::drawing::color<BitDepth, RgbType, BitSize>(hue, saturation, lightness);
                }

                static color<BitDepth, RgbType, BitSize> from_rgb(RgbType rgb)
                {
                    return omni::drawing::color<BitDepth, RgbType, BitSize>(rgb);
                }

                static color<BitDepth, RgbType, BitSize> from_argb(RgbType argb)
                {
                    return omni::drawing::color<BitDepth, RgbType, BitSize>(argb, false, false);
                }

                static color<BitDepth, RgbType, BitSize> from_rgba(RgbType rgba)
                {
                    return omni::drawing::color<BitDepth, RgbType, BitSize>(rgba, true, false);
                }

                // gets the H of the HSL (in degrees)
                static float hue(BitDepth red, BitDepth green, BitDepth blue)
                {
                    BitDepth cmax = std::max(std::max(red, green), blue);
                    BitDepth cmin = std::min(std::min(red, green), blue);
                    if (cmax == cmin) { return 0.0f; }
                    float ret = 0.0f;
                    if (cmax == red) {
                        ret = 60.0f * (std::fmod((static_cast<float>(green - blue) / (cmax - cmin)), 6.0f));
                    } else if (cmax == green) {
                        ret = 60.0f * ((static_cast<float>(blue - red) / (cmax - cmin)) + 2.0f);
                    } else if (cmax == blue) {
                        ret = 60.0f * ((static_cast<float>(red - green) / (cmax - cmin)) + 4.0f);
                    }
                    if (ret < 0.0f) { ret += 360.0f; }
                    return ret;
                }

                // gets the S of the HSL
                static float saturation(BitDepth red, BitDepth green, BitDepth blue)
                {
                    BitDepth cmax = std::max(std::max(red, green), blue);
                    BitDepth cmin = std::min(std::min(red, green), blue);
                    if (cmax == cmin) { return 0.0f; }
                    return
                        (static_cast<float>(cmax - cmin) / std::numeric_limits<BitDepth>::max())
                        /
                        (1.0f - std::fabs((static_cast<float>(cmax + cmin) / std::numeric_limits<BitDepth>::max()) - 1.0f));
                }

                static RgbType hsl_to_rgb(float hue, float saturation, float luminance)
                {
                    if ((hue > 360.0f || hue < 0.0f) ||
                        (saturation > 1.0f || saturation < 0.0f) ||
                        (luminance > 1.0f || luminance < 0.0f))
                    {
                        OMNI_ERR_RETV_FW(OMNI_ERR_RANGE_STR, omni::exceptions::invalid_range(), 0)
                    }
                    if ((hue == 0.00f) && (saturation == 0.00f) && (luminance == 0.0f)) { return 0; }
                    BitDepth nmax = std::numeric_limits<BitDepth>::max();
                    float C = (1.0f - std::fabs((2.0f * luminance) - 1.0f)) * saturation;
                    float X = C * (1.0f - std::fabs(std::fmod((hue / 60.0f), 2.0f) - 1.0f));
                    float m = luminance - C / 2.0f;
                    float tr = 0.0f;
                    float tg = 0.0f;
                    float tb = 0.0f;
                    if (hue < 120.0f) {
                        if (hue < 60.0f) {
                            tr = C;
                            tg = X;
                        } else {
                            tr = X;
                            tg = C;
                        }
                    } else if (hue < 240.0f) {
                        if (hue < 180.0f) {
                            tg = C;
                            tb = X;
                        } else {
                            tg = X;
                            tb = C;
                        }
                    } else if (hue < 360.0f) {
                        if (hue < 300.0f) {
                            tr = X;
                            tb = C;
                        } else {
                            tr = C;
                            tb = X;
                        }
                    }
                    return (
                        (static_cast<BitDepth>(::ceilf((tr + m) * nmax)) << (BitSize * 2)) ^
                        (static_cast<BitDepth>(::ceilf((tg + m) * nmax)) << BitSize) ^
                        (static_cast<BitDepth>(::ceilf((tb + m) * nmax)))
                    );
                }

                static RgbType hsl_to_rgb(float hue, uint32_t saturation, uint32_t lightness)
                {
                    return omni::drawing::color<BitDepth, RgbType, BitSize>::hsl_to_rgb(
                        hue,
                        (static_cast<float>(saturation) / 100.0f),
                        (static_cast<float>(lightness) / 100.0f)
                    );
                }

                color() :
                    OMNI_CTOR_FW(omni::drawing::color)
                    m_r(0), m_g(0), m_b(0), m_a(0), m_calc_alpha(false)
                    OMNI_SAFE_CLRDMTX_FW
                { }

                color(const omni::drawing::color<BitDepth, RgbType, BitSize>& cp) :
                    OMNI_CPCTOR_FW(cp)
                    m_r(cp.m_r), m_g(cp.m_g), m_b(cp.m_b), m_a(cp.m_a), m_calc_alpha(cp.m_calc_alpha)
                    OMNI_SAFE_CLRDMTX_FW
                { }

                color(RgbType rgb) :
                    OMNI_CTOR_FW(omni::drawing::color<T>)
                    m_r(0), m_g(0), m_b(0), m_a(std::numeric_limits<BitDepth>::max()), m_calc_alpha(false)
                    OMNI_SAFE_CLRDMTX_FW
                {
                    this->set_rgb(rgb);
                }

                color(RgbType rgb, bool calculate_alpha) :
                    OMNI_CTOR_FW(omni::drawing::color<T>)
                    m_r(0), m_g(0), m_b(0), m_a(std::numeric_limits<BitDepth>::max()), m_calc_alpha(calculate_alpha)
                    OMNI_SAFE_CLRDMTX_FW
                {
                    this->set_rgb(rgb);
                }

                color(BitDepth r, BitDepth g, BitDepth b) :
                    OMNI_CTOR_FW(omni::drawing::color)
                    m_r(r), m_g(g), m_b(b), m_a(std::numeric_limits<BitDepth>::max()), m_calc_alpha(false)
                    OMNI_SAFE_CLRDMTX_FW
                { }

                color(BitDepth r, BitDepth g, BitDepth b, bool calculate_alpha) :
                    OMNI_CTOR_FW(omni::drawing::color)
                    m_r(r), m_g(g), m_b(b), m_a(std::numeric_limits<BitDepth>::max()), m_calc_alpha(calculate_alpha)
                    OMNI_SAFE_CLRDMTX_FW
                { }

                color(BitDepth r, BitDepth g, BitDepth b, BitDepth a) :
                    OMNI_CTOR_FW(omni::drawing::color)
                    m_r(r), m_g(g), m_b(b), m_a(a), m_calc_alpha(false)
                    OMNI_SAFE_CLRDMTX_FW
                { }

                color(BitDepth r, BitDepth g, BitDepth b, BitDepth a, bool calculate_alpha) :
                    OMNI_CTOR_FW(omni::drawing::color)
                    m_r(r), m_g(g), m_b(b), m_a(a), m_calc_alpha(calculate_alpha)
                    OMNI_SAFE_CLRDMTX_FW
                { }

                color(float hue, float saturation, float lightness) :
                    OMNI_CTOR_FW(omni::drawing::color)
                    m_r(0), m_g(0), m_b(0), m_a(std::numeric_limits<BitDepth>::max()), m_calc_alpha(false)
                    OMNI_SAFE_CLRDMTX_FW
                {
                    this->set_rgb(omni::drawing::color<BitDepth, RgbType, BitSize>::hsl_to_rgb(hue, saturation, lightness));
                }

                color(float hue, uint32_t saturation, uint32_t lightness) :
                    OMNI_CTOR_FW(omni::drawing::color)
                    m_r(0), m_g(0), m_b(0), m_a(std::numeric_limits<BitDepth>::max()), m_calc_alpha(false)
                    OMNI_SAFE_CLRDMTX_FW
                {
                    this->set_rgb(omni::drawing::color<BitDepth, RgbType, BitSize>::hsl_to_rgb(hue, saturation, lightness));
                }

                ~color()
                {
                    OMNI_TRY_FW
                    OMNI_DTOR_FW
                    OMNI_CATCH_FW
                    OMNI_D5_FW("destroyed");
                }

                BitDepth r() const
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return this->m_r;
                }

                BitDepth g() const
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return this->m_g;
                }

                BitDepth b() const
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return this->m_b;
                }

                BitDepth a() const
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return this->m_a;
                }

                float alpha() const
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return static_cast<float>(this->m_a) / std::numeric_limits<BitDepth>::max();
                }

                float brightness() const
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return omni::drawing::color<BitDepth, RgbType, BitSize>::brightness(this->m_r, this->m_g, this->m_b);
                }

                float hue() const
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return omni::drawing::color<BitDepth, RgbType, BitSize>::hue(this->m_r, this->m_g, this->m_b);
                }

                float saturation() const
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return omni::drawing::color<BitDepth, RgbType, BitSize>::saturation(this->m_r, this->m_g, this->m_b);
                }

                uint32_t bit_size() const
                {
                    return BitSize;
                }

                bool calculate_alpha() const
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return this->m_calc_alpha;
                }

                BitDepth decrement_r()
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return --this->m_r;
                }

                BitDepth decrement_g()
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return --this->m_g;
                }

                BitDepth decrement_b()
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return --this->m_b;
                }

                BitDepth decrement_a()
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return --this->m_a;
                }

                BitDepth decrease_r(BitDepth val)
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return (this->m_r -= val);
                }

                BitDepth decrease_g(BitDepth val)
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return (this->m_g -= val);
                }

                BitDepth decrease_b(BitDepth val)
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return (this->m_b -= val);
                }

                BitDepth decrease_a(BitDepth val)
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return (this->m_a -= val);
                }
                
                BitDepth increment_r()
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return ++this->m_r;
                }

                BitDepth increment_g()
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return ++this->m_g;
                }

                BitDepth increment_b()
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return ++this->m_b;
                }

                BitDepth increment_a()
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return ++this->m_a;
                }

                BitDepth increase_r(BitDepth val)
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return (this->m_r += val);
                }

                BitDepth increase_g(BitDepth val)
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return (this->m_g += val);
                }

                BitDepth increase_b(BitDepth val)
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return (this->m_b += val);
                }

                BitDepth increase_a(BitDepth val)
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return (this->m_a += val);
                }

                bool empty() const
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return this->m_r == 0 &&
                         this->m_g == 0 &&
                         this->m_b == 0 &&
                         this->m_a == 0;
                }

                bool equals(BitDepth r, BitDepth g, BitDepth b) const
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return this->m_r == r &&
                         this->m_g == g &&
                         this->m_b == b;
                }

                bool equals(BitDepth r, BitDepth g, BitDepth b, BitDepth a) const
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return this->m_r == r &&
                         this->m_g == g &&
                         this->m_b == b &&
                         this->m_a == a;
                }

                void set_alpha(float alpha)
                {
                    if (alpha <= 1.00 && alpha >= 0.00) {
                        OMNI_SAFE_CLRALOCK_FW
                        this->m_a = static_cast<BitDepth>(std::numeric_limits<BitDepth>::max() * alpha);
                    } else {
                        OMNI_ERR_FW(OMNI_ERR_RANGE_STR, omni::exceptions::invalid_range())
                    }
                }

                void set_calculate_alpha(bool calc)
                {
                    OMNI_SAFE_CLRALOCK_FW
                    this->m_calc_alpha = calc;
                }

                void set_rgb(BitDepth r, BitDepth g, BitDepth b)
                {
                    OMNI_SAFE_CLRALOCK_FW
                    this->m_r = r;
                    this->m_g = g;
                    this->m_b = b;
                }

                void set_rgb(RgbType rgb)
                {
                    OMNI_SAFE_CLRALOCK_FW
                    this->m_r = static_cast<BitDepth>(rgb >> (BitSize * 2));
                    this->m_g = static_cast<BitDepth>((rgb >> BitSize) ^
                                        (static_cast<RgbType>(this->m_r) << BitSize));
                    this->m_b = static_cast<BitDepth>(rgb ^
                                        (static_cast<RgbType>(this->m_g) << BitSize) ^
                                        (static_cast<RgbType>(this->m_r) << (BitSize * 2)));
                }

                void set_rgba(BitDepth r, BitDepth g, BitDepth b, BitDepth a)
                {
                    OMNI_SAFE_CLRALOCK_FW
                    this->m_r = r;
                    this->m_g = g;
                    this->m_b = b;
                    this->m_a = a;
                }

                void set_rgba(RgbType rgba)
                {
                    OMNI_SAFE_CLRALOCK_FW
                    this->m_r = static_cast<BitDepth>(rgba >> (BitSize * 3));
                    this->m_g = static_cast<BitDepth>((rgba >> (BitSize * 2)) ^
                                        (static_cast<RgbType>(this->m_r) << BitSize));
                    this->m_b = static_cast<BitDepth>((rgba >> BitSize) ^
                                        (static_cast<RgbType>(this->m_g) << BitSize) ^
                                        (static_cast<RgbType>(this->m_r) << (BitSize * 2)));
                    this->m_a = static_cast<BitDepth>(rgba ^
                                        (static_cast<RgbType>(this->m_b) << BitSize) ^
                                        (static_cast<RgbType>(this->m_g) << (BitSize * 2)) ^
                                        (static_cast<RgbType>(this->m_r) << (BitSize * 3)));
                }

                void set_argb(RgbType argb)
                {
                    OMNI_SAFE_CLRALOCK_FW
                    this->m_a = static_cast<BitDepth>(argb >> (BitSize * 3));
                    this->m_r = static_cast<BitDepth>((argb >> (BitSize * 2)) ^
                                        (static_cast<RgbType>(this->m_a) << BitSize));
                    this->m_g = static_cast<BitDepth>((argb >> BitSize) ^
                                        (static_cast<RgbType>(this->m_r) << BitSize) ^
                                        (static_cast<RgbType>(this->m_a) << (BitSize * 2)));
                    this->m_b = static_cast<BitDepth>(argb ^
                                        (static_cast<RgbType>(this->m_g) << BitSize) ^
                                        (static_cast<RgbType>(this->m_r) << (BitSize * 2)) ^
                                        (static_cast<RgbType>(this->m_a) << (BitSize * 3)));
                }

                RgbType to_rgb() const
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return (static_cast<RgbType>(this->m_r) << (BitSize * 2)) ^
                         (static_cast<RgbType>(this->m_g) << BitSize) ^
                         static_cast<RgbType>(this->m_b);
                }

                RgbType to_rgba() const
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return (static_cast<RgbType>(this->m_r) << (BitSize * 3)) ^
                         (static_cast<RgbType>(this->m_g) << (BitSize * 2)) ^
                         (static_cast<RgbType>(this->m_b) << BitSize) ^
                         static_cast<RgbType>(this->m_a);
                }

                RgbType to_argb() const
                {
                    OMNI_SAFE_CLRALOCK_FW
                    return (static_cast<RgbType>(this->m_a) << (BitSize * 3)) ^
                         (static_cast<RgbType>(this->m_r) << (BitSize * 2)) ^
                         (static_cast<RgbType>(this->m_g) << BitSize) ^
                         static_cast<RgbType>(this->m_b);
                }

                omni::string_t to_string_t() const
                {
                    omni::sstream_t s;
                    OMNI_SAFE_CLRLOCK_FW
                    s << std::hex << "{r:" << static_cast<uint64_t>(this->m_r) <<
                                     ",g:" << static_cast<uint64_t>(this->m_g) <<
                                     ",b:" << static_cast<uint64_t>(this->m_b) <<
                                     ",a:" << this->alpha() << "}";
                    OMNI_SAFE_CLRUNLOCK_FW
                    return s.str();
                }

                const std::string to_string() const
                {
                    std::stringstream s;
                    OMNI_SAFE_CLRLOCK_FW
                    s << std::hex << "{r:" << static_cast<uint64_t>(this->m_r) <<
                                     ",g:" << static_cast<uint64_t>(this->m_g) <<
                                     ",b:" << static_cast<uint64_t>(this->m_b) <<
                                     ",a:" << this->alpha() << "}";
                    OMNI_SAFE_CLRUNLOCK_FW
                    return s.str();
                }

                const std::wstring to_wstring() const
                {
                    std::wstringstream s;
                    OMNI_SAFE_CLRLOCK_FW
                    s << std::hex << "{r:" << static_cast<uint64_t>(this->m_r) <<
                                     ",g:" << static_cast<uint64_t>(this->m_g) <<
                                     ",b:" << static_cast<uint64_t>(this->m_b) <<
                                     ",a:" << this->alpha() << "}";
                    OMNI_SAFE_CLRUNLOCK_FW
                    return s.str();
                }

                operator std::string() const { return this->to_string(); }

                operator std::wstring() const { return this->to_wstring(); }

                bool operator!=(const color<BitDepth, RgbType, BitSize>& val) const
                {
                    return !(*this == val);
                }
                
                color<BitDepth, RgbType, BitSize>& operator=(const color<BitDepth, RgbType, BitSize>& val)
                {
                    if (this != &val) {
                        OMNI_SAFE_CLRALOCK_FW
                        OMNI_SAFE_CLROALOCK_FW(val)
                        OMNI_ASSIGN_FW(val)
                        this->m_r = val.m_r;
                        this->m_g = val.m_g;
                        this->m_b = val.m_b;
                        this->m_a = val.m_a;
                    }
                    return *this;
                }

                color<BitDepth, RgbType, BitSize>& operator=(RgbType val)
                {
                    this->set_rgb(val);
                    return *this;
                }

                bool operator<(const color<BitDepth, RgbType, BitSize>& val) const
                {
                    if (this == &val) { return false; }
                    if (this->m_calc_alpha) {
                        return this->to_rgba() < val.to_rgba();
                    }
                    return this->to_rgb() < val.to_rgb();
                }

                bool operator<(RgbType val) const
                {
                    if (this->m_calc_alpha) {
                        return (this->to_rgba() < val);
                    }
                    return (this->to_rgb() < val);
                }

                bool operator>(const color<BitDepth, RgbType, BitSize>& val) const
                {
                    if (this == &val) { return false; }
                    if (this->m_calc_alpha) {
                        return this->to_rgba() > val.to_rgba();
                    }
                    return this->to_rgb() > val.to_rgb();
                }

                bool operator>(RgbType val) const
                {
                    if (this->m_calc_alpha) {
                        return (this->to_rgba() > val);
                    }
                    return (this->to_rgb() > val);
                }

                bool operator==(const color<BitDepth, RgbType, BitSize>& val) const
                {
                    if (this == &val) { return true; }
                    OMNI_SAFE_CLRALOCK_FW
                    OMNI_SAFE_CLROALOCK_FW(val)
                    return (this->m_r == val.m_r &&
                            this->m_g == val.m_g &&
                            this->m_b == val.m_b &&
                            (this->m_calc_alpha ? (this->m_a > val.m_a) : true))
                    OMNI_EQUAL_FW(val);
                }

                bool operator==(RgbType val) const
                {
                    if (this->m_calc_alpha) {
                        return (this->to_rgba() == val);
                    }
                    return (this->to_rgb() == val);
                }

                color<BitDepth, RgbType, BitSize> operator+(const color<BitDepth, RgbType, BitSize>& val)
                {
                    #if defined(OMNI_SAFE_COLOR)
                        this->m_mtx.lock();
                        if (this != &val) { val.m_mtx.lock(); }
                        color<BitDepth, RgbType, BitSize> ret(
                            (this->m_r + val.m_r),
                            (this->m_g + val.m_g),
                            (this->m_b + val.m_b),
                            (this->m_calc_alpha ? (this->m_a + val.m_a) : this->m_a),
                            this->m_calc_alpha
                        );
                        if (this != &val) { val.m_mtx.unlock(); }
                        this->m_mtx.unlock();
                        return ret;
                    #else
                        return color<BitDepth, RgbType, BitSize>(
                            (this->m_r + val.m_r),
                            (this->m_g + val.m_g),
                            (this->m_b + val.m_b),
                            (this->m_calc_alpha ? (this->m_a + val.m_a) : this->m_a),
                            this->m_calc_alpha
                        );
                    #endif
                }

                color<BitDepth, RgbType, BitSize> operator+(RgbType val)
                {
                    if (this->m_calc_alpha) {
                        return color<BitDepth, RgbType, BitSize>((this->to_rgba() + val), true);
                    }
                    return color<BitDepth, RgbType, BitSize>((this->to_rgb() + val), false);
                }

                color<BitDepth, RgbType, BitSize> operator-(const color<BitDepth, RgbType, BitSize>& val)
                {
                    #if defined(OMNI_SAFE_COLOR)
                        this->m_mtx.lock();
                        if (this != &val) { val.m_mtx.lock(); }
                        color<BitDepth, RgbType, BitSize> ret(
                            (this->m_r - val.m_r),
                            (this->m_g - val.m_g),
                            (this->m_b - val.m_b),
                            (this->m_calc_alpha ? (this->m_a - val.m_a) : this->m_a),
                            this->m_calc_alpha
                        );
                        if (this != &val) { val.m_mtx.unlock(); }
                        this->m_mtx.unlock();
                        return ret;
                    #else
                        return color<BitDepth, RgbType, BitSize>(
                            (this->m_r - val.m_r),
                            (this->m_g - val.m_g),
                            (this->m_b - val.m_b),
                            (this->m_calc_alpha ? (this->m_a - val.m_a) : this->m_a),
                            this->m_calc_alpha
                        );
                    #endif
                }

                color<BitDepth, RgbType, BitSize> operator-(RgbType val)
                {
                    if (this->m_calc_alpha) {
                        return color<BitDepth, RgbType, BitSize>((this->to_rgba() - val), true);
                    }
                    return color<BitDepth, RgbType, BitSize>((this->to_rgb() - val), false);
                }

                color<BitDepth, RgbType, BitSize>& operator+=(const color<BitDepth, RgbType, BitSize>& val)
                {
                    #if defined(OMNI_SAFE_COLOR)
                        this->m_mtx.lock();
                        if (this != &val) { val.m_mtx.lock(); }
                        this->m_r += val.m_r;
                        this->m_g += val.m_g;
                        this->m_b += val.m_b;
                        if (this->m_calc_alpha) { this->m_a += val.m_a; }
                        if (this != & val) { val.m_mtx.unlock(); }
                        this->m_mtx.unlock();
                    #else    
                        this->m_r += val.m_r;
                        this->m_g += val.m_g;
                        this->m_b += val.m_b;
                        if (this->m_calc_alpha) { this->m_a += val.m_a; }
                    #endif
                    return *this;
                }

                color<BitDepth, RgbType, BitSize>& operator+=(RgbType val)
                {
                    OMNI_SAFE_CLRALOCK_FW
                    if (this->m_calc_alpha) {
                        RgbType rgba = (
                            (static_cast<RgbType>(this->m_r) << (BitSize * 3)) ^
                            (static_cast<RgbType>(this->m_g) << (BitSize * 2)) ^
                            (static_cast<RgbType>(this->m_b) << BitSize) ^
                            (this->m_a)
                        ) + val;
                        this->m_r = (rgba >> (BitSize * 3));
                        this->m_g = static_cast<BitDepth>((rgba >> (BitSize * 2)) ^
                            (static_cast<RgbType>(this->m_r) << BitSize));
                        this->m_b = static_cast<BitDepth>((rgba >> BitSize) ^
                            (static_cast<RgbType>(this->m_g) << BitSize) ^
                            (static_cast<RgbType>(this->m_r) << (BitSize * 2)));
                        this->m_a = static_cast<BitDepth>(rgba ^
                            (static_cast<RgbType>(this->m_b) << BitSize) ^
                            (static_cast<RgbType>(this->m_g) << (BitSize * 2)) ^
                            (static_cast<RgbType>(this->m_r) << (BitSize * 3)));
                    } else {
                        RgbType rgb = (
                            (static_cast<RgbType>(this->m_r) << (BitSize * 2)) ^
                            (static_cast<RgbType>(this->m_g) << BitSize) ^
                            static_cast<RgbType>(this->m_b)) + val;
                        this->m_r = static_cast<BitDepth>(rgb >> (BitSize * 2));
                        this->m_g = static_cast<BitDepth>((rgb >> BitSize) ^ (static_cast<RgbType>(this->m_r) << BitSize));
                        this->m_b = static_cast<BitDepth>(rgb ^
                            (static_cast<RgbType>(this->m_g) << BitSize) ^
                            (static_cast<RgbType>(this->m_r) << (BitSize * 2)));
                    }
                    return *this;
                }

                color<BitDepth, RgbType, BitSize>& operator-=(const color<BitDepth, RgbType, BitSize>& val)
                {
                    #if defined(OMNI_SAFE_COLOR)
                        this->m_mtx.lock();
                        if (this != &val) { val.m_mtx.lock(); }
                        this->m_r -= val.m_r;
                        this->m_g -= val.m_g;
                        this->m_b -= val.m_b;
                        if (this->m_calc_alpha) { this->m_a -= val.m_a; }
                        if (this != & val) { val.m_mtx.unlock(); }
                        this->m_mtx.unlock();
                    #else    
                        this->m_r -= val.m_r;
                        this->m_g -= val.m_g;
                        this->m_b -= val.m_b;
                        if (this->m_calc_alpha) { this->m_a -= val.m_a; }
                    #endif
                    return *this;
                }

                color<BitDepth, RgbType, BitSize>& operator-=(RgbType val)
                {
                    OMNI_SAFE_CLRALOCK_FW
                    if (this->m_calc_alpha) {
                        RgbType rgba = ((static_cast<RgbType>(this->m_r) << (BitSize * 3)) ^
                            (static_cast<RgbType>(this->m_g) << (BitSize * 2)) ^
                            (static_cast<RgbType>(this->m_b) << BitSize) ^
                            static_cast<RgbType>(this->m_a)) - val;
                        this->m_r = (rgba >> (BitSize * 3));
                        this->m_g = ((rgba >> (BitSize * 2)) ^ (static_cast<RgbType>(this->m_r) << BitSize));
                        this->m_b = ((rgba >> BitSize) ^
                            (static_cast<RgbType>(this->m_g) << BitSize) ^
                            (static_cast<RgbType>(this->m_r) << (BitSize * 2)));
                        this->m_a = (rgba ^
                            (static_cast<RgbType>(this->m_b) << BitSize) ^
                            (static_cast<RgbType>(this->m_g) << (BitSize * 2)) ^
                            (static_cast<RgbType>(this->m_r) << (BitSize * 3)));
                    } else {
                        RgbType rgb = ((static_cast<RgbType>(this->m_r) << (BitSize * 2)) ^
                            (static_cast<RgbType>(this->m_g) << BitSize) ^
                            static_cast<RgbType>(this->m_b)) - val;
                        this->m_r = (rgb >> (BitSize * 2));
                        this->m_g = ((rgb >> BitSize) ^ (static_cast<RgbType>(this->m_r) << BitSize));
                        this->m_b = (rgb ^
                            (static_cast<RgbType>(this->m_g) << BitSize) ^
                            (static_cast<RgbType>(this->m_r) << (BitSize * 2)));
                    }
                    return *this;
                }

                //OMNI_MEMBERS_FW(omni::drawing::color<BitDepth, RgbType, BitSize>) // disposing,name,type(),hash()
                //OMNI_OSTREAM_FW(omni::drawing::color<BitDepth, RgbType, BitSize>)
                // DEV_NOTE: compilers complain about macro-function invocation with this class for the extras,
                // so we're just going to implement them directly below to avoid compiler confusion elsewhere.
                #if defined(OMNI_TYPE_INFO)
                    uint64_t type() const { return omni::type_id< omni::drawing::color<BitDepth, RgbType, BitSize> >(); }
                    uint64_t hash() const { return reinterpret_cast<uint64_t>(this); }
                #endif

                #if defined(OMNI_DISPOSE_EVENT)
                    // DEV_NOTE: we only need to define the event here, as the rest of the macros work as defined
                    omni::event1<void, const omni::drawing::color<BitDepth, RgbType, BitSize>& > disposing;
                #endif

                #if defined(OMNI_OBJECT_NAME)
                    omni::string_t name;
                #endif

                friend std::ostream& operator<<(std::ostream& s, const omni::drawing::color<BitDepth, RgbType, BitSize>& c)
                { s << c.to_string(); return s; }
                
                friend std::wostream& operator<<(std::wostream& s, const omni::drawing::color<BitDepth, RgbType, BitSize>& c)
                { s << c.to_wstring(); return s; }

            private:
                BitDepth m_r;
                BitDepth m_g;
                BitDepth m_b;
                BitDepth m_a;
                volatile bool m_calc_alpha;
                #if defined(OMNI_SAFE_COLOR)
                    mutable omni::sync::basic_lock m_mtx;
                #endif

                color(RgbType val, bool is_rgba, bool calc) :
                    OMNI_CTOR_FW(omni::drawing::color<BitDepth>)
                    m_r(0), m_g(0), m_b(0), m_a(std::numeric_limits<BitDepth>::max()), m_calc_alpha(calc)
                    OMNI_SAFE_CLRDMTX_FW
                {
                    if (is_rgba) {
                        this->set_rgba(val);
                    } else {
                        this->set_argb(val);
                    }
                }
        };

        typedef omni::drawing::color<uint8_t, uint32_t> color_t;
        typedef omni::drawing::color<uint16_t, uint64_t> color64_t;
    }
}

#endif // OMNI_COLOR_HPP