Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"Fix" README.md #91

Merged
merged 2 commits into from
Oct 21, 2024
Merged

"Fix" README.md #91

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
55f548e
chore(README.md): Backtick the following protocols
pparaxan Oct 21, 2024
b234e85
chore(README.md): Capitalize the word `Wayfire`
pparaxan Oct 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# wl-screenrec

High performance screen recorder for wlroots Wayland.
High performance screen recorder for wlroots Wayland.

Uses dma-buf transfers to get surface, and uses the GPU to do both the pixel format conversion and the encoding,
meaning the raw video data never touches the CPU, leaving it free to run your applications.
Expand All @@ -11,10 +11,10 @@ Open an issue if something is not working, I'm happy to take a look.

* wayland compositor supporting the following protocols:
* [`wlr-screencopy-unstable-v1`](https://wayland.app/protocols/wlr-screencopy-unstable-v1)
* [`linux-dmabuf-v1](https://wayland.app/protocols/linux-dmabuf-v1)
* [`xdg-output-unstable-v1](https://wayland.app/protocols/xdg-output-unstable-v1)
* [`linux-dmabuf-v1`](https://wayland.app/protocols/linux-dmabuf-v1)
* [`xdg-output-unstable-v1`](https://wayland.app/protocols/xdg-output-unstable-v1)

[Sway](https://swaywm.org/), [Hyprland](https://hyprland.org/), and [wayfire](https://wayfire.org/) all meet this criteria.
[Sway](https://swaywm.org/), [Hyprland](https://hyprland.org/), and [Wayfire](https://wayfire.org/) all meet this criteria.
* [`vaapi`](https://01.org/temp-linuxgraphics/community/vaapi) encode support, consult your distribution for how to set this up. Known good configurations:
* Intel iGPUs
* Radeon GPUs
Expand Down Expand Up @@ -96,7 +96,7 @@ wl-screenrec -g "0,0 128x128" # manual region

Capture 444 video (no pixel format compression):

> NOTE: Look at `vainfo -a` to see your supported pixel formats. Support is very
> NOTE: Look at `vainfo -a` to see your supported pixel formats. Support is very
> hardware-dependent. For example, on my machine only HEVC suports 444 formats, and
> all of 8-bit RGB formats didn't work for whatever reason.

Expand Down