OFColor.h

/*
 * Copyright (c) 2008-2026 Jonathan Schleifer <js@nil.im>
 *
 * All rights reserved.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3.0 only,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * version 3.0 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3.0 along with this program. If not, see
 * <https://www.gnu.org/licenses/>.
 */

#import "OFObject.h"
#import "OFColorSpace.h"

OF_ASSUME_NONNULL_BEGIN

@interface OFColor: OFObject
#ifdef OF_HAVE_CLASS_PROPERTIES
@property (class, readonly, nonatomic) OFColor *black;
@property (class, readonly, nonatomic) OFColor *silver;
@property (class, readonly, nonatomic) OFColor *gray;
@property (class, readonly, nonatomic) OFColor *grey
    OF_DEPRECATED(ObjFW, 1, 1, "Use +[gray] instead");
@property (class, readonly, nonatomic) OFColor *white;
@property (class, readonly, nonatomic) OFColor *maroon;
@property (class, readonly, nonatomic) OFColor *red;
@property (class, readonly, nonatomic) OFColor *purple;
@property (class, readonly, nonatomic) OFColor *fuchsia;
@property (class, readonly, nonatomic) OFColor *green;
@property (class, readonly, nonatomic) OFColor *lime;
@property (class, readonly, nonatomic) OFColor *olive;
@property (class, readonly, nonatomic) OFColor *yellow;
@property (class, readonly, nonatomic) OFColor *navy;
@property (class, readonly, nonatomic) OFColor *blue;
@property (class, readonly, nonatomic) OFColor *teal;
@property (class, readonly, nonatomic) OFColor *aqua;
#endif

@property (readonly, retain, nonatomic) OFColorSpace *colorSpace;

+ (instancetype)colorWithRed: (float)red
               green: (float)green
            blue: (float)blue
               alpha: (float)alpha;

+ (instancetype)colorWithRed: (float)red
               green: (float)green
            blue: (float)blue
               alpha: (float)alpha
          colorSpace: (OFColorSpace *)colorSpace;

+ (OFColor *)black;

+ (OFColor *)silver;

+ (OFColor *)gray;

+ (OFColor *)grey OF_DEPRECATED(ObjFW, 1, 1, "Use +[gray] instead");

+ (OFColor *)white;

+ (OFColor *)maroon;

+ (OFColor *)red;

+ (OFColor *)purple;

+ (OFColor *)fuchsia;

+ (OFColor *)green;

+ (OFColor *)lime;

+ (OFColor *)olive;

+ (OFColor *)yellow;

+ (OFColor *)navy;

+ (OFColor *)blue;

+ (OFColor *)teal;

+ (OFColor *)aqua;

- (instancetype)initWithRed: (float)red
              green: (float)green
               blue: (float)blue
              alpha: (float)alpha;

- (instancetype)initWithRed: (float)red
              green: (float)green
               blue: (float)blue
              alpha: (float)alpha
         colorSpace: (OFColorSpace *)colorSpace;

- (void)getRed: (float *)red
     green: (float *)green
      blue: (float *)blue
     alpha: (nullable float *)alpha;

- (OFColor *)colorUsingColorSpace: (OFColorSpace *)colorSpace;
@end

OF_ASSUME_NONNULL_END