Standards: Difference between revisions

Revision as of 11:27, 6 May 2025

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

Do not use any of these standards yet as they are all WIP!

World Color


Dynamic Variable Name	Type	Description	Range
`World/Hue^I`	`float`	The main HSV hue value of the world color.	`0.0` - `1.0`
`World/Saturation^I`	`float`	The main HSV saturation value of the world color.	`0.0` - `1.0`
`World/Intensity^I`	`float`	The main HSV intensity value of the world color. When in a music world, should correspond to the volume of the music.	`0.0` - Unlimited
`World/Color^I`	`ColorX`	Must be a combination of `World/Hue^I` and `World/Saturation^I` with the Intensity set to `1.0`	`(H,S,1.0)`
`World/ColorVersion`	`uint`	Must exist if there is color information in the world. Corresponds to the version of the world color standard.	`1`
`World/ColorCount`	`uint`	Must exist if there is color information in the world. Corresponds to the amount of color variables in the world.	`1` - Unlimited
`World/Hue`	`float`	Must be the same as `World/Hue0`	`World/Hue0`
`World/Saturation`	`float`	Must be the same as `World/Saturation0`	`World/Saturation0`
`World/Intensity`	`float`	Must be the same as `World/Intensity0`	`World/Intensity0`
`World/Color`	`ColorX`	Must be the same as `World/Color0`	`World/Color0`
`World/ColorType`	`uint`	Defines how users will interpret the color list. If `0`, users are free to interpret it however they like. If the user does not recognize the color type, treat the color list as if the type is set to `0`	`0` - Unlimited

For each Dynvar that has an ^I at the end of it, replace the ^I with the color unsigned color index. Indices start at 0.

Color Types


Index	Behavior	Amount of indices
0	Any.	Unlimited
1	Simple list. Colors can be anything.	Unlimited
2	Stereo channel volume. Intensity corresponds to the volume. Hue and saturation can be anything.	`2`
3	FFT16. `0` is lowest frequency, `15` is the highest. Intensity corresponds to the volume of that frequency. Hue and saturation can be anything.	`16`
4	Percussion. Louder instruments go lower in the color list. Intensity corresponds to the current loudness of that instrument. Hue and saturation can be anything.	Unlimited
5	Melody. Lower notes go lower in the color list where `0` is C2 and `59` is C7. Intensity corresponds to the current velocity of a given note. Hue and saturation can be anything.	`60`
6	Primary, Secondary, Tertiary, Quaternary colors. More common colors go lower in the color list. If a user requests the color that is above the index count, they must choose the highest one in the list. Colors can be anything.	`1` - `4`

Examples

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

@@ Line 11: / Line 11: @@
 !Range
 |-
-|<code>World/Hue'''''I'''''</code>
+|<code>World/Hue'''''<sup>I</sup>'''''</code>
 |<code>float</code>
 |The main HSV hue value of the world color.
 |<code>0.0</code> - <code>1.0</code>
 |-
-|<code>World/Saturation'''''I'''''</code>
+|<code>World/Saturation'''''<sup>I</sup>'''''</code>
 |<code>float</code>
 |The main HSV saturation value of the world color.
 |<code>0.0</code> - <code>1.0</code>
 |-
-|<code>World/Intensity'''''I'''''</code>
+|<code>World/Intensity'''''<sup>I</sup>'''''</code>
 |<code>float</code>
 |The main HSV intensity value of the world color.
@@ Line 27: / Line 27: @@
 |<code>0.0</code> - Unlimited
 |-
-|<code>World/Color'''''I'''''</code>
+|<code>World/Color'''''<sup>I</sup>'''''</code>
 |<code>ColorX</code>
-|'''Must''' be a combination of <code>World/Hue'''''I'''''</code> and <code>World/Saturation'''''I'''''</code> with the Intensity set to <code>1.0</code>
+|'''Must''' be a combination of <code>World/Hue'''''<sup>I</sup>'''''</code> and <code>World/Saturation'''''<sup>I</sup>'''''</code> with the Intensity set to <code>1.0</code>
 |<code>(H,S,1.0)</code>
 |-
@@ Line 69: / Line 69: @@
 |<code>0</code> - Unlimited
 |}
-For each Dynvar that has an <code>'''''I'''''</code> at the end of it, replace it with the color unsigned color index. Indices start at 0.
+For each Dynvar that has an <code>'''''<sup>I</sup>'''''</code> at the end of it, replace the <code>'''''<sup>I</sup>'''''</code> with the color unsigned color index. Indices start at 0.
 === Color Types ===