watermark

package
v1.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 13, 2025 License: MIT Imports: 15 Imported by: 0

README

gowatermark

使用 Go 语言开发图片水印工具,可以添加图片和透明文字水印。

安装

go get -u github.com/xing-zr/gowatermark

示例

添加图片水印
// 相关配置
config := gowatermark.ImageWatermarkConfig{
	OriginImagePath:    "./origin.jpg",        // 水印底图图片路径
	WatermarkImagePath: "./watermark.png",     // 水印图图片路径
	WatermarkPos:       gowatermark.LeftTop,   // 水印位置 有 左上、左下、右上、右下、平铺几个选项
	CompositeImagePath: "./composite.jpg",     // 合成后图片路径
    Opacity:   0.5,                            // 水印透明度 0-1 之间
    TiledRows: 3,                              // 水印平铺行数(水印类型为平铺有效)
    TiledCols: 4,                              // 水印平铺列数(水印类型为平铺有效)
}
// 生成图片水印图
err := gowatermark.CreateImageWatermark(config)
if err != nil {
	fmt.Println(err)
}
添加透明文字水印
// 相关配置 - 固定位置的透明文字水印
config := gowatermark.TransparentTextWatermarkConfig{
    OriginImagePath:    "./origin.jpg",           // 水印底图图片路径
    CompositeImagePath: "./composite.jpg",        // 合成后图片路径
    FontPath:           "./font.ttf",             // 字体文件路径
    Text:               "透明文字水印",             // 文字内容
    Size:               72,                       // 字体大小
    Color:              gowatermark.White,        // 文字颜色,提供预设颜色:White, Black, Red, Green, Blue
    WatermarkPos:       gowatermark.RightBottom, // 水印位置,支持左上、右上、左下、右下、平铺
    Opacity:            0.5,                     // 水印透明度 0-1 之间
    OffsetX:            20,                      // X轴偏移量
    OffsetY:            20,                      // Y轴偏移量
    Rotation:           0,                       // 文字旋转角度
}
// 生成透明文字水印图
err := gowatermark.CreateTransparentTextWatermark(config)
if err != nil {
    fmt.Println(err)
}

// 相关配置 - 平铺透明文字水印
configTiled := gowatermark.TransparentTextWatermarkConfig{
    OriginImagePath:    "./origin.jpg",           // 水印底图图片路径
    CompositeImagePath: "./composite_tiled.jpg",  // 合成后图片路径
    FontPath:           "./font.ttf",             // 字体文件路径
    Text:               "透明文字水印",             // 文字内容
    Size:               48,                       // 字体大小
    Color:              gowatermark.White,        // 文字颜色,提供预设颜色
    WatermarkPos:       gowatermark.Tiled,       // 水印位置设为平铺
    Opacity:            0.3,                     // 水印透明度 0-1 之间
    TiledRows:          4,                       // 平铺行数
    TiledCols:          5,                       // 平铺列数
    Rotation:           45,                      // 文字旋转角度
}
// 生成平铺透明文字水印图
err = gowatermark.CreateTransparentTextWatermark(configTiled)
if err != nil {
    fmt.Println(err)
}
字体支持

该库支持以下两种方式指定字体:

  1. 显式指定字体文件路径
config := gowatermark.TransparentTextWatermarkConfig{
    // ... other config ...
    FontPath: "./my-custom-font.ttf",
}
  1. 使用系统默认字体(将FontPath留空)
config := gowatermark.TransparentTextWatermarkConfig{
    // ... other config ...
    FontPath: "", // 将使用系统默认字体
}

系统默认字体会按以下顺序查找:

  • Linux: /usr/share/fonts/truetype/droid/DroidSansFallbackFull.ttf
  • Windows: C:/Windows/Fonts/simhei.ttf
  • macOS: /System/Library/Fonts/PingFang.ttc

如果以上路径都无法找到可用字体,则会返回错误。

可用水印位置

  • gowatermark.LeftTop - 左上角
  • gowatermark.RightTop - 右上角
  • gowatermark.LeftBottom - 左下角
  • gowatermark.RightBottom - 右下角
  • gowatermark.Tiled - 平铺模式

预设颜色

  • gowatermark.White - 白色
  • gowatermark.Black - 黑色
  • gowatermark.Red - 红色
  • gowatermark.Green - 绿色
  • gowatermark.Blue - 蓝色

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Black = color.RGBA{0, 0, 0, 255}
	White = color.RGBA{255, 255, 255, 255}
	Red   = color.RGBA{255, 0, 0, 255}
	Green = color.RGBA{0, 255, 0, 255}
	Blue  = color.RGBA{0, 0, 255, 255}
)

创建几个预选颜色

