hyprwm/aquamarine
1
0
Fork 0
mirror of https://github.com/hyprwm/aquamarine.git synced 2024-11-17 00:15:59 +01:00
Code Issues Projects Releases Packages Wiki Activity

docs: improve and expand DRM environment variable documentation

Browse source 
- Clarified explanations for `AQ_DRM_DEVICES`, `AQ_NO_ATOMIC`, `AQ_MGPU_NO_EXPLICIT`, and `AQ_NO_MODIFIERS`
- Added more detailed descriptions and use cases for each setting
- Improved formatting for better readability
This commit is contained in:
Roman Stingler 2024-09-06 20:14:30 +02:00
parent a8eb8ae014
commit e521b037aa
1 changed files with 22 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
docs/env.md
View file

@ -4,10 +4,28 @@ Unless specified otherwise, a variable is enabled if and only if it's set to `1`
### DRM
`AQ_DRM_DEVICES` -> Set an explicit list of DRM devices (GPUs) to use. It's a colon-separated list of paths, with the first being the primary. E.g. `/dev/dri/card1:/dev/dri/card0`
`AQ_NO_ATOMIC` -> Disables drm atomic modesetting
`AQ_MGPU_NO_EXPLICIT` -> Disables explicit syncing on mgpu buffers
`AQ_NO_MODIFIERS` -> Disables modifiers for DRM buffers
### DRM Devices and Settings
`AQ_DRM_DEVICES` -> This option allows you to set a specific list of DRM devices (GPUs) for the system to use.
The list is separated by colons (:), and the first device listed will be the primary GPU.
For example: `/dev/dri/card1:/dev/dri/card0`.
This means the system will primarily use `card1` and then fall back to `card0` if needed.
`AQ_NO_ATOMIC` -> Disables atomic mode setting for the DRM.
Atomic mode setting is a feature that makes screen updates more reliable by grouping changes together.
Setting AQ_NO_ATOMIC to 1 can be useful on hardware or drivers that don’t fully support atomic mode setting,
as it can prevent crashes or freezes caused by incomplete or incorrect atomic updates.
`AQ_MGPU_NO_EXPLICIT` -> Disables explicit synchronization between buffers when using multiple GPUs (multi-GPU setups).
Without explicit syncing, the system handles buffer transfers between GPUs more automatically,
which can improve performance in some cases but might introduce errors in more complex setups.
`AQ_NO_MODIFIERS` -> Disables DRM modifiers for buffers.
This can also resolve issues where a monitor fails to turn on or is not detected properly.
DRM modifiers define how pixel data is stored in memory (e.g., in optimized formats).
Setting `AQ_NO_MODIFIERS` to `1` ensures simpler buffer handling,
which might be necessary on hardware that doesn’t support advanced memory layouts,
especially for high resolutions like 4K.
### Debugging