Swiftgram/submodules/AsyncDisplayKit/Source/UIImage+ASConvenience.h
Peter 9bc996374f Add 'submodules/AsyncDisplayKit/' from commit '02bedc12816e251ad71777f9d2578329b6d2bef6'
git-subtree-dir: submodules/AsyncDisplayKit
git-subtree-mainline: d06f423e0ed3df1fed9bd10d79ee312a9179b632
git-subtree-split: 02bedc12816e251ad71777f9d2578329b6d2bef6
2019-06-11 18:42:43 +01:00

110 lines
5.1 KiB
Objective-C

//
// UIImage+ASConvenience.h
// Texture
//
// Copyright (c) Facebook, Inc. and its affiliates. All rights reserved.
// Changes after 4/13/2017 are: Copyright (c) Pinterest, Inc. All rights reserved.
// Licensed under Apache 2.0: http://www.apache.org/licenses/LICENSE-2.0
//
#import <UIKit/UIKit.h>
#import <AsyncDisplayKit/ASBaseDefines.h>
NS_ASSUME_NONNULL_BEGIN
/**
* Dramatically faster version of +[UIImage imageNamed:]. Although it is believed that imageNamed:
* has a cache and is fast, it actually performs expensive asset catalog lookups and is often a
* performance bottleneck (verified on iOS 7 through iOS 10).
*
* Use [UIImage as_imageNamed:] anywhere in your app, even if you aren't using other parts of ASDK.
* Although not the best choice for extremely large assets that are only used once, it is the ideal
* choice for any assets used in tab bars, nav bars, buttons, table or collection cells, etc.
*/
@interface UIImage (ASDKFastImageNamed)
/**
* A version of imageNamed that caches results because loading an image is expensive.
* Calling with the same name value will usually return the same object. A UIImage,
* after creation, is immutable and thread-safe so it's fine to share these objects across multiple threads.
*
* @param imageName The name of the image to load
* @return The loaded image or nil
*/
+ (nullable UIImage *)as_imageNamed:(NSString *)imageName NS_RETURNS_RETAINED;
/**
* A version of imageNamed that caches results because loading an image is expensive.
* Calling with the same name value will usually return the same object. A UIImage,
* after creation, is immutable and thread-safe so it's fine to share these objects across multiple threads.
*
* @param imageName The name of the image to load
* @param traitCollection The traits associated with the intended environment for the image.
* @return The loaded image or nil
*/
+ (nullable UIImage *)as_imageNamed:(NSString *)imageName compatibleWithTraitCollection:(nullable UITraitCollection *)traitCollection NS_RETURNS_RETAINED;
@end
/**
* High-performance flat-colored, rounded-corner resizable images
*
* For "Baked-in Opaque" corners, set cornerColor equal to the color behind the rounded image object,
* i.e. the background color.
* For "Baked-in Alpha" corners, set cornerColor = [UIColor clearColor]
*
* See http://asyncdisplaykit.org/docs/corner-rounding.html for an explanation.
*/
@interface UIImage (ASDKResizableRoundedRects)
/**
* This generates a flat-color, rounded-corner resizeable image
*
* @param cornerRadius The radius of the rounded-corner
* @param cornerColor The fill color of the corners (For Alpha corners use clearColor)
* @param fillColor The fill color of the rounded-corner image
*/
+ (UIImage *)as_resizableRoundedImageWithCornerRadius:(CGFloat)cornerRadius
cornerColor:(nullable UIColor *)cornerColor
fillColor:(UIColor *)fillColor NS_RETURNS_RETAINED AS_WARN_UNUSED_RESULT;
/**
* This generates a flat-color, rounded-corner resizeable image with a border
*
* @param cornerRadius The radius of the rounded-corner
* @param cornerColor The fill color of the corners (For Alpha corners use clearColor)
* @param fillColor The fill color of the rounded-corner image
* @param borderColor The border color. Set to nil for no border.
* @param borderWidth The border width. Dummy value if borderColor = nil.
*/
+ (UIImage *)as_resizableRoundedImageWithCornerRadius:(CGFloat)cornerRadius
cornerColor:(UIColor *)cornerColor
fillColor:(UIColor *)fillColor
borderColor:(nullable UIColor *)borderColor
borderWidth:(CGFloat)borderWidth NS_RETURNS_RETAINED AS_WARN_UNUSED_RESULT;
/**
* This generates a flat-color, rounded-corner resizeable image with a border
*
* @param cornerRadius The radius of the rounded-corner
* @param cornerColor The fill color of the corners (For Alpha corners use clearColor)
* @param fillColor The fill color of the rounded-corner image
* @param borderColor The border color. Set to nil for no border.
* @param borderWidth The border width. Dummy value if borderColor = nil.
* @param roundedCorners Select individual or multiple corners to round. Set to UIRectCornerAllCorners to round all 4 corners.
* @param scale The number of pixels per point. Provide 0.0 to use the screen scale.
*/
+ (UIImage *)as_resizableRoundedImageWithCornerRadius:(CGFloat)cornerRadius
cornerColor:(nullable UIColor *)cornerColor
fillColor:(UIColor *)fillColor
borderColor:(nullable UIColor *)borderColor
borderWidth:(CGFloat)borderWidth
roundedCorners:(UIRectCorner)roundedCorners
scale:(CGFloat)scale NS_RETURNS_RETAINED AS_WARN_UNUSED_RESULT;
@end
NS_ASSUME_NONNULL_END