Skip to content

Commit 1a9d6da

Browse files
Merge branch 'simplifyComponentTypes' into 'main'
[REMIX-4384] Simplify the component types. See merge request lightspeedrtx/dxvk-remix-nv!1808
2 parents 2fc629d + 5eb7761 commit 1a9d6da

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+594
-662
lines changed

documentation/ComponentsAndGraphs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ Then use it in your parameter definition:
135135
136136
```cpp
137137
#define LIST_INPUTS(X) \
138-
X(RtComponentPropertyType::Uint32, 0, lightType, "Light Type", "The type of light to create", \
138+
X(RtComponentPropertyType::Enum, 0, lightType, "Light Type", "The type of light to create", \
139139
property.enumValues = { \
140140
{"Point", {LightType::Point, "Omnidirectional point light"}}, \
141141
{"Spot", {LightType::Spot, "Directional spot light with falloff"}}, \

documentation/components/AnimatedFloat.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ A single animated float value\.
1717
| initialValue | Initial Value | Float | Input | 0\.0 | No |
1818
| finalValue | Final Value | Float | Input | 1\.0 | No |
1919
| duration | Duration | Float | Input | 1\.0 | No |
20-
| loopingType | Looping Type | Uint32 | Input | Loop | No |
21-
| interpolation | Interpolation | Uint32 | Input | Linear | Yes |
20+
| loopingType | Looping Type | Enum | Input | Loop | No |
21+
| interpolation | Interpolation | Enum | Input | Linear | Yes |
2222

2323
### Enabled
2424

@@ -48,7 +48,7 @@ How long it takes to animate from initial value to final value, in seconds\.
4848

4949
What happens when the float reaches the final value\.
5050

51-
Underlying Type: `Uint32`
51+
Underlying Type: `Enum`
5252

5353

5454
**Allowed Values:**
@@ -62,7 +62,7 @@ Underlying Type: `Uint32`
6262

6363
How the float will change over time\.
6464

65-
Underlying Type: `Uint32`
65+
Underlying Type: `Enum`
6666

6767

6868
**Allowed Values:**

documentation/components/BoxProximity.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Calculates the signed distance from a world position to a mesh's bounding box\.
1515
|----------|--------------|------|---------|---------------|----------|
1616
| target | Target | Prim | Input | None | No |
1717
| worldPosition | World Position | Float3 | Input | \[0\.0, 0\.0, 0\.0\] | No |
18-
| inactiveDistance | Inactive Distance | Float | Input | 0\.0 | Yes |
19-
| fullActivationDistance | Full Activation Distance | Float | Input | 1\.0 | Yes |
20-
| easingType | Easing Type | Uint32 | Input | Linear | Yes |
18+
| inactiveDistance | Inactive Distance | Float | Input | 1\.0 | Yes |
19+
| fullActivationDistance | Full Activation Distance | Float | Input | 0\.0 | Yes |
20+
| easingType | Easing Type | Enum | Input | Linear | Yes |
2121

2222
### Target
2323

@@ -43,7 +43,7 @@ The distance inside the bounding box that corresponds to a normalized value of 1
4343

4444
The type of easing to apply to the normalized output\.
4545

46-
Underlying Type: `Uint32`
46+
Underlying Type: `Enum`
4747

4848

4949
**Allowed Values:**

documentation/components/Interpolate.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Interpolates a value from an input range to an output range with optional easing
1717
| inputMin | Input Min | Float | Input | 0\.0 | No |
1818
| inputMax | Input Max | Float | Input | 1\.0 | No |
1919
| clampInput | Clamp Input | Bool | Input | false | Yes |
20-
| easingType | Easing Type | Uint32 | Input | Linear | No |
20+
| easingType | Easing Type | Enum | Input | Linear | No |
2121
| shouldReverse | Should Reverse | Bool | Input | false | Yes |
2222
| outputMin | Output Min | NumberOrVector | Input | 0 | No |
2323
| outputMax | Output Max | NumberOrVector | Input | 0 | No |
@@ -46,7 +46,7 @@ If true, \`value\` will be clamped to the input range\.
4646

4747
The type of easing to apply\.
4848

49-
Underlying Type: `Uint32`
49+
Underlying Type: `Enum`
5050

5151

5252
**Allowed Values:**
@@ -93,12 +93,10 @@ This component supports flexible types. The following type combinations are vali
9393

9494
| # | clampInput | easingType | inputMax | inputMin | interpolatedValue | outputMax | outputMin | shouldReverse | value |
9595
|---|---|---|---|---|---|---|---|---|---|
96-
| 1 | Bool | Uint32 | Float | Float | Float | Float | Float | Bool | Float |
97-
| 2 | Bool | Uint32 | Float | Float | Float2 | Float2 | Float2 | Bool | Float |
98-
| 3 | Bool | Uint32 | Float | Float | Float3 | Float3 | Float3 | Bool | Float |
99-
| 4 | Bool | Uint32 | Float | Float | Color4 | Color4 | Color4 | Bool | Float |
100-
101-
**Note:** Float3 and Color3 both use the same underlying type (3-component vector). Color4 uses a 4-component vector.
96+
| 1 | Bool | Enum | Float | Float | Float | Float | Float | Bool | Float |
97+
| 2 | Bool | Enum | Float | Float | Float2 | Float2 | Float2 | Bool | Float |
98+
| 3 | Bool | Enum | Float | Float | Float3 | Float3 | Float3 | Bool | Float |
99+
| 4 | Bool | Enum | Float | Float | Float4 | Float4 | Float4 | Bool | Float |
102100

103101
## Usage Notes
104102

documentation/components/InterpolateFloat.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Interpolates a value from an input range to an output range with optional easing
1717
| inputMin | Input Min | Float | Input | 0\.0 | No |
1818
| inputMax | Input Max | Float | Input | 1\.0 | No |
1919
| clampInput | Clamp Input | Bool | Input | false | Yes |
20-
| easingType | Easing Type | Uint32 | Input | Linear | No |
20+
| easingType | Easing Type | Enum | Input | Linear | No |
2121
| shouldReverse | Should Reverse | Bool | Input | false | Yes |
2222
| outputMin | Output Min | Float | Input | 0\.0 | No |
2323
| outputMax | Output Max | Float | Input | 1\.0 | No |
@@ -46,7 +46,7 @@ If true, \`value\` will be clamped to the input range\.
4646

4747
The type of easing to apply\.
4848

49-
Underlying Type: `Uint32`
49+
Underlying Type: `Enum`
5050

5151

5252
**Allowed Values:**

documentation/components/LoopFloat.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Applies looping behavior to a float value\. Value is unchanged if it is inside
1616
| value | Value | Float | Input | 0\.0 | No |
1717
| minRange | Min Range | Float | Input | 0\.0 | No |
1818
| maxRange | Max Range | Float | Input | 1\.0 | No |
19-
| loopingType | Looping Type | Uint32 | Input | Loop | No |
19+
| loopingType | Looping Type | Enum | Input | Loop | No |
2020

2121
### Value
2222

@@ -37,7 +37,7 @@ The maximum value of the looping range\.
3737

3838
How the value should loop within the range\.
3939

40-
Underlying Type: `Uint32`
40+
Underlying Type: `Enum`
4141

4242

4343
**Allowed Values:**

documentation/components/MeshHashChecker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The mesh hash to check for usage in the current frame\.
2525
| Property | Display Name | Type | IO Type | Default Value | Optional |
2626
|----------|--------------|------|---------|---------------|----------|
2727
| isUsed | Is Used | Bool | Output | false | No |
28-
| usageCount | Usage Count | Uint32 | Output | 0 | No |
28+
| usageCount | Usage Count | Float | Output | 0\.0 | No |
2929

3030
### Is Used
3131

documentation/components/RtxOptionLayerAction.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Controls an RtxOptionLayer by name, allowing dynamic enable/disable, strength ad
1717
| enabled | Enabled | Bool | Input | true | Yes |
1818
| blendStrength | Blend Strength | Float | Input | 1\.0 | Yes |
1919
| blendThreshold | Blend Threshold | Float | Input | 0\.1 | Yes |
20-
| priority | Priority | Uint32 | Input | 10000 | Yes |
20+
| priority | Priority | Enum | Input | 10000 | Yes |
2121

2222
### Config Path
2323

@@ -63,11 +63,11 @@ The priority for the option layer\. Higher values are blended onto lower values\
6363

6464
| Property | Display Name | Type | IO Type | Default Value | Optional |
6565
|----------|--------------|------|---------|---------------|----------|
66-
| cachedLayerPtr | | Uint64 | State | 0 | No |
66+
| holdsReference | | Bool | State | false | No |
6767

6868
###
6969

70-
Cached pointer to the RtxOptionLayer \(internal use\)\.
70+
True if the component is holding a reference to the RtxOptionLayer\.
7171

7272

7373
## Usage Notes

documentation/components/TextureHashChecker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The texture hash to check for usage in the current frame\.
2525
| Property | Display Name | Type | IO Type | Default Value | Optional |
2626
|----------|--------------|------|---------|---------------|----------|
2727
| isUsed | Is Used | Bool | Output | false | No |
28-
| usageCount | Usage Count | Uint32 | Output | 0 | No |
28+
| usageCount | Usage Count | Float | Output | 0\.0 | No |
2929

3030
### Is Used
3131

src/dxvk/rtx_render/graph/components/animated_float.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ namespace components {
3535
X(RtComponentPropertyType::Float, 0.0f, initialValue, "Initial Value", "The value at time t=0.") \
3636
X(RtComponentPropertyType::Float, 1.0f, finalValue, "Final Value", "The value at time t=duration.") \
3737
X(RtComponentPropertyType::Float, 1.0f, duration, "Duration", "How long it takes to animate from initial value to final value, in seconds.", property.minValue = 0.000001f) \
38-
X(RtComponentPropertyType::Uint32, static_cast<uint32_t>(LoopingType::Loop), loopingType, "Looping Type", \
38+
X(RtComponentPropertyType::Enum, static_cast<uint32_t>(LoopingType::Loop), loopingType, "Looping Type", \
3939
"What happens when the float reaches the final value.", \
4040
property.enumValues = kLoopingTypeEnumValues) \
41-
X(RtComponentPropertyType::Uint32, static_cast<uint32_t>(InterpolationType::Linear), interpolation, "Interpolation", \
41+
X(RtComponentPropertyType::Enum, static_cast<uint32_t>(InterpolationType::Linear), interpolation, "Interpolation", \
4242
"How the float will change over time.", \
4343
property.optional = true, \
4444
property.enumValues = kInterpolationTypeEnumValues) \

0 commit comments

Comments
 (0)