v/deskreen
1
0
Fork 0
mirror of https://github.com/pavlobu/deskreen.git synced 2025-05-27 21:00:08 -07:00
Code Issues Projects Releases Wiki Activity

docs more

Browse Source
This commit is contained in:
Pavlo Buidenkov 2021-01-24 12:14:21 +02:00
parent 4568ebbb44
commit 436ca1c919
2 changed files with 21 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -25,7 +25,7 @@ If you are a seasoned Windows or Linux or MacOS hacker with a knowledge of low l
On a long run Deskreen seeks for getting rid of Display Dummy Plugs, because most people don't like using them. Sometimes they can't use them because all available display ports are already taken.
**So we need to have native drivers for Win / Mac / Linux that will help to enable virtual display wihtout Dummy Display Plugs.**
There are already working commercial solutions out there with their own drivers which they don't disclose, but this task is doable with a help of entire community.
The goal of Deskreen is to enable community power and knowledge to overcome these technical challanges and make it a go-to second screen solution, that everyone will benefit from!
The goal of Deskreen is to enable community power and knowledge to overcome these technical challenges and make it a go-to second screen solution that everyone will benefit from!
We plan on making virtual display driver support for each of three main operating systems and place all OS related codes in **[`./drivers`](drivers)** subdirectory of this project.
You can find brief requirements for driver API in **[`./drivers/README.md`](drivers)**.

25
drivers/README.md
View File

@ -1,11 +1,18 @@
## Deskreen `drivers` : getting rid of Display Dummy Plugs
## Deskreen `drivers` : getting rid from Display Dummy Plugs
We plan to add vritual display driver support for three most popular operating systems. The driver related codes can be places in following subdirectories `win`, `mac`, `linux`.
It is a challanging technical task and we need to enable an entire community to solve it. If you know a solution and willing to contribute, you are highly welcome!
We plan to add vritual display driver support for three most popular operating systems. The driver related codes can be placed in following subdirectories `win`, `mac`, `linux`.
It is a challenging technical task and we need to enable an entire community power to solve it. If you know a solution and willing to contribute, you are highly welcome!
### Things that you need to keep in mind while making your virtual display driver solution for Deskreen:
1. The driver code can be in any language you are comfortable with, the most important that the API should provide a functionality to **add**, **set virtual display resolution**, **get virtual display resolution**, and **remove** the virtual display.
1. The driver code can be in any language you are comfortable with, the most important that the API should provide a functionality to:
- **add**
- **set virtual display resolution**
- **get virtual display resolution**
- **get available resolutions of virtual display**
- **remove the virtual display**
2. Your driver code will be interfaced with Typescript/JavaScript after your successful submission. You **don't** have to write an interface for JS yourself. The community will come to help. It is going to be implemented by maintainer and other community members if there are any to voluneer. But if you want, you can participate in making a JS interface for it.
3. After creating virtual display with you driver code API, it should display virtual screen in native **OS** _Displays_ settings, so that user will be able to arrange it as a normal display. (similar to how commercial solutions work)
@ -14,7 +21,9 @@ It is a challanging technical task and we need to enable an entire community to
#### Add Virtual Display
```C++
driver.addVirtualDisplay(width: 640, height: 480) : // returns OS specific virtual display ID usually it's integer but can be other type as well.
// creates a virtual display with a list of common display resolutions available, sets default display resolution to
// some decent one ex: 1280x720
driver.addVirtualDisplay() : // returns OS specific virtual display ID usually it's integer but can be other type as well.
```
#### Set Virtual Display Resolution
@ -29,6 +38,12 @@ driver.setVirtualDisplayResolution(virtualDisplayID: 123543, width: 640, height:
driver.getVirtualDisplayResolution(virtualDisplayID: 123543) : // returns object: { width: int, height: int }
```
#### Get Available Virtual Display Resolutions
```C++
driver.getAvailableVirtualDisplayResolutions(virtualDisplayID: 123543) : // returns object: { width: int, height: int }
```
#### Remove Virtual Display -- disconnects virtual display from OS
```C++