Documentation

Visual Effects

Watermarks and filters are passed on the image URL with visual_effect.

Watermark

We support adding params on image to append watermark on it. Supported params are:

  • text: Text to be added on image, need to be encoded in base64 (url-safe).
  • font: Font name, currently we support 11 fonts, see below for details, need to be encoded in base64 (url-safe).
  • color: Text color, in hex format, could be 6 chars (without transparency) or 8 chars (with transparent)
  • width: Relative text width, in percentage from 0 to 1
  • height: Relative text height, in percentage from 0 to 1
  • offset_x: Relative text x position, in percentage from 0 to 1
  • offset_y: Relative text y position, in percentage from 0 to 1

We use __ to divide key and value, for example you want to temporarily add text Hello World on image, you can use text__SGVsbG8gV29ybGQ= as param.

Example

We wish to add 我的世界是什么 to https://559a238.webp.ee/images/create-proxy.png, with font set to XiaolaiSC(小赖字体) (Base64: WGlhb2xhaVND) then it can be called with below:

Image with a XiaolaiSC watermark

https://559a238.webp.ee/images/create-proxy.png?visual_effect=watermark,text__5oiR55qE5LiW55WM5piv5LuA5LmI,width__0.1,height__0.1,offset_x__0.23,offset_y__0.34,color__001489,font__WGlhb2xhaVND

Supported Fonts

Font NameParameter nameBase64
Sanssans 12c2FucyAxMg
RobotoRobotoUm9ib3Rv
Noto SansNoto SansTm90byBTYW5z
Source Han Sans(思源黑体)Source Han Sans HC VFU291cmNlIEhhbiBTYW5zIEhDIFZG
wqy-zenhei(文泉驿正黑体)WenQuanYi Zen HeiV2VuUXVhbllpIFplbiBIZWk
FZFangSong-Z02(方正仿宋)FZFangSong-Z02RlpGYW5nU29uZy1aMDI
FZHei-B01(方正黑体)FZHei-B01RlpIZWktQjAx
FZKai-Z03(方正楷体)FZKai-Z03RlpLYWktWjAz
FZShuSong-Z01(方正书宋)FZShuSong-Z01RlpTaHVTb25nLVowMQ
Architects DaughterArchitects DaughterQXJjaGl0ZWN0cyBEYXVnaHRlcg
Gloria HallelujahGloria HallelujahR2xvcmlhIEhhbGxlbHVqYWg
XiaolaiSC(小赖字体)XiaolaiSCWGlhb2xhaVND
LXGW WenKai(霞鹜文楷)LXGW WenKaiTFhHVyBXZW5LYWk

Font preview:

Params:

  • text: We have 一只 憂鬱的臺灣烏龜。こんにちわ,ガッキー! 조선말 Tiếng
  • width: 1
  • height: 0.037
  • offset_x: 0.02
  • offset_y: 0.05
Font NameParameter namePreview
Sanssans 12Sans watermark preview
RobotoRobotoRoboto watermark preview
Noto SansNoto SansNoto Sans watermark preview
Source Han Sans(思源黑体)Source Han Sans HC VFSource Han Sans(思源黑体) watermark preview
wqy-zenhei(文泉驿正黑体)WenQuanYi Zen Heiwqy-zenhei(文泉驿正黑体) watermark preview
FZFangSong-Z02(方正仿宋)FZFangSong-Z02FZFangSong-Z02(方正仿宋) watermark preview
FZHei-B01(方正黑体)FZHei-B01FZHei-B01(方正黑体) watermark preview
FZKai-Z03(方正楷体)FZKai-Z03FZKai-Z03(方正楷体) watermark preview
FZShuSong-Z01(方正书宋)FZShuSong-Z01FZShuSong-Z01(方正书宋) watermark preview
Architects DaughterArchitects DaughterArchitects Daughter watermark preview
Gloria HallelujahGloria HallelujahGloria Hallelujah watermark preview
XiaolaiSC(小赖字体)XiaolaiSCXiaolaiSC(小赖字体) watermark preview
LXGW WenKai(霞鹜文楷)LXGW WenKaiLXGW WenKai(霞鹜文楷) watermark preview

If you'd like to enable watermark on all proxy images, you can create and add it on Dashboard.

Filter

We support filters on image, currently we support the following filters:

1977, aden, brannan, Brooklyn, clarendon, earlybird, gingham, hudson, inkwell, kelvin, lark, lofi, maven, mayfair, moon, nashville, perpetua, reyes, rise, slumber, stinson, toaster, valencia, walden, willow, xpro2

Colors are from: https://github.com/una/CSSgram

Example

We use __ to divide key and value, for example we wish to add Brooklyn filter to https://559a238.webp.ee/images/create-proxy.png, then it can be called with below:

https://559a238.webp.ee/images/create-proxy.png?visual_effect=filter,name__Brooklyn
Filter NamePreview
-(Original Image)Original image without a filter
19771977 filter preview
adenaden filter preview
brannanbrannan filter preview
BrooklynBrooklyn filter preview
clarendonclarendon filter preview
earlybirdearlybird filter preview
ginghamgingham filter preview
hudsonhudson filter preview
inkwellinkwell filter preview
kelvinkelvin filter preview
larklark filter preview
lofilofi filter preview
mavenmaven filter preview
mayfairmayfair filter preview
moonmoon filter preview
nashvillenashville filter preview
perpetuaperpetua filter preview
reyesreyes filter preview
riserise filter preview
slumberslumber filter preview
stinsonstinson filter preview
toastertoaster filter preview
valenciavalencia filter preview
waldenwalden filter preview
willowwillow filter preview
xpro2xpro2 filter preview