首页
/ node-x11 技术文档

node-x11 技术文档

2024-12-24 23:37:30作者:温艾琴Wonderful

1. 安装指南

1.1 安装环境要求

  • Node.js:确保已安装 Node.js 环境。
  • npm:Node.js 的包管理工具。

1.2 安装步骤

  1. 打开终端或命令行工具。
  2. 运行以下命令安装 node-x11
    npm install x11
    

1.3 Windows 用户特别说明

Windows 用户需要额外安装 X11 服务器:

  1. 安装 XMingCygwin/X
  2. 获取 node-x11 的副本,可以通过 git 或从 Github 下载。

2. 项目使用说明

2.1 基本使用

node-x11 是一个用于 Node.js 的 X11 协议客户端,支持多种 X11 扩展协议。以下是一个简单的使用示例:

var x11 = require('x11');

var Exposure = x11.eventMask.Exposure;
var PointerMotion = x11.eventMask.PointerMotion;

x11.createClient(function(err, display) {
  if (!err) {
    var X = display.client;
    var root = display.screen[0].root;
    var wid = X.AllocID();
    X.CreateWindow(
      wid,
      root, // new window id, parent
      0,
      0,
      500,
      500, // x, y, w, h
      0,
      0,
      0,
      0, // border, depth, class, visual
      { eventMask: Exposure | PointerMotion } // other parameters
    );
    X.MapWindow(wid);
    var gc = X.AllocID();
    X.CreateGC(gc, wid);
    var white = display.screen[0].white_pixel;
    var black = display.screen[0].black_pixel;
    cidBlack = X.AllocID();
    cidWhite = X.AllocID();
    X.CreateGC(cidBlack, wid, { foreground: black, background: white });
    X.CreateGC(cidWhite, wid, { foreground: white, background: black });
    X.on('event', function(ev) {
      if (ev.type == 12) {
        X.PolyFillRectangle(wid, cidWhite, [0, 0, 500, 500]);
        X.PolyText8(wid, cidBlack, 50, 50, ['Hello, Node.JS!']);
      }
    });
    X.on('error', function(e) {
      console.log(e);
    });
  } else {
    console.log(err);
  }
});

2.2 示例截图

  • 俄罗斯方块游戏
  • XRENDER 渐变效果
  • OpenGL glxgears
  • OpenGL 茶壶

3. 项目API使用文档

3.1 createClient

创建一个 X11 客户端连接。

x11.createClient(function(err, display) {
  // 处理连接成功或失败
});

3.2 CreateWindow

创建一个新窗口。

X.CreateWindow(wid, root, x, y, width, height, border, depth, class, visual, options);

3.3 MapWindow

将窗口映射到屏幕上。

X.MapWindow(wid);

3.4 CreateGC

创建一个图形上下文。

X.CreateGC(gc, wid, options);

3.5 on('event')

监听事件。

X.on('event', function(ev) {
  // 处理事件
});

3.6 on('error')

监听错误。

X.on('error', function(e) {
  // 处理错误
});

4. 项目安装方式

4.1 使用 npm 安装

npm install x11

4.2 手动安装

从 Github 下载项目源码,解压后进入项目目录,运行以下命令:

npm install

通过以上步骤,您可以顺利安装并使用 node-x11 项目。

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
144
1.94 K
kernelkernel
deepin linux kernel
C
22
6
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
930
554
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
887
394
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
64
512