Merge pull request #743 from go-vgo/bitmap-pr

Update: update readme.md and godoc
This commit is contained in:
Evans 2025-11-25 11:21:47 -08:00 committed by GitHub
commit 0dc14a00fb
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 30 additions and 9 deletions

View file

@ -57,7 +57,9 @@ GCC
brew install go
```
Xcode Command Line Tools (And Privacy setting: [#277](https://github.com/go-vgo/robotgo/issues/277))
Xcode Command Line Tools; <br>
And Privacy setting, add Screen Recording and Accessibility under: <br>
`System Settings > Privacy & Security > Accessibility, Screen & System Audio Recording`.
```
xcode-select --install
@ -89,11 +91,9 @@ X11 with the XTest extension (the Xtst library)
"Clipboard": xsel xclip
"Bitmap": libpng (Just used by the "bitmap".)
"Event-Gohook": xcb, xkb, libxkbcommon (Just used by the "hook".)
```
##### Ubuntu:
@ -111,13 +111,11 @@ sudo apt install libx11-dev xorg-dev libxtst-dev
# Clipboard
sudo apt install xsel xclip
#
# Bitmap
sudo apt install libpng++-dev
# GoHook
sudo apt install xcb libxcb-xkb-dev x11-xkb-utils libx11-xcb-dev libxkbcommon-x11-dev libxkbcommon-dev
```
##### Fedora:
@ -129,13 +127,11 @@ sudo dnf install libXtst-devel
# Clipboard
sudo dnf install xsel xclip
#
# Bitmap
sudo dnf install libpng-devel
# GoHook
sudo dnf install libxkbcommon-devel libxkbcommon-x11-devel xorg-x11-xkb-utils-devel
```
## Installation:

29
doc.go
View file

@ -1,5 +1,6 @@
// Copyright 2016 The go-vgo Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// Copyright (c) 2016-2025 AtomAI, All rights reserved.
//
// See the COPYRIGHT file at the top-level directory of this distribution and at
// https://github.com/go-vgo/robotgo/blob/master/LICENSE
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
@ -117,3 +118,27 @@ Keys are supported:
"lights_kbd_up" Turn up keyboard backlight brightness No Windows support
"lights_kbd_down" Turn down keyboard backlight brightness No Windows support
*/
/*
## Type Conversion
| | type conversion | func
|-----|---------------------|----------------------
| * | robotgo.Bitmap -> robotgo.CBitmap | robotgo.ToCBitmap()
| | robotgo.Bitmap -> *image.RGBA | robotgo.ToRGBAGo()
| * | robotgo.CBitmap -> C.MMBitmapRef | robotgo.ToMMBitmapRef()
| | robotgo.CBitmap -> robotgo.Bitmap | robotgo.ToBitmap()
| | robotgo.CBitmap -> image.Image | robotgo.ToImage()
| | robotgo.CBitmap -> *image.RGBA | robotgo.ToRGBA()
| * | C.MMBitmapRef -> robotgo.CBitmap | robotgo.CBitmap()
| * | image.Image -> robotgo.Bitmap | robotgo.ImgToBitmap()
| | image.Image -> robotgo.CBitmap | robotgo.ImgToCBitmap()
| | image.Image -> []byte | robotgo.ToByteImg()
| | image.Image -> string | robotgo.ToStringImg()
| * | *image.RGBA -> robotgo.Bitmap | robotgo.RGBAToBitmap()
| * | []byte -> image.Image | robotgo.ByteToImg()
| | []byte-> robotgo.CBitmap | robotgo.ByteToCBitmap()
| | []byte -> string | string()
| * | string -> image.Image | robotgo.StrToImg()
| | string -> byte | []byte()
*/