Files
bundesmessenger-ios/Riot/Utils/AvatarGenerator.h
T
Mauro Romito 12837d4b89 update license
2024-09-25 12:24:52 +02:00

55 lines
1.5 KiB
Objective-C

/*
Copyright 2024 New Vector Ltd.
Copyright 2015 OpenMarket Ltd
SPDX-License-Identifier: AGPL-3.0-only
Please see LICENSE in the repository root for full details.
*/
#import <UIKit/UIKit.h>
/**
`AvatarGenerator` class generate an avatar image from objects
*/
@interface AvatarGenerator : NSObject
/**
Create a squared UIImage with the text and the background color.
@param text the text.
@param color the background color.
@return the avatar image.
*/
+ (UIImage *)imageFromText:(NSString*)text withBackgroundColor:(UIColor*)color;
/**
Generate a squared avatar for a matrix item (room, room member...).
@param itemId the matrix identifier of the item
@param displayname the item displayname (if nil, the itemId is used by default).
@return the avatar image
*/
+ (UIImage*)generateAvatarForMatrixItem:(NSString*)itemId withDisplayName:(NSString*)displayname;
/**
Generate a squared avatar for a matrix item (room, room member...) with a preferred size
@param itemId the matrix identifier of the item
@param displayname the item displayname (if nil, the itemId is used by default).
@param size the expected size of the returned image
@param fontSize the expected font size
@return the avatar image
*/
+ (UIImage*)generateAvatarForMatrixItem:(NSString*)itemId withDisplayName:(NSString*)displayname size:(CGFloat)size andFontSize:(CGFloat)fontSize;
/**
Generate an avatar for a text.
@param text the text.
@return the avatar image
*/
+ (UIImage*)generateAvatarForText:(NSString*)text;
/**
Clear all the resources stored in memory.
*/
+ (void)clear;
@end