gitea/vendor/github.com/issue9/identicon/doc.go

38 lines
1.5 KiB
Go
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

// Copyright 2015 by caixw, All rights reserved.
// Use of this source code is governed by a MIT
// license that can be found in the LICENSE file.
// 一个基于hash值生成随机图像的包。
//
// 关于identicon并没有统一的标准一般用于在用户注册时
// 取用户的邮箱或是访问IP等数据(也可以是其它任何数据)
// 进行hash运算之后根据hash数据产生一张图像
// 这样即可以为用户产生一张独特的头像,又不会泄漏用户的隐藏。
//
// 在identicon中把图像分成以下九个部分:
// -------------
// | 1 | 2 | 3 |
// -------------
// | 4 | 5 | 6 |
// -------------
// | 7 | 8 | 9 |
// -------------
// 其中1、3、9、7为不同角度(依次增加90度)的同一张图片,
// 2、6、8、4也是如此这样可以保持图像是对称的比较美观。
// 5则单独使用一张图片。
//
// // 根据用户访问的IP为其生成一张头像
// img, _ := identicon.Make(128, color.NRGBA{},color.NRGBA{}, []byte("192.168.1.1"))
// fi, _ := os.Create("/tmp/u1.png")
// png.Encode(fi, img)
// fi.Close()
//
// // 或者
// ii, _ := identicon.New(128, color.NRGBA{}, color.NRGBA{}, color.NRGBA{})
// img := ii.Make([]byte("192.168.1.1"))
// img = ii.Make([]byte("192.168.1.2"))
//
// NOTE: go test 会在当前目录的testdata文件夹下产生大量的随机图片。
// 要运行测试,必须保证该文件夹是存在的,且有相应的写入权限。
package identicon