View Source
var (
	// DefaultFont 默认字体,程序启动时自动加载系统默认字体
	DefaultFont *truetype.Font
)
View Source
var DefaultWatermarkOptions = WatermarkOptions{
	Size:     48,
	Color:    Black,
	Opacity:  0.5,
	Rotation: 0,
	OffsetX:  20,
	OffsetY:  20,
}

DefaultWatermarkOptions 默认水印选项

Functions

func AddTextWatermark added in v1.3.0

func AddTextWatermark(img []byte, text string, position WatermarkPos, opts *WatermarkOptions) (image.Image, error)

AddTextWatermark 快速添加单个文字水印

func AddTextWatermarkToFile added in v1.3.0

func AddTextWatermarkToFile(imagePath string, text string, position WatermarkPos, opts *WatermarkOptions) (image.Image, error)

AddTextWatermarkToFile 快速添加单个文字水印到文件

func AddTiledTextWatermark added in v1.3.0

func AddTiledTextWatermark(img []byte, text string, rows, cols int, opts *WatermarkOptions) (image.Image, error)

AddTiledTextWatermark 快速添加平铺文字水印

func AddTiledTextWatermarkToFile added in v1.3.0

func AddTiledTextWatermarkToFile(imagePath string, text string, rows, cols int, opts *WatermarkOptions) (image.Image, error)

AddTiledTextWatermarkToFile 快速添加平铺文字水印到文件

func CreateImageWatermark

func CreateImageWatermark(config ImageWatermarkConfig) error

func CreateTextImage

func CreateTextImage(text string, fontSize float64, fontData []byte, textColor color.RGBA, rotation float64) (*image.NRGBA, error)

CreateTextImage 创建文字图像

func CreateTransparentTextWatermark

func CreateTransparentTextWatermark(config TransparentTextWatermarkConfig) (image.Image, error)

CreateTransparentTextWatermark 创建透明文字水印 先将文字渲染到透明图层,然后作为图片叠加到目标图片上

func LoadFont

func LoadFont(fontPath string) (*truetype.Font, error)

LoadFont 加载字体文件,如果fontPath为空则使用默认字体

func MeasureText

func MeasureText(face font.Face, text string) (int, int)

MeasureText 计算给定文字的宽度和高度

func PrepareOutputPath

func PrepareOutputPath(path string) error

PrepareOutputPath 准备输出文件路径,删除已存在的文件并创建必要的目录

func SaveImage added in v1.3.0

func SaveImage(img image.Image, outputPath string) error

SaveImage 保存图片到文件

func WatermarkExamples added in v1.3.0

func WatermarkExamples()

WatermarkExamples 展示水印功能的使用示例

Types

type ImageWatermarkConfig

type ImageWatermarkConfig struct {
	OriginImagePath    string       // 原图地址
	WatermarkImagePath string       // 水印图地址
	WatermarkPos       WatermarkPos // 水印位置
	CompositeImagePath string       // 合成图地址
	OffsetX            int          // 水印位置偏移量X
	OffsetY            int          // 水印位置偏移量Y
	Opacity            float64      // 水印透明度
	TiledRows          int          // 水印图横向平铺行数
	TiledCols          int          // 水印图横向平铺列数
}

type TransparentTextWatermarkConfig

type TransparentTextWatermarkConfig struct {
	OriginImagePath    string       // 原图地址(与OriginImageBytes二选一)
	OriginImageBytes   []byte       // 原图字节数组(与OriginImagePath二选一)
	CompositeImagePath string       // 合成图地址(可选,为空时不保存到文件)
	FontPath           string       // 字体文件地址(可选,为空时使用系统默认字体)
	Text               string       // 文字内容
	Size               float64      // 文字大小
	Color              color.RGBA   // 文字颜色
	WatermarkPos       WatermarkPos // 水印位置
	Opacity            float64      // 水印透明度
	OffsetX            int          // 水印位置偏移量X
	OffsetY            int          // 水印位置偏移量Y
	Rotation           float64      // 文字旋转角度
	TiledRows          int          // 水印图横向平铺行数(仅Tiled位置时使用)
	TiledCols          int          // 水印图横向平铺列数(仅Tiled位置时使用)
}

TransparentTextWatermarkConfig 透明文字水印配置

type WatermarkOptions added in v1.3.0

type WatermarkOptions struct {
	FontPath string     // 字体文件路径
	Size     float64    // 字体大小
	Color    color.RGBA // 字体颜色
	Opacity  float64    // 透明度
	Rotation float64    // 旋转角度
	OffsetX  int        // X轴偏移
	OffsetY  int        // Y轴偏移
}

WatermarkOptions 水印选项

type WatermarkPos

type WatermarkPos string
const (
	LeftTop     WatermarkPos = "left_top"
	RightTop    WatermarkPos = "right_top"
	LeftBottom  WatermarkPos = "left_bottom"
	RightBottom WatermarkPos = "right_bottom"
	Tiled       WatermarkPos = "tiled"
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
⌂ 换网址