3. nativeImage

原文:https://github.com/electron/electron/blob/master/docs/api/native-image.md
译者:Lin

使用PNG或JPG文件创建托盘图标,dock图标和应用图标。

进程:进程:主进程渲染进程

Electron中,对于需要图像的接口,你可以传入文件的路径或者NativeImage实例。当传入null时将使用一个空的图像。

例如,当创建一个托盘活着设置一个窗口的图标,你可以传入一个String类型的图像文件的地址:

const {BrowserWindow, Tray} = require('electron')

const appIcon = new Tray('/Users/somebody/images/icon.png')
let win = new BrowserWindow({icon: '/Users/somebody/images/window.png'})
console.log(appIcon, win)

或者从剪贴板返回的NativeImage中读取图像:

const {clipboard, Tray} = require('electron')
const image = clipboard.readImage()
const appIcon = new Tray(image)
console.log(appIcon)

支持的类型

当前支持PNGJPEG图像类型。建议使用PNG,因为它支持透明和无损压缩。

Windows中,你也可以从文件路径中加载ICO图标。为了最好的可视化效果,建议至少包含以下尺寸:

  • Small icon
    • 16x16 (100% DPI scale)
    • 20x20 (125% DPI scale)
    • 24x24 (150% DPI scale)
    • 32x32 (200% DPI scale)
  • Large icon
    • 32x32 (100% DPI scale)
    • 40x40 (125% DPI scale)
    • 48x48 (150% DPI scale)
    • 64x64 (200% DPI scale)
  • 256x256

点击this article中的Size requirements部分。

高分辨率图像

有支持高DPI的平台上,例如苹果Retina显示屏,你可以在图像的基本文件名的后面添加@2x来标记这个事一个高分辨率的图像。

例如,如果icon.png是一个标准分辨率的正常图像,那么icon@2x.png将被处理为一个有两倍DPI密度的高分辨率图像。

如果你想同时支持不同DPI密度显示屏,你可以将不同尺寸的图像放在同一个文件夹下,并且使用不包含DPI后缀的文件名。例如:

images/
├── icon.png
├── icon@2x.png
└── icon@3x.png
const {Tray} = require('electron')
let appIcon = new Tray('/Users/somebody/images/icon.png')
console.log(appIcon)

支持以下DPI的后缀名:

  • @1x
  • @1.25x
  • @1.33x
  • @1.4x
  • @1.5x
  • @1.8x
  • @2x
  • @2.5x
  • @3x
  • @4x
  • @5x

模版图像

模版图像包括黑色和无颜色(和一个透明通道)。模版图像是不打算被作为单独的图像而使用的,并且通常和其他内容混合创建一个理想的最终形态。

最常见的情况是在菜单栏图标上使用模版图像,所以它可以适应浅色和暗色的菜单栏。

注意:只有MacOS支持模版图像。

为了使用一个模版图像,它的文件名字必须以Template单词结尾。例如:

  • xxxTemplate.png
  • xxxTemplate@2x.png

方法

nativeImage模块又以下方法,所有的方法斗返回一个NativeImage类的实例:

nativeImage.createEmpty()

返回值为NativeImage类型

创建一个空的NativeImage实例。

nativeImage.createFromPath(path)

  • path String类型

返回值为NativeImage类型

使用本地文件地址创建一个新的NativeImage实例。如果path不存在,或者不能被读取,或者不是一个图像,那么这个方法返回一个空的图像。

const nativeImage = require('electron').nativeImage

let image = nativeImage.createFromPath('/Users/somebody/images/icon.png')
console.log(image)

nativeImage.createFromBuffer(buffer[, options])

  • buffer Buffer类型
  • options Object类型(可选参数)
    • width Integer类型(可选参数)- 对于bitmap buffers是必须的参数。
    • height Integer类型(可选参数)- 对于bitmap buffers是必须的参数。
    • scaleFactor Double类型(可选参数)- 默认是1.0。

返回值为NativeImage类型

通过buffer创建一个新的NativeImage实例。

nativeImage.createFromDataURL(dataURL)

  • dataURL String类型

