Skip to content

described matrix channelOrder in more detail #4133

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

described matrix channelOrder in more detail #4133

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bdf68a3
described matrix channelOrder in more detail
moritzvieli Aug 10, 2024
b3dc4f6
Update docs/fixture-format.md
moritzvieli Aug 20, 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
12 changes: 11 additions & 1 deletion docs/fixture-format.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ Then, either use the resolved channel keys directly in a mode's channel list, or
{
"insert": "matrixChannels", // static value for matrix channels
"repeatFor": "eachPixelXYZ", // see below
"channelOrder": "perPixel", // or "perChannel"
"channelOrder": "perPixel", // see below
"templateChannels": [
"Red $pixelKey",
"Green $pixelKey",
Expand All @@ -319,6 +319,16 @@ Then, either use the resolved channel keys directly in a mode's channel list, or
* `"eachPixelGroup"`: Gets computed into an array of all pixel group keys, ordered by appearance in the JSON file.
- For the above [matrix structure](#matrix-structure) example, this results in `["Inner ring", "Middle ring", "Outer ring"]`.

`channelOrder` defines how the channels are ordered. Possible values are:

* `"perPixel"`: For the above [matrix structure](#matrix-structure) example, this results in
- `["Red Inner ring", "Green Inner ring", "Blue Inner ring"]`
- `["Red Middle ring", "Green Middle ring", "Blue Middle ring"]`
- `["Red Outer ring", "Green Outer ring", "Blue Outer ring"]`
* `"perChannel"`: For the above [matrix structure](#matrix-structure) example, this results in
- `["Red Inner ring", "Red Middle ring", "Red Outer ring"]`
- `["Green Inner ring", "Green Middle ring", "Green Outer ring"]`
- `["Blue Inner ring", "Blue Middle ring", "Blue Outer ring"]`
Comment on lines +324 to +331
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically, it always results in a flat list, so maybe better replace it with this?

Suggested change
* `"perPixel"`: For the above [matrix structure](#matrix-structure) example, this results in
- `["Red Inner ring", "Green Inner ring", "Blue Inner ring"]`
- `["Red Middle ring", "Green Middle ring", "Blue Middle ring"]`
- `["Red Outer ring", "Green Outer ring", "Blue Outer ring"]`
* `"perChannel"`: For the above [matrix structure](#matrix-structure) example, this results in
- `["Red Inner ring", "Red Middle ring", "Red Outer ring"]`
- `["Green Inner ring", "Green Middle ring", "Green Outer ring"]`
- `["Blue Inner ring", "Blue Middle ring", "Blue Outer ring"]`
* `"perPixel"`: For the above [matrix structure](#matrix-structure) example, this results in
- `"Red Inner ring"`
- `"Green Inner ring"`
- `"Blue Inner ring"`
- `"Red Middle ring"`
- `"Green Middle ring"`
- `"Blue Middle ring"`
- `"Red Outer ring"`
- `"Green Outer ring"`
- `"Blue Outer ring"`
* `"perChannel"`: For the above [matrix structure](#matrix-structure) example, this results in
- `"Red Inner ring"`
- `"Red Middle ring"`
- `"Red Outer ring"`
- `"Green Inner ring"`
- `"Green Middle ring"`
- `"Green Outer ring"`
- `"Blue Inner ring"`
- `"Blue Middle ring"`
- `"Blue Outer ring"`

However, this is quite long. Better suggestions?


### Wheels

Expand Down
Loading