通过dataURL创建一个新的NativeImage实例。

类: NativeImage

使用PNG或JPG文件创建托盘图标,dock图标和应用图标。

进程:主进程渲染进程

实例的方法

NativeImage类的实例有以下方法:

image.toPNG([options])

  • options Object类型(可选参数)
    • scaleFactor Double类型(可选参数)- 默认是1.0。

返回值为Buffer类型 - 一个包含图像的PNG编码数据的Buffer

image.toJPEG(quality)

  • quality Integer类型(必传参数)- 在0 - 100之间。

返回值为Buffer类型 - 一个包含图像的JPEG编码数据的Buffer

image.toBitmap([options])

  • options Object类型(可选参数)
    • scaleFactor Double类型(可选参数)- 默认为1.0。

返回值为Buffer类型 - 一个包含图像的原始位图的数据副本的Buffer

image.toDataURL([options])

  • options Object类型(可选参数)
    • scaleFactor Double类型(可选参数)- 默认为1.0。

返回值为String类型 - 图片的数据地址。

image.getBitmap([options])

  • options Object类型(可选参数)
    • scaleFactor Double类型(可选参数)- 默认值为1.0。

返回值为Buffer类型 - 一个包含图像的原始位图的数据的Buffer

getBitmap()toBitmap()的区别是,getBitmap()不会复制位图数据,所以你必须在当前事件循环标记中直接使用返回的Buffer,否则数据将会被改变或者被销毁。

image.getNativeHandle() MacOS

返回值为Buffer类型 - 一个存储底层处理本地图像的C指针的Buffer。MacOS中,将返回一个指向NSImage实例的指针。

请注意,返回的指针是一个指向底层的本地土图像来代替一个副本的弱指针,所以你必须确保对应的nativeImage实例一直存在。

image.isEmpty()

返回值为Boolean类型 - 图像是否是空。

image.getSize()

返回值为Object类型:

  • width Integer类型
  • height Integer类型

image.setTemplateImage(option)

  • option Boolean类型

将图像转为一个模版图像。

image.isTemplateImage()

返回值为Boolean类型 - 图像是否是一个模版图像。

image.crop(rect)

  • rect Object类型 - 图像要修剪的区域
    • x Integer类型
    • y Integer类型
    • width Integer类型
    • height Integer类型

返回值为NativeImage类型 - 被修剪的图像。

image.resize(options)

  • options Object类型
    • width Integer类型(可选参数)- 默认是图像的宽
    • height Integer类型(可选参数)- 默认是图像的高
    • quality String类型(可选参数)- 期望的重设大小的图片的质量。值可以是goodbetterbest。默认是best。这个值表示一个期望的质量和速度。它们将转化为一个具体的算法,这个算法取决于底层平台的处理能力(CPU,GPU)。这三个方法可能在一个给定的平台上被映射到同一个算法上。

返回值为NativeImage - 重设大小的图像。

如果只指定了height或者width,那么将使用当前的纵横比来重设图像。

image.getAspectRatio()

返回值为Float类型 - 图像的纵横比。

image.addRepresentation(options)

  • options Object类型
    • scaleFactor Double类型 - The scale factor to add the image representation for.
    • width Integer类型(可选参数)- 默认为0。如果一个二进制位图传给了buffer,那么这个选项必须设置。
    • height Integer类型(可选参数)- 默认为0。如果一个二进制位图传给了buffer,那么这个选项必须设置。
    • buffer Buffer类型(可选参数)- 包含原始图像数据的buffer。
    • dataURL String类型(可选参数)- 包含了base64编码的PNG或JPEG图像的数据地址。

添加一个指定的缩放因数的图像表现。这个可以被用来明确的添加不同缩放因素表现到一个图像上。这个方法可以在空图像上调用。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,133评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,682评论 3 390
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,784评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,508评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,603评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,607评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,604评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,359评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,805评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,121评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,280评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,959评论 5 339
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,588评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,206评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,442评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,193评论 2 367
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,144评论 2 352

推荐阅读更多精彩内容